You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# The offset correction distance. See calibration section (WIP) for more details.
102
+
offset: 8mm
103
+
# The corrected photon count in counts per second. See calibration section (WIP) for more details.
104
+
crosstalk: 53406cps
105
+
106
+
# Hardware pins
107
+
pins:
108
+
# Shutdown/Enable pin, which is needed to change the I2C address. Required with multiple sensors.
109
+
xshut: GPIO3
110
+
# Interrupt pin. Use to notify us when a measurement is ready. This feature is WIP.
111
+
# This needs to be an internal pin.
112
+
interrupt: GPIO1
113
+
114
+
# Roode people counting algorithm
115
+
roode:
116
+
# Smooth out measurements by using the minimum distance from this number of readings
117
+
sampling: 2
118
+
119
+
# The orientation of the two sensor pads in relation to the entryway being tracked.
120
+
# The advised orientation is parallel, but if needed this can be changed to perpendicular.
121
+
orientation: parallel
122
+
123
+
# This controls the size of the Region of Interest the sensor should take readings in.
124
+
# The current default is
125
+
roi: { height: 16, width: 6 }
126
+
# We have an experiential automatic mode that can be enabled with
127
+
roi: auto
128
+
# or only automatic for one dimension
129
+
roi: { height: 16, width: auto }
130
+
131
+
# The detection thresholds for determining whether a measurement should count as a person crossing.
132
+
# A reading must be greater than the minimum and less than the maximum to count as a crossing.
133
+
# These can be given as absolute distances or as percentages.
134
+
# Percentages are based on the automatically determined idle or resting distance.
135
+
detection_thresholds:
136
+
min: 0%# default minimum is any distance
137
+
max: 85%# default maximum is 85%
138
+
# an example of absolute units
139
+
min: 50mm
140
+
max: 234cm
141
+
142
+
# The people counting algorithm works by splitting the sensor's capability reading area into two zones.
143
+
# This allows for detecting whether a crossing is an entry or exit based on which zones was crossed first.
144
+
zones:
145
+
# Flip the entry/exit zones. If Roode seems to be counting backwards, set this to true.
146
+
invert: false
147
+
148
+
# Entry/Exit zones can set overrides for individual ROI & detection thresholds here.
149
+
# If omitted, they use the options configured above.
150
+
entry:
151
+
# Entry zone will automatically configure ROI, regardless of ROI above.
152
+
roi: auto
153
+
exit:
154
+
roi:
155
+
# Exit zone will have a height of 8 and a width of number set above or default or auto
156
+
height: 8
157
+
# Additionally, zones can manually set their center point.
158
+
# Usually though, this is left for Roode to automatically determine.
159
+
center: 124
160
+
161
+
detection_thresholds:
162
+
# Exit zone's min detection threshold will be 5% of idle/resting distance, regardless of setting above.
163
+
min: 5%
164
+
# Exit zone's max detection threshold will be 70% of idle/resting distance, regardless of setting above.
165
+
max: 70%
166
+
```
167
+
168
+
### Sensors
89
169
170
+
#### People Counter
171
+
172
+
The most important one is the people counter.
173
+
```yaml
90
174
number:
91
175
- platform: roode
92
176
people_counter:
93
177
name: People Count
94
178
```
179
+
Regardless of how close we can get, people counting will never be perfect.
180
+
This allows the current people count to be adjusted easily via Home Assistant.
95
181
96
-
### Configuration variables
97
-
98
-
-**i2c_address (Optional, integer)**: The I²C address of the sensor. Defaults to `0x29`.
99
-
-**update_interval (Optional, Time)**: The interval to check the sensor. Defaults to `100ms`.
100
-
-**calibration (Optional, exclusive-mode)**: Enables automatic zone calibration:
101
-
-**max_threshold_percentage (Optional, int)**: The maxium threshold in % which needs to be reached to detect a person. Min: `50` Max: `100`. Defaults to `85`.
102
-
-**min_threshold_percentage (Optional, int)**: The minimum threshold in % which needs to be reached to detect a person. Min: `0` Max: `100`. Defaults to `0`.
103
-
-**roi_calibration (Optional, bool)**: Enables automatic ROI calibration (experimental). Defaults to `false`.
-**manual_threshold (required, int)**: The threshold for both zones. Min: `40` Max: `4000`. Defaults to `2000`.
106
-
-**roi_height (required, int)**: The height of the ROI zones. Min: `4` Max: `16`. Defaults to `16`.
107
-
-**roi_width (required, int)**: The height of the ROI zones. Min: `4` Max: `16`. Defaults to `6`.
108
-
-**sensor_mode(required, int)**: Sets the distance mode of the sensor if `calibration=false`.
109
-
- Options: `0=short`, `1=long`, `2=max`. Defaults to `true`.
110
-
-**timing_budget (optional, int)**: The timing budget for the sensor. Increasing this slows down detection but increases accuracy. Min: `10ms` Max: `1000s`. Defaults to `10ms`.
111
-
-**invert_direction (Optional, bool)**: Inverts the counting direction. Switch to `true` if the movement count appears backwards. Defaults to `false`.
112
-
-**advised_sensor_orientation(Optional, bool)**: Advised orientation has the two sensor pads parallel to the entryway.
113
-
So `false` means the pads are perpendicular to the entryway.
114
-
Defaults to `true`.
115
-
116
-
### Sensor
117
-
118
-
Example Sensor setup to use all available features:
0 commit comments