mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 16:56:50 +00:00
Remove non existing name suggestion from file documentation (#33288)
* Remove non existing name suggestion from file documentation * Apply suggestions from code review * tiny tweaks --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
parent
699ed98e93
commit
418eca09e0
@ -20,15 +20,16 @@ related:
|
|||||||
ha_config_flow: true
|
ha_config_flow: true
|
||||||
---
|
---
|
||||||
|
|
||||||
The File integration allows to store notifications to a file or to set up a sensor based on a file's content.
|
The File integration allows storing notifications in a file or setting up a sensor based on a file's content.
|
||||||
|
|
||||||
{% include integrations/config_flow.md %}
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
## Notifications
|
## Notifications
|
||||||
|
|
||||||
Make sure that the file you want to use is added to the [allowlist_external_dirs](https://www.home-assistant.io/integrations/homeassistant/#allowlist_external_dirs). The file will be created if it doesn't exist. Add the path of your [configuration](/docs/configuration/) folder (e.g., `/config`) to save the file there. Setting the optional parameter `name` allows multiple notifiers to be created. Setting `timestamp` to `true` adds a timestamp to every entry.
|
Make sure that the file you want to use is added to the [allowlist_external_dirs](https://www.home-assistant.io/integrations/homeassistant/#allowlist_external_dirs). The file will be created if it doesn't exist, but make sure the folder exists. Add the path of your [configuration](/docs/configuration/) folder (for example, `/config/file_notifications`) to save the file there. Setting `timestamp` to `true` adds a timestamp to every logged entry.
|
||||||
|
After creating a config entry, you can change the entry name, the name of the notify entity, or the entity ID, if you prefer.
|
||||||
|
|
||||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
To use notifications in automations or scripts, see the [getting started with automation page](/getting-started/automation/).
|
||||||
|
|
||||||
Use the `notify.send_message` entity service to store notification messages.
|
Use the `notify.send_message` entity service to store notification messages.
|
||||||
|
|
||||||
@ -42,7 +43,7 @@ In this section you find some real-life examples of how to use this sensor.
|
|||||||
|
|
||||||
#### Entries as JSON
|
#### Entries as JSON
|
||||||
|
|
||||||
Assuming that the log file contains multiple values formatted as JSON like shown below:
|
Assuming that the log file contains multiple values formatted as JSON as shown below:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
[...]
|
[...]
|
||||||
@ -50,7 +51,7 @@ Assuming that the log file contains multiple values formatted as JSON like shown
|
|||||||
{"temperature": 22, "humidity": 36}
|
{"temperature": 22, "humidity": 36}
|
||||||
```
|
```
|
||||||
|
|
||||||
This would require the following settings extract the temperature:
|
This would require the following settings to extract the temperature:
|
||||||
|
|
||||||
- Name: `Temperature`
|
- Name: `Temperature`
|
||||||
- File path: `/home/user/.homeassistant/sensor.json`
|
- File path: `/home/user/.homeassistant/sensor.json`
|
||||||
@ -59,7 +60,7 @@ This would require the following settings extract the temperature:
|
|||||||
|
|
||||||
#### Entries as CSV
|
#### Entries as CSV
|
||||||
|
|
||||||
Assuming the log file contains multiple values formatted as CSV like shown below:
|
Assuming the log file contains multiple values formatted as CSV as shown below:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
timestamp,temperature,humidity
|
timestamp,temperature,humidity
|
||||||
|
Loading…
x
Reference in New Issue
Block a user