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

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

Welcome
-------

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

Unicorn HAT is a Raspberry Pi add-on with 64 individually controllable RGB LEDs.

* More information - https://shop.pimoroni.com/products/unicorn-hat
* GPIO pinout - https://pinout.xyz/unicorn_hat
* Get the code - https://github.com/pimoroni/unicorn-hat
* Get started - https://learn.pimoroni.com/tutorial/unicorn-hat/getting-started-with-unicorn-hat
* Get help - http://forums.pimoroni.com/c/support

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

.. automoduleoutline:: unicornhat
   :members:

Brightness
----------

.. autofunction:: unicornhat.brightness

Clear
-----

.. autofunction:: unicornhat.clear

Get Brightness
--------------

.. autofunction:: unicornhat.get_brightness

Get Pixel
---------

.. autofunction:: unicornhat.get_pixel

Get Pixels
----------

.. autofunction:: unicornhat.get_pixels

Get Shape
---------

.. autofunction:: unicornhat.get_shape

Turn Off
--------

.. autofunction:: unicornhat.off

Rotation
--------

.. autofunction:: unicornhat.rotation

Set All
-------

.. autofunction:: unicornhat.set_all

Set Layout
----------

.. autofunction:: unicornhat.set_layout

Set Pixel
---------

.. autofunction:: unicornhat.set_pixel

Set Pixel HSV
-------------

.. autofunction:: unicornhat.set_pixel_hsv

Set Pixels
----------

.. autofunction:: unicornhat.set_pixels

Shade Pixels
------------

.. autofunction:: unicornhat.shade_pixels

Show
----

.. autofunction:: unicornhat.show
