Skip to content

Commit 180b64e

Browse files
committed
fix gdk101 fw version reporting
Signed-off-by: szewcu <[email protected]>
1 parent bb927ab commit 180b64e

File tree

1 file changed

+50
-5
lines changed

1 file changed

+50
-5
lines changed

content/components/sensor/gdk101.md

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,10 @@ A sensor platform to radiation data
7676

7777
Configuration variables:
7878

79-
- **radiation_dose_per_1m** (**Required**): Radiation average dose per 1 minute.
79+
- **radiation_dose_per_1m** (*Optional*): Radiation average dose per 1 minute.
8080
All options from [Sensor](#config-sensor).
8181

82-
- **radiation_dose_per_10m** (**Required**): Radiation average dose per 10 minutes.
83-
All options from [Sensor](#config-sensor).
84-
85-
- **version** (**Required**): Fimware version of the module.
82+
- **radiation_dose_per_10m** (*Optional*): Radiation average dose per 10 minutes.
8683
All options from [Sensor](#config-sensor).
8784

8885
- **status** (*Optional*): Sensor status.
@@ -108,6 +105,54 @@ Configuration variables:
108105
- **vibrations** (**Required**): Vibration status.
109106
All options from [Binary Sensor](#config-binary_sensor).
110107

108+
## Text Sensor
109+
110+
```yaml
111+
# Example configuration entry
112+
text_sensor:
113+
- platform: gdk101
114+
version:
115+
name: "GDK101 FW Version"
116+
```
117+
118+
Text sensor that report firmware version of the sensor.
119+
120+
Configuration variables:
121+
122+
- **version** (*Optional*): Firmware version of the module.
123+
All options from [Text Sensor](#config-text_sensor).
124+
125+
## Sensor Status
126+
127+
Sensor status indicates how long sensor work which indicates accuracy of the measurements
128+
129+
| 0 | Power On ~ 10sec |
130+
| 1 | 10sec to 10min |
131+
| 2 | After 10 min |
132+
133+
This can be represented by a template text sensor such as below:
134+
135+
```yaml
136+
sensor:
137+
- platform: gdk101
138+
status:
139+
name: "GDK101 status"
140+
id: gdk101_status
141+
- platform: template
142+
name: "GDK101 Status Description"
143+
lambda: |-
144+
int status = int(id(gdk101_status).state);
145+
if (status == 0) {
146+
return {"Powered On"};
147+
} else if (status == 1) {
148+
return {"Settling"};
149+
} else if (status == 2) {
150+
return {"Settled"};
151+
} else {
152+
return {"Unknown status"};
153+
}
154+
```
155+
111156
## See Also
112157

113158
- [Sensor Filters](#sensor-filters)

0 commit comments

Comments
 (0)