first commit
This commit is contained in:
commit
5893b00dd2
1669 changed files with 1982740 additions and 0 deletions
105
libraries/M5Unit-ENV/README.md
Normal file
105
libraries/M5Unit-ENV/README.md
Normal file
|
|
@ -0,0 +1,105 @@
|
|||
# M5Unit - ENV
|
||||
|
||||
## Overview
|
||||
|
||||
### SKU:U001 & U001-B & U001-C & U090 & U053-B & U053-D & U103
|
||||
|
||||
Contains M5Stack-**UNIT ENV & Hat ENV & UNIT BPS & UNIT CO2** series related case programs.
|
||||
|
||||
ENV is an environmental sensor with integrated SHT30 and QMP6988 internally to detect temperature, humidity, and atmospheric pressure data.
|
||||
|
||||
BPS is a barometer unit, which integrates the Bosch BMP280 pressure sensor to measure atmospheric pressure and estimate the altitude.
|
||||
|
||||
BPS(QMP6988) Unit is a barometer unit that uses QMP6988 barometric pressure sensor to measure atmospheric pressure and altitude estimation
|
||||
|
||||
CO2 is a photoacoustic Carbon Dioxide (CO2) Unit that will tell you the CO2 PPM (parts-per-million) composition of ambient air.
|
||||
|
||||
## Related Link
|
||||
|
||||
- [Unit ENVIV - Document & Datasheet](https://docs.m5stack.com/en/unit/ENV%E2%85%A3%20Unit)
|
||||
- [Unit ENVIII - Document & Datasheet](https://docs.m5stack.com/en/unit/envIII)
|
||||
- [Unit ENVII - Document & Datasheet](https://docs.m5stack.com/en/unit/envII)
|
||||
- [Unit ENV - Document & Datasheet](https://docs.m5stack.com/en/unit/env)
|
||||
- [Hat ENVIII - Document & Datasheet](https://docs.m5stack.com/en/hat/hat_envIII)
|
||||
- [Hat ENVII - Document & Datasheet](https://docs.m5stack.com/en/hat/hat_envII)
|
||||
- [Unit BPS - Document & Datasheet](https://docs.m5stack.com/en/unit/bps)
|
||||
- [Unit BPS(QMP6988) - Document & Datasheet](https://docs.m5stack.com/en/unit/BPS(QMP6988))
|
||||
- [Unit CO2 - Document & Datasheet](https://docs.m5stack.com/en/unit/co2)
|
||||
|
||||
## Required Libraries:
|
||||
|
||||
- [Adafruit_BMP280_Library](https://github.com/adafruit/Adafruit_BMP280_Library)
|
||||
- [Adafruit_Sensor](https://github.com/adafruit/Adafruit_Sensor)
|
||||
- [Sensirion I2C SCD4x](https://github.com/Sensirion/arduino-i2c-scd4x)
|
||||
- [Sensirion I2C SHT4x](https://github.com/Sensirion/arduino-i2c-sht4x)
|
||||
- [Sensirion Core](https://github.com/Sensirion/arduino-core)
|
||||
|
||||
## License
|
||||
|
||||
- [M5Unit-ENV - MIT](LICENSE)
|
||||
|
||||
---
|
||||
|
||||
## M5UnitUnified
|
||||
Library for Unit ENV using [M5UnitUnified](https://github.com/m5stack/M5UnitUnified).
|
||||
M5UnitUnified is a library for unified handling of various M5 units products.
|
||||
|
||||
### Supported units
|
||||
- Unit CO2 (SKU:U103)
|
||||
- Unit CO2L (SKU:U104)
|
||||
- Unit ENVIII (SKU:U001-C)
|
||||
- Unit ENVIV (SKU:U001-D)
|
||||
- Unit ENVPro (SKU:U169)
|
||||
- Unit TVOC (SKU:U088)
|
||||
|
||||
### SKU:U088
|
||||
|
||||
TVOC/eCO2 mini Unit is a digital multi-pixel gas sensor unit with integrated SGP30.
|
||||
|
||||
It mainly measures various VOC (volatile organic compounds) and H2 in the air. It can be programmed to detect TVOC (total volatile organic compounds) and eCO2 (equivalent carbon dioxide reading)Concentration measurement.
|
||||
|
||||
Typical measurement accuracy is 15% within the measurement range, the SGP30 reading is internally calibrated and output, which can maintain long-term stability. SGP30 uses I2C protocol communication with on-chip humidity compensation function, which can be turned on through an external humidity sensor.
|
||||
|
||||
If you need to obtain accurate results, you need to calibrate according to a known measurement source. SGP30 has a built-in calibration function. In addition, eCO2 is calculated based on the concentration of H2 and cannot completely replace "true" CO2 sensors for laboratory use.
|
||||
|
||||
## Related Link
|
||||
See also examples using conventional methods here.
|
||||
|
||||
- [UnitTVOC/eCO2 & Datasheet](https://docs.m5stack.com/en/unit/tvoc)
|
||||
|
||||
|
||||
### Include file
|
||||
```cpp
|
||||
#include <M5UnitUnifiedENV.h> // For UnitUnified
|
||||
//#include <M5UnitENV.h> // When using M5UnitUnified, do not use it at the same time as conventional libraries
|
||||
```
|
||||
Supported units will be added in the future.
|
||||
|
||||
### Required Libraries:
|
||||
- [M5UnitUnified](https://github.com/m5stack/M5UnitUnified)
|
||||
- [M5Utility](https://github.com/m5stack/M5Utility)
|
||||
- [M5HAL](https://github.com/m5stack/M5HAL)
|
||||
|
||||
The Bosch library is required by ENVPro to obtain values that cannot be obtained without using the Bosch library.
|
||||
- [Bosch-BME68x-Library](https://github.com/boschsensortec/Bosch-BME68x-Library)
|
||||
- [Bosch-BSEC2-Library](https://github.com/boschsensortec/Bosch-BSEC2-Library) (Excluding NanoC6)
|
||||
|
||||
### Examples
|
||||
See also [examples/UnitUnified](examples/UnitUnified)
|
||||
|
||||
### Doxygen document
|
||||
[GitHub Pages](https://m5stack.github.io/M5Unit-ENV/)
|
||||
|
||||
If you want to generate documents on your local machine, execute the following command
|
||||
|
||||
```
|
||||
bash docs/doxy.sh
|
||||
```
|
||||
|
||||
It will output it under docs/html
|
||||
If you want to output Git commit hashes to html, do it for the git cloned folder.
|
||||
|
||||
#### Required
|
||||
- [Doxyegn](https://www.doxygen.nl/)
|
||||
- [pcregrep](https://formulae.brew.sh/formula/pcre2)
|
||||
- [Git](https://git-scm.com/) (Output commit hash to html)
|
||||
Loading…
Add table
Add a link
Reference in a new issue