diff --git a/FAQ.md b/FAQ.md index fb630be7..a037f81f 100644 --- a/FAQ.md +++ b/FAQ.md @@ -143,7 +143,7 @@ after enabling this option all i2c device drivers will become non-thread safe. ## Porting I2C libs to I2Cdev -See [porting.md](docs/porting.md). +See [Porting.md](Porting.md). ## My DHT sensor doesn't work well/doesn't work at all! diff --git a/Metadata.md b/Metadata.md index cc947994..fc5cfc6e 100644 --- a/Metadata.md +++ b/Metadata.md @@ -84,13 +84,13 @@ foo: trombik A `Person` represents a person. `Person` is used to describe a copyrights holder and a code owner. A `Person` must be defined in `persons.yml` file. -| Name | Type | Description | Required | -|-------------|------|-------------|----------| -| `name` | `String` | A unique ID string of the person. Use GitHub account or GitHub project if the person has one | Yes | -| `full_name` | `String` | Full name of the person or the project | No | -| `gh_id` | `String` | GitHub account name or project name | No | -| `email` | `String` | Email address of the person | No | -| `url` | `String` | Web site URL | No | +| Name | Type | Description | Required | +|-------------|----------|----------------------------------------------------------------------------------------------|----------| +| `name` | `String` | A unique ID string of the person. Use GitHub account or GitHub project if the person has one | Yes | +| `full_name` | `String` | Full name of the person or the project | No | +| `gh_id` | `String` | GitHub account name or project name | No | +| `email` | `String` | Email address of the person | No | +| `url` | `String` | Web site URL | No | When any of `gh_id`, `email`, or `website` is not available, `person` must have a full name because it is used to identify the source of code. @@ -119,9 +119,9 @@ full_name: Foo `bar` buz ### Target -| Name | Type | Description | Required | -|------|------|-------------|----------| -| `name` | `String` | Name of the build target in `esp-idf`, or `esp8266`. | Yes | +| Name | Type | Description | Required | +|--------|----------|------------------------------------------------------|----------| +| `name` | `String` | Name of the build target in `esp-idf`, or `esp8266`. | Yes | An example: @@ -131,9 +131,9 @@ name: esp32 ### License -| Name | Type | Description | Required | -|------|------|-------------|----------| -| `name` | `String` | SPDX License Identifier (see [the list of licenses](https://spdx.org/licenses/)) | Yes | +| Name | Type | Description | Required | +|--------|----------|----------------------------------------------------------------------------------|----------| +| `name` | `String` | SPDX License Identifier (see [the list of licenses](https://spdx.org/licenses/)) | Yes | An example: @@ -143,11 +143,11 @@ name: BSD-3 ### Copyright -| Name | Type | Description | Required | -|------|------|-------------|----------| -| `author` | `Person` | Copyrights holder. See also `Person`. | No | -| `name` | `String` | The value of `name` of `Person`. A shorthand for `author` | No | -| `year` | `Integer` | Registration year of the copyrights | Yes | +| Name | Type | Description | Required | +|----------|-----------|-----------------------------------------------------------|----------| +| `author` | `Person` | Copyrights holder. See also `Person`. | No | +| `name` | `String` | The value of `name` of `Person`. A shorthand for `author` | No | +| `year` | `Integer` | Registration year of the copyrights | Yes | `Copyright` must have only one of `author` and `name`, not both. @@ -171,10 +171,10 @@ year: 2021 A `Group` represents a group of `Component`s. A `Group` must be in `groups.yml`. -| Name | Type | Description | Required | -|------|------|-------------|----------| -| `name` | `String` | A unique ID of the group | Yes | -| `description` | `String` | Description of the group | Yes | +| Name | Type | Description | Required | +|---------------|----------|--------------------------|----------| +| `name` | `String` | A unique ID of the group | Yes | +| `description` | `String` | Description of the group | Yes | `name` should be short, and memorable. Use `-` as a word separator. It must not include spaces (`[0-9a-zA-Z-]+` in regular expression). @@ -202,30 +202,27 @@ components: ### Component -| Name | Type | Description | Required | -|------|------|-----------------------------------------------------------|----------| -| `name` | `String` | The name of the component. Must be unique. | Yes | -| `description` | `String` | A short description of the component. | Yes | -| `group` | `Group` | The primary group name of the component. | Yes | -| `groups` | A list of `Group` | A list of zero or more of `Group` | No | -| `code_owners` | A list of `Person` | A list of one or more of `Person` | Yes | -| `depends` | A list of `Component` | Zero or more of `component` that the component depends on | No | -| `thread_safe` | `Strnig` | One of `yes`, `no`, and `N/A` | Yes | -| `targets` | A list of `Target` | One or more of supported `target` | Yes | -| `license` | `License` | License used in the component | Yes | -| `copyrights` | A list of `Copyright` | One or more of copyright holder | Yes | +| Name | Type | Description | Required | +|---------------|-----------------------|-----------------------------------------------------------|----------| +| `name` | `String` | The name of the component. Must be unique. | Yes | +| `description` | `String` | A short description of the component. | Yes | +| `version` | `String` | Component version. | Yes | +| `groups` | A list of `Group` | A list of one or more of `Group` | No | +| `code_owners` | A list of `Person` | A list of one or more of `Person` | Yes | +| `depends` | A list of `Component` | Zero or more of `component` that the component depends on | No | +| `thread_safe` | `Strnig` | One of `yes`, `no`, and `N/A` | Yes | +| `targets` | A list of `Target` | One or more of supported `target` | Yes | +| `license` | `License` | License used in the component | Yes | +| `copyrights` | A list of `Copyright` | One or more of copyright holder | Yes | FIXME `depends` must be a list because some drivers have conditional `REQUIRES` in `CMakeLists.txt`. ## Usages of metadata in the project -The current implementation uses `ruby` and `rspec` ruby gem to validate -metadata in all components, and generate `README.md`. - Requirements are: -* `python` >=3.11 +* `python` >=3.10 After installing requirements, run: @@ -238,17 +235,17 @@ pip install -r devtool/requirements.txt To validate metadata, run: ```console -./devtools/devtool.py --repo=. check +python ./devtools/devtool.py check ``` ### Generating `README.md` -`README.md` is generated from the metadata and `README.md.erb`. To update +`README.md` is generated from the metadata and `devtools/devtools/template/README.md`. To update `README.md`, run the following command at the repository root directory: ```console -bundle exec rake -C devtools readme > README.md +python ./devtools/devtool.py render ``` ## Known issues diff --git a/README.md b/README.md index 9b619782..0400f1d0 100644 --- a/README.md +++ b/README.md @@ -86,12 +86,12 @@ or [GitLab examples](https://gitlab.com/UncleRus/esp-idf-lib/tree/master/example | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **ads111x** | Driver for ADS1113/ADS1114/ADS1115 and ADS1013/ADS1014/ADS1015 I2C ADC | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **ads111x** | Driver for ADS1113/ADS1114/ADS1115 and ADS1013/ADS1014/ADS1015 I2C ADC | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **ads130e08** | Driver for ADS130E08 ADC | MIT | esp32, esp32s3 | yes | -| **hx711** | Driver for HX711 24-bit ADC for weigh scales | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | no | -| **mcp342x** | Driver for 18-Bit, delta-sigma ADC MCP3426/MCP3427/MCP3428 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **mcp4725** | Driver for 12-bit DAC MCP4725 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **pcf8591** | Driver for 8-bit ADC and an 8-bit DAC PCF8591 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **hx711** | Driver for HX711 24-bit ADC for weigh scales | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | no | +| **mcp342x** | Driver for 18-Bit, delta-sigma ADC MCP3426/MCP3427/MCP3428 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **mcp4725** | Driver for 12-bit DAC MCP4725 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **pcf8591** | Driver for 8-bit ADC and an 8-bit DAC PCF8591 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **sgm58031** | Driver for SGM58031 16-bit I2C ADC | ISC | esp32, esp8266, esp32s2, esp32s3, esp32c3 | yes | @@ -99,11 +99,11 @@ or [GitLab examples](https://gitlab.com/UncleRus/esp-idf-lib/tree/master/example | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **ccs811** | Driver for AMS CCS811 digital gas sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **mhz19b** | Driver for MH-Z19B NDIR CO₂ sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | no | -| **scd30** | Driver for SCD30 CO₂ sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **scd4x** | Driver for SCD40/SCD41 miniature CO₂ sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **sgp40** | Driver for SGP40 Indoor Air Quality Sensor for VOC Measurements | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **ccs811** | Driver for AMS CCS811 digital gas sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **mhz19b** | Driver for MH-Z19B NDIR CO₂ sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | no | +| **scd30** | Driver for SCD30 CO₂ sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **scd4x** | Driver for SCD40/SCD41 miniature CO₂ sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **sgp40** | Driver for SGP40 Indoor Air Quality Sensor for VOC Measurements | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | ### Battery controllers @@ -111,14 +111,14 @@ or [GitLab examples](https://gitlab.com/UncleRus/esp-idf-lib/tree/master/example | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| | **lc709203f** | Driver for LC709203F battery fuel gauge | ISC | esp32, esp8266, esp32s2, esp32c3 | yes | -| **max1704x** | Driver for MAX17043/MAX17044/MAX17048/MAX17049 battery fuel gauge | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **max1704x** | Driver for MAX17043/MAX17044/MAX17048/MAX17049 battery fuel gauge | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | ### Common libraries | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **calibration** | Multi-point calibration library | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | n/a | +| **calibration** | Multi-point calibration library | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | n/a | | **color** | Common library for RGB and HSV colors | MIT | esp32, esp8266, esp32s2, esp32c3 | n/a | | **esp_idf_lib_helpers** | Common support library for esp-idf-lib | ISC | esp32, esp8266, esp32s2, esp32c3 | n/a | | **framebuffer** | RGB framebuffer component | MIT | esp32, esp32s2, esp32c3 | n/a | @@ -132,8 +132,8 @@ or [GitLab examples](https://gitlab.com/UncleRus/esp-idf-lib/tree/master/example | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **ina219** | Driver for INA219/INA220 bidirectional current/power monitor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **ina260** | Driver for INA260 precision digital current and power monitor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **ina219** | Driver for INA219/INA220 bidirectional current/power monitor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **ina260** | Driver for INA260 precision digital current and power monitor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **ina3221** | Driver for INA3221 shunt and bus voltage monitor | MIT | esp32, esp8266, esp32s2, esp32c3 | yes | @@ -141,37 +141,37 @@ or [GitLab examples](https://gitlab.com/UncleRus/esp-idf-lib/tree/master/example | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **ccs811** | Driver for AMS CCS811 digital gas sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **mhz19b** | Driver for MH-Z19B NDIR CO₂ sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | no | -| **scd30** | Driver for SCD30 CO₂ sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **scd4x** | Driver for SCD40/SCD41 miniature CO₂ sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **ccs811** | Driver for AMS CCS811 digital gas sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **mhz19b** | Driver for MH-Z19B NDIR CO₂ sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | no | +| **scd30** | Driver for SCD30 CO₂ sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **scd4x** | Driver for SCD40/SCD41 miniature CO₂ sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | ### GPIO expanders | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **mcp23008** | Driver for 8-bit I2C GPIO expander MCP23008 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **mcp23x17** | Driver for I2C/SPI 16 bit GPIO expanders MCP23017/MCP23S17 | BSD-3 | esp32, esp32s2, esp32c3 | yes | -| **pca9557** | Driver for PCA9537/PCA9557/TCA9534 remote 4/8-bit I/O expanders for I2C-bus | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **mcp23008** | Driver for 8-bit I2C GPIO expander MCP23008 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **mcp23x17** | Driver for I2C/SPI 16 bit GPIO expanders MCP23017/MCP23S17 | BSD-3-Clause | esp32, esp32s2, esp32c3 | yes | +| **pca9557** | Driver for PCA9537/PCA9557/TCA9534 remote 4/8-bit I/O expanders for I2C-bus | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **pcf8574** | Driver for PCF8574 remote 8-bit I/O expander for I2C-bus | MIT | esp32, esp8266, esp32s2, esp32c3 | yes | | **pcf8575** | Driver for PCF8575 remote 16-bit I/O expander for I2C-bus | MIT | esp32, esp8266, esp32s2, esp32c3 | yes | -| **tca95x5** | Driver for TCA9535/TCA9555 remote 16-bit I/O expanders for I2C-bus | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **tca95x5** | Driver for TCA9535/TCA9555 remote 16-bit I/O expanders for I2C-bus | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | ### Humidity sensors | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **aht** | Driver for AHT10/AHT15/AHT20 temperature and humidity sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **am2320** | Driver for AM2320 temperature and humidity sensor (I2C) | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **bme680** | Driver for BME680 digital environmental sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **dht** | Driver for DHT11, AM2301 (DHT21, DHT22, AM2302, AM2321), Itead Si7021 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | no | -| **hdc1000** | Driver for HDC1000 temperature and humidity sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **aht** | Driver for AHT10/AHT15/AHT20 temperature and humidity sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **am2320** | Driver for AM2320 temperature and humidity sensor (I2C) | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **bme680** | Driver for BME680 digital environmental sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **dht** | Driver for DHT11, AM2301 (DHT21, DHT22, AM2302, AM2321), Itead Si7021 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | no | +| **hdc1000** | Driver for HDC1000 temperature and humidity sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **hts221** | Driver for HTS221 temperature and humidity sensor | ISC | esp32, esp32s2, esp32c3 | yes | -| **sht3x** | Driver for Sensirion SHT30/SHT31/SHT35 digital temperature and humidity sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **sht4x** | Driver for Sensirion SHT40/SHT41/SHT45 digital temperature and humidity sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **si7021** | Driver for Si7013/Si7020/Si7021/HTU2xD/SHT2x and compatible temperature and humidity sensors | BSD-3 | esp32, esp32c3, esp8266, esp32s2, esp32c3 | yes | +| **sht3x** | Driver for Sensirion SHT30/SHT31/SHT35 digital temperature and humidity sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **sht4x** | Driver for Sensirion SHT40/SHT41/SHT45 digital temperature and humidity sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **si7021** | Driver for Si7013/Si7020/Si7021/HTU2xD/SHT2x and compatible temperature and humidity sensors | BSD-3-Clause | esp32, esp32c3, esp8266, esp32s2, esp32c3 | yes | ### Inertial measurement units @@ -187,7 +187,7 @@ or [GitLab examples](https://gitlab.com/UncleRus/esp-idf-lib/tree/master/example | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| | **button** | HW timer-based driver for GPIO buttons | MIT | esp32, esp8266, esp32s2, esp32c3 | yes | -| **encoder** | HW timer-based driver for incremental rotary encoders | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **encoder** | HW timer-based driver for incremental rotary encoders | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **ls7366r** | Driver for LS7366R Quadrature Encoder Counter | MIT | esp32, esp32s2, esp32c3 | yes | @@ -198,17 +198,17 @@ or [GitLab examples](https://gitlab.com/UncleRus/esp-idf-lib/tree/master/example | **ht16k33** | HT16K33 LED controller driver | MIT | esp32, esp8266, esp32s2, esp32c3 | yes | | **led_strip** | RMT-based driver for WS2812B/SK6812/APA106/SM16703 LED strips | MIT | esp32, esp32s2, esp32c3 | yes | | **led_strip_spi** | SPI-based driver for SK9822/APA102 LED strips | MIT | esp32, esp32c3, esp8266, esp32s2, esp32c3 | yes | -| **max7219** | Driver for 8-Digit LED display drivers, MAX7219/MAX7221 | BSD-3 | esp32, esp32s2, esp32c3 | yes | +| **max7219** | Driver for 8-Digit LED display drivers, MAX7219/MAX7221 | BSD-3-Clause | esp32, esp32s2, esp32c3 | yes | ### Light sensors | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **bh1750** | Driver for BH1750 light sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **tsl2561** | Driver for light-to-digital converter TSL2561 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **bh1750** | Driver for BH1750 light sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **tsl2561** | Driver for light-to-digital converter TSL2561 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **tsl2591** | Driver for light-to-digital converter TSL2591 | MIT | esp32, esp8266, esp32s2, esp32c3 | yes | -| **tsl4531** | Driver for digital ambient light sensor TSL4531 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **tsl4531** | Driver for digital ambient light sensor TSL4531 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **veml7700** | Driver for VEML7700 ambient light sensor | ISC | esp32, esp8266, esp32s2, esp32c3 | yes | @@ -216,74 +216,74 @@ or [GitLab examples](https://gitlab.com/UncleRus/esp-idf-lib/tree/master/example | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **hmc5883l** | Driver for 3-axis digital compass HMC5883L and HMC5983L | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **qmc5883l** | Driver for QMC5883L 3-axis magnetic sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **hmc5883l** | Driver for 3-axis digital compass HMC5883L and HMC5983L | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **qmc5883l** | Driver for QMC5883L 3-axis magnetic sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | ### Other misc libraries | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **ds3502** | Driver for nonvolatile digital potentiometer DS3502 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **ds3502** | Driver for nonvolatile digital potentiometer DS3502 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **example** | An example component | ISC | esp32, esp8266, esp32s2, esp32c3 | n/a | -| **hd44780** | Driver for HD44780 compatible LCD text displays | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | no | -| **pca9685** | Driver for 16-channel, 12-bit PWM PCA9685 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **rda5807m** | Driver for single-chip broadcast FM radio tuner RDA5807M | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **tca9548** | Driver for TCA9548A/PCA9548A low-voltage 8-channel I2C switch | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **hd44780** | Driver for HD44780 compatible LCD text displays | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | no | +| **pca9685** | Driver for 16-channel, 12-bit PWM PCA9685 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **rda5807m** | Driver for single-chip broadcast FM radio tuner RDA5807M | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **tca9548** | Driver for TCA9548A/PCA9548A low-voltage 8-channel I2C switch | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **tda74xx** | Driver for TDA7439/TDA7439DS/TDA7440D audioprocessors | MIT | esp32, esp8266, esp32s2, esp32c3 | yes | -| **ultrasonic** | Driver for ultrasonic range meters, e.g. HC-SR04, HY-SRF05 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | no | -| **wiegand** | Wiegand protocol receiver | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | no | +| **ultrasonic** | Driver for ultrasonic range meters, e.g. HC-SR04, HY-SRF05 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | no | +| **wiegand** | Wiegand protocol receiver | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | no | ### Pressure sensors | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **bme680** | Driver for BME680 digital environmental sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **bme680** | Driver for BME680 digital environmental sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **bmp180** | Driver for BMP180 digital pressure sensor | MIT | esp32, esp8266, esp32s2, esp32c3 | yes | | **bmp280** | Driver for BMP280/BME280 digital pressure sensor | MIT | esp32, esp8266, esp32s2, esp32c3 | yes | | **dps310** | Driver for DPS310 barometric pressure sensor | ISC | esp32, esp8266, esp32s2, esp32c3 | yes | -| **ms5611** | Driver for barometic pressure sensor MS5611-01BA03 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **ms5611** | Driver for barometic pressure sensor MS5611-01BA03 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | ### Real-time clocks | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **ds1302** | Driver for DS1302 RTC module | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | no | -| **ds1307** | Driver for DS1307 RTC module | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **ds1302** | Driver for DS1302 RTC module | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | no | +| **ds1307** | Driver for DS1307 RTC module | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **ds3231** | Driver for DS1337 RTC and DS3231 high precision RTC module | MIT | esp32, esp8266, esp32s2, esp32c3 | yes | -| **pcf8563** | Driver for PCF8563 real-time clock/calendar | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **pcf8563** | Driver for PCF8563 real-time clock/calendar | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | ### Temperature sensors | Component | Description | License | Supported on | Thread safety | |--------------------------|----------------------------------------------------------------------------------|---------|--------------------|---------------| -| **aht** | Driver for AHT10/AHT15/AHT20 temperature and humidity sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **am2320** | Driver for AM2320 temperature and humidity sensor (I2C) | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **bh1900nux** | Driver for BH1900NUX temperature sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **bme680** | Driver for BME680 digital environmental sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **aht** | Driver for AHT10/AHT15/AHT20 temperature and humidity sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **am2320** | Driver for AM2320 temperature and humidity sensor (I2C) | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **bh1900nux** | Driver for BH1900NUX temperature sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **bme680** | Driver for BME680 digital environmental sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **bmp180** | Driver for BMP180 digital pressure sensor | MIT | esp32, esp8266, esp32s2, esp32c3 | yes | | **bmp280** | Driver for BMP280/BME280 digital pressure sensor | MIT | esp32, esp8266, esp32s2, esp32c3 | yes | -| **dht** | Driver for DHT11, AM2301 (DHT21, DHT22, AM2302, AM2321), Itead Si7021 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | no | +| **dht** | Driver for DHT11, AM2301 (DHT21, DHT22, AM2302, AM2321), Itead Si7021 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | no | | **dps310** | Driver for DPS310 barometric pressure sensor | ISC | esp32, esp8266, esp32s2, esp32c3 | yes | -| **ds18x20** | Driver for DS18B20/DS18S20 families of 1-Wire temperature sensor ICs | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | no | -| **hdc1000** | Driver for HDC1000 temperature and humidity sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **ds18x20** | Driver for DS18B20/DS18S20 families of 1-Wire temperature sensor ICs | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | no | +| **hdc1000** | Driver for HDC1000 temperature and humidity sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | | **hts221** | Driver for HTS221 temperature and humidity sensor | ISC | esp32, esp32s2, esp32c3 | yes | | **lm75** | Driver for LM75, a digital temperature sensor and thermal watchdog | ISC | esp32, esp8266, esp32s2, esp32c3 | yes | -| **max31725** | Driver for MAX31725/MAX31726 temperature sensors | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **max31855** | Driver for MAX31855 cold-junction compensated thermocouple-to-digital converter | BSD-3 | esp32, esp32s2, esp32c3 | yes | -| **max31865** | Driver for MAX31865 resistance converter for platinum RTDs | BSD-3 | esp32, esp32s2, esp32c3 | yes | -| **mcp960x** | Driver for MCP9600/MCP9601, thermocouple EMF to temperature converter | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **mcp9808** | Driver for MCP9808 Digital Temperature Sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **ms5611** | Driver for barometic pressure sensor MS5611-01BA03 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **sht3x** | Driver for Sensirion SHT30/SHT31/SHT35 digital temperature and humidity sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **sht4x** | Driver for Sensirion SHT40/SHT41/SHT45 digital temperature and humidity sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **si7021** | Driver for Si7013/Si7020/Si7021/HTU2xD/SHT2x and compatible temperature and humidity sensors | BSD-3 | esp32, esp32c3, esp8266, esp32s2, esp32c3 | yes | -| **sts21** | Driver for STS21 temperature sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **sts3x** | Driver for Sensirion STS30/STS31/STS35 digital temperature sensor | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | -| **tsys01** | Driver for precision digital temperature sensor TSYS01 | BSD-3 | esp32, esp8266, esp32s2, esp32c3 | yes | +| **max31725** | Driver for MAX31725/MAX31726 temperature sensors | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **max31855** | Driver for MAX31855 cold-junction compensated thermocouple-to-digital converter | BSD-3-Clause | esp32, esp32s2, esp32c3 | yes | +| **max31865** | Driver for MAX31865 resistance converter for platinum RTDs | BSD-3-Clause | esp32, esp32s2, esp32c3 | yes | +| **mcp960x** | Driver for MCP9600/MCP9601, thermocouple EMF to temperature converter | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **mcp9808** | Driver for MCP9808 digital temperature sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **ms5611** | Driver for barometic pressure sensor MS5611-01BA03 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **sht3x** | Driver for Sensirion SHT30/SHT31/SHT35 digital temperature and humidity sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **sht4x** | Driver for Sensirion SHT40/SHT41/SHT45 digital temperature and humidity sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **si7021** | Driver for Si7013/Si7020/Si7021/HTU2xD/SHT2x and compatible temperature and humidity sensors | BSD-3-Clause | esp32, esp32c3, esp8266, esp32s2, esp32c3 | yes | +| **sts21** | Driver for STS21 temperature sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **sts3x** | Driver for Sensirion STS30/STS31/STS35 digital temperature sensor | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | +| **tsys01** | Driver for precision digital temperature sensor TSYS01 | BSD-3-Clause | esp32, esp8266, esp32s2, esp32c3 | yes | ## Library maintainers diff --git a/components/ads111x/.eil.yml b/components/ads111x/.eil.yml index c43c3038..17160688 100644 --- a/components/ads111x/.eil.yml +++ b/components/ads111x/.eil.yml @@ -1,5 +1,6 @@ name: ads111x description: Driver for ADS1113/ADS1114/ADS1115 and ADS1013/ADS1014/ADS1015 I2C ADC +version: 1.1.2 groups: - adc-dac code_owners: UncleRus diff --git a/components/ads111x/ads111x.h b/components/ads111x/ads111x.h index 726d44c5..23902d36 100644 --- a/components/ads111x/ads111x.h +++ b/components/ads111x/ads111x.h @@ -33,6 +33,8 @@ * * ESP-IDF driver for ADS1113/ADS1114/ADS1115, ADS1013/ADS1014/ADS1015 I2C ADC * + * Version: 1.1.2 + * * Ported from esp-open-rtos * * Copyright (c) 2016, 2018 Ruslan V. Uss diff --git a/components/ads130e08/.eil.yml b/components/ads130e08/.eil.yml index 01a6c651..72ae391e 100644 --- a/components/ads130e08/.eil.yml +++ b/components/ads130e08/.eil.yml @@ -1,5 +1,6 @@ name: ads130e08 description: Driver for ADS130E08 ADC +version: 1.0.0 groups: - adc-dac code_owners: weslleymfd diff --git a/components/aht/.eil.yml b/components/aht/.eil.yml index 954a09b5..af3718f0 100644 --- a/components/aht/.eil.yml +++ b/components/aht/.eil.yml @@ -1,5 +1,6 @@ name: aht description: Driver for AHT10/AHT15/AHT20 temperature and humidity sensor +version: 1.0.0 groups: - temperature - humidity diff --git a/components/am2320/.eil.yml b/components/am2320/.eil.yml index 08b70c00..2cc311ff 100644 --- a/components/am2320/.eil.yml +++ b/components/am2320/.eil.yml @@ -1,5 +1,6 @@ name: am2320 description: Driver for AM2320 temperature and humidity sensor (I2C) +version: 1.0.0 groups: - temperature - humidity diff --git a/components/bh1750/.eil.yml b/components/bh1750/.eil.yml index 3e4b6934..912c3661 100644 --- a/components/bh1750/.eil.yml +++ b/components/bh1750/.eil.yml @@ -1,5 +1,6 @@ name: bh1750 description: Driver for BH1750 light sensor +version: 1.1.0 groups: - light code_owners: diff --git a/components/bh1900nux/.eil.yml b/components/bh1900nux/.eil.yml index 13f2599b..b8a783d1 100644 --- a/components/bh1900nux/.eil.yml +++ b/components/bh1900nux/.eil.yml @@ -1,5 +1,6 @@ name: bh1900nux description: Driver for BH1900NUX temperature sensor +version: 1.0.0 groups: - temperature code_owners: UncleRus diff --git a/components/bme680/.eil.yml b/components/bme680/.eil.yml index d234f958..7134374d 100644 --- a/components/bme680/.eil.yml +++ b/components/bme680/.eil.yml @@ -1,5 +1,6 @@ name: bme680 description: Driver for BME680 digital environmental sensor +version: 1.0.0 groups: - pressure - humidity diff --git a/components/bmp180/.eil.yml b/components/bmp180/.eil.yml index 0bc595a0..0fe95249 100644 --- a/components/bmp180/.eil.yml +++ b/components/bmp180/.eil.yml @@ -1,5 +1,6 @@ name: bmp180 description: Driver for BMP180 digital pressure sensor +version: 1.0.0 groups: - pressure - temperature diff --git a/components/bmp280/.eil.yml b/components/bmp280/.eil.yml index c6438620..e8c48cda 100644 --- a/components/bmp280/.eil.yml +++ b/components/bmp280/.eil.yml @@ -1,5 +1,6 @@ name: bmp280 description: Driver for BMP280/BME280 digital pressure sensor +version: 1.0.0 groups: - pressure - temperature diff --git a/components/button/.eil.yml b/components/button/.eil.yml index 88d30428..20093e1c 100644 --- a/components/button/.eil.yml +++ b/components/button/.eil.yml @@ -1,5 +1,6 @@ name: button description: HW timer-based driver for GPIO buttons +version: 1.0.0 groups: - input code_owners: diff --git a/components/calibration/.eil.yml b/components/calibration/.eil.yml index c62402d3..844b220f 100644 --- a/components/calibration/.eil.yml +++ b/components/calibration/.eil.yml @@ -1,5 +1,6 @@ name: calibration description: Multi-point calibration library +version: 0.1.0 groups: - common code_owners: diff --git a/components/ccs811/.eil.yml b/components/ccs811/.eil.yml index beaa3eee..8b5f51c8 100644 --- a/components/ccs811/.eil.yml +++ b/components/ccs811/.eil.yml @@ -1,5 +1,6 @@ name: ccs811 description: Driver for AMS CCS811 digital gas sensor +version: 1.0.0 groups: - air-quality - gas diff --git a/components/color/.eil.yml b/components/color/.eil.yml index d94561be..0c8c9c97 100644 --- a/components/color/.eil.yml +++ b/components/color/.eil.yml @@ -1,5 +1,6 @@ name: color description: Common library for RGB and HSV colors +version: 1.0.0 groups: - common code_owners: diff --git a/components/dht/.eil.yml b/components/dht/.eil.yml index 4f8849ad..b3ad95e8 100644 --- a/components/dht/.eil.yml +++ b/components/dht/.eil.yml @@ -1,5 +1,6 @@ name: dht description: Driver for DHT11, AM2301 (DHT21, DHT22, AM2302, AM2321), Itead Si7021 +version: 1.1.0 groups: - humidity - temperature diff --git a/components/dps310/.eil.yml b/components/dps310/.eil.yml index 3189b0f4..62f21ef7 100644 --- a/components/dps310/.eil.yml +++ b/components/dps310/.eil.yml @@ -1,5 +1,6 @@ name: dps310 description: Driver for DPS310 barometric pressure sensor +version: 1.0.0 groups: - pressure - temperature diff --git a/components/ds1302/.eil.yml b/components/ds1302/.eil.yml index 33224a0b..9a30e19c 100644 --- a/components/ds1302/.eil.yml +++ b/components/ds1302/.eil.yml @@ -1,5 +1,6 @@ name: ds1302 description: Driver for DS1302 RTC module +version: 1.1.0 groups: - rtc code_owners: diff --git a/components/ds1307/.eil.yml b/components/ds1307/.eil.yml index a2878f80..54778e53 100644 --- a/components/ds1307/.eil.yml +++ b/components/ds1307/.eil.yml @@ -1,5 +1,6 @@ name: ds1307 description: Driver for DS1307 RTC module +version: 1.0.1 groups: - rtc code_owners: diff --git a/components/ds18x20/.eil.yml b/components/ds18x20/.eil.yml index 7151e55b..9c089404 100644 --- a/components/ds18x20/.eil.yml +++ b/components/ds18x20/.eil.yml @@ -1,5 +1,6 @@ name: ds18x20 description: Driver for DS18B20/DS18S20 families of 1-Wire temperature sensor ICs +version: 1.2.0 groups: - temperature code_owners: diff --git a/components/ds3231/.eil.yml b/components/ds3231/.eil.yml index 6d20e250..9393a6fa 100644 --- a/components/ds3231/.eil.yml +++ b/components/ds3231/.eil.yml @@ -1,5 +1,6 @@ name: ds3231 description: Driver for DS1337 RTC and DS3231 high precision RTC module +version: 1.1.0 groups: - rtc code_owners: diff --git a/components/ds3502/.eil.yml b/components/ds3502/.eil.yml index 105cf3e7..69605694 100644 --- a/components/ds3502/.eil.yml +++ b/components/ds3502/.eil.yml @@ -1,5 +1,6 @@ name: ds3502 description: Driver for nonvolatile digital potentiometer DS3502 +version: 1.0.0 groups: - misc code_owners: diff --git a/components/encoder/.eil.yml b/components/encoder/.eil.yml index 08b2c08e..d741eb2d 100644 --- a/components/encoder/.eil.yml +++ b/components/encoder/.eil.yml @@ -1,6 +1,6 @@ name: encoder -description: | - HW timer-based driver for incremental rotary encoders +description: HW timer-based driver for incremental rotary encoders +version: 1.0.0 groups: - input code_owners: diff --git a/components/esp_idf_lib_helpers/.eil.yml b/components/esp_idf_lib_helpers/.eil.yml index e0e1ec80..eb4f9e0d 100644 --- a/components/esp_idf_lib_helpers/.eil.yml +++ b/components/esp_idf_lib_helpers/.eil.yml @@ -1,6 +1,6 @@ name: esp_idf_lib_helpers -description: | - Common support library for esp-idf-lib +description: Common support library for esp-idf-lib +version: 1.2.0 groups: - common code_owners: diff --git a/components/example/.eil.yml b/components/example/.eil.yml index 1557e452..a83433fa 100644 --- a/components/example/.eil.yml +++ b/components/example/.eil.yml @@ -1,5 +1,6 @@ name: example description: An example component +version: 0.0.1 groups: - misc code_owners: trombik diff --git a/components/framebuffer/.eil.yml b/components/framebuffer/.eil.yml index f869c156..87915ba5 100644 --- a/components/framebuffer/.eil.yml +++ b/components/framebuffer/.eil.yml @@ -1,5 +1,6 @@ name: framebuffer description: RGB framebuffer component +version: 0.0.1 groups: - common code_owners: UncleRus diff --git a/components/hd44780/.eil.yml b/components/hd44780/.eil.yml index 3a1ff7e3..ac0ac973 100644 --- a/components/hd44780/.eil.yml +++ b/components/hd44780/.eil.yml @@ -1,6 +1,6 @@ name: hd44780 -description: | - Driver for HD44780 compatible LCD text displays +description: Driver for HD44780 compatible LCD text displays +version: 1.2.0 groups: - misc code_owners: diff --git a/components/hdc1000/.eil.yml b/components/hdc1000/.eil.yml index 189f539a..b0f88c49 100644 --- a/components/hdc1000/.eil.yml +++ b/components/hdc1000/.eil.yml @@ -1,6 +1,6 @@ name: hdc1000 -description: | - Driver for HDC1000 temperature and humidity sensor +description: Driver for HDC1000 temperature and humidity sensor +version: 1.0.0 groups: - temperature - humidity diff --git a/components/hmc5883l/.eil.yml b/components/hmc5883l/.eil.yml index f2e105dc..6f85b124 100644 --- a/components/hmc5883l/.eil.yml +++ b/components/hmc5883l/.eil.yml @@ -1,6 +1,6 @@ name: hmc5883l -description: | - Driver for 3-axis digital compass HMC5883L and HMC5983L +description: Driver for 3-axis digital compass HMC5883L and HMC5983L +version: 1.0.0 groups: - magnetic code_owners: diff --git a/components/ht16k33/.eil.yml b/components/ht16k33/.eil.yml index a857b025..4ed1438f 100644 --- a/components/ht16k33/.eil.yml +++ b/components/ht16k33/.eil.yml @@ -1,5 +1,6 @@ name: ht16k33 description: HT16K33 LED controller driver +version: 1.0.0 groups: - led code_owners: chudsaviet diff --git a/components/hts221/.eil.yml b/components/hts221/.eil.yml index 5beaaae6..2c4fdf95 100644 --- a/components/hts221/.eil.yml +++ b/components/hts221/.eil.yml @@ -1,6 +1,6 @@ name: hts221 -description: | - Driver for HTS221 temperature and humidity sensor. +description: Driver for HTS221 temperature and humidity sensor +version: 1.0.0 groups: - temperature - humidity diff --git a/components/hx711/.eil.yml b/components/hx711/.eil.yml index f823dc62..e70ae64b 100644 --- a/components/hx711/.eil.yml +++ b/components/hx711/.eil.yml @@ -1,6 +1,6 @@ name: hx711 -description: | - Driver for HX711 24-bit ADC for weigh scales +description: Driver for HX711 24-bit ADC for weigh scales +version: 1.0.0 groups: - adc-dac code_owners: diff --git a/components/i2cdev/.eil.yml b/components/i2cdev/.eil.yml index 460d7a01..10c8abb6 100644 --- a/components/i2cdev/.eil.yml +++ b/components/i2cdev/.eil.yml @@ -1,5 +1,6 @@ name: i2cdev description: ESP-IDF I2C master thread-safe utilities +version: 1.5.0 groups: - common code_owners: diff --git a/components/icm42670/.eil.yml b/components/icm42670/.eil.yml index e76bd0ea..008cd962 100644 --- a/components/icm42670/.eil.yml +++ b/components/icm42670/.eil.yml @@ -1,5 +1,6 @@ name: icm42670 description: Driver for TDK ICM-42670-P 6-Axis IMU +version: 1.0.0 groups: - imu code_owners: janveeh diff --git a/components/ina219/.eil.yml b/components/ina219/.eil.yml index 4ed153fa..cb1f422c 100644 --- a/components/ina219/.eil.yml +++ b/components/ina219/.eil.yml @@ -1,5 +1,6 @@ name: ina219 description: Driver for INA219/INA220 bidirectional current/power monitor +version: 1.0.0 groups: - current code_owners: UncleRus diff --git a/components/ina260/.eil.yml b/components/ina260/.eil.yml index 93a7b27f..4681511b 100644 --- a/components/ina260/.eil.yml +++ b/components/ina260/.eil.yml @@ -1,5 +1,6 @@ name: ina260 description: Driver for INA260 precision digital current and power monitor +version: 1.0.0 groups: - current code_owners: UncleRus diff --git a/components/ina3221/.eil.yml b/components/ina3221/.eil.yml index 8cbe63b4..a73468fb 100644 --- a/components/ina3221/.eil.yml +++ b/components/ina3221/.eil.yml @@ -1,5 +1,6 @@ name: ina3221 description: Driver for INA3221 shunt and bus voltage monitor +version: 1.1.0 groups: - current code_owners: UncleRus diff --git a/components/lc709203f/.eil.yml b/components/lc709203f/.eil.yml index a596616b..a6a5be0e 100644 --- a/components/lc709203f/.eil.yml +++ b/components/lc709203f/.eil.yml @@ -1,5 +1,6 @@ name: lc709203f description: Driver for LC709203F battery fuel gauge +version: 1.0.0 groups: - battery code_owners: jmpmscorp diff --git a/components/led_strip/.eil.yml b/components/led_strip/.eil.yml index fea5c1ef..72de2962 100644 --- a/components/led_strip/.eil.yml +++ b/components/led_strip/.eil.yml @@ -1,5 +1,6 @@ name: led_strip description: RMT-based driver for WS2812B/SK6812/APA106/SM16703 LED strips +version: 1.2.0 groups: - led code_owners: UncleRus diff --git a/components/led_strip_spi/.eil.yml b/components/led_strip_spi/.eil.yml index 514f4699..55b65aae 100644 --- a/components/led_strip_spi/.eil.yml +++ b/components/led_strip_spi/.eil.yml @@ -1,5 +1,6 @@ name: led_strip_spi description: SPI-based driver for SK9822/APA102 LED strips +version: 1.0.0 groups: - led code_owners: trombik diff --git a/components/lib8tion/.eil.yml b/components/lib8tion/.eil.yml index 451bd38c..8343c24e 100644 --- a/components/lib8tion/.eil.yml +++ b/components/lib8tion/.eil.yml @@ -1,5 +1,6 @@ name: lib8tion description: Math functions specifically designed for LED programming +version: 1.0.0 groups: - common code_owners: UncleRus diff --git a/components/lm75/.eil.yml b/components/lm75/.eil.yml index 14480991..2e895b54 100644 --- a/components/lm75/.eil.yml +++ b/components/lm75/.eil.yml @@ -1,6 +1,6 @@ name: lm75 -description: | - Driver for LM75, a digital temperature sensor and thermal watchdog +description: Driver for LM75, a digital temperature sensor and thermal watchdog +version: 1.0.0 groups: - temperature code_owners: diff --git a/components/ls7366r/.eil.yml b/components/ls7366r/.eil.yml index d17cf6d8..11d346f0 100644 --- a/components/ls7366r/.eil.yml +++ b/components/ls7366r/.eil.yml @@ -1,5 +1,6 @@ name: ls7366r description: Driver for LS7366R Quadrature Encoder Counter +version: 1.0.0 groups: - input code_owners: Jkallus diff --git a/components/max1704x/.eil.yml b/components/max1704x/.eil.yml index b2b14309..1b5d896d 100644 --- a/components/max1704x/.eil.yml +++ b/components/max1704x/.eil.yml @@ -1,5 +1,6 @@ name: max1704x description: Driver for MAX17043/MAX17044/MAX17048/MAX17049 battery fuel gauge +version: 0.9.0 groups: - battery code_owners: shuki25 diff --git a/components/max31725/.eil.yml b/components/max31725/.eil.yml index eacb0026..cfc6081f 100644 --- a/components/max31725/.eil.yml +++ b/components/max31725/.eil.yml @@ -1,5 +1,6 @@ name: max31725 description: Driver for MAX31725/MAX31726 temperature sensors +version: 1.0.0 groups: - temperature code_owners: UncleRus diff --git a/components/max31855/.eil.yml b/components/max31855/.eil.yml index 6bf05f72..c235105d 100644 --- a/components/max31855/.eil.yml +++ b/components/max31855/.eil.yml @@ -1,5 +1,6 @@ name: max31855 description: Driver for MAX31855 cold-junction compensated thermocouple-to-digital converter +version: 1.0.0 groups: - temperature code_owners: UncleRus diff --git a/components/max31865/.eil.yml b/components/max31865/.eil.yml index 615c5c85..36993f82 100644 --- a/components/max31865/.eil.yml +++ b/components/max31865/.eil.yml @@ -1,5 +1,6 @@ name: max31865 description: Driver for MAX31865 resistance converter for platinum RTDs +version: 1.0.0 groups: - temperature code_owners: UncleRus diff --git a/components/max7219/.eil.yml b/components/max7219/.eil.yml index 2920b945..59e1e6e4 100644 --- a/components/max7219/.eil.yml +++ b/components/max7219/.eil.yml @@ -1,5 +1,6 @@ name: max7219 description: Driver for 8-Digit LED display drivers, MAX7219/MAX7221 +version: 1.0.0 groups: - led code_owners: UncleRus diff --git a/components/mcp23008/.eil.yml b/components/mcp23008/.eil.yml index 0831c994..da450141 100644 --- a/components/mcp23008/.eil.yml +++ b/components/mcp23008/.eil.yml @@ -1,5 +1,6 @@ name: mcp23008 description: Driver for 8-bit I2C GPIO expander MCP23008 +version: 1.0.0 groups: - gpio code_owners: UncleRus diff --git a/components/mcp23x17/.eil.yml b/components/mcp23x17/.eil.yml index e45b6bad..364e5e71 100644 --- a/components/mcp23x17/.eil.yml +++ b/components/mcp23x17/.eil.yml @@ -1,5 +1,6 @@ name: mcp23x17 description: Driver for I2C/SPI 16 bit GPIO expanders MCP23017/MCP23S17 +version: 1.1.2 groups: - gpio code_owners: UncleRus diff --git a/components/mcp342x/.eil.yml b/components/mcp342x/.eil.yml index 8586f6d4..fe581415 100644 --- a/components/mcp342x/.eil.yml +++ b/components/mcp342x/.eil.yml @@ -1,5 +1,6 @@ name: mcp342x description: Driver for 18-Bit, delta-sigma ADC MCP3426/MCP3427/MCP3428 +version: 1.0.0 groups: - adc-dac code_owners: UncleRus diff --git a/components/mcp4725/.eil.yml b/components/mcp4725/.eil.yml index c1cc20ee..6e9ce829 100644 --- a/components/mcp4725/.eil.yml +++ b/components/mcp4725/.eil.yml @@ -1,5 +1,6 @@ name: mcp4725 description: Driver for 12-bit DAC MCP4725 +version: 1.0.0 groups: - adc-dac code_owners: UncleRus diff --git a/components/mcp960x/.eil.yml b/components/mcp960x/.eil.yml index bdc99e6a..7a3e27d0 100644 --- a/components/mcp960x/.eil.yml +++ b/components/mcp960x/.eil.yml @@ -1,5 +1,6 @@ name: mcp960x description: Driver for MCP9600/MCP9601, thermocouple EMF to temperature converter +version: 1.0.0 groups: - temperature code_owners: UncleRus diff --git a/components/mcp9808/.eil.yml b/components/mcp9808/.eil.yml index 6b853892..e2df8bd9 100644 --- a/components/mcp9808/.eil.yml +++ b/components/mcp9808/.eil.yml @@ -1,5 +1,6 @@ name: mcp9808 -description: Driver for MCP9808 Digital Temperature Sensor +description: Driver for MCP9808 digital temperature sensor +version: 1.0.0 groups: - temperature code_owners: UncleRus diff --git a/components/mhz19b/.eil.yml b/components/mhz19b/.eil.yml index 3f8c78d7..aede9beb 100644 --- a/components/mhz19b/.eil.yml +++ b/components/mhz19b/.eil.yml @@ -1,5 +1,6 @@ name: mhz19b description: Driver for MH-Z19B NDIR CO₂ sensor +version: 1.1.0 groups: - air-quality - gas diff --git a/components/mpu6050/.eil.yml b/components/mpu6050/.eil.yml index d3cc5085..38eb9fc8 100644 --- a/components/mpu6050/.eil.yml +++ b/components/mpu6050/.eil.yml @@ -1,5 +1,6 @@ name: mpu6050 description: Driver for MPU6000/MPU6050 6-axis MotionTracking device +version: 2.1.0 groups: - imu code_owners: diff --git a/components/ms5611/.eil.yml b/components/ms5611/.eil.yml index 1138121b..718b05b5 100644 --- a/components/ms5611/.eil.yml +++ b/components/ms5611/.eil.yml @@ -1,5 +1,6 @@ name: ms5611 description: Driver for barometic pressure sensor MS5611-01BA03 +version: 1.1.0 groups: - pressure - temperature diff --git a/components/noise/.eil.yml b/components/noise/.eil.yml index c25b0c54..1415446e 100644 --- a/components/noise/.eil.yml +++ b/components/noise/.eil.yml @@ -1,5 +1,6 @@ name: noise description: Noise generation functions +version: 1.0.0 groups: - common code_owners: UncleRus diff --git a/components/onewire/.eil.yml b/components/onewire/.eil.yml index 1f00dd48..2782dc17 100644 --- a/components/onewire/.eil.yml +++ b/components/onewire/.eil.yml @@ -1,5 +1,6 @@ name: onewire description: Bit-banging 1-Wire driver +version: 1.0.0 groups: - common code_owners: UncleRus diff --git a/components/pca9557/.eil.yml b/components/pca9557/.eil.yml index 00f49093..7a26e164 100644 --- a/components/pca9557/.eil.yml +++ b/components/pca9557/.eil.yml @@ -1,5 +1,6 @@ name: pca9557 description: Driver for PCA9537/PCA9557/TCA9534 remote 4/8-bit I/O expanders for I2C-bus +version: 1.0.0 groups: - gpio code_owners: UncleRus diff --git a/components/pca9685/.eil.yml b/components/pca9685/.eil.yml index 55d2b045..e7633a16 100644 --- a/components/pca9685/.eil.yml +++ b/components/pca9685/.eil.yml @@ -1,5 +1,6 @@ name: pca9685 description: Driver for 16-channel, 12-bit PWM PCA9685 +version: 1.0.0 groups: - misc code_owners: UncleRus diff --git a/components/pcf8563/.eil.yml b/components/pcf8563/.eil.yml index e42f731b..ff40a479 100644 --- a/components/pcf8563/.eil.yml +++ b/components/pcf8563/.eil.yml @@ -1,5 +1,6 @@ name: pcf8563 description: Driver for PCF8563 real-time clock/calendar +version: 1.0.0 groups: - rtc code_owners: UncleRus diff --git a/components/pcf8574/.eil.yml b/components/pcf8574/.eil.yml index 554f85b5..3d0dbe0b 100644 --- a/components/pcf8574/.eil.yml +++ b/components/pcf8574/.eil.yml @@ -1,5 +1,6 @@ name: pcf8574 description: Driver for PCF8574 remote 8-bit I/O expander for I2C-bus +version: 1.0.0 groups: - gpio code_owners: UncleRus diff --git a/components/pcf8575/.eil.yml b/components/pcf8575/.eil.yml index 60012f47..c1344f03 100644 --- a/components/pcf8575/.eil.yml +++ b/components/pcf8575/.eil.yml @@ -1,5 +1,6 @@ name: pcf8575 description: Driver for PCF8575 remote 16-bit I/O expander for I2C-bus +version: 1.0.0 groups: - gpio code_owners: UncleRus diff --git a/components/pcf8591/.eil.yml b/components/pcf8591/.eil.yml index 3c8b419e..15e09342 100644 --- a/components/pcf8591/.eil.yml +++ b/components/pcf8591/.eil.yml @@ -1,5 +1,6 @@ name: pcf8591 description: Driver for 8-bit ADC and an 8-bit DAC PCF8591 +version: 1.0.0 groups: - adc-dac code_owners: UncleRus diff --git a/components/qmc5883l/.eil.yml b/components/qmc5883l/.eil.yml index ec53b7c1..62de474a 100644 --- a/components/qmc5883l/.eil.yml +++ b/components/qmc5883l/.eil.yml @@ -1,5 +1,6 @@ name: qmc5883l description: Driver for QMC5883L 3-axis magnetic sensor +version: 1.0.0 groups: - magnetic code_owners: UncleRus diff --git a/components/rda5807m/.eil.yml b/components/rda5807m/.eil.yml index 79d254d9..e1283248 100644 --- a/components/rda5807m/.eil.yml +++ b/components/rda5807m/.eil.yml @@ -1,5 +1,6 @@ name: rda5807m description: Driver for single-chip broadcast FM radio tuner RDA5807M +version: 1.0.0 groups: - misc code_owners: UncleRus diff --git a/components/scd30/.eil.yml b/components/scd30/.eil.yml index 173bee7a..d3024761 100644 --- a/components/scd30/.eil.yml +++ b/components/scd30/.eil.yml @@ -1,5 +1,6 @@ name: scd30 description: Driver for SCD30 CO₂ sensor +version: 1.0.5 groups: - gas - air-quality diff --git a/components/scd4x/.eil.yml b/components/scd4x/.eil.yml index fb0fd868..54b7065e 100644 --- a/components/scd4x/.eil.yml +++ b/components/scd4x/.eil.yml @@ -1,5 +1,6 @@ name: scd4x description: Driver for SCD40/SCD41 miniature CO₂ sensor +version: 1.0.0 groups: - gas - air-quality diff --git a/components/sgm58031/.eil.yml b/components/sgm58031/.eil.yml index 70d00a00..7ab99a9a 100644 --- a/components/sgm58031/.eil.yml +++ b/components/sgm58031/.eil.yml @@ -1,5 +1,6 @@ name: sgm58031 description: Driver for SGM58031 16-bit I2C ADC +version: 1.0.0 groups: - adc-dac code_owners: jmpmscorp diff --git a/components/sgp40/.eil.yml b/components/sgp40/.eil.yml index 57c3b0fa..b14bc259 100644 --- a/components/sgp40/.eil.yml +++ b/components/sgp40/.eil.yml @@ -1,5 +1,6 @@ name: sgp40 description: Driver for SGP40 Indoor Air Quality Sensor for VOC Measurements +version: 1.0.0 groups: - air-quality code_owners: UncleRus diff --git a/components/sht3x/.eil.yml b/components/sht3x/.eil.yml index 9d73f773..8dab1041 100644 --- a/components/sht3x/.eil.yml +++ b/components/sht3x/.eil.yml @@ -1,5 +1,6 @@ name: sht3x description: Driver for Sensirion SHT30/SHT31/SHT35 digital temperature and humidity sensor +version: 1.0.1 groups: - temperature - humidity diff --git a/components/sht4x/.eil.yml b/components/sht4x/.eil.yml index ef7c319f..abe4c8c7 100644 --- a/components/sht4x/.eil.yml +++ b/components/sht4x/.eil.yml @@ -1,5 +1,6 @@ name: sht4x description: Driver for Sensirion SHT40/SHT41/SHT45 digital temperature and humidity sensor +version: 1.0.0 groups: - temperature - humidity diff --git a/components/si7021/.eil.yml b/components/si7021/.eil.yml index a8278bbc..a16c66c8 100644 --- a/components/si7021/.eil.yml +++ b/components/si7021/.eil.yml @@ -1,7 +1,6 @@ name: si7021 -description: | - Driver for Si7013/Si7020/Si7021/HTU2xD/SHT2x and compatible temperature - and humidity sensors +description: Driver for Si7013/Si7020/Si7021/HTU2xD/SHT2x and compatible temperature and humidity sensors +version: 1.0.1 groups: - temperature - humidity diff --git a/components/sts21/.eil.yml b/components/sts21/.eil.yml index 9d0630ee..850fa3bf 100644 --- a/components/sts21/.eil.yml +++ b/components/sts21/.eil.yml @@ -1,5 +1,6 @@ name: sts21 description: Driver for STS21 temperature sensor +version: 1.0.0 groups: - temperature code_owners: diff --git a/components/sts3x/.eil.yml b/components/sts3x/.eil.yml index e8d6bedd..8b690050 100644 --- a/components/sts3x/.eil.yml +++ b/components/sts3x/.eil.yml @@ -1,5 +1,6 @@ name: sts3x description: Driver for Sensirion STS30/STS31/STS35 digital temperature sensor +version: 1.0.0 groups: - temperature code_owners: slimcdk diff --git a/components/tca9548/.eil.yml b/components/tca9548/.eil.yml index 939a6c9a..5c2b9908 100644 --- a/components/tca9548/.eil.yml +++ b/components/tca9548/.eil.yml @@ -1,5 +1,6 @@ name: tca9548 description: Driver for TCA9548A/PCA9548A low-voltage 8-channel I2C switch +version: 1.0.0 groups: - misc code_owners: UncleRus diff --git a/components/tca95x5/.eil.yml b/components/tca95x5/.eil.yml index 1739fe3f..cc462096 100644 --- a/components/tca95x5/.eil.yml +++ b/components/tca95x5/.eil.yml @@ -1,5 +1,6 @@ name: tca95x5 description: Driver for TCA9535/TCA9555 remote 16-bit I/O expanders for I2C-bus +version: 1.0.0 groups: - gpio code_owners: UncleRus diff --git a/components/tda74xx/.eil.yml b/components/tda74xx/.eil.yml index 476f2d46..e4d5874d 100644 --- a/components/tda74xx/.eil.yml +++ b/components/tda74xx/.eil.yml @@ -1,5 +1,6 @@ name: tda74xx description: Driver for TDA7439/TDA7439DS/TDA7440D audioprocessors +version: 1.0.0 groups: - misc code_owners: UncleRus diff --git a/components/tsl2561/.eil.yml b/components/tsl2561/.eil.yml index 5d0169ae..4baa70a2 100644 --- a/components/tsl2561/.eil.yml +++ b/components/tsl2561/.eil.yml @@ -1,5 +1,6 @@ name: tsl2561 description: Driver for light-to-digital converter TSL2561 +version: 1.0.0 groups: - light code_owners: UncleRus diff --git a/components/tsl2591/.eil.yml b/components/tsl2591/.eil.yml index e961a711..50246837 100644 --- a/components/tsl2591/.eil.yml +++ b/components/tsl2591/.eil.yml @@ -1,5 +1,6 @@ name: tsl2591 description: Driver for light-to-digital converter TSL2591 +version: 1.0.0 groups: - light code_owners: UncleRus diff --git a/components/tsl4531/.eil.yml b/components/tsl4531/.eil.yml index d464161f..4561271a 100644 --- a/components/tsl4531/.eil.yml +++ b/components/tsl4531/.eil.yml @@ -1,5 +1,6 @@ name: tsl4531 description: Driver for digital ambient light sensor TSL4531 +version: 1.0.1 groups: - light code_owners: UncleRus diff --git a/components/tsys01/.eil.yml b/components/tsys01/.eil.yml index cf9e7efa..710f9c21 100644 --- a/components/tsys01/.eil.yml +++ b/components/tsys01/.eil.yml @@ -1,5 +1,6 @@ name: tsys01 description: Driver for precision digital temperature sensor TSYS01 +version: 1.0.0 groups: - temperature code_owners: UncleRus diff --git a/components/ultrasonic/.eil.yml b/components/ultrasonic/.eil.yml index 4667e74a..c16e9514 100644 --- a/components/ultrasonic/.eil.yml +++ b/components/ultrasonic/.eil.yml @@ -1,5 +1,6 @@ name: ultrasonic description: Driver for ultrasonic range meters, e.g. HC-SR04, HY-SRF05 +version: 1.0.0 groups: - misc code_owners: UncleRus diff --git a/components/veml7700/.eil.yml b/components/veml7700/.eil.yml index 11e3e300..8b66f7ea 100644 --- a/components/veml7700/.eil.yml +++ b/components/veml7700/.eil.yml @@ -1,5 +1,6 @@ name: veml7700 description: Driver for VEML7700 ambient light sensor +version: 1.0.0 groups: - light code_owners: Th3Link diff --git a/components/wiegand/.eil.yml b/components/wiegand/.eil.yml index f204f468..60b757bb 100644 --- a/components/wiegand/.eil.yml +++ b/components/wiegand/.eil.yml @@ -1,5 +1,6 @@ name: wiegand description: Wiegand protocol receiver +version: 1.1.0 groups: - misc code_owners: UncleRus diff --git a/devtools/devtool/metadata.py b/devtools/devtool/metadata.py index 0cfc8c49..2cbb5632 100644 --- a/devtools/devtool/metadata.py +++ b/devtools/devtool/metadata.py @@ -41,7 +41,13 @@ def from_value(raw: bool | str) -> ThreadSafety: class Licenses(str, Enum): ISC = 'ISC' MIT = 'MIT' - BSD3 = 'BSD-3' + BSD3 = 'BSD-3-Clause' + + @staticmethod + def from_value(raw: str) -> Licenses: + if raw == 'BSD-3': + return Licenses.BSD3 + return Licenses(raw) class Group(pydantic.BaseModel): @@ -70,6 +76,7 @@ class Copyright(pydantic.BaseModel): class Component(pydantic.BaseModel): name: str description: str + version: str groups: t.List[Group] = [] code_owners: t.List[Person] = [] depends: t.List[str] = [] @@ -107,13 +114,14 @@ def load(m: Metadata, dirname: os.PathLike) -> Component: lc = str(raw['license']) try: - lc = Licenses(lc.upper()) + lc = Licenses.from_value(lc.upper()) except: raise InvalidLicenseError(ctx, lc) res = Component( name=ctx, description=raw['description'].strip().strip('.').replace('\n', ' '), + version=raw['version'].strip(), groups=m.get_groups(ctx, raw), code_owners=m.get_persons(ctx, raw['code_owners']), depends=[lib for lib in raw['depends']],