diff --git a/README.md b/README.md new file mode 100644 index 0000000..c9200db --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# ESP air quality sensor + +## Components + +- BME680 in I2C mode +- SenseAir Sunrise (buggy early revision, will need updating for newer sensors) + +## Pinout + +- I2C_SDA0 16 - i2c for BME680 +- I2C_SCL0 17 +- I2C_SDA1 5 (senseair sunrise uart TX) +- I2C_SCL1 18 (senseair sunrise uart RX) +- CO2_NRDY 23 +- CO2_COMSEL 13 (high=uart) +- CO2_EN 15 sunrise restart pin, works like nReset + +## Licensing + +- Console component, proprietary (c) VZLU 2021, developed for VZLUSAT2 with CSP parts removed in this version. Partly based on esp32 console, including 3rd party Linenoise library. +- BSEC2 by Bosch, see lib for details +- web templating, telnet protocol, tcp socket server and the actual metering app (c) Ondřej Hruška 2018-2022