diff --git a/source/_components/alarm_control_panel.alarmdecoder.markdown b/source/_components/alarm_control_panel.alarmdecoder.markdown index 476773df3eb..98810aaa2a1 100644 --- a/source/_components/alarm_control_panel.alarmdecoder.markdown +++ b/source/_components/alarm_control_panel.alarmdecoder.markdown @@ -27,7 +27,9 @@ The Alarm Decoder component gives you access to several services for you to cont - `alarm_disarm`: Disarms the alarm from any state. Also clears a `check_zone` flag after an alarm was triggered. - `alarmdecoder_alarm_toggle_chime`: Toggles the alarm's chime state. -**Note**: `alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder component. +

+`alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder platform. +

### {% linkable_title Attributes %} diff --git a/source/_components/binary_sensor.hive.markdown b/source/_components/binary_sensor.hive.markdown index ffba6e29d16..49486d62d76 100644 --- a/source/_components/binary_sensor.hive.markdown +++ b/source/_components/binary_sensor.hive.markdown @@ -14,11 +14,12 @@ ha_iot_class: "Cloud Polling" --- -The 'hive' binary sensor component integrates your Hive sensors into Home Assistant. +The `hive` binary sensor component integrates your Hive sensors into Home Assistant. -The Hive binary sensor component supports the following Hive products: -- **Hive Window or Door Sensor** -- **Hive Motion Sensor** +The platform supports the following Hive products: + +- Hive Window or Door Sensor +- Hive Motion Sensor

diff --git a/source/_components/binary_sensor.random.markdown b/source/_components/binary_sensor.random.markdown index d8a01291200..b1208681a8a 100644 --- a/source/_components/binary_sensor.random.markdown +++ b/source/_components/binary_sensor.random.markdown @@ -16,6 +16,8 @@ ha_release: 0.57 The `random` binary sensor platform is creating random states (`True`, 1, `on` or `False`, 0, `off`). This can be useful if you want to test automation rules. It generates a new state every time it is polled. +## {% linkable_title Configuration %} + To enable the random binary sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/binary_sensor.workday.markdown b/source/_components/binary_sensor.workday.markdown index b63d8f778da..1ba1f8bd8c7 100644 --- a/source/_components/binary_sensor.workday.markdown +++ b/source/_components/binary_sensor.workday.markdown @@ -26,7 +26,7 @@ To enable the `workday` sensor in your installation, add the following to your ` binary_sensor: - platform: workday country: DE - workdays: [ mon, wed, fri ] + workdays: [mon, wed, fri] ``` Configuration variables: diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown index 5999dc48ac6..9825c5f9cc6 100644 --- a/source/_components/calendar.google.markdown +++ b/source/_components/calendar.google.markdown @@ -16,7 +16,7 @@ ha_release: 0.33 The `google` calendar platform allows you to connect to your [Google Calendars](https://calendar.google.com) and generate binary sensors. The sensors created can trigger based on any event on the calendar or only for matching events. When you first setup this component it will generate a new configuration file `google_calendars.yaml` that will contain information about all of the calendars you can see. -### {% linkable_title Prerequisites %} +## {% linkable_title Prerequisites %} Generate a Client ID and Client Secret on [Google Developers Console](https://console.developers.google.com/start/api?id=calendar). @@ -30,7 +30,7 @@ Generate a Client ID and Client Secret on [Google Developers Console](https://co 1. Save the client ID and secret as you will need to put these in your `configuration.yaml` file. 1. Click on "Library", search for "Google Calendar API" and enable it. -### {% linkable_title Basic Setup %} +## {% linkable_title Configuration %} To integrate Google Calendar in Home Assistant, add the following section to your `configuration.yaml` file: @@ -61,7 +61,7 @@ The next steps will require you to have Home Assistant running. After you have it running complete the Google authentication that pops up. It will give you a URL and a code to enter. This will grant your Home Assistant service access to all the Google Calendars that the account you authenticate with can read. This is a Read-Only view of these calendars. -### {% linkable_title Calendar Configuration %} +## {% linkable_title Calendar Configuration %} Editing the `google_calendars.yaml` file. diff --git a/source/_components/climate.hive.markdown b/source/_components/climate.hive.markdown index dd3fd41ca51..12f46885533 100644 --- a/source/_components/climate.hive.markdown +++ b/source/_components/climate.hive.markdown @@ -14,13 +14,15 @@ ha_iot_class: "Cloud Polling" --- -The 'hive' climate component integrates your Hive thermostat and hot water into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**. +The `hive` climate platform integrates your Hive thermostat and hot water into Home Assistant, enabling control of setting the **mode** and setting the **target temperature**. + A short boost for Hive Heating or Hive Hot water can be set by using the **Aux Heat** function, this will turn on the boost feature for Hive Heating or Hive Hot water for 30 minutes at 0.5 degrees higher than the current temperature. -The Hive climate component supports the following Hive products: -- **Hive Active Heating** -- **Hive Multizone** -- **Hot water control** +The platform supports the following Hive products: + +- Hive Active Heating +- Hive Multizone +- Hot water control

diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index f196288c7ae..edd0b8ebb14 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -25,6 +25,8 @@ The Google Assistant component requires a bit more setup than most due to the wa To use Google Assistant, your Home Assistant configuration has to be externally accessible with a hostname and SSL certificate. If you haven't already configured that, you should do so before continuing.

+## {% linkable_title Configuration %} + To enable this, add the following lines to your `configuration.yaml` file: ```yaml diff --git a/source/_components/hive.markdown b/source/_components/hive.markdown index fbe0d5b17ff..16f2a77ac43 100644 --- a/source/_components/hive.markdown +++ b/source/_components/hive.markdown @@ -14,11 +14,13 @@ ha_iot_class: "Cloud Polling" --- -This Hive component is the main component to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices into Home Assistant, including support for multizone heating. +The `hive` component is the main component to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all your Hive devices into Home Assistant, including support for multizone heating. This component uses the unofficial API used in the official Hive website [https://my.hivehome.com](https://my.hivehome.com), and you will need to use the same Username and Password you use on the Hive website to configure this Hive component in Home Assistant. -To add your Hive devices into your Home Assistant installation, using the default scan_interval, add the following to your 'configuration.yaml' file: + + +To add your Hive devices into your Home Assistant installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/light.hive.markdown b/source/_components/light.hive.markdown index 78daeb5641c..44221f63711 100644 --- a/source/_components/light.hive.markdown +++ b/source/_components/light.hive.markdown @@ -14,12 +14,13 @@ ha_iot_class: "Cloud Polling" --- -The 'hive' light component integrates your Hive lights into Home Assistant, enabling control of various settings, depending on the model light. +The `hive` light platform integrates your Hive lights into Home Assistant, enabling control of various settings, depending on the model light. -The Hive light component supports the following Hive products: -- **Hive Active Light Dimmable** -- **Hive Active Light Cool to Warm White** -- **Hive Active Light Color Changing** +The platform supports the following Hive products: + +- Hive Active Light Dimmable +- Hive Active Light Cool to Warm White +- Hive Active Light Color Changing

diff --git a/source/_components/media_player.onkyo.markdown b/source/_components/media_player.onkyo.markdown index 0c6dc4d2d3d..13a50152dc1 100644 --- a/source/_components/media_player.onkyo.markdown +++ b/source/_components/media_player.onkyo.markdown @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `onkyo` platform allows you to control a [Onkyo](http://www.onkyo.com/) and some recent [Pioneer](http://www.pioneerelectronics.com) receivers from Home Assistant. Please be aware that you need to enable "Network Standby" for this component to work in your Hardware. +## {% linkable_title Configuration %} + To add an Onkyo or Pioneer receiver to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/notify.clicksend.markdown b/source/_components/notify.clicksend.markdown index a5f9d587fde..8d619617b42 100644 --- a/source/_components/notify.clicksend.markdown +++ b/source/_components/notify.clicksend.markdown @@ -15,9 +15,12 @@ ha_release: 0.48 The `clicksend` platform uses [ClickSend](https://clicksend.com) to deliver notifications from Home Assistant. -### Get your ClickSend API Credentials +## {% linkable_title Prerequisites %} + 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`. +## {% linkable_title Configuration %} + To add ClickSend to your installation, add the following to your Home Assistant `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.hive.markdown b/source/_components/sensor.hive.markdown index 4fa0221f31a..0d4d087516f 100644 --- a/source/_components/sensor.hive.markdown +++ b/source/_components/sensor.hive.markdown @@ -14,11 +14,12 @@ ha_iot_class: "Cloud Polling" --- -The 'hive' sensor component exposes hive data as a sensor. +The `hive` sensor component exposes Hive data as a sensor. -The Hive sensor component exposes the following sensors: -- **Hive Hub Online Status** -- **Hive Outside Temperature** +The platform exposes the following sensors: + +- Hive Hub Online Status +- Hive Outside Temperature

Full configuration details can be found on the main [Hive component](/components/hive/) page. diff --git a/source/_components/sensor.sht31.markdown b/source/_components/sensor.sht31.markdown index 73660bbbdc1..7adbfc2ceea 100644 --- a/source/_components/sensor.sht31.markdown +++ b/source/_components/sensor.sht31.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Local Polling" The `sht31` sensor platform allows you to get the current temperature and humidity from a Sensirion SHT31 device. +## {% linkable_title Configuration %} + To use your SHT31 sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.thethingsnetwork.markdown b/source/_components/sensor.thethingsnetwork.markdown index cce7aad5697..faeb8b7e650 100644 --- a/source/_components/sensor.thethingsnetwork.markdown +++ b/source/_components/sensor.thethingsnetwork.markdown @@ -17,6 +17,8 @@ The `thethingsnetwork` sensor platform allows you to get data from a [The Things This platform requires that the [The Things Network component](/components/thethingsnetwork/) is set up and the [The Things Network Storage Integration](https://www.thethingsnetwork.org/docs/applications/storage/) as well. +## {% linkable_title Prerequisites %} + Visit the [The Things Network Console](https://console.thethingsnetwork.org/) website, log in with your The Things Network credentials, choose your application from **Applications** and go to **Integrations**. Add a new integration. @@ -54,6 +56,8 @@ Select **Devices** to get the ID of your device that you want to use. Devices overview

+## {% linkable_title Configuration %} + To enable this platform, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/switch.hive.markdown b/source/_components/switch.hive.markdown index 8f7d8677221..e4ea4837975 100644 --- a/source/_components/switch.hive.markdown +++ b/source/_components/switch.hive.markdown @@ -14,10 +14,11 @@ ha_iot_class: "Cloud Polling" --- -The 'hive' switch component integrates your Hive plugs into Home Assistant, enabling control of your devices. +The `hive` switch platform integrates your Hive plugs into Home Assistant, enabling control of your devices. -The Hive switch component supports the following Hive products: -- **Hive Active Plug** +The platform supports the following Hive products: + +- Hive Active Plug

diff --git a/source/_components/switch.rainbird.markdown b/source/_components/switch.rainbird.markdown index 6fba9a2f995..673c4d19287 100644 --- a/source/_components/switch.rainbird.markdown +++ b/source/_components/switch.rainbird.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Local Polling" This `rainbird` switch platform allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. +## {% linkable_title Configuration %} + Once you have enabled the [Rain Bird component](/components/rainbird), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.rest.markdown b/source/_components/switch.rest.markdown index 79388ff24b7..65f0afcd3ee 100644 --- a/source/_components/switch.rest.markdown +++ b/source/_components/switch.rest.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Local Polling" The `rest` switch platform allows you to control a given endpoint that supports a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). The switch can get the state via GET and set the state via POST on a given REST resource. +## {% linkable_title Configuration %} + To enable this switch, add the following lines to your `configuration.yaml` file: ```yaml @@ -93,7 +95,7 @@ switch: resource: http://IP_ADDRESS/led_endpoint body_on: '{"active": "true"}' body_off: '{"active": "false"}' - is_on_template: '{{value_json.is_active}}' + is_on_template: '{{ value_json.is_active }}' headers: Content-Type: application/json ``` diff --git a/source/_components/tts.amazon_polly.markdown b/source/_components/tts.amazon_polly.markdown index 6561bc6d09c..8be1fdc0a5e 100644 --- a/source/_components/tts.amazon_polly.markdown +++ b/source/_components/tts.amazon_polly.markdown @@ -15,6 +15,8 @@ ha_release: 0.37 The `amazon_polly` text-to-speech platform that works with [Amazon Polly](https://aws.amazon.com/polly/) to create the spoken output. Polly is a paid service via Amazon Web Services. There is a [free tier](https://aws.amazon.com/polly/pricing/) for the first 12 months and then a charge per million characters afterwards. +## {% linkable_title Configuration %} + To get started, add the following lines to your `configuration.yaml` (example for Amazon Polly): ```yaml @@ -23,33 +25,62 @@ tts: - platform: amazon_polly aws_access_key_id: AWS_ACCESS_KEY_ID aws_secret_access_key: AWS_SECRET_ACCESS_KEY - profile_name: AWS_PROFILE - region_name: 'us-east-1' - voice: Joanna ``` -Configuration variables: +{% configuration %} +aws_access_key_id: + description: "Your AWS Access Key ID. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`." + required: true + type: string +aws_secret_access_key: + description: "Your AWS Secret Access Key. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`." + required: true + type: string +profile_name: + description: A credentials profile name. For more information, please see the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) for more information. + required: false + type: string +region_name: + description: "The region identifier to connect to. The default is `us-east-1`. See the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions." + required: false + type: string or list +name: + description: "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`." + required: false + type: string +text_type: + description: "Specify wherever to use text (default) or ssml markup by default." + required: false + type: string + default: text +voice: + description: "Voice name to be used. See the [Amazon Documentation](http://docs.aws.amazon.com/polly/latest/dg/voicelist.html) for available voices." + required: false + type: string +output_format: + description: "Override the default output format, e.g., `mp3`, `ogg_vorbis` or `pcm`." + required: false + type: string + default: mp3 +sample_rate: + description: "Override the default sample rate, defaults to 22050 for MP3 and Ogg Vorbis, 16000 for pcm." + required: false + type: string +{% endconfiguration %} -| Parameter | Value | Description | -|---------------------|----------|-------------| -| `aws_access_key_id` | Required | Your AWS Access Key ID. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name` | -| `aws_secret_access_key` | Required | Your AWS Secret Access Key. For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html). If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`. | -| `profile_name` | Optional | A credentials profile name. For more information, please see the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) for more information. | -| `region_name` | Optional | The region identifier to connect to. The default is `us-east-1`. See the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions. | -| `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`. | -| `text_type` | text/ssml | text or ssml: Specify wherever to use text (default) or ssml markup by default. | -| `voice` | Optional | Voice name to be used. See the [Amazon Documentation](http://docs.aws.amazon.com/polly/latest/dg/voicelist.html) for available voices. | -| `output_format` | mp3/ogg_vorbis/pcm | Override the default output format, defaults to MP3. | -| `sample_rate` | 8000/16000/22050 | Override the default sample rate, defaults to 22050 for MP3 and Ogg Vorbis, 16000 for pcm. | -## Usage +## {% linkable_title Usage %} + Say to all `media_player` device entities: + ```yaml - service: tts.amazon_polly_say data_template: message: 'Hello from Amazon Polly' ``` + or + ```yaml - service: tts.amazon_polly_say data_template: