8000 Merge pull request #1550 from sommersoft/move_drivers_rst · tannewt/circuitpython@f7a397d · GitHub
[go: up one dir, main page]
Skip to content

Commit f7a397d

Browse files
dhalbertdhalbert
authored
Merge pull request micropython#1550 from sommersoft/move_drivers_rst
Step 2: Move The Docs
2 parents 619b4f1 + c80e22b commit f7a397d

File tree

1 file changed

+14
-233
lines changed

1 file changed

+14
-233
lines changed

‎docs/drivers.rst

Lines changed: 14 additions & 233 deletions
Original file line numberDiff line numberDiff line change
@@ -1,252 +1,33 @@
1-
.. _adafruit-libndrivers:
2-
3-
Additional Adafruit Libraries and Drivers on GitHub
4-
===================================================
1+
Additional CircuitPython Libraries and Drivers on GitHub
2+
=========================================================
53

64
These are libraries and drivers available in separate GitHub repos. They are
75
designed for use with CircuitPython and may or may not work with
86
`MicroPython <https://micropython.org>`_.
97

10-
.. _bundle_installation:
118

12-
Bundle
13-
------
9+
Adafruit CircuitPython Library Bundle
10+
--------------------------------------
1411

1512
We provide a bundle of all our libraries to ease installation of drivers and
1613
their dependencies. The bundle is primarily geared to the Adafruit Express line
1714
of boards which feature a relatively large external flash. With Express boards,
1815
its easy to copy them all onto the filesystem. However, if you don't have
1916
enough space simply copy things over as they are needed.
2017

21-
The bundles are available `on GitHub <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>`_.
22-
23-
To install them:
24-
25-
#. `Download <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>`_
26-
and unzip the latest zip that's not a source zip.
27-
#. Copy the ``lib`` folder to the ``CIRCUITPY`` or ``MICROPYTHON``.
28-
29-
Foundational
30-
------------
31-
32-
These libraries provide critical functionality to many of the drivers below. It
33-
is recommended to always have them installed onto the CircuitPython file system in
34-
the ``lib/`` directory. Some drivers may not work without them.
35-
36-
.. toctree::
37-
38-
Register Library <https://circuitpython.readthedocs.io/projects/register/en/latest/>
39-
BusDevice Library <https://circuitpython.readthedocs.io/projects/busdevice/en/latest/>
40-
41-
Board-specific Helpers
42-
----------------------
43-
44-
These libraries tie lower-level libraries together to provide an easy, out-of-box experience for
45-
specific boards.
46-
47-
.. toctree::
48-
49-
Adafruit CircuitPlayground Express <https://circuitpython.readthedocs.io/projects/circuitplayground/en/latest/>
50-
Adafruit FeatherWings <https://circuitpython.readthedocs.io/projects/featherwing/en/latest/>
51-
52-
Helper Libraries
53-
-----------------
54-
55-
These libraries build on top of the low level APIs to simplify common tasks.
56-
57-
.. toctree::
58-
59-
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/>
60-
Waveform Generation <https://circuitpython.readthedocs.io/projects/waveform/en/latest/>
61-
OneWire <https://circuitpython.readthedocs.io/projects/onewire/en/latest/>
62-
Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/en/latest/>
63-
InfraRed Remote <https://circuitpython.readthedocs.io/projects/irremote/en/latest/>
64-
Fancy LED (similar to FastLED) <https://circuitpython.readthedocs.io/projects/fancyled/en/latest/>
65-
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
66-
AVR programming <https://circuitpython.readthedocs.io/projects/avrprog/en/latest/>
67-
DC Motor and Servo <https://circuitpython.readthedocs.io/projects/motor/en/latest/>
68-
SD Card <https://circuitpython.readthedocs.io/projects/sd/en/latest/>
69-
Image Load <https://circuitpython.readthedocs.io/projects/imageload/en/latest/>
70-
miniQR Non-hardware QR code generator <https://circuitpython.readthedocs.io/projects/miniqr/en/latest/>
71-
Slideshow <https://circuitpython.readthedocs.io/projects/slideshow/en/latest/>
72-
LED Animation <https://circuitpython.readthedocs.io/projects/led-animation/en/latest/>
73-
Bluetooth Low Energy (BLE) <https://circuitpython.readthedocs.io/projects/ble/en/latest/>
74-
Bluefruit LE Connect App <https://circuitpython.readthedocs.io/projects/bluefruitconnect/en/latest/>
75-
76-
Blinky
77-
--------
78-
79-
Multi-color led drivers.
80-
81-
.. toctree::
82-
83-
NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/en/latest/>
84-
DotStar <https://circuitpython.readthedocs.io/projects/dotstar/en/latest/>
85-
WS2801 <https://circuitpython.readthedocs.io/projects/ws2801/en/latest/>
86-
Pixie <https://circuitpython.readthedocs.io/projects/pixie/en/latest/>
87-
88-
Displays
89-
-------------
90-
91-
Drivers used to display information. Either pixel or segment based.
92-
93-
.. toctree::
94-
95-
RGB Displays <https://circuitpython.readthedocs.io/projects/rgb_display/en/latest/>
96-
Character LCD <https://circuitpython.readthedocs.io/projects/charlcd/en/latest/>
97-
HT16K33 LED Matrices and Segment Displays <https://circuitpython.readthedocs.io/projects/ht16k33/en/latest/>
98-
IS31FL3731 Charlieplexed LED Matrix <https://circuitpython.readthedocs.io/projects/is31fl3731/en/latest/>
99-
MAX7219 LED Matrix <https://circuitpython.readthedocs.io/projects/max7219/en/latest/>
100-
SSD1306 OLED Driver <https://circuitpython.readthedocs.io/projects/ssd1306/en/latest/>
101-
E-Paper Display <https://circuitpython.readthedocs.io/projects/epd/en/latest/>
102-
103-
Real-time clocks
104-
-----------------
105-
106-
Chips that keep current calendar time with a backup battery. The current date and time is available
107-
through ``datetime``.
108-
109-
.. toctree::
110-
111-
DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/en/latest/>
112-
DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/en/latest/>
113-
PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/en/latest/>
114-
115-
Motion Sensors
116-
----------------
117-
118-
Motion relating sensing including ``acceleration``, ``magnetic``, ``gyro``, and ``orientation``.
119-
120-
.. toctree::
121-
122-
ADXL34x 3 Axis Accelerometer <https://circuitpython.readthedocs.io/projects/adxl34x/en/latest/>
123-
BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation <https://circuitpython.readthedocs.io/projects/bno055/en/latest/>
124-
FXAS21002C Gyroscope <https://circuitpython.readthedocs.io/projects/fxas21002c/en/latest/>
125-
FXOS8700 Accelerometer <https://circuitpython.readthedocs.io/projects/fxos8700/en/latest/>
126-
GPS Global Position <https://circuitpython.readthedocs.io/projects/gps/en/latest/>
127-
L3GD20 Gyroscope <https://circuitpython.readthedocs.io/projects/l3gd20/latest/>
128-
LIS3DH Accelerometer <https://circuitpython.readthedocs.io/projects/lis3dh/en/latest/>
129-
LSM303 Accelerometer and Magnetometer <https://circuitpython.readthedocs.io/projects/lsm303/en/latest/>
130-
LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds0/en/latest/>
131-
LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds1/en/latest/>
132-
MLX90390 3 Axis Mangetometer <https://circuitpython.readthedocs.io/projects/mlx90393/en/latest/>
133-
MMA8451 3 axis accelerometer <https://circuitpython.readthedocs.io/projects/mma8451/en/latest/>
134-
135-
Environmental Sensors
136-
----------------------
137-
138-
Sense attributes of the environment including ``temperature``, ``relative_humidity``, ``pressure``,
139-
equivalent carbon dioxide (``eco2`` / ``eCO2``), and total volatile organic compounds (``tvoc`` /
140-
``TVOC``).
141-
142-
.. toctree::
143-
144-
AM2320 Temperature and Humidity <https://circuitpython.readthedocs.io/projects/am2320/en/latest/>
145-
BME280 Temperature, Humidity and Pressure <https://circuitpython.readthedocs.io/projects/bme280/en/latest/>
146-
BME680 Temperature, Humidity, Pressure and Gas <https://circuitpython.readthedocs.io/projects/bme680/en/latest/>
147-
BMP280 Barometric Pressure and Altitude <https://circuitpython.readthedocs.io/projects/bmp280/en/latest/>
148-
BMP3xx Barometric Pressure and Altimeter <https://circuitpython.readthedocs.io/projects/bmp3xx/en/latest/>
149-
CCS811 Air Quality <https://circuitpython.readthedocs.io/projects/ccs811/en/latest/>
150-
DHT Temperature and Humidity <https://circuitpython.readthedocs.io/projects/dht/en/latest/>
151-
DS18x20 Temperature <https://circuitpython.readthedocs.io/projects/ds18x20/en/latest/>
152-
HTU21D Temperature and Humidity <https://circuitpython.readthedocs.io/projects/htu21d/en/latest/>
153-
MAX31865 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31865/en/latest/>
154-
MAX31855 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31855/en/latest/>
155-
MAX31856 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31856/en/latest/>
156-
MCP9808 Temperature <https://circuitpython.readthedocs.io/projects/mcp9808/en/latest/>
157-
MP115A2 Barometric Pressure, Temperature <https://circuitpython.readthedocs.io/projects/mpl115a2/en/latest/>
158-
MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor <https://circuitpython.readthedocs.io/projects/mpl3115a2/en/latest/>
159-
MPRLS Ported Absolute Pressure <https://circuitpython.readthedocs.io/projects/mprls/en/latest/>
160-
SGP30 Air Quality <https://circuitpython.readthedocs.io/projects/sgp30/en/latest/>
161-
SHT31-D Temperature and Humidity <https://circuitpython.readthedocs.io/projects/sht31d/en/latest/>
162-
Si7021 Temperature and Humidity <https://circuitpython.readthedocs.io/projects/si7021/en/latest/>
163-
Thermistor Temperature <https://circuitpython.readthedocs.io/projects/thermistor/en/latest/>
164-
TMP007 Contactless Temperature <https://circuitpython.readthedocs.io/projects/tmp007/en/latest/>
165-
MLX90614 Contactless Temperature <https://circuitpython.readthedocs.io/projects/mlx90614/en/latest/>
166-
167-
Light Sensors
168-
---------------
169-
170-
These sensors detect light related attributes such as ``color``, ``light`` (unit-less), and
171-
``lux`` (light in SI lux).
172-
173-
.. toctree::
174-
175-
APDS9960 Proximity, Light, RGB, and Gesture <https://circuitpython.readthedocs.io/projects/apds9960/en/latest/>
176-
AS726x Color Spectrum Sensor <https://circuitpython.readthedocs.io/projects/as726x/en/latest/>
177-
TCS34725 Color Sensor <https://circuitpython.readthedocs.io/projects/tcs34725/en/latest/>
178-
TSL2561 Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2561/en/latest/>
179-
TSL2591 High Dynamic Range Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2591/en/latest/>
180-
VCNL4010 Proximity and Light <https://circuitpython.readthedocs.io/projects/vcnl4010/en/latest/>
181-
VEML6070 UV Index <https://circuitpython.readthedocs.io/projects/veml6070/en/latest/>
182-
VEML6075 UV Index <https://circuitpython.readthedocs.io/projects/veml6075/en/latest/>
183-
184-
Distance Sensors
185-
------------------
186-
187-
These sensors measure the ``distance`` to another object and may also measure light level (``light`` and ``lux``).
188-
189-
.. toctree::
190-
191-
Garmin LIDARLite I2C <https://circuitpython.readthedocs.io/projects/lidarlite/en/latest/>
192-
TFmini IR Time of Flight ~30cm - 12m <https://circuitpython.readthedocs.io/projects/tfmini/en/latest/>
193-
VL6180x 5 - 100 mm <https://circuitpython.readthedocs.io/projects/vl6180x/en/latest/>
194-
VL53L0x ~30 - 1000 mm <https://circuitpython.readthedocs.io/projects/vl53l0x/en/latest/>
195-
HC-SR04 Ultrasonic Range Sensors <https://circuitpython.readthedocs.io/projects/hcsr04/en/latest/>
196-
197-
Radio
198-
--------
199-
200-
These chips communicate to other's over radio.
201-
202-
.. toctree::
203-
204-
Adafruit Bluefruit LE SPI Friend <https://circuitpython.readthedocs.io/projects/bluefruitspi/en/latest/>
205-
RFM9x LoRa <https://circuitpython.readthedocs.io/projects/rfm9x/en/latest/>
206-
RFM69 Packet Radio <https://circuitpython.readthedocs.io/projects/rfm69/en/latest/>
207-
PN532 NFC/RFID <https://circuitpython.readthedocs.io/projects/pn532/en/latest/>
208-
209-
IO Expansion
210-
--------------
18+
- The Adafruit bundles are available on GitHub: <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>.
21119

212-
These provide functionality similar to `analogio`, `digitalio`, `pulseio`, and `touchio`.
20+
- Documentation for the bundle, which includes links to documentation for all
21+
libraries, is available here: <https://circuitpython.readthedocs.io/projects/bundle/en/latest/>.
21322

214-
.. toctree::
21523

216-
Adafruit SeeSaw <https://circuitpython.readthedocs.io/projects/seesaw/en/latest/>
217-
ADS1x15 Analog-to-Digital Converter <https://circuitpython.readthedocs.io/projects/ads1x15/en/latest/>
218-
Crickit Robotics Boards <https://circuitpython.readthedocs.io/projects/crickit/en/latest/>
219-
DS2413 OneWire GPIO Expander <https://circuitpython.readthedocs.io/projects/ds2413/en/latest/>
220-
FocalTech Capacitive Touch <https://circuitpython.readthedocs.io/projects/focaltouch/en/latest/>
221-
MCP230xx GPIO Expander <https://circuitpython.readthedocs.io/projects/mcp230xx/en/latest/>
222-
MCP4725 Digital-to-Analog Converter <https://circuitpython.readthedocs.io/projects/mcp4725/en/latest/>
223-
PCA9685 16 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/pca9685/en/latest/>
224-
TLC5947 24 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc5947/en/latest/>
225-
TLC59711 12 x 16-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc59711/en/latest/>
226-
MPR121 Capacitive Touch Sensor <https://circuitpython.readthedocs.io/projects/mpr121/en/latest/>
227-
TCA9548 I2C Multiplexer <https://circuitpython.readthedocs.io/projects/tca9548a/en/latest/>
228-
MCP3xxx SPI ADC <https://circuitpython.readthedocs.io/projects/mcp3xxx/en/latest/>
24+
CircuitPython Community Library Bundle
25+
---------------------------------------
22926

230-
Miscellaneous
231-
----------------
27+
This bundle contains non-Adafruit sponsored libraries, that are written and submitted
28+
by members of the community.
23229

233-
.. toctree::
30+
- The Community bundles are available on GitHub: <https://github.com/adafruit/CircuitPython_Community_Bundle/releases>.
23431

235-
CAP1188 8-Key Capacitive Touch <https://circuitpython.readthedocs.io/projects/cap1188/en/latest/>
236-
Si4713 Stereo FM Transmitter <https://circuitpython.readthedocs.io/projects/si4713/en/latest/>
237-
AMG88xx Grid-Eye IR Camera <https://circuitpython.readthedocs.io/projects/amg88xx/en/latest/>
238-
Trellis 4x4 Keypad <https://circuitpython.readthedocs.io/projects/trellis/en/latest/>
239-
NeoTrellis 4x4 Keypad <https://circuitpython.readthedocs.io/projects/neotrellis/en/latest/>
240-
NeoTrellis M4 4x8 Keypad <https://circuitpython.readthedocs.io/projects/trellism4/en/latest/>
241-
DRV2605 Haptic Motor Controller <https://circuitpython.readthedocs.io/projects/drv2605/en/latest/>
242-
MAX9744 Audio Amplifier <https://circuitpython.readthedocs.io/projects/max9744/en/latest/>
243-
Si5351 Clock Generator <https://circuitpython.readthedocs.io/projects/si5351/en/latest/>
244-
Thermal Printer <https://circuitpython.readthedocs.io/projects/thermal_printer/en/latest/>
245-
VC0706 TTL Camera <https://circuitpython.readthedocs.io/projects/vc0706/en/latest/>
246-
INA219 High Side Current <https://circuitpython.readthedocs.io/projects/ina219/en/latest/>
247-
Fingerprint <https://circuitpython.readthedocs.io/projects/fingerprint/en/latest/>
248-
STMPE610 Resistive Touchscreen <https://circuitpython.readthedocs.io/projects/stmpe610/en/latest/>
249-
Matrix Keypad <https://circuitpython.readthedocs.io/projects/matrixkeypad/en/latest/>
250-
VS1053 Audio Codec <https://circuitpython.readthedocs.io/projects/vs1053/en/latest/>
251-
FRAM Non-Volatile Memory <https://circuitpython.readthedocs.io/projects/fram/en/latest/>
252-
74HC595 Shift Register <https://circuitpython.readthedocs.io/projects/74hc595/en/latest/>
32+
- Documentation is not available on ReadTheDocs at this time. See each library for any
33+
included documentation.

0 commit comments

Comments
 (0)
0