Skip to content

Commit e640ea3

Browse files
Update README.md
1 parent d8a1e71 commit e640ea3

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# co2 display esp32
1+
# CO<sub>2</sub> display esp32
22

33
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/bdbc66cdcdfd46ab99144949714cc822)](https://app.codacy.com/gh/CelliesProjects/co2-display-esp32/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
44

55
![SAM_3242](https://github.com/user-attachments/assets/76c282f7-baca-4862-9028-22992eba1542)
66

7-
This project is designed to display CO2 levels using a [Panel ESP32-4848S040](https://homeding.github.io/boards/esp32s3/panel-4848S040.htm).<br>
8-
It reads data from a Senseair S8 CO2 sensor and an SHT31 temperature and humidity sensor, displaying the real-time readings.
7+
This is a [PlatformIO](https://platformio.org/) project designed to display CO<sub>2</sub> levels using a [Panel ESP32-4848S040](https://homeding.github.io/boards/esp32s3/panel-4848S040.htm).<br>
8+
It reads data from a Senseair S8 CO<sub>2</sub> sensor and an SHT31 temperature and humidity sensor, displaying the real-time readings and the history of the last 2 hours.
99

10-
Sensors are on separate sensor board and are read over websocket.<br>
11-
This setup is chosen because the CO2 sensor uses over 300mA when reading and this made the tft screen flicker during the reading.<br>
10+
Sensors are on separate sensor board and are retrieved over websocket.<br>
11+
This setup is chosen because the SenseAir S8 CO<sub>2</sub> sensor uses up to 300mA when reading and this makes the tft screen flicker during reading.<br>
1212
You can find the sensor code at the [SensorHub repo](https://github.com/CelliesProjects/SensorHub).
1313

1414
There is also weather forecast data shown which is retrieved from [visualcrossing.com](https://www.visualcrossing.com/).<br>
@@ -17,14 +17,14 @@ You can setup your free account [here](https://www.visualcrossing.com/weather-ap
1717

1818
### Installation
1919

20-
Assuming you already have the [SensorHub](https://github.com/CelliesProjects/SensorHub) and a [visualcrossing account](https://www.visualcrossing.com/weather-api) API key you can use these steps to install:
20+
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:
2121

2222
1. Clone this repository.
2323
```bash
2424
git clone https://github.com/CelliesProjects/co2-display-esp32.git
2525
```
2626

27-
2. Add a secrets.h file to the include folder with the following content:<br>
27+
2. Open the extracted folder in PlatformIO and add a `secrets.h` file to the `include` folder with the following content:<br>
2828
```c++
2929
#ifndef SECRETS
3030
#define SECRETS
@@ -38,7 +38,11 @@ const char *VISUAL_CROSSING_API_KEY = "your api key";
3838

3939
#endif
4040
```
41-
3. Build and upload the firmware to the ESP32 board using PlatformIO.
41+
3. Build and upload the firmware to the ESP32.
42+
43+
### Done!
44+
45+
If all went well the board will now search for the sensorhub and connect automagically.
4246

4347
## License
4448
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)