.. role:: python(code)
   :language: python

.. toctree::
   :titlesonly:
   :maxdepth: 0

Welcome
-------

This documentation will guide you through the methods available in the Button SHIM python library.

Button SHIM is a tiny Raspberry Pi add-on with 5 tactile buttons and one teeny RGB LED.

* More information - https://shop.pimoroni.com/products/button-shim
* Get the code - https://github.com/pimoroni/button-shim
* Get help - http://forums.pimoroni.com/c/support

At A Glance
-----------

.. automoduleoutline:: buttonshim
   :members:

Set The Pixel
-------------

.. automodule:: buttonshim
   :noindex:
   :members: set_pixel

Handle A Button Press
---------------------

.. automodule:: buttonshim
   :noindex:
   :members: on_press

Handle A Button Release
-----------------------

.. automodule:: buttonshim
   :noindex:
   :members: on_release

Handle A Button Hold
--------------------

.. automodule:: buttonshim
   :noindex:
   :members: on_hold

Get The Name Of A Button
------------------------

.. automodule:: buttonshim
   :noindex:
   :members: NAMES

