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

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

Welcome
-------

This documentation will guide you through the methods available in the Drum HAT python library.

Drum HAT is a musical Raspberry Pi add-on with 8 capacitive-touch drum pads.

* More information - https://shop.pimoroni.com/products/drum-hat
* GPIO Pinout - http://pinout.xyz/pinout/drum_hat
* Get the code - https://github.com/pimoroni/drum-hat
* Get help - http://forums.pimoroni.com/c/support

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

.. automoduleoutline:: drumhat
   :members:

Turn Off All Lights
-------------------

.. automodule:: drumhat
   :noindex:
   :members: all_off

Turn On All Lights
------------------

.. automodule:: drumhat
   :noindex:
   :members: all_on

Turn On A Light
---------------

.. automodule:: drumhat
   :noindex:
   :members: led_on

Turn Off A Light
----------------

.. automodule:: drumhat
   :noindex:
   :members: led_off

Detect A Hit
------------

.. automodule:: drumhat
   :noindex:
   :members: on_hit

Detect A Release
----------------

.. automodule:: drumhat
   :noindex:
   :members: on_release
