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-21 08:16:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update file notify component configuration (#7528)

Browse Source
This commit is contained in:
Klaas Schoute 2018-11-16 08:54:38 +01:00 committed by Fabian Affolter
parent b1fac434e0
commit 1f1a2253f3
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
source/_components/notify.file.markdown
View File

@ -12,7 +12,6 @@ ha_category: Notifications
ha_release: pre 0.7
---
The `file` platform allows you to store notifications from Home Assistant as a file.
To enable file notifications in your installation, add the following to your `configuration.yaml` file:
@ -25,10 +24,21 @@ notify:
filename: FILENAME
```
Configuration variables:
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
- **filename** (*Required*): Name of the file to use. The file will be created if it doesn't exist and saved in your [configuration](/docs/configuration/) folder.
- **timestamp** (*Optional*): Setting `timestamp` to `True` adds a timestamp to every entry.
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: notify
type: string
filename:
description: Name of the file to use. The file will be created if it doesn't exist and saved in your [configuration](/docs/configuration/) folder.
required: true
type: string
timestamp:
description: Setting `timestamp` to `True` adds a timestamp to every entry.
required: false
default: false
type: boolean
{% endconfiguration %}
To use notifications, please see the [getting started with automation page](/getting-started/automation/).