Skip to content

Organizing Helpers list #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 30, 2019
Merged

Organizing Helpers list #189

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
01a067d
first pass at organizing helpers
Aug 28, 2019
75a2ae9
add line break
Aug 28, 2019
51e328a
uncat. -> Miscellaneous
Aug 28, 2019
33b4714
adding audio and cpython style categories
Aug 28, 2019
5d2c7d3
add descriptions
Aug 28, 2019
deacdbe
add subheadings
Aug 30, 2019
3b2290e
fix sphinx styling
Aug 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 100 additions & 31 deletions docs/drivers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,53 +35,122 @@ Helper Libraries

These libraries build on top of the low level APIs to simplify common tasks.

LED Helpers
^^^^^^^^^^^^

Helpers for animating LEDs.

.. toctree::

Fancy LED (similar to FastLED) <https://circuitpython.readthedocs.io/projects/fancyled/en/latest/>
LED Animation <https://adafruit-circuitpython-led-animation.readthedocs.io/en/latest/>

User Interface and GFX Helpers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Helpers for building graphical interfaces using the displayio core module.

.. toctree::

Adafruit IO <https://circuitpython.readthedocs.io/projects/adafruitio/en/latest/>
AVR programming <https://circuitpython.readthedocs.io/projects/avrprog/en/latest/>
Azure IoT <https://circuitpython.readthedocs.io/projects/azureiot/en/latest/>
binascii <https://circuitpython.readthedocs.io/projects/binascii/en/latest/>
Bitmap Font <https://circuitpython.readthedocs.io/projects/bitmap-font/en/latest/>
Bluefruit LE Connect App <https://circuitpython.readthedocs.io/projects/bluefruitconnect/en/latest/>
Bluetooth Low Energy (BLE) <https://circuitpython.readthedocs.io/projects/ble/en/latest/>
Board Test Suite <https://circuitpython.readthedocs.io/projects/boardtest/en/latest/>
Google Cloud IoT Core <https://circuitpython.readthedocs.io/projects/gc_iot_core/en/latest/>
Cursor Control <https://circuitpython.readthedocs.io/projects/cursorcontrol/en/latest/>
DC Motor and Servo <https://circuitpython.readthedocs.io/projects/motor/en/latest/>
Debouncer <https://circuitpython.readthedocs.io/projects/debouncer/en/latest/>
Bitmap Font <https://circuitpython.readthedocs.io/projects/bitmap-font/en/latest/>
Display Button <https://circuitpython.readthedocs.io/projects/display_button/en/latest/>
Display Shapes <https://circuitpython.readthedocs.io/projects/display_shapes/en/latest/>
Display Text <https://circuitpython.readthedocs.io/projects/display-text/en/latest/>
Fancy LED (similar to FastLED) <https://circuitpython.readthedocs.io/projects/fancyled/en/latest/>
PyBadger <https://circuitpython.readthedocs.io/projects/pybadger/en/latest/>
PYOA <https://circuitpython.readthedocs.io/projects/pyoa/en/latest/>
Turtle Graphics <https://circuitpython.readthedocs.io/projects/turtle/en/latest/>
Slideshow <https://circuitpython.readthedocs.io/projects/slideshow/en/latest/>
Framebuf Module <https://circuitpython.readthedocs.io/projects/framebuf/en/latest/>
hashlib <https://circuitpython.readthedocs.io/projects/hashlib/en/latest/>
Hue Lights <https://circuitpython.readthedocs.io/projects/hue/en/latest/>
miniQR Non-hardware QR code generator <https://circuitpython.readthedocs.io/projects/miniqr/en/latest/>
Image Load <https://circuitpython.readthedocs.io/projects/imageload/en/latest/>
InfraRed Remote <https://circuitpython.readthedocs.io/projects/irremote/en/latest/>
IterTools <https://circuitpython.readthedocs.io/projects/itertools/en/latest/>
JSON Web Token (JWT) <https://circuitpython.readthedocs.io/projects/jwt/en/latest/>
LED Animation <https://adafruit-circuitpython-led-animation.readthedocs.io/en/latest/>

Motor Helpers
^^^^^^^^^^^^^^

Helpers for driving motors, servos, and steppers.

.. toctree::

DC Motor and Servo <https://circuitpython.readthedocs.io/projects/motor/en/latest/>
MotorKit <https://circuitpython.readthedocs.io/projects/motorkit/en/latest/>
ServoKit <https://circuitpython.readthedocs.io/projects/servokit/en/latest/>

Internet of Things Web Service Helpers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Helpers for connecting with hosted and self-hosted internet-of-things web services.

.. toctree::

Adafruit IO <https://circuitpython.readthedocs.io/projects/adafruitio/en/latest/>
Azure IoT <https://circuitpython.readthedocs.io/projects/azureiot/en/latest/>
Google Cloud IoT Core <https://circuitpython.readthedocs.io/projects/gc_iot_core/en/latest/>
LIFX Lights <https://circuitpython.readthedocs.io/projects/lifx/en/latest/>
Logging <https://circuitpython.readthedocs.io/projects/logging/en/latest/>
Hue Lights <https://circuitpython.readthedocs.io/projects/hue/en/latest/>

Internet-of-Things/Wireless Protocol Helpers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Helpers for interfacing with the internet or wireless communication.

.. toctree::

Bluefruit LE Connect App <https://circuitpython.readthedocs.io/projects/bluefruitconnect/en/latest/>
Bluetooth Low Energy (BLE) <https://circuitpython.readthedocs.io/projects/ble/en/latest/>
TinyLoRa TTN Helper <https://circuitpython.readthedocs.io/projects/tinylora/en/latest/>
Mini ESP Tool <https://circuitpython.readthedocs.io/projects/miniesptool/en/latest/>
MiniMQTT <https://circuitpython.readthedocs.io/projects/minimqtt/en/latest/>
miniQR Non-hardware QR code generator <https://circuitpython.readthedocs.io/projects/miniqr/en/latest/>
MotorKit <https://circuitpython.readthedocs.io/projects/motorkit/en/latest/>
NTP (Network time Protocol) <https://circuitpython.readthedocs.io/projects/ntp/en/latest/>
OneWire <https://circuitpython.readthedocs.io/projects/onewire/en/latest/>
PyBadger <https://circuitpython.readthedocs.io/projects/pybadger/en/latest/>
PYOA <https://circuitpython.readthedocs.io/projects/pyoa/en/latest/>
JSON Web Token (JWT) <https://circuitpython.readthedocs.io/projects/jwt/en/latest/>
Requests <https://circuitpython.readthedocs.io/projects/requests/en/latest/>
Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/en/latest/>
NTP (Network time Protocol) <https://circuitpython.readthedocs.io/projects/ntp/en/latest/>

Cryptography Helpers
^^^^^^^^^^^^^^^^^^^^^

Helpers for secure communication.

.. toctree::

RSA <https://circuitpython.readthedocs.io/projects/rsa/en/latest/>

CPython-module Helpers
^^^^^^^^^^^^^^^^^^^^^^^

Pure-Python implementations of standard CPython libraries. Some of these
modules may have a CircuitPython Core API implementation too.

.. toctree::

binascii <https://circuitpython.readthedocs.io/projects/binascii/en/latest/>
IterTools <https://circuitpython.readthedocs.io/projects/itertools/en/latest/>
Logging <https://circuitpython.readthedocs.io/projects/logging/en/latest/>
hashlib <https://circuitpython.readthedocs.io/projects/hashlib/en/latest/>

Audio Helpers
^^^^^^^^^^^^^^^

Music, noisemakers, and more.

.. toctree::

Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/en/latest/>
Waveform Generation <https://circuitpython.readthedocs.io/projects/waveform/en/latest/>

Miscellaneous Helpers
^^^^^^^^^^^^^^^^^^^^^^^

.. toctree::

AVR programming <https://circuitpython.readthedocs.io/projects/avrprog/en/latest/>
Board Test Suite <https://circuitpython.readthedocs.io/projects/boardtest/en/latest/>
Debouncer <https://circuitpython.readthedocs.io/projects/debouncer/en/latest/>
InfraRed Remote <https://circuitpython.readthedocs.io/projects/irremote/en/latest/>
OneWire <https://circuitpython.readthedocs.io/projects/onewire/en/latest/>
SD Card <https://circuitpython.readthedocs.io/projects/sd/en/latest/>
ServoKit <https://circuitpython.readthedocs.io/projects/servokit/en/latest/>
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
Slideshow <https://circuitpython.readthedocs.io/projects/slideshow/en/latest/>
TinyLoRa TTN Helper <https://circuitpython.readthedocs.io/projects/tinylora/en/latest/>
Turtle Graphics <https://circuitpython.readthedocs.io/projects/turtle/en/latest/>
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/>
Waveform Generation <https://circuitpython.readthedocs.io/projects/waveform/en/latest/>


Blinky
--------
Expand Down