summaryrefslogtreecommitdiff
path: root/docs/drivers.rst
diff options
context:
space:
mode:
authorScott Shawcroft <scott.shawcroft@gmail.com>2018-03-06 18:24:56 -0800
committerScott Shawcroft <scott.shawcroft@gmail.com>2018-03-06 18:24:56 -0800
commit4f55205bf5e4dcdaf8bce3e34b1f0145fe5aa535 (patch)
tree3d77b3a4d83a0349da13dff5e747f44e03fa78c0 /docs/drivers.rst
parentf16619ad3cc8d19d739902632d52628b43dcf390 (diff)
Fix links. Adding the en/latest/ circumvents a ReadTheDocs bug
which redirects projects incorrectly.
Diffstat (limited to 'docs/drivers.rst')
-rw-r--r--docs/drivers.rst147
1 files 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) <https://circuitpython.readthedocs.io/projects/hid/>
- Waveform Generation <https://circuitpython.readthedocs.io/projects/waveform/>
- OneWire <https://circuitpython.readthedocs.io/projects/onewire/>
- Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/>
- InfraRed Remote <https://circuitpython.readthedocs.io/projects/irremote/>
- Fancy LED (similar to FastLED) <https://circuitpython.readthedocs.io/projects/fancyled/>
- SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/>
- AVR programming <https://circuitpython.readthedocs.io/projects/avrprog/>
- DC Motor and Servo <https://circuitpython.readthedocs.io/projects/motor/>
- SD Card <https://circuitpython.readthedocs.io/projects/sd/>
+ 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/>
+ OneWire <https://circuitpython.readthedocs.io/projects/onewire/en/latest/>
+ Ring Tone Text Transfer Language (RTTTL) <https://circuitpython.readthedocs.io/projects/rtttl/en/latest/>
+ InfraRed Remote <https://circuitpython.readthedocs.io/projects/irremote/en/latest/>
+ Fancy LED (similar to FastLED) <https://circuitpython.readthedocs.io/projects/fancyled/en/latest/>
+ SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
+ AVR programming <https://circuitpython.readthedocs.io/projects/avrprog/en/latest/>
+ DC Motor and Servo <https://circuitpython.readthedocs.io/projects/motor/en/latest/>
+ SD Card <https://circuitpython.readthedocs.io/projects/sd/en/latest/>
Blinky
--------
@@ -74,8 +74,8 @@ Multi-color led drivers.
.. toctree::
- NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/>
- DotStar <https://circuitpython.readthedocs.io/projects/dotstar/>
+ NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/en/latest/>
+ DotStar <https://circuitpython.readthedocs.io/projects/dotstar/en/latest/>
Displays
-------------
@@ -84,12 +84,12 @@ Drivers used to display information. Either pixel or segment based.
.. toctree::
- RGB Displays <https://circuitpython.readthedocs.io/projects/rgb_display/>
- Character LCD <https://circuitpython.readthedocs.io/projects/charlcd/>
- HT16K33 LED Matrices and Segment Displays <https://circuitpython.readthedocs.io/projects/ht16k33/>
- IS31FL3731 Charlieplexed LED Matrix <https://circuitpython.readthedocs.io/projects/is31fl3731/>
- MAX7219 LED Matrix <https://circuitpython.readthedocs.io/projects/max7219/>
- SSD1306 OLED Driver <https://circuitpython.readthedocs.io/projects/ssd1306/>
+ RGB Displays <https://circuitpython.readthedocs.io/projects/rgb_display/en/latest/>
+ Character LCD <https://circuitpython.readthedocs.io/projects/charlcd/en/latest/>
+ HT16K33 LED Matrices and Segment Displays <https://circuitpython.readthedocs.io/projects/ht16k33/en/latest/>
+ IS31FL3731 Charlieplexed LED Matrix <https://circuitpython.readthedocs.io/projects/is31fl3731/en/latest/>
+ MAX7219 LED Matrix <https://circuitpython.readthedocs.io/projects/max7219/en/latest/>
+ SSD1306 OLED Driver <https://circuitpython.readthedocs.io/projects/ssd1306/en/latest/>
Real-time clocks
-----------------
@@ -99,9 +99,9 @@ through ``datetime``.
.. toctree::
- DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/>
- DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/>
- PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/>
+ DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/en/latest/>
+ DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/en/latest/>
+ PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/en/latest/>
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 <https://circuitpython.readthedocs.io/projects/bno055/>
- FXAS21002C Gyroscope <https://circuitpython.readthedocs.io/projects/fxas21002C/>
- FXOS8700 Accelerometer <https://circuitpython.readthedocs.io/projects/fxos8700/>
- GPS Global Position <https://circuitpython.readthedocs.io/projects/gps/>
- LIS3DH Accelerometer <https://circuitpython.readthedocs.io/projects/lis3dh/>
- LSM303 Accelerometer and Magnetometer <https://circuitpython.readthedocs.io/projects/lsm303/>
- LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds0/>
- LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds1/>
- MMA8451 3 axis accelerometer <https://circuitpython.readthedocs.io/projects/mma8451/>
+
+ BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation <https://circuitpython.readthedocs.io/projects/bno055/en/latest/>
+ FXAS21002C Gyroscope <https://circuitpython.readthedocs.io/projects/fxas21002C/en/latest/>
+ FXOS8700 Accelerometer <https://circuitpython.readthedocs.io/projects/fxos8700/en/latest/>
+ GPS Global Position <https://circuitpython.readthedocs.io/projects/gps/en/latest/>
+ LIS3DH Accelerometer <https://circuitpython.readthedocs.io/projects/lis3dh/en/latest/>
+ LSM303 Accelerometer and Magnetometer <https://circuitpython.readthedocs.io/projects/lsm303/en/latest/>
+ LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds0/en/latest/>
+ LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature <https://circuitpython.readthedocs.io/projects/lsm9ds1/en/latest/>
+ MMA8451 3 axis accelerometer <https://circuitpython.readthedocs.io/projects/mma8451/en/latest/>
Environmental Sensors
----------------------
@@ -128,20 +129,20 @@ equivalent carbon dioxide (``eco2`` / ``eCO2``), and total volatile organic comp
.. toctree::
- BME280 Temperature, Humidity and Pressure <https://circuitpython.readthedocs.io/projects/bme280/>
- BME680 Temperature, Humidity, Pressure and Gas <https://circuitpython.readthedocs.io/projects/bme680/>
- BMP280 Barometric Pressure and Altitude <https://circuitpython.readthedocs.io/projects/bmp280/>
- CCS811 Air Quality <https://circuitpython.readthedocs.io/projects/ccs811/>
- DHT Temperature and Humidity <https://circuitpython.readthedocs.io/projects/dht/>
- DS18x20 Temperature <https://circuitpython.readthedocs.io/projects/ds18x20/>
- MAX31865 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31865/>
- MAX31855 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31855/>
- MCP9808 Temperature <https://circuitpython.readthedocs.io/projects/mcp9808/>
- MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor <https://circuitpython.readthedocs.io/projects/mpl3115a2/>
- SGP30 Air Quality <https://circuitpython.readthedocs.io/projects/sgp30/>
- SHT31-D Temperature and Humidity <https://circuitpython.readthedocs.io/projects/sht31d/>
- Si7021 Temperature and Humidity <https://circuitpython.readthedocs.io/projects/si7021/>
- Thermistor Temperature <https://circuitpython.readthedocs.io/projects/thermistor/>
+ BME280 Temperature, Humidity and Pressure <https://circuitpython.readthedocs.io/projects/bme280/en/latest/>
+ BME680 Temperature, Humidity, Pressure and Gas <https://circuitpython.readthedocs.io/projects/bme680/en/latest/>
+ BMP280 Barometric Pressure and Altitude <https://circuitpython.readthedocs.io/projects/bmp280/en/latest/>
+ CCS811 Air Quality <https://circuitpython.readthedocs.io/projects/ccs811/en/latest/>
+ DHT Temperature and Humidity <https://circuitpython.readthedocs.io/projects/dht/en/latest/>
+ DS18x20 Temperature <https://circuitpython.readthedocs.io/projects/ds18x20/en/latest/>
+ MAX31865 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31865/en/latest/>
+ MAX31855 Thermocouple Amplifier, Temperature <https://circuitpython.readthedocs.io/projects/max31855/en/latest/>
+ MCP9808 Temperature <https://circuitpython.readthedocs.io/projects/mcp9808/en/latest/>
+ MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor <https://circuitpython.readthedocs.io/projects/mpl3115a2/en/latest/>
+ SGP30 Air Quality <https://circuitpython.readthedocs.io/projects/sgp30/en/latest/>
+ SHT31-D Temperature and Humidity <https://circuitpython.readthedocs.io/projects/sht31d/en/latest/>
+ Si7021 Temperature and Humidity <https://circuitpython.readthedocs.io/projects/si7021/en/latest/>
+ Thermistor Temperature <https://circuitpython.readthedocs.io/projects/thermistor/en/latest/>
Light Sensors
---------------
@@ -151,12 +152,12 @@ These sensors detect light related attributes such as ``color``, ``light`` (unit
.. toctree::
- APDS9960 Proximity, Light, RGB, and Gesture <https://circuitpython.readthedocs.io/projects/apds9960/>
- TCS34725 Color Sensor <https://circuitpython.readthedocs.io/projects/tcs34725/>
- TSL2561 Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2561/>
- TSL2591 High Dynamic Range Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2591/>
- VCNL4010 Proximity and Light <https://circuitpython.readthedocs.io/projects/vcnl4010/>
- VEML6070 UV Index <https://circuitpython.readthedocs.io/projects/veml6070/>
+ APDS9960 Proximity, Light, RGB, and Gesture <https://circuitpython.readthedocs.io/projects/apds9960/en/latest/>
+ TCS34725 Color Sensor <https://circuitpython.readthedocs.io/projects/tcs34725/en/latest/>
+ TSL2561 Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2561/en/latest/>
+ TSL2591 High Dynamic Range Light Sensor <https://circuitpython.readthedocs.io/projects/tsl2591/en/latest/>
+ VCNL4010 Proximity and Light <https://circuitpython.readthedocs.io/projects/vcnl4010/en/latest/>
+ VEML6070 UV Index <https://circuitpython.readthedocs.io/projects/veml6070/en/latest/>
Distance Sensors
------------------
@@ -165,8 +166,8 @@ These sensors measure the ``distance`` to another object and may also measure li
.. toctree::
- VL6180x 5 - 100 mm <https://circuitpython.readthedocs.io/projects/vl6180x/>
- VL53L0x ~30 - 1000 mm <https://circuitpython.readthedocs.io/projects/vl53l0x/>
+ VL6180x 5 - 100 mm <https://circuitpython.readthedocs.io/projects/vl6180x/en/latest/>
+ VL53L0x ~30 - 1000 mm <https://circuitpython.readthedocs.io/projects/vl53l0x/en/latest/>
Radio
--------
@@ -175,8 +176,8 @@ These chips communicate to other's over radio.
.. toctree::
- RFM9x LoRa <https://circuitpython.readthedocs.io/projects/rfm9x/>
- RFM69 Packet Radio <https://circuitpython.readthedocs.io/projects/rfm69/>
+ RFM9x LoRa <https://circuitpython.readthedocs.io/projects/rfm9x/en/latest/>
+ RFM69 Packet Radio <https://circuitpython.readthedocs.io/projects/rfm69/en/latest/>
IO Expansion
--------------
@@ -185,15 +186,15 @@ These provide functionality similar to `analogio`, `digitalio`, `pulseio`, and `
.. toctree::
- Adafruit SeeSaw <https://circuitpython.readthedocs.io/projects/seesaw/>
- ADS1x15 Analog-to-Digital Converter <https://circuitpython.readthedocs.io/projects/ads1x15/>
- DS2413 OneWire GPIO Expander <https://circuitpython.readthedocs.io/projects/d2413/>
- FocalTech Capacitive Touch <https://circuitpython.readthedocs.io/projects/focaltouch/>
- MCP4725 Digital-to-Analog Converter <https://circuitpython.readthedocs.io/projects/mcp4725/>
- PCA9685 16 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/pca9685/>
- TLC5947 24 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc5947/>
- TLC59711 12 x 16-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc59711/>
- MCP4725 Capacitive Touch Sensor <https://circuitpython.readthedocs.io/projects/mpr121/>
+ Adafruit SeeSaw <https://circuitpython.readthedocs.io/projects/seesaw/en/latest/>
+ ADS1x15 Analog-to-Digital Converter <https://circuitpython.readthedocs.io/projects/ads1x15/en/latest/>
+ DS2413 OneWire GPIO Expander <https://circuitpython.readthedocs.io/projects/ds2413/en/latest/>
+ FocalTech Capacitive Touch <https://circuitpython.readthedocs.io/projects/focaltouch/en/latest/>
+ MCP4725 Digital-to-Analog Converter <https://circuitpython.readthedocs.io/projects/mcp4725/en/latest/>
+ PCA9685 16 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/pca9685/en/latest/>
+ TLC5947 24 x 12-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc5947/en/latest/>
+ TLC59711 12 x 16-bit PWM Driver <https://circuitpython.readthedocs.io/projects/tlc59711/en/latest/>
+ MPR121 Capacitive Touch Sensor <https://circuitpython.readthedocs.io/projects/mpr121/en/latest/>
Miscellaneous
@@ -201,13 +202,13 @@ Miscellaneous
.. toctree::
- Si4713 Stereo FM Transmitter <https://circuitpython.readthedocs.io/projects/si4713/>
- AMG88xx Grid-Eye IR Camera <https://circuitpython.readthedocs.io/projects/amg88xx/>
- Trellis 4x4 Keypad <https://circuitpython.readthedocs.io/projects/trellis/>
- DRV2605 Haptic Motor Controller <https://circuitpython.readthedocs.io/projects/drv2605/>
- MAX9744 Audio Amplifier <https://circuitpython.readthedocs.io/projects/max9744/>
- Si5351 Clock Generator <https://circuitpython.readthedocs.io/projects/si5351/>
- Thermal Printer <https://circuitpython.readthedocs.io/projects/thermal_printer/>
- VC0706 TTL Camera <https://circuitpython.readthedocs.io/projects/vc0706/>
- INA219 High Side Current <https://circuitpython.readthedocs.io/projects/ina219/>
- Fingerprint <https://circuitpython.readthedocs.io/projects/fingerprint/>
+ Si4713 Stereo FM Transmitter <https://circuitpython.readthedocs.io/projects/si4713/en/latest/>
+ AMG88xx Grid-Eye IR Camera <https://circuitpython.readthedocs.io/projects/amg88xx/en/latest/>
+ Trellis 4x4 Keypad <https://circuitpython.readthedocs.io/projects/trellis/en/latest/>
+ DRV2605 Haptic Motor Controller <https://circuitpython.readthedocs.io/projects/drv2605/en/latest/>
+ MAX9744 Audio Amplifier <https://circuitpython.readthedocs.io/projects/max9744/en/latest/>
+ Si5351 Clock Generator <https://circuitpython.readthedocs.io/projects/si5351/en/latest/>
+ Thermal Printer <https://circuitpython.readthedocs.io/projects/thermal_printer/en/latest/>
+ VC0706 TTL Camera <https://circuitpython.readthedocs.io/projects/vc0706/en/latest/>
+ INA219 High Side Current <https://circuitpython.readthedocs.io/projects/ina219/en/latest/>
+ Fingerprint <https://circuitpython.readthedocs.io/projects/fingerprint/en/latest/>