From efcaa6f124be098f6471d5beae88a87f1a058421 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 30 Oct 2018 07:41:39 +0100 Subject: [PATCH] Update Clicksend_tts notify component configuration (#7259) --- .../_components/notify.clicksend_tts.markdown | 39 ++++++++++++++----- 1 file changed, 29 insertions(+), 10 deletions(-) diff --git a/source/_components/notify.clicksend_tts.markdown b/source/_components/notify.clicksend_tts.markdown index 6009c9e9871..562a6c56ebd 100644 --- a/source/_components/notify.clicksend_tts.markdown +++ b/source/_components/notify.clicksend_tts.markdown @@ -13,7 +13,6 @@ ha_release: 0.55 redirect_from: /components/notify.clicksendaudio/ --- - The `clicksend_tts` platform uses [ClickSend](https://clicksend.com) to deliver text-to-speech (TTS) notifications from Home Assistant. Go to your [ClickSend Dashboard](https://dashboard.clicksend.com) section and create your new project. After creating your project, you should now be able to obtain your `username` and `api_key`. @@ -29,14 +28,34 @@ notify: recipient: PHONE_NO ``` -Configuration variables: - -* **name** (Optional): Setting the optional parameter name allows multiple notifiers to be created. The default value is `ClickSend`. The notifier will bind to the service notify.NOTIFIER_NAME. -* **username** (Required): Your username. -* **api_key** (Required): Your API Key. -* **recipient** (Required): Your phone number. This is where you want to send your notification SMS messages (e.g., `09171234567`) -* **language** (Optional): The language you want to use to convert the message to audio. Accepted values are found in the [ClickSend Documentation](http://docs.clicksend.apiary.io/#reference/voice/voice-languages). Default value is `en-us`. -* **voice** (Optional): The voice that needs to be used to play the message to the recipient. Allowed values are `female` or `male`. Default value is `female`. +{% 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: ClickSend + type: string +username: + description: Your username. + required: true + type: string +api_key: + description: Your API Key. + required: true + type: string +recipient: + description: Your phone number. This is where you want to send your notification SMS messages (e.g., `09171234567`). + required: true + type: string +language: + description: The language you want to use to convert the message to audio. Accepted values are found in the [ClickSend Documentation](http://docs.clicksend.apiary.io/#reference/voice/voice-languages). + required: false + default: en-us + type: string +voice: + description: The voice that needs to be used to play the message to the recipient. Allowed values are `female` or `male`. + required: false + default: female + type: string +{% endconfiguration %} To use notifications, please see the [getting started with automation page](/getting-started/automation/). -