Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mp-se committed Mar 5, 2023
1 parent f71eace commit da04ce8
Showing 1 changed file with 10 additions and 17 deletions.
27 changes: 10 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,23 @@

This is a project that I have done for my own Keezer, if you like it please feel free to suggest improvements.

For docs see: https://mp-se.github.io/kegmon/index.html (Not yet updated to match v0.4)
For docs see: https://mp-se.github.io/kegmon/index.html

# Hardware

* Supports ESP8266 D1 mini or ESP32s2 mini
* Loadcells and HX711 converters
* DHT22 or DS18B20 temperature sensors
* OLED 0.92" display

# Features

* Based on ESP8266 D1 mini, HX711 sensors and OLED 0.92" display
* Can measure weight from 1 or 2 scales
* Stable scale presentation (data is filtered and processed)
* Support temperature/humidity sensor in one scale base
* Integration with Brewfather to retrive data on brew
* Integration with Brewspy to retrive data on brew and also update the remaning volume and pours
* Display data in weight or volume
* Integration with Home Assistant
* Weights and Volumes in Metric, Imperial (both US and UK)
* Pour detection for pours over 100 ml

# Future considerations

* Considering switching to ESP32 for more processing power.
* Switching to larger display, 3-4" TFT (will require ESP32)
* PCB and 3d printed case design

# Changes to v0.5

* Refactored the level detection code and added a kalman filter to smooth out any peeks in readings. Level detection will be done using the statistics mathod. This refactor will also allow for additional options for doing level detection in the future. The kalman filter makes level detection slower but less sensitive to data errors. If you are pouring multiple pints these could show up as one pour.
* Updates on the display is done using last read scale values, it will not be accurate but show fast response when a beer is poured.
* Added Home Assistant integration via MQTT so that levels can be shown in a dashboard.
* Added graphs under the stability option so that we can see the graphs over the readings. It will show the raw, kalman and stable values. This is only managed in the browser since there is limited memory on the esp8266 for storing the data there. A refresh of the browser will remove the readings. This is a simpler way to see the stability of the scale if there is no influxdb availble.
* Updated schema so that DHT22 is powered by D6. This method allows reset of the sensor if it stops responding. Can also be powered by 3.3V

0 comments on commit da04ce8

Please sign in to comment.