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

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

Welcome
-------

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

Piano HAT is a musical Raspberry Pi add-on with 13 capacitive-touch piano keys plus octave and instrument select pads.

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

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

.. automoduleoutline:: pianohat
   :members:

Automatic LEDs
--------------

.. automodule:: pianohat
   :noindex:
   :members: auto_leds

Get A Button State
------------------

.. automodule:: pianohat
   :noindex:
   :members: get_state

Instrument Button
-----------------

.. automodule:: pianohat
   :noindex:
   :members: on_instrument

Note
----

.. automodule:: pianohat
   :noindex:
   :members: on_note

Octave Down
-----------

.. automodule:: pianohat
   :noindex:
   :members: on_octave_down

Octave Up
---------

.. automodule:: pianohat
   :noindex:
   :members: on_octave_up

Turn LED On/Off
---------------

.. automodule:: pianohat
   :noindex:
   :members: set_led

Change LED Transition Speed
---------------------------

.. automodule:: pianohat
   :noindex:
   :members: set_led_ramp_rate
