Skip to content

Commit 96b0776

Browse files
authored
Merge pull request #189 from brentru/organize-helpers
Organizing Helpers list
2 parents 6fc95dc + 3b2290e commit 96b0776

File tree

1 file changed

+100
-31
lines changed

1 file changed

+100
-31
lines changed

docs/drivers.rst

Lines changed: 100 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -35,53 +35,122 @@ Helper Libraries
3535

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

38+
LED Helpers
39+
^^^^^^^^^^^^
40+
41+
Helpers for animating LEDs.
42+
43+
.. toctree::
44+
45+
Fancy LED (similar to FastLED) <https://circuitpython.readthedocs.io/projects/fancyled/en/latest/>
46+
LED Animation <https://adafruit-circuitpython-led-animation.readthedocs.io/en/latest/>
47+
48+
User Interface and GFX Helpers
49+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
50+
51+
Helpers for building graphical interfaces using the displayio core module.
52+
3853
.. toctree::
3954

40-
Adafruit IO <https://circuitpython.readthedocs.io/projects/adafruitio/en/latest/>
41-
AVR programming <https://circuitpython.readthedocs.io/projects/avrprog/en/latest/>
42-
Azure IoT <https://circuitpython.readthedocs.io/projects/azureiot/en/latest/>
43-
binascii <https://circuitpython.readthedocs.io/projects/binascii/en/latest/>
44-
Bitmap Font <https://circuitpython.readthedocs.io/projects/bitmap-font/en/latest/>
45-
Bluefruit LE Connect App <https://circuitpython.readthedocs.io/projects/bluefruitconnect/en/latest/>
46-
Bluetooth Low Energy (BLE) <https://circuitpython.readthedocs.io/projects/ble/en/latest/>
47-
Board Test Suite <https://circuitpython.readthedocs.io/projects/boardtest/en/latest/>
48-
Google Cloud IoT Core <https://circuitpython.readthedocs.io/projects/gc_iot_core/en/latest/>
4955
Cursor Control <https://circuitpython.readthedocs.io/projects/cursorcontrol/en/latest/>
50-
DC Motor and Servo <https://circuitpython.readthedocs.io/projects/motor/en/latest/>
51-
Debouncer <https://circuitpython.readthedocs.io/projects/debouncer/en/latest/>
56+
Bitmap Font <https://circuitpython.readthedocs.io/projects/bitmap-font/en/latest/>
5257
Display Button <https://circuitpython.readthedocs.io/projects/display_button/en/latest/>
5358
Display Shapes <https://circuitpython.readthedocs.io/projects/display_shapes/en/latest/>
5459
Display Text <https://circuitpython.readthedocs.io/projects/display-text/en/latest/>
55-
Fancy LED (similar to FastLED) <https://circuitpython.readthedocs.io/projects/fancyled/en/latest/>
60+
PyBadger <https://circuitpython.readthedocs.io/projects/pybadger/en/latest/>
61+
PYOA <https://circuitpython.readthedocs.io/projects/pyoa/en/latest/>
62+
Turtle Graphics <https://circuitpython.readthedocs.io/projects/turtle/en/latest/>
63+
Slideshow <https://circuitpython.readthedocs.io/projects/slideshow/en/latest/>
5664
Framebuf Module <https://circuitpython.readthedocs.io/projects/framebuf/en/latest/>
57-
hashlib <https://circuitpython.readthedocs.io/projects/hashlib/en/latest/>
58-
Hue Lights <https://circuitpython.readthedocs.io/projects/hue/en/latest/>
65+
miniQR Non-hardware QR code generator <https://circuitpython.readthedocs.io/projects/miniqr/en/latest/>
5966
Image Load <https://circuitpython.readthedocs.io/projects/imageload/en/latest/>
60-
InfraRed Remote <https://circuitpython.readthedocs.io/projects/irremote/en/latest/>
61-
IterTools <https://circuitpython.readthedocs.io/projects/itertools/en/latest/>
62-
JSON Web Token (JWT) <https://circuitpython.readthedocs.io/projects/jwt/en/latest/>
63-
LED Animation <https://adafruit-circuitpython-led-animation.readthedocs.io/en/latest/>
67+
68+
Motor Helpers
69+
^^^^^^^^^^^^^^
70+
71+
Helpers for driving motors, servos, and steppers.
72+
73+
.. toctree::
74+
75+
DC Motor and Servo <https://circuitpython.readthedocs.io/projects/motor/en/latest/>
76+
MotorKit <https://circuitpython.readthedocs.io/projects/motorkit/en/latest/>
77+
ServoKit <https://circuitpython.readthedocs.io/projects/servokit/en/latest/>
78+
79+
Internet of Things Web Service Helpers
80+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
81+
82+
Helpers for connecting with hosted and self-hosted internet-of-things web services.
83+
84+
.. toctree::
85+
86+
Adafruit IO <https://circuitpython.readthedocs.io/projects/adafruitio/en/latest/>
87+
Azure IoT <https://circuitpython.readthedocs.io/projects/azureiot/en/latest/>
88+
Google Cloud IoT Core <https://circuitpython.readthedocs.io/projects/gc_iot_core/en/latest/>
6489
LIFX Lights <https://circuitpython.readthedocs.io/projects/lifx/en/latest/>
65-
Logging <https://circuitpython.readthedocs.io/projects/logging/en/latest/>
90+
Hue Lights <https://circuitpython.readthedocs.io/projects/hue/en/latest/>
91+
92+
Internet-of-Things/Wireless Protocol Helpers
93+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
94+
95+
Helpers for interfacing with the internet or wireless communication.
96+
97+
.. toctree::
98+
99+
Bluefruit LE Connect App <https://circuitpython.readthedocs.io/projects/bluefruitconnect/en/latest/>
100+
Bluetooth Low Energy (BLE) <https://circuitpython.readthedocs.io/projects/ble/en/latest/>
101+
TinyLoRa TTN Helper <https://circuitpython.readthedocs.io/projects/tinylora/en/latest/>
66102
Mini ESP Tool <https://circuitpython.readthedocs.io/projects/miniesptool/en/latest/>
67103
MiniMQTT <https://circuitpython.readthedocs.io/projects/minimqtt/en/latest/>
68-
miniQR Non-hardware QR code generator <https://circuitpython.readthedocs.io/projects/miniqr/en/latest/>
69-
MotorKit <https://circuitpython.readthedocs.io/projects/motorkit/en/latest/>
70-
NTP (Network time Protocol) <https://circuitpython.readthedocs.io/projects/ntp/en/latest/>
71-
OneWire <https://circuitpython.readthedocs.io/projects/onewire/en/latest/>
72-
PyBadger <https://circuitpython.readthedocs.io/projects/pybadger/en/latest/>
73-
PYOA <https://circuitpython.readthedocs.io/projects/pyoa/en/latest/>
104+
JSON Web Token (JWT) <https://circuitpython.readthedocs.io/projects/jwt/en/latest/>
74105
Requests <https://circuitpython.readthedocs.io/projects/requests/en/latest/>
75-
Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/en/latest/>
106+
NTP (Network time Protocol) <https://circuitpython.readthedocs.io/projects/ntp/en/latest/>
107+
108+
Cryptography Helpers
109+
^^^^^^^^^^^^^^^^^^^^^
110+
111+
Helpers for secure communication.
112+
113+
.. toctree::
114+
76115
RSA <https://circuitpython.readthedocs.io/projects/rsa/en/latest/>
116+
117+
CPython-module Helpers
118+
^^^^^^^^^^^^^^^^^^^^^^^
119+
120+
Pure-Python implementations of standard CPython libraries. Some of these
121+
modules may have a CircuitPython Core API implementation too.
122+
123+
.. toctree::
124+
125+
binascii <https://circuitpython.readthedocs.io/projects/binascii/en/latest/>
126+
IterTools <https://circuitpython.readthedocs.io/projects/itertools/en/latest/>
127+
Logging <https://circuitpython.readthedocs.io/projects/logging/en/latest/>
128+
hashlib <https://circuitpython.readthedocs.io/projects/hashlib/en/latest/>
129+
130+
Audio Helpers
131+
^^^^^^^^^^^^^^^
132+
133+
Music, noisemakers, and more.
134+
135+
.. toctree::
136+
137+
Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/en/latest/>
138+
Waveform Generation <https://circuitpython.readthedocs.io/projects/waveform/en/latest/>
139+
140+
Miscellaneous Helpers
141+
^^^^^^^^^^^^^^^^^^^^^^^
142+
143+
.. toctree::
144+
145+
AVR programming <https://circuitpython.readthedocs.io/projects/avrprog/en/latest/>
146+
Board Test Suite <https://circuitpython.readthedocs.io/projects/boardtest/en/latest/>
147+
Debouncer <https://circuitpython.readthedocs.io/projects/debouncer/en/latest/>
148+
InfraRed Remote <https://circuitpython.readthedocs.io/projects/irremote/en/latest/>
149+
OneWire <https://circuitpython.readthedocs.io/projects/onewire/en/latest/>
77150
SD Card <https://circuitpython.readthedocs.io/projects/sd/en/latest/>
78-
ServoKit <https://circuitpython.readthedocs.io/projects/servokit/en/latest/>
79151
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
80-
Slideshow <https://circuitpython.readthedocs.io/projects/slideshow/en/latest/>
81-
TinyLoRa TTN Helper <https://circuitpython.readthedocs.io/projects/tinylora/en/latest/>
82-
Turtle Graphics <https://circuitpython.readthedocs.io/projects/turtle/en/latest/>
83152
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/>
84-
Waveform Generation <https://circuitpython.readthedocs.io/projects/waveform/en/latest/>
153+
85154

86155
Blinky
87156
--------

0 commit comments

Comments
 (0)