Regenerate device listing (#1592)

* Regenerate device listing * adjust categories for firmata and board abstraction
dotnet · Jul 16, 2021 · 135b856 · 135b856
1 parent d9e2e0b
commit 135b856
Show file tree

Hide file tree

Showing 15 changed files with 57 additions and 11 deletions.
diff --git a/src/devices/AD5328/category.txt b/src/devices/AD5328/category.txt
@@ -1 +1 @@
-Dac
+dac
diff --git a/src/devices/Arduino/README.md b/src/devices/Arduino/README.md
@@ -1,4 +1,4 @@
-# SPI, GPIO and I2C drivers for Arduino with Firmata.
+# SPI, GPIO and I2C drivers for Arduino with Firmata
 
 This binding supports GPIO, PWM, SPI and I2C access from a normal Desktop environment (Windows, Linux) trough an Arduino board. This is done trough an Arduino program called "Firmata" developed for this particular purpose. 
 

diff --git a/src/devices/Arduino/category.txt b/src/devices/Arduino/category.txt
@@ -1,6 +1,2 @@
-i2c
 usb
-gpio
-adc
 protocol
-spi
diff --git a/src/devices/Board/README.md b/src/devices/Board/README.md
@@ -0,0 +1,4 @@
+# Board abstraction
+
+A "board" is a piece of hardware that offers low-level interfaces to other devices. Typically, it has GPIO pins and one or multiple SPI or I2C busses.
+There should be exactly one instance of a board class per hardware component in an application, but it is possible to work with multiple boards at once (i.e. when having a GPIO expander connected to the Raspberry Pi).
diff --git a/src/devices/Board/category.txt b/src/devices/Board/category.txt
@@ -1,5 +1 @@
-i2c
-usb
-gpio
-adc
 protocol
diff --git a/src/devices/Device-Index.md b/src/devices/Device-Index.md
@@ -4,9 +4,11 @@
 
 * [1-wire](OneWire/README.md)
 * [28BYJ-48 Stepper Motor 5V 4-Phase 5-Wire & ULN2003 Driver Board](Uln2003/README.md)
+* [AD5328 - Digital to Analog Convertor](AD5328/README.md)
 * [Adafruit Seesaw - extension board (ADC, PWM, GPIO expander)](Seesaw/README.md)
 * [ADS1115 - Analog to Digital Converter](Ads1115/README.md)
 * [ADXL345 - Accelerometer](Adxl345/README.md)
+* [ADXL357 - Accelerometer](Adxl357/README.md)
 * [AGS01DB - MEMS VOC Gas Sensor](Ags01db/README.md)
 * [AHT10/15/20 - Temperature and humidity sensor modules](Ahtxx/README.md)
 * [AK8963 - Magnetometer](Ak8963/README.md)
@@ -17,6 +19,7 @@
 * [BMP180 - barometer, altitude and temperature sensor](Bmp180/README.md)
 * [BMxx80 Device Family](Bmxx80/README.md)
 * [BNO055 - inertial measurement unit](Bno055/README.md)
+* [Board abstraction](Board/README.md)
 * [BrickPi3](BrickPi3/README.md)
 * [Buzzer - Piezo Buzzer Controller](Buzzer/README.md)
 * [CCS811 Gas sensor](Ccs811/README.md)
@@ -29,16 +32,20 @@
 * [Explorer HAT Pro (Pimoroni)](ExplorerHat/README.md)
 * [Generic shift register](ShiftRegister/README.md)
 * [GoPiGo3](GoPiGo3/README.md)
+* [GpioDriver for other boards](Gpio/README.md)
 * [GrovePi](GrovePi/README.md)
 * [HC-SR04 - Ultrasonic Ranging Module](Hcsr04/README.md)
 * [HC-SR501 - PIR Motion Sensor](Hcsr501/README.md)
 * [HMC5883L - 3 Axis Digital Compass](Hmc5883l/README.md)
 * [HTS221 - Capacitive digital sensor for relative humidity and temperature](Hts221/README.md)
 * [INA219 - Bidirectional Current/Power Monitor](Ina219/README.md)
 * [Key Matrix](KeyMatrix/README.md)
+* [LidarLiteV3 - LIDAR Time of Flight Sensor](LidarLiteV3/README.md)
 * [LM75 - Digital Temperature Sensor](Lm75/README.md)
 * [LPS25H - Piezoresistive pressure and thermometer sensor](Lps25h/README.md)
 * [LSM9DS1 - 3D accelerometer, gyroscope and magnetometer](Lsm9Ds1/README.md)
+* [Max31856 - cold-junction compensated thermocouple to digital converter](Max31856/README.md)
+* [MAX31865 - Resistance Temperature Detector Amplifier](Max31865/README.md)
 * [MAX44009 - Ambient Light Sensor](Max44009/README.md)
 * [Max7219 (LED Matrix driver)](Max7219/README.md)
 * [MBI5027 -- 16-bit shift register with error detection](Mbi5027/README.md)
@@ -59,6 +66,7 @@
 * [OpenHardwareMonitor client library](HardwareMonitor/README.md)
 * [Pca95x4 - I2C GPIO Expander](Pca95x4/README.md)
 * [Pca9685 - I2C PWM Driver](Pca9685/README.md)
+* [PCD8544 - 48 × 84 pixels matrix LCD, famous Nokia 5110 screen](Pcd8544/README.md)
 * [PiJuice - power supply for Raspberry Pi](PiJuice/README.md)
 * [PN5180 - RFID and NFC reader](Pn5180/README.md)
 * [PN532 - RFID and NFC reader](Pn532/README.md)
@@ -70,6 +78,7 @@
 * [RGBLedMatrix - RGB LED Matrix](RGBLedMatrix/README.md)
 * [Segment display driver (HT16K33)](Display/README.md)
 * [Sense HAT](SenseHat/README.md)
+* [SensorHub - Environmental sensor](SensorHub/README.md)
 * [Servo Motor](ServoMotor/README.md)
 * [SHT3x - Temperature & Humidity Sensor](Sht3x/README.md)
 * [SHTC3 - Temperature & Humidity Sensor](Shtc3/README.md)
@@ -80,10 +89,13 @@
 * [Software SPI](SoftwareSpi/README.md)
 * [Solomon Systech Ssd1306 OLED display](Ssd13xx/README.md)
 * [Solomon Systech Ssd1351 - CMOS OLED](Ssd1351/README.md)
+* [SPI, GPIO and I2C drivers for Arduino with Firmata](Arduino/README.md)
 * [SPI, GPIO and I2C drivers for FT4222](Ft4222/README.md)
 * [Still image recording library](Media/README.md)
 * [STUSB4500 - Autonomous USB-C PD controller for Power Sinks / UFP](StUsb4500/README.md)
+* [System.Device.Model - attributes for device bindings](System.Device.Model/README.md)
 * [TCS3472x Sensors](Tcs3472x/README.md)
+* [TLC1543 - 10-bit ADC with 11 input channels](Tlc1543/README.md)
 * [TM1637 - Segment Display](Tm1637/README.md)
 * [TSL256x - Illuminance sensor](Tsl256x/README.md)
 * [VL53L0X - distance sensor](Vl53L0X/README.md)

diff --git a/src/devices/Gpio/category.txt b/src/devices/Gpio/category.txt
@@ -0,0 +1,2 @@
+gpio
+protocol
diff --git a/src/devices/Max31856/category.txt b/src/devices/Max31856/category.txt
@@ -0,0 +1,2 @@
+thermocouple
+thermometer
diff --git a/src/devices/Pcd8544/category.txt b/src/devices/Pcd8544/category.txt
@@ -0,0 +1,2 @@
+lcd
+display
diff --git a/src/devices/README.md b/src/devices/README.md
@@ -17,10 +17,16 @@ Our vision: the majority of .NET bindings are written completely in .NET languag
 * [INA219 - Bidirectional Current/Power Monitor](Ina219/README.md)
 * [Mcp3428 - Analog to Digital Converter (I2C)](Mcp3428/README.md)
 * [MCP3xxx family of Analog to Digital Converters](Mcp3xxx/README.md)
+* [TLC1543 - 10-bit ADC with 11 input channels](Tlc1543/README.md)
+
+### Digital/Analog converters
+
+* [AD5328 - Digital to Analog Convertor](AD5328/README.md)
 
 ### Accelerometers
 
 * [ADXL345 - Accelerometer](Adxl345/README.md)
+* [ADXL357 - Accelerometer](Adxl357/README.md)
 * [BNO055 - inertial measurement unit](Bno055/README.md)
 * [LSM9DS1 - 3D accelerometer, gyroscope and magnetometer](Lsm9Ds1/README.md)
 * [MPU6500/MPU9250 - Gyroscope, Accelerometer, Temperature and Magnetometer (MPU9250 only)](Mpu9250/README.md)
@@ -43,6 +49,7 @@ Our vision: the majority of .NET bindings are written completely in .NET languag
 * [Bh1745 - RGB Sensor](Bh1745/README.md)
 * [BH1750FVI - Ambient Light Sensor](Bh1750fvi/README.md)
 * [MAX44009 - Ambient Light Sensor](Max44009/README.md)
+* [SensorHub - Environmental sensor](SensorHub/README.md)
 * [TCS3472x Sensors](Tcs3472x/README.md)
 * [TSL256x - Illuminance sensor](Tsl256x/README.md)
 
@@ -52,6 +59,7 @@ Our vision: the majority of .NET bindings are written completely in .NET languag
 * [BMxx80 Device Family](Bmxx80/README.md)
 * [LPS25H - Piezoresistive pressure and thermometer sensor](Lps25h/README.md)
 * [Sense HAT](SenseHat/README.md)
+* [SensorHub - Environmental sensor](SensorHub/README.md)
 
 ### Altimeters
 
@@ -68,11 +76,14 @@ Our vision: the majority of .NET bindings are written completely in .NET languag
 * [HTS221 - Capacitive digital sensor for relative humidity and temperature](Hts221/README.md)
 * [LM75 - Digital Temperature Sensor](Lm75/README.md)
 * [LPS25H - Piezoresistive pressure and thermometer sensor](Lps25h/README.md)
+* [Max31856 - cold-junction compensated thermocouple to digital converter](Max31856/README.md)
+* [MAX31865 - Resistance Temperature Detector Amplifier](Max31865/README.md)
 * [MCP9808 - Digital Temperature Sensor](Mcp9808/README.md)
 * [MLX90614 - Infra Red Thermometer](Mlx90614/README.md)
 * [MPU6500/MPU9250 - Gyroscope, Accelerometer, Temperature and Magnetometer (MPU9250 only)](Mpu9250/README.md)
 * [OpenHardwareMonitor client library](HardwareMonitor/README.md)
 * [Sense HAT](SenseHat/README.md)
+* [SensorHub - Environmental sensor](SensorHub/README.md)
 * [SHT3x - Temperature & Humidity Sensor](Sht3x/README.md)
 * [SHTC3 - Temperature & Humidity Sensor](Shtc3/README.md)
 * [Si7021 - Temperature & Humidity Sensor](Si7021/README.md)
@@ -130,6 +141,7 @@ Our vision: the majority of .NET bindings are written completely in .NET languag
 * [DHTxx - Digital-Output Relative Humidity & Temperature Sensor Module](Dhtxx/README.md)
 * [HTS221 - Capacitive digital sensor for relative humidity and temperature](Hts221/README.md)
 * [Sense HAT](SenseHat/README.md)
+* [SensorHub - Environmental sensor](SensorHub/README.md)
 * [SHT3x - Temperature & Humidity Sensor](Sht3x/README.md)
 * [SHTC3 - Temperature & Humidity Sensor](Shtc3/README.md)
 * [Si7021 - Temperature & Humidity Sensor](Si7021/README.md)
@@ -145,6 +157,7 @@ Our vision: the majority of .NET bindings are written completely in .NET languag
 ### Distance sensors
 
 * [HC-SR04 - Ultrasonic Ranging Module](Hcsr04/README.md)
+* [LidarLiteV3 - LIDAR Time of Flight Sensor](LidarLiteV3/README.md)
 * [VL53L0X - distance sensor](Vl53L0X/README.md)
 
 ### Passive InfraRed (motion) sensors
@@ -161,6 +174,7 @@ Our vision: the majority of .NET bindings are written completely in .NET languag
 * [APA102 - Double line transmission integrated control LED](Apa102/README.md)
 * [Character LCD (Liquid Crystal Display)](CharacterLcd/README.md)
 * [Max7219 (LED Matrix driver)](Max7219/README.md)
+* [PCD8544 - 48 × 84 pixels matrix LCD, famous Nokia 5110 screen](Pcd8544/README.md)
 * [RGBLedMatrix - RGB LED Matrix](RGBLedMatrix/README.md)
 * [Segment display driver (HT16K33)](Display/README.md)
 * [Sense HAT](SenseHat/README.md)
@@ -227,6 +241,7 @@ Our vision: the majority of .NET bindings are written completely in .NET languag
 
 ### USB devices
 
+* [SPI, GPIO and I2C drivers for Arduino with Firmata](Arduino/README.md)
 * [SPI, GPIO and I2C drivers for FT4222](Ft4222/README.md)
 * [STUSB4500 - Autonomous USB-C PD controller for Power Sinks / UFP](StUsb4500/README.md)
 
@@ -235,6 +250,7 @@ Our vision: the majority of .NET bindings are written completely in .NET languag
 * [Charlieplex Segment binding](Charlieplex/README.md)
 * [Digital liquid level switch](LiquidLevel/README.md)
 * [Generic shift register](ShiftRegister/README.md)
+* [GpioDriver for other boards](Gpio/README.md)
 * [Key Matrix](KeyMatrix/README.md)
 * [MBI5027 -- 16-bit shift register with error detection](Mbi5027/README.md)
 * [Quadrature Rotary Encoder](RotaryEncoder/README.md)
@@ -245,16 +261,21 @@ Our vision: the majority of .NET bindings are written completely in .NET languag
 * [GoPiGo3](GoPiGo3/README.md)
 * [GrovePi](GrovePi/README.md)
 * [Sense HAT](SenseHat/README.md)
+* [SensorHub - Environmental sensor](SensorHub/README.md)
 
 ### Protocols providers/libraries
 
 * [1-wire](OneWire/README.md)
 * [Adafruit Seesaw - extension board (ADC, PWM, GPIO expander)](Seesaw/README.md)
+* [Board abstraction](Board/README.md)
+* [GpioDriver for other boards](Gpio/README.md)
 * [MotorHat](MotorHat/README.md)
 * [Pca9685 - I2C PWM Driver](Pca9685/README.md)
 * [Software PWM](SoftPwm/README.md)
 * [Software SPI](SoftwareSpi/README.md)
+* [SPI, GPIO and I2C drivers for Arduino with Firmata](Arduino/README.md)
 * [SPI, GPIO and I2C drivers for FT4222](Ft4222/README.md)
+* [System.Device.Model - attributes for device bindings](System.Device.Model/README.md)
 
 ### Power monitors and related devices
 

diff --git a/src/devices/SensorHub/category.txt b/src/devices/SensorHub/category.txt
@@ -0,0 +1,5 @@
+thermometer
+barometer
+hygrometer
+light
+multi
diff --git a/src/devices/System.Device.Model/category.txt b/src/devices/System.Device.Model/category.txt
@@ -0,0 +1 @@
+protocol
diff --git a/src/devices/Tlc1543/README.md b/src/devices/Tlc1543/README.md
@@ -1,4 +1,4 @@
-# Tlc1543
+# TLC1543 - 10-bit ADC with 11 input channels
 
 ## Summary
 

diff --git a/src/devices/Tlc1543/category.txt b/src/devices/Tlc1543/category.txt
@@ -0,0 +1 @@
+adc
diff --git a/tools/device-listing/Program.cs b/tools/device-listing/Program.cs
@@ -12,6 +12,7 @@
 string[] categoriesToDisplay = new string[]
 {
     "adc",
+    "dac",
     "accelerometer",
     "gas",
     "liquid",
@@ -53,6 +54,7 @@
 Dictionary<string, string?> categoriesDescriptions = new()
 {
     { "adc", "Analog/Digital converters" },
+    { "dac", "Digital/Analog converters" },
     { "accelerometer", "Accelerometers" },
     { "voc", "Volatile Organic Compound sensors" },
     { "gas", "Gas sensors" },
@@ -95,6 +97,8 @@
     { "gpio", "GPIO or bit operating devices" },
     { "power", "Power monitors and related devices" },
     { "multi", "Multi-device or robot kit" },
+    { "lidar", "LIDAR Time of Flight devices" },
+    { "thermocouple", "Thermocouple devices" },
     // Bucket for stuff we want mentioned but there is no clear category
     // In other words: anything allowing a way to create PWM channel, SPI/I2C/... device
     { "protocol", "Protocols providers/libraries" },