diff --git a/source/_components/media_player.gpmdp.markdown b/source/_components/media_player.gpmdp.markdown index 59bd64ec5b0..18d47bd263a 100644 --- a/source/_components/media_player.gpmdp.markdown +++ b/source/_components/media_player.gpmdp.markdown @@ -10,7 +10,7 @@ footer: true logo: gpmdp.png ha_category: Media Player ha_iot_class: "Local Polling" -ha_release: 0.20 +ha_release: "0.20" --- diff --git a/source/_components/media_player.lg_netcast.markdown b/source/_components/media_player.lg_netcast.markdown index bce6a71e0f8..624854a210c 100644 --- a/source/_components/media_player.lg_netcast.markdown +++ b/source/_components/media_player.lg_netcast.markdown @@ -10,7 +10,7 @@ footer: true logo: lg.png ha_category: Media Player ha_iot_class: "Local Poll" -ha_release: 0.20 +ha_release: "0.20" --- The `lg_netcast` platform allows you to control a LG Smart TV running NetCast 3.0 (LG Smart TV models released in 2012) and NetCast 4.0 (LG Smart TV models released in 2013). For the new LG WebOS TV's use the [webostv](/components/mediaplayer.webostv) platform. diff --git a/source/_components/media_player.roku.markdown b/source/_components/media_player.roku.markdown index e64ac96ecfa..4de5d21de9b 100644 --- a/source/_components/media_player.roku.markdown +++ b/source/_components/media_player.roku.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: roku.png ha_category: Media Player -ha_release: 0.20 +ha_release: "0.20" --- The [Roku](http://www.roku.com/) media players will be automatically discovered if you enable the [discovery component](/components/discovery/). diff --git a/source/_components/notify.aws_lambda.markdown b/source/_components/notify.aws_lambda.markdown index 6f7a873448d..1eee6770b08 100644 --- a/source/_components/notify.aws_lambda.markdown +++ b/source/_components/notify.aws_lambda.markdown @@ -9,10 +9,12 @@ sharing: true footer: true logo: aws_lambda.png ha_category: Notifications -ha_release: 0.20 +ha_release: "0.20" --- -The AWS Lambda notify platform enables invoking [AWS Lambda](https://aws.amazon.com/lambda/) functions. +The `aws_lambda` notification platform enables invoking [AWS Lambda](https://aws.amazon.com/lambda/) functions. + +To use this notification platform in your installation, add the following to your `configuration.yaml` file: ### Configuration @@ -25,7 +27,6 @@ notify: aws_secret_access_key: AWS_SECRET_ACCESS_KEY profile_name: AWS_PROFILE region_name: 'us-east-1' - # Optional context: ... ``` @@ -39,7 +40,7 @@ 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`. - **context** (*Optional*): An optional dictionary you can provide to pass custom context through to the Lambda function. The `context` dictionary (if any) is combined with the same data available at the `/api/config` HTTP API route. -### Usage +### {% linkable_title Usage %} AWS Lambda is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) or a partial ARN. For more information, please see the [boto3 docs](http://boto3.readthedocs.io/en/latest/reference/services/lambda.html#Lambda.Client.invoke). diff --git a/source/_components/notify.aws_sns.markdown b/source/_components/notify.aws_sns.markdown index 03e631f1bb0..f153ee11051 100644 --- a/source/_components/notify.aws_sns.markdown +++ b/source/_components/notify.aws_sns.markdown @@ -9,12 +9,12 @@ sharing: true footer: true logo: aws_sns.png ha_category: Notifications -ha_release: 0.20 +ha_release: "0.20" --- -The AWS SNS notify platform enables publishing to an [AWS SNS](https://aws.amazon.com/sns/) topic or application. +The `aws_sns` notification platform enables publishing to an [AWS SNS](https://aws.amazon.com/sns/) topic or application. -### Configuration +To use this notification platform in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -35,7 +35,7 @@ Configuration variables: - **region_name** (*Required*): The region identifier to connect to. The default is `us-east-1`. - **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`. -### Usage +### {% linkable_title Usage %} AWS SNS is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)). For more information, please see the [boto3 docs](http://boto3.readthedocs.io/en/latest/reference/services/sns.html#SNS.Client.publish). diff --git a/source/_components/notify.aws_sqs.markdown b/source/_components/notify.aws_sqs.markdown index b89bdbc8a06..d4a6c836eb0 100644 --- a/source/_components/notify.aws_sqs.markdown +++ b/source/_components/notify.aws_sqs.markdown @@ -9,12 +9,12 @@ sharing: true footer: true logo: aws_sqs.png ha_category: Notifications -ha_release: 0.20 +ha_release: "0.20" --- -The AWS SQS notify platform enables publishing to an [AWS SQS](https://aws.amazon.com/sqs/) message queue. +The `aws_sqs` notification platform enables publishing to an [AWS SQS](https://aws.amazon.com/sqs/) message queue. -### Configuration +To use this notification platform in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -35,7 +35,7 @@ Configuration variables: - **region_name** (*Required*): The region identifier to connect to. The default is `us-east-1`. - **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`. -### Usage +### {% linkable_title Usage %} AWS SQS is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the [SQS docs](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html). diff --git a/source/_components/notify.ecobee.markdown b/source/_components/notify.ecobee.markdown index a8a4f93c2d2..0eb55d9b7c1 100644 --- a/source/_components/notify.ecobee.markdown +++ b/source/_components/notify.ecobee.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Ecobee Notify" -description: "Instructions how to setup the Ecobee notify component within Home Assistant." +description: "Instructions how to setup the Ecobee notification component within Home Assistant." date: 2016-05-12 09:00 sidebar: true comments: false @@ -9,12 +9,12 @@ sharing: true footer: true logo: ecobee.png ha_category: Notify -ha_release: 0.20 +ha_release: "0.20" --- -To get your Ecobee sensors working with Home Assistant, you must first have the main [Ecobee component](/components/ecobee/) loaded and running. Once you have that configured, you can setup this component to send messages to your thermostat. +To get your Ecobee notifications working with Home Assistant, you must first have the main [Ecobee component](/components/ecobee/) loaded and running. Once you have that configured, you can setup this component to send messages to your Ecobee device. -Add the following to your `configuration.yaml` file: +To use this notification platform in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -26,7 +26,6 @@ notify: 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`. -- **index** (*Optional*): If you have more than one thermostat, you can create a notifier for each one by providing the zero based index for each thermostat. (Default: 0) To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/notify.twilio_sms.markdown b/source/_components/notify.twilio_sms.markdown index 91413c2df3f..f8865443eea 100644 --- a/source/_components/notify.twilio_sms.markdown +++ b/source/_components/notify.twilio_sms.markdown @@ -9,12 +9,12 @@ sharing: true footer: true logo: twilio.png ha_category: Notifications -ha_release: 0.20 +ha_release: "0.20" --- -The `twilio` notify platform enables sending notifications via SMS, powered by [Twilio](https://twilio.com). +The `twilio` notification platform enables sending notifications via SMS, powered by [Twilio](https://twilio.com). -To use this nofification in your installation, add the following to your `configuration.yaml` file: +To use this notification platform in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.lastfm.markdown b/source/_components/sensor.lastfm.markdown index a8c8edbf3f5..b8dc42ff417 100644 --- a/source/_components/sensor.lastfm.markdown +++ b/source/_components/sensor.lastfm.markdown @@ -10,7 +10,7 @@ footer: true logo: lastfm.png ha_category: Sensor ha_iot_class: "Cloud Polling" -ha_release: 0.20 +ha_release: "0.20" --- diff --git a/source/_components/sensor.supervisord.markdown b/source/_components/sensor.supervisord.markdown index 28f7dc41e5a..c51ed73c8f0 100644 --- a/source/_components/sensor.supervisord.markdown +++ b/source/_components/sensor.supervisord.markdown @@ -8,11 +8,13 @@ comments: false sharing: true footer: true ha_category: Sensor -ha_release: 0.20 +ha_release: "0.20" --- The `supervisord` platform allows you to track the states of [Supervisor](http://supervisord.org/). +To use this sensor in your installation, add the following to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry sensor: