From 1e1496bc623521e2a38fdc402faad725103530ba Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 7 Oct 2017 22:21:18 +0200 Subject: [PATCH] Add ClickSend TTS notify --- .../notify.clicksendaudio.markdown | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 source/_components/notify.clicksendaudio.markdown diff --git a/source/_components/notify.clicksendaudio.markdown b/source/_components/notify.clicksendaudio.markdown new file mode 100644 index 00000000000..66c4a1274ea --- /dev/null +++ b/source/_components/notify.clicksendaudio.markdown @@ -0,0 +1,41 @@ +--- +layout: page +title: "ClickSend" +description: "Instructions on how to add ClickSend text-to-speech (TTS) notifications to Home Assistant." +date: 2017-10-04 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: clicksend.png +ha_category: Notifications +ha_release: 0.55 +--- + + +The `clicksendaudio` 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`. + +To add ClickSend to your installation, add the following to your Home Assistant `configuration.yaml` file: + +```yaml +notify: + - platform: clicksend + name: ClickSend + username: CLICKSEND_USERNAME + api_key: CLICKSEND_API_KEY + 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 no. This is where you want to send your notification SMS messages. eg: `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'. + +To use notifications, please see the [getting started with automation page](https://home-assistant.io/getting-started/automation/). +