Skip to content

Commit 25d7c4b

Browse files
authored
Merge pull request #24 from Lyr3x/feature/documentation
Update readme
2 parents 3a6bbd6 + 98ad9ac commit 25d7c4b

File tree

1 file changed

+10
-20
lines changed

1 file changed

+10
-20
lines changed

README.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
11
# RooDe
22
People counter working with any smart home system which supports MQTT
33
Project planning in public Trello Board: https://trello.com/b/Yonlc8Fw
4-
**Version 1.0 will break the support for all old hardware configurations working right now (IR-Sensors and VL53L0X)**
5-
## Version 1.0 - Featurelist
6-
Here is a list of features which are working or in _work_
7-
* Counting people entering and leaving a room
8-
* Sensor threhsold calibration with standard deviation
9-
* Receiving commands from the controller e.g. recalibration or manual counter setting
10-
* OLED support
11-
* Sleep mode with Motion Sensor support
12-
* Domoticz Events provided (Roode is useable with every MQTT Controller)
13-
* _Introduction of the new Sensor - VL53L1X_
14-
* _Completely configurable over WebUI_
15-
* _Firmware upgrades over WebUI_
16-
* _Automatically creates Domoticz devices_
174

185
## Hardware
196
There will be a specific Hardware setup (recommended brands etc.) soon!
@@ -22,21 +9,24 @@ There will be a specific Hardware setup (recommended brands etc.) soon!
229
* Optional HC-SR501
2310
* Optional 128x32 OLED
2411
* Power Supply
25-
* Encolsure (see .stl files
12+
* Encolsure (see .stl files) - will be updated soon!
2613

2714
## Changelog
2815
### Changelog v1.0
2916
#### Additions and Breaking Changes
30-
* Add full VL53L1X support
17+
* ESPHome
3118
* Removes legacy support which includes
3219
* Arduino plattform
3320
* MySensors plattform
3421
* **Non** VL53L1X-Sensors
35-
* MQTT support
36-
* Automatic device creation in Domoticz
37-
* Configuration WebUI (may be moved to a later version)
38-
* Removal of Config.h
39-
* OTA support
22+
* VL531L1X TOF Sensor with configurable ROI zones for one-sensor-solution
23+
* Counting people entering and leaving a room with path tracking for improved accuracy
24+
* Sensor threhsold calibration for each zone
25+
* Receiving commands from the the controller e.g softreset
26+
* OLED support (coming in 1.1)
27+
* Sleep mode with Motion Sensor support (coming in 1.1)
28+
* Firmware upgrades over WebUI (esphome)
29+
4030

4131
### Changelog v0.9.6
4232
#### Additions

0 commit comments

Comments
 (0)