From f16619ad3cc8d19d739902632d52628b43dcf390 Mon Sep 17 00:00:00 2001 From: Scott Shawcroft Date: Tue, 6 Mar 2018 16:54:13 -0800 Subject: Update driver links including categories! --- conf.py | 2 +- docs/drivers.rst | 197 +++++++++++++++++++++++++++++++++++++++++++++++-------- 2 files changed, 170 insertions(+), 29 deletions(-) diff --git a/conf.py b/conf.py index cb46b13a5..7353ad038 100644 --- a/conf.py +++ b/conf.py @@ -334,5 +334,5 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {"cpython": ('https://docs.python.org/3/', None), - "bus_device": ('https://circuitpython.readthedocs.io/projects/bus_device/en/latest/', None), + "bus_device": ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None), "register": ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None)} diff --git a/docs/drivers.rst b/docs/drivers.rst index d1baed8e1..40f56b2b0 100644 --- a/docs/drivers.rst +++ b/docs/drivers.rst @@ -13,10 +13,10 @@ Bundle ------ We provide a bundle of all our libraries to ease installation of drivers and -their dependencies. he bundle is primarily geared to the Adafruit Express line -of boards which will feature a relatively large external flash. With Express -boards, its easy to copy them all onto the filesystem. However, if you don't -have enough space simply copy things over as they are needed. +their dependencies. The bundle is primarily geared to the Adafruit Express line +of boards which feature a relatively large external flash. With Express boards, +its easy to copy them all onto the filesystem. However, if you don't have +enough space simply copy things over as they are needed. The bundles are available `on GitHub `_. @@ -26,8 +26,8 @@ To install them: and unzip the latest zip that's not a source zip. #. Copy the ``lib`` folder to the ``CIRCUITPY`` or ``MICROPYTHON``. -Foundational Libraries ----------------------- +Foundational +------------ These libraries provide critical functionality to many of the drivers below. It is recommended to always have them installed onto the CircuitPython file system in @@ -36,37 +36,178 @@ the ``lib/`` directory. Some drivers may not work without them. .. toctree:: Register Library - BusDevice Library + BusDevice Library + +Board-specific Helpers +---------------------- + +These libraries tie lower-level libraries together to provide an easy, out-of-box experience for +specific boards. + +.. toctree:: + + Adafruit CircuitPlayground Express + Adafruit FeatherWings Helper Libraries ----------------- +----------------- These libraries build on top of the low level APIs to simplify common tasks. .. toctree:: - USB Human Interface Device (Keyboard and Mouse) + USB Human Interface Device (Keyboard and Mouse) + Waveform Generation + OneWire + Ring Tone Text Transfer Language (RTTTL) + InfraRed Remote + Fancy LED (similar to FastLED) + SimpleIO + AVR programming + DC Motor and Servo + SD Card + +Blinky +-------- + +Multi-color led drivers. + +.. toctree:: + + NeoPixel + DotStar + +Displays +------------- + +Drivers used to display information. Either pixel or segment based. + +.. toctree:: + + RGB Displays + Character LCD + HT16K33 LED Matrices and Segment Displays + IS31FL3731 Charlieplexed LED Matrix + MAX7219 LED Matrix + SSD1306 OLED Driver + +Real-time clocks +----------------- + +Chips that keep current calendar time with a backup battery. The current date and time is available +through ``datetime``. + +.. toctree:: + + DS1307 Real-time Clock (5V RTC Breakout) + DS3231 Real-time Clock (Precision RTC) + PCF8523 Real-time Clock (Adalogger RTC) + +Motion Sensors +---------------- + +Motion relating sensing including ``acceleration``, ``magnetic``, ``gyro``, and ``orientation``. + +.. toctree:: + BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation + FXAS21002C Gyroscope + FXOS8700 Accelerometer + GPS Global Position + LIS3DH Accelerometer + LSM303 Accelerometer and Magnetometer + LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature + LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature + MMA8451 3 axis accelerometer + +Environmental Sensors +---------------------- + +Sense attributes of the environment including ``temperature``, ``relative_humidity``, ``pressure``, +equivalent carbon dioxide (``eco2`` / ``eCO2``), and total volatile organic compounds (``tvoc`` / +``TVOC``). + +.. toctree:: + + BME280 Temperature, Humidity and Pressure + BME680 Temperature, Humidity, Pressure and Gas + BMP280 Barometric Pressure and Altitude + CCS811 Air Quality + DHT Temperature and Humidity + DS18x20 Temperature + MAX31865 Thermocouple Amplifier, Temperature + MAX31855 Thermocouple Amplifier, Temperature + MCP9808 Temperature + MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor + SGP30 Air Quality + SHT31-D Temperature and Humidity + Si7021 Temperature and Humidity + Thermistor Temperature + +Light Sensors +--------------- + +These sensors detect light related attributes such as ``color``, ``light`` (unit-less), and +``lux`` (light in SI lux). + +.. toctree:: + + APDS9960 Proximity, Light, RGB, and Gesture + TCS34725 Color Sensor + TSL2561 Light Sensor + TSL2591 High Dynamic Range Light Sensor + VCNL4010 Proximity and Light + VEML6070 UV Index + +Distance Sensors +------------------ + +These sensors measure the ``distance`` to another object and may also measure light level (``light`` and ``lux``). + +.. toctree:: + + VL6180x 5 - 100 mm + VL53L0x ~30 - 1000 mm + +Radio +-------- + +These chips communicate to other's over radio. + +.. toctree:: + + RFM9x LoRa + RFM69 Packet Radio -Drivers -------- +IO Expansion +-------------- -Drivers provide easy access to sensors and other chips without requiring a -knowledge of the interface details of the chip itself. +These provide functionality similar to `analogio`, `digitalio`, `pulseio`, and `touchio`. + +.. toctree:: + + Adafruit SeeSaw + ADS1x15 Analog-to-Digital Converter + DS2413 OneWire GPIO Expander + FocalTech Capacitive Touch + MCP4725 Digital-to-Analog Converter + PCA9685 16 x 12-bit PWM Driver + TLC5947 24 x 12-bit PWM Driver + TLC59711 12 x 16-bit PWM Driver + MCP4725 Capacitive Touch Sensor + + +Miscellaneous +---------------- .. toctree:: - NeoPixel - SimpleIO - RGB Displays - SD Card - Analog-to-digital converters: ADS1015 and ADS1115 - DS3231 Real-time Clock (Precision RTC) - DS1307 Real-time Clock (5V RTC Breakout) - PCF8523 Real-time Clock (Adalogger RTC) - TCS34725 Color Sensor - TSL2561 Light Sensor - PCA9685 Motor and Servo Controllers - HT16K33 LED Matrices and Segment Displays - IS31FL3731 Charlieplexed LED Matrix - MAX7219 LED Matrix - DotStar + Si4713 Stereo FM Transmitter + AMG88xx Grid-Eye IR Camera + Trellis 4x4 Keypad + DRV2605 Haptic Motor Controller + MAX9744 Audio Amplifier + Si5351 Clock Generator + Thermal Printer + VC0706 TTL Camera + INA219 High Side Current + Fingerprint -- cgit v1.2.3 From 4f55205bf5e4dcdaf8bce3e34b1f0145fe5aa535 Mon Sep 17 00:00:00 2001 From: Scott Shawcroft Date: Tue, 6 Mar 2018 18:24:56 -0800 Subject: Fix links. Adding the en/latest/ circumvents a ReadTheDocs bug which redirects projects incorrectly. --- docs/drivers.rst | 147 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 74 insertions(+), 73 deletions(-) diff --git a/docs/drivers.rst b/docs/drivers.rst index 40f56b2b0..23c0c0b32 100644 --- a/docs/drivers.rst +++ b/docs/drivers.rst @@ -56,16 +56,16 @@ These libraries build on top of the low level APIs to simplify common tasks. .. toctree:: - USB Human Interface Device (Keyboard and Mouse) - Waveform Generation - OneWire - Ring Tone Text Transfer Language (RTTTL) - InfraRed Remote - Fancy LED (similar to FastLED) - SimpleIO - AVR programming - DC Motor and Servo - SD Card + USB Human Interface Device (Keyboard and Mouse) + Waveform Generation + OneWire + Ring Tone Text Transfer Language (RTTTL) + InfraRed Remote + Fancy LED (similar to FastLED) + SimpleIO + AVR programming + DC Motor and Servo + SD Card Blinky -------- @@ -74,8 +74,8 @@ Multi-color led drivers. .. toctree:: - NeoPixel - DotStar + NeoPixel + DotStar Displays ------------- @@ -84,12 +84,12 @@ Drivers used to display information. Either pixel or segment based. .. toctree:: - RGB Displays - Character LCD - HT16K33 LED Matrices and Segment Displays - IS31FL3731 Charlieplexed LED Matrix - MAX7219 LED Matrix - SSD1306 OLED Driver + RGB Displays + Character LCD + HT16K33 LED Matrices and Segment Displays + IS31FL3731 Charlieplexed LED Matrix + MAX7219 LED Matrix + SSD1306 OLED Driver Real-time clocks ----------------- @@ -99,9 +99,9 @@ through ``datetime``. .. toctree:: - DS1307 Real-time Clock (5V RTC Breakout) - DS3231 Real-time Clock (Precision RTC) - PCF8523 Real-time Clock (Adalogger RTC) + DS1307 Real-time Clock (5V RTC Breakout) + DS3231 Real-time Clock (Precision RTC) + PCF8523 Real-time Clock (Adalogger RTC) Motion Sensors ---------------- @@ -109,15 +109,16 @@ Motion Sensors Motion relating sensing including ``acceleration``, ``magnetic``, ``gyro``, and ``orientation``. .. toctree:: - BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation - FXAS21002C Gyroscope - FXOS8700 Accelerometer - GPS Global Position - LIS3DH Accelerometer - LSM303 Accelerometer and Magnetometer - LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature - LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature - MMA8451 3 axis accelerometer + + BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation + FXAS21002C Gyroscope + FXOS8700 Accelerometer + GPS Global Position + LIS3DH Accelerometer + LSM303 Accelerometer and Magnetometer + LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature + LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature + MMA8451 3 axis accelerometer Environmental Sensors ---------------------- @@ -128,20 +129,20 @@ equivalent carbon dioxide (``eco2`` / ``eCO2``), and total volatile organic comp .. toctree:: - BME280 Temperature, Humidity and Pressure - BME680 Temperature, Humidity, Pressure and Gas - BMP280 Barometric Pressure and Altitude - CCS811 Air Quality - DHT Temperature and Humidity - DS18x20 Temperature - MAX31865 Thermocouple Amplifier, Temperature - MAX31855 Thermocouple Amplifier, Temperature - MCP9808 Temperature - MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor - SGP30 Air Quality - SHT31-D Temperature and Humidity - Si7021 Temperature and Humidity - Thermistor Temperature + BME280 Temperature, Humidity and Pressure + BME680 Temperature, Humidity, Pressure and Gas + BMP280 Barometric Pressure and Altitude + CCS811 Air Quality + DHT Temperature and Humidity + DS18x20 Temperature + MAX31865 Thermocouple Amplifier, Temperature + MAX31855 Thermocouple Amplifier, Temperature + MCP9808 Temperature + MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor + SGP30 Air Quality + SHT31-D Temperature and Humidity + Si7021 Temperature and Humidity + Thermistor Temperature Light Sensors --------------- @@ -151,12 +152,12 @@ These sensors detect light related attributes such as ``color``, ``light`` (unit .. toctree:: - APDS9960 Proximity, Light, RGB, and Gesture - TCS34725 Color Sensor - TSL2561 Light Sensor - TSL2591 High Dynamic Range Light Sensor - VCNL4010 Proximity and Light - VEML6070 UV Index + APDS9960 Proximity, Light, RGB, and Gesture + TCS34725 Color Sensor + TSL2561 Light Sensor + TSL2591 High Dynamic Range Light Sensor + VCNL4010 Proximity and Light + VEML6070 UV Index Distance Sensors ------------------ @@ -165,8 +166,8 @@ These sensors measure the ``distance`` to another object and may also measure li .. toctree:: - VL6180x 5 - 100 mm - VL53L0x ~30 - 1000 mm + VL6180x 5 - 100 mm + VL53L0x ~30 - 1000 mm Radio -------- @@ -175,8 +176,8 @@ These chips communicate to other's over radio. .. toctree:: - RFM9x LoRa - RFM69 Packet Radio + RFM9x LoRa + RFM69 Packet Radio IO Expansion -------------- @@ -185,15 +186,15 @@ These provide functionality similar to `analogio`, `digitalio`, `pulseio`, and ` .. toctree:: - Adafruit SeeSaw - ADS1x15 Analog-to-Digital Converter - DS2413 OneWire GPIO Expander - FocalTech Capacitive Touch - MCP4725 Digital-to-Analog Converter - PCA9685 16 x 12-bit PWM Driver - TLC5947 24 x 12-bit PWM Driver - TLC59711 12 x 16-bit PWM Driver - MCP4725 Capacitive Touch Sensor + Adafruit SeeSaw + ADS1x15 Analog-to-Digital Converter + DS2413 OneWire GPIO Expander + FocalTech Capacitive Touch + MCP4725 Digital-to-Analog Converter + PCA9685 16 x 12-bit PWM Driver + TLC5947 24 x 12-bit PWM Driver + TLC59711 12 x 16-bit PWM Driver + MPR121 Capacitive Touch Sensor Miscellaneous @@ -201,13 +202,13 @@ Miscellaneous .. toctree:: - Si4713 Stereo FM Transmitter - AMG88xx Grid-Eye IR Camera - Trellis 4x4 Keypad - DRV2605 Haptic Motor Controller - MAX9744 Audio Amplifier - Si5351 Clock Generator - Thermal Printer - VC0706 TTL Camera - INA219 High Side Current - Fingerprint + Si4713 Stereo FM Transmitter + AMG88xx Grid-Eye IR Camera + Trellis 4x4 Keypad + DRV2605 Haptic Motor Controller + MAX9744 Audio Amplifier + Si5351 Clock Generator + Thermal Printer + VC0706 TTL Camera + INA219 High Side Current + Fingerprint -- cgit v1.2.3