https://github.com/celliesprojects/co2-display-esp32
An app to show indoor co2 levels and air quality
https://github.com/celliesprojects/co2-display-esp32
co2-monitoring esp32-4848s040 esp32-s3 indoor-air-quality platformio senseair-s8 sht31 visualcrossing-api visualcrossingweather
Last synced: about 2 months ago
JSON representation
An app to show indoor co2 levels and air quality
- Host: GitHub
- URL: https://github.com/celliesprojects/co2-display-esp32
- Owner: CelliesProjects
- Created: 2024-08-10T18:14:49.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-19T13:02:05.000Z (over 1 year ago)
- Last Synced: 2024-10-20T05:47:19.138Z (over 1 year ago)
- Topics: co2-monitoring, esp32-4848s040, esp32-s3, indoor-air-quality, platformio, senseair-s8, sht31, visualcrossing-api, visualcrossingweather
- Language: C
- Homepage:
- Size: 81.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CO2 display esp32
[](https://app.codacy.com/gh/CelliesProjects/co2-display-esp32/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
This is a [PlatformIO](https://platformio.org/) project designed to display CO2 levels using a [Panel ESP32-4848S040](https://homeding.github.io/boards/esp32s3/panel-4848S040.htm).
It reads data from a Senseair S8 CO2 sensor and an SHT31 temperature and humidity sensor, displaying the real-time readings and the history of the last hour.
Sensors are on a separate sensor board and the sensor values are pushed to this board through websocket.
This setup is chosen because the SenseAir S8 CO2 sensor uses up to 300mA when reading and this makes the tft screen flicker during reading when the CO2 sensor is on the same board as the display.
You can find the sensor code at the [SensorHub repo](https://github.com/CelliesProjects/SensorHub).
There is also weather forecast data shown which is retrieved from [visualcrossing.com](https://www.visualcrossing.com/).
You will need to setup an account with visualcrossing to be able to download weather data. 1000 free API credits per day are included in the free accounts. No CC needed.
You can setup your free account [here](https://www.visualcrossing.com/weather-api).
### Installation
Assuming you already have the [SensorHub](https://github.com/CelliesProjects/SensorHub) running and a [visualcrossing account](https://www.visualcrossing.com/weather-api) API key you can use these steps to install:
1. Clone this repository.
```bash
git clone https://github.com/CelliesProjects/co2-display-esp32.git
```
2. Open the extracted folder in PlatformIO and add a `secrets.h` file to the `include` folder with the following content:
```c++
#ifndef SECRETS
#define SECRETS
const char *WIFI_SSID = "network";
const char *WIFI_PSK = "password";
const char *VISUAL_CROSSING_CITY = "city";
const char *VISUAL_CROSSING_COUNTRY = "country";
const char *VISUAL_CROSSING_API_KEY = "your api key";
#endif
```
3. Build and upload the firmware to the ESP32.
### Done!
If all went well the board will now search for the sensorhub and connect automagically.
## License
This project is licensed under the MIT License.