diff --git a/README.md b/README.md index 1d884c4..d89c8b4 100644 --- a/README.md +++ b/README.md @@ -18,19 +18,20 @@ higher concentrations of CO2 inside will make you sleepy and have an impact on y ## build -just solder everything according to the connection schema. -get yourself a copy of esphome (https://esphome.io/) and compile the firmware with 'co2ampel=USER_ROOMesphome co2sensor.yaml run' (replace user with a nick that identifies you or your organisation and room with the place the sensor is located at - these will be used for online graphing!) -hold boot on your esp32 until fw upload starts. +* solder everything according to the connection schema +* get yourself a copy of esphome (https://esphome.io/) +* compile the firmware with ```co2ampel=USER_ROOMesphome co2sensor.yaml run``` (replace user with a nick that identifies you or your organisation and room with the place the sensor is located at - these will be used for online graphing!) +* hold boot on your esp32 until fw upload starts. ## setup -place the sensor in your room, keep it away from direct exposure of breath (give it at least 1-2m distance to humans or other co2 sources to get the average co2 level of the room) -when there is a freifunk wifi around there is nothing to do for you, same when you defined your own wifi via secrets.yaml. -else just wait a bit and the sensor will spawn an wifi without a password. connect with your phone and choose to login or open http://192.168.4.1 in a browser to enter your wifi credentials -when everything is done, the default config will send the sensor readings back to the project where you can view online graphs (see grafana) +* place the sensor in your room, keep it away from direct exposure of breath (give it at least 1-2m distance to humans or other co2 sources to get the average co2 level of the room) +* when there is a freifunk wifi around there is nothing to do for you, same when you defined your own wifi via secrets.yaml. +* else just wait a bit and the sensor will spawn an wifi without a password. connect with your phone and choose to login or open http://192.168.4.1 in a browser to enter your wifi credentials +* when everything is done, the default config will send the sensor readings back to the project where you can view online graphs (see grafana) ## grafana -there is a quick setup on http://co2.cyber23.de:3000/d/1axlpIdGk/co2?orgId=1&refresh=10s your sensor should apper in the list as soon it has wifi +there is a quick setup on http://co2.cyber23.de:3000/d/1axlpIdGk/co2?orgId=1&refresh=10s your sensor should apper in the list on the left as soon it is connected via wifi ### schema @@ -69,13 +70,13 @@ either way it might be a good idea to have a capacitor between VCC and GND. my p | 400 ppm | none | no | more or less the baseline of the sensor hardware and means 'fresh air quality' | | 400-800ppm | none | no | safe zone and can be considered good air quality | | 800-1500ppm | yellow | no | warning zone (consider to open windows) and is between medium and bad air quality | -| > 1500ppm | red | yes | bad air quality, ppl in the room will be affected in a negative way | +| > 1500ppm | red + blink | no | bad air quality, ppl in the room will be affected in a negative way | ## todo - * cooldown time for buzzer (alarm only once every n minutes) -> lambda/interval/on_time? - * add openings for mh-z19 to the case - * adjust light tunnel to use frosted acrylic glass - * add a silent switch for meeting rooms and such (no buzzer, but flash at a regular interval to attract attention) +- [ ] cooldown time for buzzer (alarm only once every n minutes) -> lambda/interval/on_time? +- [x] add openings for mh-z19 to the case +- [x] adjust light tunnel to use frosted acrylic glass +- [ ] add a silent switch for meeting rooms and such (no buzzer, but flash at a regular interval to attract attention)