jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update file sensor component configuration (#7473)

Browse Source
This commit is contained in:
Klaas Schoute 2018-11-12 11:13:47 +01:00 committed by Fabian Affolter
parent 8c08d4e254
commit 423f5918ef
1 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
source/_components/sensor.file.markdown
View File

@ -13,7 +13,6 @@ ha_iot_class: "Local Polling"
ha_release: 0.45 ha_release: 0.45
--- ---
The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [whitelist_external_dirs](/docs/configuration/basic/).
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
@ -27,12 +26,25 @@ sensor:
file_path: /home/user/.homeassistant/sensor-data.txt file_path: /home/user/.homeassistant/sensor-data.txt
``` ```
Configuration variables: {% configuration %}
file_path:
- **file_path** (*Required*): path to file that stores the sensor data. description: Path to file that stores the sensor data.
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `File`. required: true
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any. type: string
- **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. name:
description: Name of the sensor to use in the frontend.
required: false
default: file name
type: string
unit_of_measurement:
description: Defines the units of measurement of the sensor, if any.
required: false
type: string
value_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
required: false
type: template
{% endconfiguration %}
## {% linkable_title Examples %} ## {% linkable_title Examples %}
@ -59,4 +71,3 @@ sensor:
value_template: {% raw %}'{{ value_json.temperature }}'{% endraw %} value_template: {% raw %}'{{ value_json.temperature }}'{% endraw %}
unit_of_measurement: '°C' unit_of_measurement: '°C'
``` ```