From 16075843a1a9a523f9e52019aede7f29f4b06d28 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 5 Nov 2024 16:12:37 -0600 Subject: [PATCH 1/5] manual add --- docs/drivers.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/drivers.rst b/docs/drivers.rst index ea04c756..61519f8f 100644 --- a/docs/drivers.rst +++ b/docs/drivers.rst @@ -27,7 +27,7 @@ specific boards. .. toctree:: - Adafruit CircuitPlayground + Adafruit CircuitPlayground (adafruit_circuitplayground) Adafruit CLUE Adafruit ESP32S2TFT Adafruit FeatherWings From 7c9270a2a0524e82f9947c8a5d1e5feff84c46e9 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 5 Nov 2024 16:54:01 -0600 Subject: [PATCH 2/5] adding import names to drivers.rst --- add_import_names.py | 27 ++ docs/drivers.rst | 694 ++++++++++++++++++++++---------------------- 2 files changed, 374 insertions(+), 347 deletions(-) create mode 100644 add_import_names.py diff --git a/add_import_names.py b/add_import_names.py new file mode 100644 index 00000000..7fc7268e --- /dev/null +++ b/add_import_names.py @@ -0,0 +1,27 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT +""" +Creates updated_drivers.rst which includes import names for each module. +""" + +if __name__ == '__main__': + with open('docs/drivers.rst', 'r') as drivers_rst: + with open("updated_drivers.rst", "w") as updated_drivers_rst: + lines = drivers_rst.readlines() + + for line in lines: + + if "")[0] + #print(docs_url) + + short_name = line.split("https://docs.circuitpython.org/projects/")[1].split("/en/latest/")[0] + insert_index = line.index("<") - 1 + #print(f"adafruit_{short_name} | {insert_index}") + + modified = line[:insert_index] + f" (adafruit_{short_name})" + line[insert_index:] + #print(modified) + updated_drivers_rst.write(modified) + else: + updated_drivers_rst.write(line) diff --git a/docs/drivers.rst b/docs/drivers.rst index 61519f8f..c5f1f154 100644 --- a/docs/drivers.rst +++ b/docs/drivers.rst @@ -16,8 +16,8 @@ the ``lib/`` directory. Some drivers may not work without them. .. toctree:: - BusDevice Library - Register Library + BusDevice Library (adafruit_busdevice) + Register Library (adafruit_register) Board-specific Helpers ---------------------- @@ -27,20 +27,20 @@ specific boards. .. toctree:: - Adafruit CircuitPlayground (adafruit_circuitplayground) - Adafruit CLUE - Adafruit ESP32S2TFT - Adafruit FeatherWings - Adafruit FunHouse - Adafruit MacroPad - Adafruit MagTag - Adafruit MONSTER M4SK - Adafruit PortalBase - Adafruit PyCamera - Adafruit PyPortal - Adafruit Qualia S3 - PyBadger (PyBadge and PyGamer) - MatrixPortal (Metro M4 Airlift + RGB Shield) + Adafruit CircuitPlayground (adafruit_circuitplayground) (adafruit_circuitplayground) + Adafruit CLUE (adafruit_clue) + Adafruit ESP32S2TFT (adafruit_esp32s2tft) + Adafruit FeatherWings (adafruit_featherwing) + Adafruit FunHouse (adafruit_funhouse) + Adafruit MacroPad (adafruit_macropad) + Adafruit MagTag (adafruit_magtag) + Adafruit MONSTER M4SK (adafruit_monsterm4sk) + Adafruit PortalBase (adafruit_portalbase) + Adafruit PyCamera (adafruit_pycamera) + Adafruit PyPortal (adafruit_pyportal) + Adafruit Qualia S3 (adafruit_qualia) + PyBadger (PyBadge and PyGamer) (adafruit_pybadger) + MatrixPortal (Metro M4 Airlift + RGB Shield) (adafruit_matrixportal) Helper Libraries ----------------- @@ -54,9 +54,9 @@ Helpers for animating LEDs. .. toctree:: - Fancy LED (similar to FastLED) - LED Animation - PixelMap + Fancy LED (similar to FastLED) (adafruit_fancyled) + LED Animation (adafruit_led-animation) + PixelMap (adafruit_pixelmap) User Interface and GFX Helpers ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -65,26 +65,26 @@ Helpers for building graphical interfaces using the displayio core module and fr .. toctree:: - Cursor Control - Bitmap Font - Bitmap Saver - Display Button - Display Notification - Display Shapes - Display Text - Framebuf Module - GFX (framebuf) - Image Load - miniQR Non-hardware QR code generator - Pixel Framebuf Module - ProgressBar - PYOA - Slideshow - Simple Text Display - Turtle Graphics - WSGI - DisplayIO Layout - Dash Display + Cursor Control (adafruit_cursorcontrol) + Bitmap Font (adafruit_bitmap-font) + Bitmap Saver (adafruit_bitmapsaver) + Display Button (adafruit_display-button) + Display Notification (adafruit_display_notification) + Display Shapes (adafruit_display-shapes) + Display Text (adafruit_display_text) + Framebuf Module (adafruit_framebuf) + GFX (framebuf) (adafruit_gfx) + Image Load (adafruit_imageload) + miniQR Non-hardware QR code generator (adafruit_miniqr) + Pixel Framebuf Module (adafruit_pixel_framebuf) + ProgressBar (adafruit_progressbar) + PYOA (adafruit_pyoa) + Slideshow (adafruit_slideshow) + Simple Text Display (adafruit_simple-text-display) + Turtle Graphics (adafruit_turtle) + WSGI (adafruit_wsgi) + DisplayIO Layout (adafruit_displayio-layout) + Dash Display (adafruit_dash_display) Motor Helpers ^^^^^^^^^^^^^^ @@ -93,10 +93,10 @@ Helpers for driving motors, servos, and steppers. .. toctree:: - DC Motor and Servo - EMC2101 Fan Controller and Temperature monitor - MotorKit - ServoKit + DC Motor and Servo (adafruit_motor) + EMC2101 Fan Controller and Temperature monitor (adafruit_emc2101) + MotorKit (adafruit_motorkit) + ServoKit (adafruit_servokit) Internet of Things Web Service Helpers ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -105,12 +105,12 @@ Helpers for connecting with hosted and self-hosted internet-of-things web servic .. toctree:: - Adafruit IO - Amazon AWS IoT - Azure IoT - Google Cloud IoT Core - Hue Lights - LIFX Lights + Adafruit IO (adafruit_adafruitio) + Amazon AWS IoT (adafruit_aws_iot) + Azure IoT (adafruit_azureiot) + Google Cloud IoT Core (adafruit_gc_iot_core) + Hue Lights (adafruit_hue) + LIFX Lights (adafruit_lifx) Internet/Internet-of-Things Helpers ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -119,16 +119,16 @@ Helpers for interfacing with the internet, including IoT protocols. .. toctree:: - Connection Manager - Fake Requests - HTTP Server - JSON Stream - JSON Web Token (JWT) - MiniMQTT - NTP (Network time Protocol) - Requests - OAuth2.0 - Template Engine + Connection Manager (adafruit_connectionmanager) + Fake Requests (adafruit_fakerequests) + HTTP Server (adafruit_httpserver) + JSON Stream (adafruit_json_stream) + JSON Web Token (JWT) (adafruit_jwt) + MiniMQTT (adafruit_minimqtt) + NTP (Network time Protocol) (adafruit_ntp) + Requests (adafruit_requests) + OAuth2.0 (adafruit_oauth2) + Template Engine (adafruit_templateengine) Bluetooth Low Energy Helpers ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -137,23 +137,23 @@ Helpers for Bluetooth Low Energy (BLE). .. toctree:: - Bluefruit LE Connect App - BLE Base Library - BLE Adafruit Services - BLE Apple Media Service - BLE Apple Notification Center Service - BLE Location Beacons - BLE BerryMed Pulse Oximeter Service - BLE BroadcastNet - BLE Cycling Speed and Cadence - BLE Eddystone Beacon - BLE File Transfer - BLE Heart Rate - BLE iBBQ - BLE LYWSD03MMC (Xiaomi Mijia) - BLE Magic Light - BLE MIDI - BLE Radio + Bluefruit LE Connect App (adafruit_bluefruitconnect) + BLE Base Library (adafruit_ble) + BLE Adafruit Services (adafruit_ble_adafruit) + BLE Apple Media Service (adafruit_ble_apple_media) + BLE Apple Notification Center Service (adafruit_ble_apple_notification_center) + BLE Location Beacons (adafruit_ble_beacon) + BLE BerryMed Pulse Oximeter Service (adafruit_ble_berrymed_pulse_oximeter) + BLE BroadcastNet (adafruit_ble_broadcastnet) + BLE Cycling Speed and Cadence (adafruit_ble_cycling_speed_and_cadence) + BLE Eddystone Beacon (adafruit_ble_eddystone) + BLE File Transfer (adafruit_ble_file_transfer) + BLE Heart Rate (adafruit_ble_heart_rate) + BLE iBBQ (adafruit_ble_ibbq) + BLE LYWSD03MMC (Xiaomi Mijia) (adafruit_ble_lywsd03mmc) + BLE Magic Light (adafruit_ble_magic_light) + BLE MIDI (adafruit_ble_midi) + BLE Radio (adafruit_ble_radio) LoRa Wireless Helpers @@ -163,7 +163,7 @@ Helpers for wireless communication via LoRa. .. toctree:: - TinyLoRa TTN Helper (LoRaWAN) + TinyLoRa TTN Helper (LoRaWAN) (adafruit_tinylora) Cryptography Helpers ^^^^^^^^^^^^^^^^^^^^^ @@ -172,7 +172,7 @@ Helpers for secure communication. .. toctree:: - RSA + RSA (adafruit_rsa) CPython-module Helpers ^^^^^^^^^^^^^^^^^^^^^^^ @@ -182,12 +182,12 @@ modules may have a CircuitPython Core API implementation too. .. toctree:: - asyncio - binascii - datetime - IterTools - Logging - hashlib + asyncio (adafruit_asyncio) + binascii (adafruit_binascii) + datetime (adafruit_datetime) + IterTools (adafruit_itertools) + Logging (adafruit_logging) + hashlib (adafruit_hashlib) Audio Helpers ^^^^^^^^^^^^^^^ @@ -196,41 +196,41 @@ Music, noisemakers, and more. .. toctree:: - MIDI - Ring Tone Text Transfer Language (RTTTL) - Waveform Generation - Wave file I/O + MIDI (adafruit_midi) + Ring Tone Text Transfer Language (RTTTL) (adafruit_rtttl) + Waveform Generation (adafruit_waveform) + Wave file I/O (adafruit_wave) Miscellaneous Helpers ^^^^^^^^^^^^^^^^^^^^^^^ .. toctree:: - AVR programming - BitbangIO - Board Test Suite - Colorsys - Debouncer - Debug I2C - Ducky - InfraRed Remote - Mini ESP Tool (ESP chips loader) - NeoKey - OneWire - Pastebin services - PIOASM converter for RP2 boards - PIO UART - Prompt Toolkit - Radial Controller - SD Card - SimpleIO - SimpleMath - Test Repo - USB HID - Human Interface Device (Keyboard and Mouse) - USB Host Descriptors - USB Host Mass Storage - USB Host MIDI - Ticks + AVR programming (adafruit_avrprog) + BitbangIO (adafruit_bitbangio) + Board Test Suite (adafruit_boardtest) + Colorsys (adafruit_colorsys) + Debouncer (adafruit_debouncer) + Debug I2C (adafruit_debug_i2c) + Ducky (adafruit_ducky) + InfraRed Remote (adafruit_irremote) + Mini ESP Tool (ESP chips loader) (adafruit_miniesptool) + NeoKey (adafruit_neokey) + OneWire (adafruit_onewire) + Pastebin services (adafruit_pastebin) + PIOASM converter for RP2 boards (adafruit_pioasm) + PIO UART (adafruit_pio_uart) + Prompt Toolkit (adafruit_prompt_toolkit) + Radial Controller (adafruit_radial-controller) + SD Card (adafruit_sd) + SimpleIO (adafruit_simpleio) + SimpleMath (adafruit_simplemath) + Test Repo (adafruit_testrepo) + USB HID - Human Interface Device (Keyboard and Mouse) (adafruit_hid) + USB Host Descriptors (adafruit_usb-host-descriptors) + USB Host Mass Storage (adafruit_usb-host-mass-storage) + USB Host MIDI (adafruit_usb-host-midi) + Ticks (adafruit_ticks) Blinky -------- @@ -239,14 +239,14 @@ Multi-color LED drivers. .. toctree:: - DotStar - NeoPixel - NeoPixel SPI - NeoPxl8 - Pixie - RGB LED - TM1814 - WS2801 + DotStar (adafruit_dotstar) + NeoPixel (neopixel) + NeoPixel SPI (neopixel_spi) + NeoPxl8 (adafruit_neopxl8) + Pixie (adafruit_pixie) + RGB LED (adafruit_rgbled) + TM1814 (adafruit_tm1814) + WS2801 (adafruit_ws2801) Displays ------------- @@ -266,64 +266,64 @@ Color TFT-LCD .. toctree:: - HX8357 (displayio) - ILI9341 and ILI9340 (displayio) - ST7735 (displayio) - ST7735R (displayio) - ST7789 (displayio) - RGB Displays (framebuf) + HX8357 (displayio) (adafruit_hx8357) + ILI9341 and ILI9340 (displayio) (adafruit_ili9341) + ST7735 (displayio) (adafruit_st7735) + ST7735R (displayio) (adafruit_st7735r) + ST7789 (displayio) (adafruit_st7789) + RGB Displays (framebuf) (adafruit_rgb_display) OLED ^^^^^^^^^^^^^^^ .. toctree:: - SH1106 OLED (displayio) - SH1107 OLED (displayio) - SSD1305 OLED (displayio) - SSD1305 OLED (framebuf) - SSD1306 OLED (displayio) - SSD1306 OLED (framebuf) - SSD1322 OLED (displayio) - SSD1325 OLED (displayio) - SSD1327 OLED (displayio) - SSD1331 OLED (displayio) - SSD1351 OLED (displayio) + SH1106 OLED (displayio) (adafruit_displayio_sh1106) + SH1107 OLED (displayio) (adafruit_displayio-sh1107) + SSD1305 OLED (displayio) (adafruit_displayio_ssd1305) + SSD1305 OLED (framebuf) (adafruit_ssd1305) + SSD1306 OLED (displayio) (adafruit_displayio_ssd1306) + SSD1306 OLED (framebuf) (adafruit_ssd1306) + SSD1322 OLED (displayio) (adafruit_ssd1322) + SSD1325 OLED (displayio) (adafruit_ssd1325) + SSD1327 OLED (displayio) (adafruit_ssd1327) + SSD1331 OLED (displayio) (adafruit_ssd1331) + SSD1351 OLED (displayio) (adafruit_ssd1351) E-Paper / E-Ink ^^^^^^^^^^^^^^^ .. toctree:: - ACeP7In (displayio) - E-Paper Display (framebuf) - EK79686 (displayio) - IL0373 (displayio) - IL0398 (displayio) - IL91874 (displayio) - SPD1656 (displayio) - SSD1608 (displayio) - SSD1675 (displayio) - SSD1680 (displayio) - SSD1681 (displayio) - UC8151D (displayio) + ACeP7In (displayio) (adafruit_acep7in) + E-Paper Display (framebuf) (adafruit_epd) + EK79686 (displayio) (adafruit_ek79686) + IL0373 (displayio) (adafruit_il0373) + IL0398 (displayio) (adafruit_il0398) + IL91874 (displayio) (adafruit_il91874) + SPD1656 (displayio) (adafruit_spd1656) + SSD1608 (displayio) (adafruit_ssd1608) + SSD1675 (displayio) (adafruit_ssd1675) + SSD1680 (displayio) (adafruit_ssd1680) + SSD1681 (displayio) (adafruit_ssd1681) + UC8151D (displayio) (adafruit_uc8151d) Other ^^^^^^^^^^^^^^^ .. toctree:: - Character LCD - FT5336 Capacitive Touch Screen Driver - HT16K33 LED Matrices and Segment Displays - IS31FL3731 Charlieplexed LED Matrix - IS31FL3741 RGB LED Matrix driver - MAX7219 LED Matrix - Nokia PCD8544 Display - RA8875 40-Pin Display Driver - Sharp Memory Display - ST7565 Graphic Displays - TSC2007 Resistive Touch Screen Driver + Character LCD (adafruit_charlcd) + FT5336 Capacitive Touch Screen Driver (adafruit_ft5336) + HT16K33 LED Matrices and Segment Displays (adafruit_ht16k33) + IS31FL3731 Charlieplexed LED Matrix (adafruit_is31fl3731) + IS31FL3741 RGB LED Matrix driver (adafruit_is31fl3741) + MAX7219 LED Matrix (adafruit_max7219) + Nokia PCD8544 Display (adafruit_pcd8544) + RA8875 40-Pin Display Driver (adafruit_ra8875) + Sharp Memory Display (adafruit_sharpmemorydisplay) + ST7565 Graphic Displays (adafruit_st7565) + TSC2007 Resistive Touch Screen Driver (adafruit_tsc2007) Real-time clocks ----------------- @@ -333,10 +333,10 @@ through ``datetime``. .. toctree:: - DS1307 Real-time Clock (5V RTC Breakout) - DS3231 Real-time Clock (Precision RTC) - PCF8523 Real-time Clock (Adalogger RTC) - PCF8563 Real-time Clock + DS1307 Real-time Clock (5V RTC Breakout) (adafruit_ds1307) + DS3231 Real-time Clock (Precision RTC) (adafruit_ds3231) + PCF8523 Real-time Clock (Adalogger RTC) (adafruit_pcf8523) + PCF8563 Real-time Clock (adafruit_pcf8563) Motion Sensors ---------------- @@ -345,33 +345,33 @@ Motion relating sensing including ``acceleration``, ``magnetic``, ``gyro``, and .. toctree:: - ADXL34x 3 Axis Accelerometer - ADXL37x 3 Axis Accelerometer - BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation - BNO08X 9 Axis Sensor Fusion IMU - BNO08X_RVC Simple UART Heading Library - FXAS21002C Gyroscope - FXOS8700 Accelerometer - GPS Global Position - ICM20X Wide-range 6-DoF Accelerometer and Gyro Family - L3GD20 3-Axis Gyroscope - LIS2MDL 3-Axis Magnetometer - LIS331HH and H3LIS331 3-Axis Accelerometers - LIS3DH Accelerometer - LIS3MDL 3-Axis Magnetometer - LSM303 Accelerometer Only - LSM303 Accelerometer and Magnetometer - LSM303DLH Magnetometer Only - LSM6DSOX, LSM6DS33, and ISM330DHCT Accelerometer, Gyroscope and Temperature - LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature - LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature - MLX90393 3 Axis Magnetometer - MLX90395 3-Axis Magnetometer - MMA8451 3 Axis Accelerometer - MMC56X3 Magnetometers - MPU6050 Accelerometer, Gyroscope, and Temperature Sensor - MSA301 3 Axis Accelerometer - TLV493D 3 Axis Magnetometer + ADXL34x 3 Axis Accelerometer (adafruit_adxl34x) + ADXL37x 3 Axis Accelerometer (adafruit_adxl37x) + BNO055 Accelerometer, Magnetometer, Gyroscope and Absolution Orientation (adafruit_bno055) + BNO08X 9 Axis Sensor Fusion IMU (adafruit_bno08x) + BNO08X_RVC Simple UART Heading Library (adafruit_bno08x_rvc) + FXAS21002C Gyroscope (adafruit_fxas21002c) + FXOS8700 Accelerometer (adafruit_fxos8700) + GPS Global Position (adafruit_gps) + ICM20X Wide-range 6-DoF Accelerometer and Gyro Family (adafruit_icm20x) + L3GD20 3-Axis Gyroscope (adafruit_l3gd20) + LIS2MDL 3-Axis Magnetometer (adafruit_lis2mdl) + LIS331HH and H3LIS331 3-Axis Accelerometers (adafruit_lis331) + LIS3DH Accelerometer (adafruit_lis3dh) + LIS3MDL 3-Axis Magnetometer (adafruit_lis3mdl) + LSM303 Accelerometer Onl (adafruit_lsm303-accel)y + LSM303 Accelerometer and Magnetometer (adafruit_lsm303) + LSM303DLH Magnetometer Onl (adafruit_lsm303dlh-mag)y + LSM6DSOX, LSM6DS33, and ISM330DHCT Accelerometer, Gyroscope and Temperature (adafruit_lsm6dsox) + LSM9DS0 Accelerometer, Magnetometer, Gyroscope and Temperature (adafruit_lsm9ds0) + LSM9DS1 Accelerometer, Magnetometer, Gyroscope and Temperature (adafruit_lsm9ds1) + MLX90393 3 Axis Magnetometer (adafruit_mlx90393) + MLX90395 3-Axis Magnetometer (adafruit_mlx90395) + MMA8451 3 Axis Accelerometer (adafruit_mma8451) + MMC56X3 Magnetometers (adafruit_mmc56x3) + MPU6050 Accelerometer, Gyroscope, and Temperature Sensor (adafruit_mpu6050) + MSA301 3 Axis Accelerometer (adafruit_msa301) + TLV493D 3 Axis Magnetometer (adafruit_tlv493d) Environmental Sensors ---------------------- @@ -383,50 +383,50 @@ equivalent carbon dioxide (``eco2`` / ``eCO2``), and total volatile organic comp .. toctree:: - ADT7410 High Accuracy Temperature Sensor - AGS02MA Gas Sensor - AHTx0 Tempertaure and Humidity Sensor - AM2320 Temperature and Humidity - BME280 Temperature, Humidity and Pressure - BME680 Temperature, Humidity, Pressure and Gas - BMP280 Barometric Pressure and Altitude - BMP3xx Barometric Pressure and Altimeter - CCS811 Air Quality - DHT Temperature and Humidity - DPS310 Precision Barometric Pressure / Altitude Sensor - DS18x20 Temperature - ENS160 (ScioSense) digital multi-gas sensor - HDC302x Temperature and Humidity Sensor - HTS221 Temperature and Humidity Sensor - HTU21D Temperature and Humidity - HTU31D Temperature and Humidity - LPS2X Family of Barometric Pressure, Temperature Sensors - LPS35HW Water Resistant Barometric Pressure, Temperature - SGP40 Air Quality Sensor - MAX31855 Thermocouple Amplifier, Temperature - MAX31856 Thermocouple Amplifier, Temperature - MAX31865 Thermocouple Amplifier, Temperature - MCP9600 Thermocouple Amplifier - MCP9808 Temperature - MLX90614 Contactless Temperature - MPL115A2 Barometric Pressure, Temperature - MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor - MPRLS Ported Absolute Pressure - MS8607 Pressure, Temperature, Humidity - PCT2075 Temperature Sensor - PM25 Air Quality Sensor - SCD30 CO2, Temperature, and Humidity Sensor - SCD4x Temperature and Humidity Sensor - SGP30 Air Quality - SHT31-D Temperature and Humidity - SHT4x Temperature and Humidity - SHTC3 Temperature and Humidity - Si7021 Temperature and Humidity - TC74 Digital Temperature Sensor - TMP006 Contactless IR Thermopile Sensor - TMP007 Contactless Temperature - TMP117 High-Precision Temperature Sensor - Thermistor Temperature + ADT7410 High Accuracy Temperature Sensor (adafruit_adt7410) + AGS02MA Gas Sensor (adafruit_ags02ma) + AHTx0 Tempertaure and Humidity Sensor (adafruit_ahtx0) + AM2320 Temperature and Humidity (adafruit_am2320) + BME280 Temperature, Humidity and Pressure (adafruit_bme280) + BME680 Temperature, Humidity, Pressure and Gas (adafruit_bme680) + BMP280 Barometric Pressure and Altitude (adafruit_bmp280) + BMP3xx Barometric Pressure and Altimeter (adafruit_bmp3xx) + CCS811 Air Quality (adafruit_ccs811) + DHT Temperature and Humidity (adafruit_dht) + DPS310 Precision Barometric Pressure / Altitude Sensor (adafruit_dps310) + DS18x20 Temperature (adafruit_ds18x20) + ENS160 (ScioSense) digital multi-gas sensor (adafruit_ens160) + HDC302x Temperature and Humidity Sensor (adafruit_hdc302x) + HTS221 Temperature and Humidity Sensor (adafruit_hts221) + HTU21D Temperature and Humidity (adafruit_htu21d) + HTU31D Temperature and Humidity (adafruit_htu31d) + LPS2X Family of Barometric Pressure, Temperature Sensors (adafruit_lps2x) + LPS35HW Water Resistant Barometric Pressure, Temperature (adafruit_lps35hw) + SGP40 Air Quality Sensor (adafruit_sgp40) + MAX31855 Thermocouple Amplifier, Temperature (adafruit_max31855) + MAX31856 Thermocouple Amplifier, Temperature (adafruit_max31856) + MAX31865 Thermocouple Amplifier, Temperature (adafruit_max31865) + MCP9600 Thermocouple Amplifier (adafruit_mcp9600) + MCP9808 Temperature (adafruit_mcp9808) + MLX90614 Contactless Temperature (adafruit_mlx90614) + MPL115A2 Barometric Pressure, Temperature (adafruit_mpl115a2) + MPL3115A2 Barometric Pressure, Altitude and Temperature Sensor (adafruit_mpl3115a2) + MPRLS Ported Absolute Pressure (adafruit_mprls) + MS8607 Pressure, Temperature, Humidity (adafruit_ms8607) + PCT2075 Temperature Sensor (adafruit_pct2075) + PM25 Air Quality Sensor (adafruit_pm25) + SCD30 CO2, Temperature, and Humidity Sensor (adafruit_scd30) + SCD4x Temperature and Humidity Sensor (adafruit_scd4x) + SGP30 Air Quality (adafruit_sgp30) + SHT31-D Temperature and Humidity (adafruit_sht31d) + SHT4x Temperature and Humidity (adafruit_sht4x) + SHTC3 Temperature and Humidity (adafruit_shtc3) + Si7021 Temperature and Humidity (adafruit_si7021) + TC74 Digital Temperature Sensor (adafruit_tc74) + TMP006 Contactless IR Thermopile Sensor (adafruit_tmp006) + TMP007 Contactless Temperature (adafruit_tmp007) + TMP117 High-Precision Temperature Sensor (adafruit_tmp117) + Thermistor Temperature (adafruit_thermistor) Light Sensors --------------- @@ -436,24 +436,24 @@ These sensors detect light related attributes such as ``color``, ``light`` (unit .. toctree:: - APDS9960 Proximity, Light, RGB, and Gesture - AS726x Color Spectrum Sensor - AS7341 11-Channel Multi-Spectral Digital Sensor - BH1750 Ambient Light - GUVx I2C UV Light Sensors - LTR329 LTR303 Light Sensors - LTR390 Ambient Light and UV Sensor - TCS34725 Color Sensor - TSL2561 Light Sensor - TSL2591 High Dynamic Range Light Sensor - VCNL4010 Proximity and Light - VCNL4020 Proximity and Light - VCNL4040 Proximity and Light - VCNL4200 Proximity and Light - VEML6070 UV Index - VEML6075 UV Index - VEML7700 High Accuracy Ambient Light Sensor - SI1145 Digital UV Index IR Visible Light Sensor + APDS9960 Proximity, Light, RGB, and Gesture (adafruit_apds9960) + AS726x Color Spectrum Sensor (adafruit_as726x) + AS7341 11-Channel Multi-Spectral Digital Sensor (adafruit_as7341) + BH1750 Ambient Light (adafruit_bh1750) + GUVx I2C UV Light Sensors (adafruit_guvx-i2c) + LTR329 LTR303 Light Sensors (adafruit_ltr329-ltr303) + LTR390 Ambient Light and UV Sensor (adafruit_ltr390) + TCS34725 Color Sensor (adafruit_tcs34725) + TSL2561 Light Sensor (adafruit_tsl2561) + TSL2591 High Dynamic Range Light Sensor (adafruit_tsl2591) + VCNL4010 Proximity and Light (adafruit_vcnl4010) + VCNL4020 Proximity and Light (adafruit_vcnl4020) + VCNL4040 Proximity and Light (adafruit_vcnl4040) + VCNL4200 Proximity and Light (adafruit_vcnl4200) + VEML6070 UV Index (adafruit_veml6070) + VEML6075 UV Index (adafruit_veml6075) + VEML7700 High Accuracy Ambient Light Sensor (adafruit_veml7700) + SI1145 Digital UV Index IR Visible Light Sensor (adafruit_si1145) Distance Sensors ------------------ @@ -462,15 +462,15 @@ These sensors measure the ``distance`` to another object and may also measure li .. toctree:: - Garmin LIDARLite I2C - HC-SR04 Ultrasonic Range Sensors - Slamtech RPLidar - TFmini IR Time of Flight ~30cm - 12m - US-100 Ultrasonic Distance Sensor - VL6180x 5 - 100 mm - VL53L0x ~30 - 1000 mm - VL53L1X ~30 - 4000 mm - VL53L4CD Time of Flight + Garmin LIDARLite I2C (adafruit_lidarlite) + HC-SR04 Ultrasonic Range Sensors (adafruit_hcsr04) + Slamtech RPLidar (adafruit_rplidar) + TFmini IR Time of Flight ~30cm - 12m (adafruit_tfmini) + US-100 Ultrasonic Distance Sensor (adafruit_us100) + VL6180x 5 - 100 mm (adafruit_vl6180x) + VL53L0x ~30 - 1000 mm (adafruit_vl53l0x) + VL53L1X ~30 - 4000 mm (adafruit_vl53l1x) + VL53L4CD Time of Flight (adafruit_vl53l4cd) Radio -------- @@ -479,14 +479,14 @@ These chips communicate to others over radio. .. toctree:: - Adafruit Bluefruit LE SPI Friend - AirLift Co-Processor Manager - ESP WiFi Co-Processor using AT Commands - ESP32 WiFi Co-Processor over SPI - RFM LoRa & Packet Radio - RFM9x LoRa - RFM69 Packet Radio - PN532 NFC/RFID + Adafruit Bluefruit LE SPI Friend (adafruit_bluefruitspi) + AirLift Co-Processor Manager (adafruit_airlift) + ESP WiFi Co-Processor using AT Commands (adafruit_esp-atcontrol) + ESP32 WiFi Co-Processor over SPI (adafruit_esp32spi) + RFM LoRa & Packet Radio (adafruit_rfm) + RFM9x LoRa (adafruit_rfm9x) + RFM69 Packet Radio (adafruit_rfm69) + PN532 NFC/RFID (adafruit_pn532) IO Expansion -------------- @@ -495,85 +495,85 @@ These provide functionality similar to ``analogio``, ``digitalio``, ``pulseio``, .. toctree:: - AD569x 16-bit DAC - Adafruit SeeSaw - ADG72x Analog Matrix Switches - ADS1x15 Analog-to-Digital Converter - ADS7830 8-Channel 8-Bit ADC - AW9523 GPIO expander and LED driver - Crickit Robotics Boards - CST8XX Capacitive Touch - DS2413 OneWire GPIO Expander - FocalTech Capacitive Touch - HX711 24-bit ADC - MCP2515 CAN bus controller - MCP230xx GPIO Expander - MCP3xxx SPI ADC - MCP3421 18-bit ADC - MCP4725 Digital-to-Analog Converter - MCP4728 4-Channel, 12-bit Digital-to-Analog Converter - MPR121 Capacitive Touch Sensor - NAU7802 24-Bit ADC - PCA9554 GPIO Expander - PCA9685 16 x 12-bit PWM Driver - PCF8574 GPIO Expander - PCF8575 GPIO Expander - PCF8591 ADC + DAC Combo - TCA8418 I2C Keyboard Multiplexor - TCA9548 I2C Multiplexer - TLA202X 12-bit I2C DAC - TLC5947 24 x 12-bit PWM Driver - TLC59711 12 x 16-bit PWM Driver + AD569x 16-bit DAC (adafruit_ad569x) + Adafruit SeeSaw (adafruit_seesaw) + ADG72x Analog Matrix Switches (adafruit_adg72x) + ADS1x15 Analog-to-Digital Converter (adafruit_ads1x15) + ADS7830 8-Channel 8-Bit ADC (adafruit_ads7830) + AW9523 GPIO expander and LED driver (adafruit_aw9523) + Crickit Robotics Boards (adafruit_crickit) + CST8XX Capacitive Touch (adafruit_cst8xx) + DS2413 OneWire GPIO Expander (adafruit_ds2413) + FocalTech Capacitive Touch (adafruit_focaltouch) + HX711 24-bit ADC (adafruit_hx711) + MCP2515 CAN bus controller (adafruit_mcp2515) + MCP230xx GPIO Expander (adafruit_mcp230xx) + MCP3xxx SPI ADC (adafruit_mcp3xxx) + MCP3421 18-bit ADC (adafruit_mcp3421) + MCP4725 Digital-to-Analog Converter (adafruit_mcp4725) + MCP4728 4-Channel, 12-bit Digital-to-Analog Converter (adafruit_mcp4728) + MPR121 Capacitive Touch Sensor (adafruit_mpr121) + NAU7802 24-Bit ADC (adafruit_nau7802) + PCA9554 GPIO Expander (adafruit_pca9554) + PCA9685 16 x 12-bit PWM Driver (adafruit_pca9685) + PCF8574 GPIO Expander (adafruit_pcf8574) + PCF8575 GPIO Expander (adafruit_pcf8575) + PCF8591 ADC + DAC Combo (adafruit_pcf8591) + TCA8418 I2C Keyboard Multiplexor (adafruit_tca8418) + TCA9548 I2C Multiplexer (adafruit_tca9548a) + TLA202X 12-bit I2C DAC (adafruit_tla202x) + TLC5947 24 x 12-bit PWM Driver (adafruit_tlc5947) + TLC59711 12 x 16-bit PWM Driver (adafruit_tlc59711) Miscellaneous ---------------- .. toctree:: - 24LC32 EEPROM - 74HC595 Shift Register - ATECCx08 Cryptographic Co-Processor - AMG88xx Grid-Eye IR Camera - BD3491FS Audio Processor - CAP1188 8-Key Capacitive Touch - CH9328 UART to HID Keyboard - DRV2605 Haptic Motor Controller - DS1841 I2C Logarithmic Potentiometer - DS248x 1-Wire to I2C - DS3502 I2C Potentiometer - Dymo Scale - Fingerprint Sensor - Floppy - FONA Cellular Module - FRAM Non-Volatile Memory - Gizmo - HUSB238 - INA219 High Side Current - INA260 Current and Power Monitor - INA3221 Three Channel Amp Power Monitor - LC709203F Fuel Gauge and Battery Monitor - Matrix Keypad - MAX1704x Fuel Gauge - MAX9744 Audio Amplifier - MLX90640 Thermal Camera - NeoTrellis 4x4 Keypad - NeoTrellis M4 4x8 Keypad - Nunchuk - OV2640 Camera - OV5640 Camera - OV7670 Camera - Pixelbuf - RockBlock Iridium Satellite Modem - S-35710 Low-Power Wake Up Timer - Si4713 Stereo FM Transmitter - Si5351 Clock Generator - STMPE610 Resistive Touchscreen - Touchscreen 4-Wire Resistive - TPA2016 Audio Amplifier with AGC - Trellis 4x4 Keypad - TT21100 Capacitive Touchscreen Driver - VC0706 TTL Camera - VS1053 Audio Codec - Wii Classic - Wiznet5k Ethernet Module - WM8960 Audio Codec + 24LC32 EEPROM (adafruit_24lc32) + 74HC595 Shift Register (adafruit_74hc595) + ATECCx08 Cryptographic Co-Processor (adafruit_atecc) + AMG88xx Grid-Eye IR Camera (adafruit_amg88xx) + BD3491FS Audio Processor (adafruit_bd3491fs) + CAP1188 8-Key Capacitive Touch (adafruit_cap1188) + CH9328 UART to HID Keyboard (adafruit_ch9328) + DRV2605 Haptic Motor Controller (adafruit_drv2605) + DS1841 I2C Logarithmic Potentiometer (adafruit_ds1841) + DS248x 1-Wire to I2C (adafruit_ds248x) + DS3502 I2C Potentiometer (adafruit_ds3502) + Dymo Scale (adafruit_dymoscale) + Fingerprint Sensor (adafruit_fingerprint) + Floppy (adafruit_floppy) + FONA Cellular Module (adafruit_fona) + FRAM Non-Volatile Memory (adafruit_fram) + Gizmo (adafruit_gizmo) + HUSB238 (adafruit_husb238) + INA219 High Side Current (adafruit_ina219) + INA260 Current and Power Monitor (adafruit_ina260) + INA3221 Three Channel Amp Power Monitor (adafruit_ina3221) + LC709203F Fuel Gauge and Battery Monitor (adafruit_lc709203f) + Matrix Keypad (adafruit_matrixkeypad) + MAX1704x Fuel Gauge (adafruit_max1704x) + MAX9744 Audio Amplifier (adafruit_max9744) + MLX90640 Thermal Camera (adafruit_mlx90640) + NeoTrellis 4x4 Keypad (adafruit_neotrellis) + NeoTrellis M4 4x8 Keypad (adafruit_trellism4) + Nunchuk (adafruit_nunchuk) + OV2640 Camera (adafruit_ov2640) + OV5640 Camera (adafruit_ov5640) + OV7670 Camera (adafruit_ov7670) + Pixelbuf (adafruit_pixelbuf) + RockBlock Iridium Satellite Modem (adafruit_rockblock) + S-35710 Low-Power Wake Up Timer (adafruit_s35710) + Si4713 Stereo FM Transmitter (adafruit_si4713) + Si5351 Clock Generator (adafruit_si5351) + STMPE610 Resistive Touchscreen (adafruit_stmpe610) + Touchscreen 4-Wire Resistive (adafruit_touchscreen) + TPA2016 Audio Amplifier with AGC (adafruit_tpa2016) + Trellis 4x4 Keypad (adafruit_trellis) + TT21100 Capacitive Touchscreen Driver (adafruit_tt21100) + VC0706 TTL Camera (adafruit_vc0706) + VS1053 Audio Codec (adafruit_vs1053) + Wii Classic (adafruit_wii_classic) + Wiznet5k Ethernet Module (adafruit_wiznet5k) + WM8960 Audio Codec (adafruit_wm8960) From 229be5f24833d9eeb82019ecd0f160fe6485f2af Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 5 Nov 2024 16:55:33 -0600 Subject: [PATCH 3/5] remove duplicate --- docs/drivers.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/drivers.rst b/docs/drivers.rst index c5f1f154..0108f236 100644 --- a/docs/drivers.rst +++ b/docs/drivers.rst @@ -27,7 +27,7 @@ specific boards. .. toctree:: - Adafruit CircuitPlayground (adafruit_circuitplayground) (adafruit_circuitplayground) + Adafruit CircuitPlayground (adafruit_circuitplayground) Adafruit CLUE (adafruit_clue) Adafruit ESP32S2TFT (adafruit_esp32s2tft) Adafruit FeatherWings (adafruit_featherwing) From 1a6a6e4959c3eb4ec634f9a042a5e40a8021ba42 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 5 Nov 2024 17:20:33 -0600 Subject: [PATCH 4/5] format --- add_import_names.py | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/add_import_names.py b/add_import_names.py index 7fc7268e..96371a54 100644 --- a/add_import_names.py +++ b/add_import_names.py @@ -5,8 +5,8 @@ Creates updated_drivers.rst which includes import names for each module. """ -if __name__ == '__main__': - with open('docs/drivers.rst', 'r') as drivers_rst: +if __name__ == "__main__": + with open("docs/drivers.rst", "r") as drivers_rst: with open("updated_drivers.rst", "w") as updated_drivers_rst: lines = drivers_rst.readlines() @@ -14,14 +14,20 @@ if "")[0] - #print(docs_url) + # print(docs_url) - short_name = line.split("https://docs.circuitpython.org/projects/")[1].split("/en/latest/")[0] + short_name = line.split("https://docs.circuitpython.org/projects/")[ + 1 + ].split("/en/latest/")[0] insert_index = line.index("<") - 1 - #print(f"adafruit_{short_name} | {insert_index}") + # print(f"adafruit_{short_name} | {insert_index}") - modified = line[:insert_index] + f" (adafruit_{short_name})" + line[insert_index:] - #print(modified) + modified = ( + line[:insert_index] + + f" (adafruit_{short_name})" + + line[insert_index:] + ) + # print(modified) updated_drivers_rst.write(modified) else: updated_drivers_rst.write(line) From e7716c6b9016f553c983db1acb57de1550cfe248 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 5 Nov 2024 18:58:26 -0600 Subject: [PATCH 5/5] update nau7802, asyncio, colorsys, simplio --- docs/drivers.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/drivers.rst b/docs/drivers.rst index 0108f236..6bfb75de 100644 --- a/docs/drivers.rst +++ b/docs/drivers.rst @@ -182,7 +182,7 @@ modules may have a CircuitPython Core API implementation too. .. toctree:: - asyncio (adafruit_asyncio) + asyncio (asyncio) binascii (adafruit_binascii) datetime (adafruit_datetime) IterTools (adafruit_itertools) @@ -209,7 +209,7 @@ Miscellaneous Helpers AVR programming (adafruit_avrprog) BitbangIO (adafruit_bitbangio) Board Test Suite (adafruit_boardtest) - Colorsys (adafruit_colorsys) + Colorsys (colorsys) Debouncer (adafruit_debouncer) Debug I2C (adafruit_debug_i2c) Ducky (adafruit_ducky) @@ -223,7 +223,7 @@ Miscellaneous Helpers Prompt Toolkit (adafruit_prompt_toolkit) Radial Controller (adafruit_radial-controller) SD Card (adafruit_sd) - SimpleIO (adafruit_simpleio) + SimpleIO (simpleio) SimpleMath (adafruit_simplemath) Test Repo (adafruit_testrepo) USB HID - Human Interface Device (Keyboard and Mouse) (adafruit_hid) @@ -513,7 +513,7 @@ These provide functionality similar to ``analogio``, ``digitalio``, ``pulseio``, MCP4725 Digital-to-Analog Converter (adafruit_mcp4725) MCP4728 4-Channel, 12-bit Digital-to-Analog Converter (adafruit_mcp4728) MPR121 Capacitive Touch Sensor (adafruit_mpr121) - NAU7802 24-Bit ADC (adafruit_nau7802) + NAU7802 24-Bit ADC (cedargrove_nau7802) PCA9554 GPIO Expander (adafruit_pca9554) PCA9685 16 x 12-bit PWM Driver (adafruit_pca9685) PCF8574 GPIO Expander (adafruit_pcf8574)