From 1f1a2253f3aa5f0e4057409b3a38ec22130135d3 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Fri, 16 Nov 2018 08:54:38 +0100 Subject: [PATCH] Update file notify component configuration (#7528) --- source/_components/notify.file.markdown | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/source/_components/notify.file.markdown b/source/_components/notify.file.markdown index 9a94b1177e4..7b978d331fc 100644 --- a/source/_components/notify.file.markdown +++ b/source/_components/notify.file.markdown @@ -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/).