Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raulgotor/co2monitor
CO2 monitor based in MH-Z19B IR CO2 sensor, using a TTGO module with integrated display, and transferring data to ThingsBoard.io
https://github.com/raulgotor/co2monitor
co2-sensor esp32 mh-z19b thingsboard ttgo-t-display
Last synced: 3 months ago
JSON representation
CO2 monitor based in MH-Z19B IR CO2 sensor, using a TTGO module with integrated display, and transferring data to ThingsBoard.io
- Host: GitHub
- URL: https://github.com/raulgotor/co2monitor
- Owner: raulgotor
- Created: 2021-02-07T11:34:35.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-10-08T21:15:41.000Z (about 2 years ago)
- Last Synced: 2024-06-30T05:37:38.779Z (5 months ago)
- Topics: co2-sensor, esp32, mh-z19b, thingsboard, ttgo-t-display
- Language: C
- Homepage:
- Size: 8.32 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-thingsboard - TTGO ESP32 CO2 Monitor
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
TTGO ESP32 CO2 Monitor
CO2 Monitor based on the MH-Z19B Infrared CO2 sensor running on a ESP32 TTGO Display V1.1
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
Here you get a wireless battery powered CO2 monitor device with color display and internet connectivity.
It is based on the very well known MH-Z19B sensor, and on a ESP32 TTGO Display board, which
integrates a display and two control push buttons, therefore facilitating build from readily
available components. As the device is battery powered, it is very handy to perform on-field measurements.
The information is sent to a specified Thingsboard.io server for further plotting.
Basic features are:
- WiFi enabled CO2 monitor
- MH-Z19B CO2 Sensor: 400 - 10000 ppm CO2 range
- Display (IPS ST7789V 1.14 Inch) controlled by LVGL library v6.0
- Battery operated
- Display shows actual CO2 concentration as well as wifi and backend status and battery level
- Automatic display power-off
- Thingsboard.io integration
- WiFi manager handling reconnection and AP configuration
### Built With
* ESP-IDF v4.4-dev-3042-g220590d599
## Getting Started
### Set-up
This repository is meant to be run in a ESP32 TTGO Display V1.1, but can be ran on any compatible
ESP32 module connected to an external display according to TTGO module schematics. The default connection of the sensor
with the TTGO board is as follows:
| MH-Z19 | TTGO GPIO |
|--------|-----------|
| Vin | 5V |
| GND | GND |
| Rx | 25 |
| Tx | 33 |
### Installation
#### Prerequisites
- Install ESP-IDF Framework, follow the walk-through [here](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html).
#### Steps
1. Clone the repo
```sh
git clone https://github.com/raulgotor/co2monitor.git
```
2. cd into the repo folder and update submodules:
```sh
cd co2monitor && git submodule update --init --recursive
```
__NOTE__: LVGL library and drivers dependencies comes with some issues that cannot be fixed from these repository,
therefore are addressed as patches. Please apply the following patches:
```
cd components/lvgl
git apply ../../patch/lvgl.patch
cd ../lvgl_esp32_drivers
git apply ../../patch/st7789.patch
```
3. Flash the firmware into the hardware:
```sh
idf.py flash
```
## Usage
After booting, the device will start sampling CO2 concentration and showing the result at the display. Additionally, it
will connect to the configured WiFi network and each measurement will be sent to the specified Thingsboard.io server.
### Configuring WiFi credentials
If a configured network is not available, the device will launch an access point named __CO2_Monitor__. Connect to that
network and a captive portal will pop-up (if it doesn't, manually navigate to address ...... in your browser).
Configure it with your network credentials and press __Join__. If everything went well, you'll see your network SSID on the
device display, together with the signal strength.
A small pilot next to the signal strength indicator shows the backend connectivity status: green or red depending if it
was able to post messages to the backend.
### Configuring Thingsboard server and token
### Turning the display on and off
The display can be turned on and off by pressing the bottom-right button at the TTGO board. Additionally, the display
will turn off automatically after a specific amount of time which can be configured at the firmware configuration menu.
Launch the configuration menu with `idf.py menuconfig` and navigate to `Component config -> Application configuration -> Backlight automatic turn off` and select the desired
timeout (in seconds). To disable automatic turn off, configure it to 0 seconds.
### Calibrating CO2 sensor
Place the device outdoors (the CO2 concentration outdoors is around 410ppm at the atmosphere), and after 15 minutes,
press the bottom-left button on the TTGO board. The device will calibrate itself and take the current measured concentration
as 400 ppm.
__NOTE__: don't press the calibration button indoors as it will wrongly calibrate the device.
### Further documentation
## Roadmap
See the [open issues](https://github.com/raulgotor/co2monitor/issues) for a list of proposed features (and known issues).
## Contributing
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Raúl Gotor
Project Link: [https://github.com/raulgotor/co2monitor](https://github.com/raulgotor/co2monitor)
## Acknowledgements
* [LVGL - Light and Versatile Graphics Library](https://lvgl.io)
* [esp32-wifi-manager](https://github.com/tonyp7/esp32-wifi-manager)
* [Embedded C Coding Standard, 2018 Michael Barr](https://barrgroup.com/sites/default/files/barr_c_coding_standard_2018.pdf)
* [Best README template](https://github.com/othneildrew/Best-README-Template)
[contributors-shield]: https://img.shields.io/github/contributors/raulgotor/co2monitor.svg?style=for-the-badge
[contributors-url]: https://github.com/raulgotor/co2monitor/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/raulgotor/co2monitor.svg?style=for-the-badge
[forks-url]: https://github.com/raulgotor/co2monitor/network/members
[stars-shield]: https://img.shields.io/github/stars/raulgotor/co2monitor.svg?style=for-the-badge
[stars-url]: https://github.com/raulgotor/co2monitor/stargazers
[issues-shield]: https://img.shields.io/github/issues/raulgotor/co2monitor.svg?style=for-the-badge
[issues-url]: https://github.com/raulgotor/co2monitor/issues
[license-shield]: https://img.shields.io/github/license/raulgotor/co2monitor.svg?style=for-the-badge
[license-url]: https://github.com/raulgotor/co2monitor/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/raulgotor