@@ -33,13 +29,29 @@ For Home Assistant Cloud Users, documentation can be found [here](https://www.na
-### Requirements
+**Steps to Integrate an Amazon Alexa Smart Home Skill with Home Assistant**
-- Amazon Developer Account. You can sign on [here](https://developer.amazon.com).
-- An [AWS account](https://aws.amazon.com/free/) is need if you want to use Smart Home Skill API. Part of your Smart Home Skill will be hosted on [AWS Lambda](https://aws.amazon.com/lambda/pricing/). However you don't need worry the cost, AWS Lambda allow free to use up to 1 millions requests and 1GB outbound data transfer per month.
-- The Smart Home API also needs your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport), this is so account linking can take place. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Hass.io using the [Duck DNS](/addons/duckdns/) add-on is the easiest method.
+- [Requirements](#requirements)
+- [Create an Amazon Alexa Smart Home Skill](#create-an-amazon-alexa-smart-home-skill)
+- [Create an AWS Lambda Function](#create-an-aws-lambda-function)
+ - [Create an IAM Role for Lambda](#create-an-iam-role-for-lambda)
+ - [Add Code to the Lambda Function](#add-code-to-the-lambda-function)
+ - [Test the Lambda Function](#test-the-lambda-function)
+- [Configure the Smart Home Service Endpoint](#configure-the-smart-home-service-endpoint)
+- [Account Linking](#account-linking)
+- [Alexa Smart Home Component Configuration](#alexa-smart-home-component-configuration)
+- [Supported Integrations](#supported-integrations)
+- [Alexa Web-Based App](#alexa-web-based-app)
+- [Troubleshooting](#troubleshooting)
+- [Debugging](#debugging)
-### Create Your Amazon Alexa Smart Home Skill
+## Requirements
+
+- The Alexa Smart Home API requires your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using an SSL/TLS certificate. A self-signed certificate will work, but a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport) is recommended. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Hass.io using the [Duck DNS](/addons/duckdns/) add-on is the easiest method.
+- Amazon Developer Account. Sign up [here](https://developer.amazon.com).
+- An [Amazon Web Services (AWS)](https://aws.amazon.com/free/) account is required to host the Lambda function for your Alexa Smart Home Skill. [AWS Lambda](https://aws.amazon.com/lambda/pricing/) is free to use for up to 1-million requests and 1GB outbound data transfer per month.
+
+## Create an Amazon Alexa Smart Home Skill
- Sign in [Alexa Developer Console][alexa-dev-console], you can create your free account on the sign in page.
- Go to `Alexa Skills` page if you are not, click `Create Skill` button to start the process.
@@ -53,13 +65,13 @@ For Home Assistant Cloud Users, documentation can be found [here](https://www.na
- In next screen, make sure *v3* is selected in `Payload version`.
- Now, you have created a skeleton of Smart Home skill. Next step we will do some "real" developer work. You can keep Alex Developer Console opened, we need change the skill configuration later.
-### Create Your Lambda Function
+## Create an AWS Lambda Function
Alexa Smart Home skill will trigger a AWS Lambda function to process the request, we will write a small piece of code hosted as an Lambda function basically redirect the request to your Home Assistant instance, then Alexa integration integration in Home Assistant will process the request and send back the response. Your Lambda function will delivery the response back to Alexa.
-There already are some great tutorials and solutions in our community to achieve same goal "Create your Alexa Smart Home Skill to connect Home Assistant", for example: [Haaska](https://github.com/mike-grant/haaska/wiki).
+There already are some great tutorials and solutions in our community to achieve same goal "Create your Alexa Smart Home Skill to connect Home Assistant", for example: [haaska](https://github.com/mike-grant/haaska/wiki).
You can follow this document or others, but you cannot mixed-match different solutions since they may have different design.
@@ -69,7 +81,7 @@ Amazon also provided a [step-by-step guide](https://developer.amazon.com/docs/sm
OK, let's go. You first need sign in your [AWS console](https://console.aws.amazon.com/), if you don't have an AWS account yet, you can create a new user [here](https://aws.amazon.com/free/) with 12-month free tire benefit. You don't need worry the cost if your account already pass the first 12 months, AWS provides up to 1 million Lambda request, 1GB outbound data and all inbound data for free, every month, all users. See [Lambda pricing](https://aws.amazon.com/lambda/pricing/) for details.
-#### Create an IAM Role for Lambda
+### Create an IAM Role for Lambda
First thing you need to do after sing in [AWS console](https://console.aws.amazon.com/) is to create an IAM Role for Lambda execution. AWS has very strict access control, you have to specific define and assign the permissions.
@@ -84,7 +96,7 @@ First thing you need to do after sing in [AWS console](https://console.aws.amazo
- You can skip `Add tags` page, click `Next: Review`.
- Give your new role a name, such as `AWSLambdaBasicExecutionRole-SmartHome`, then click `Create role` button. You should be able to find your new role in the roles list now.
-#### Create a Lambda function and add code
+### Add Code to the Lambda Function
Next you need create a Lambda function.
@@ -92,7 +104,7 @@ Next you need create a Lambda function.
- **IMPORTANT** Your current region will be displayed on the top right corner, make sure you select right region base on your Amazon account's country:
* **US East (N.Virginia)** region for English (US) or English (CA) skills
* **EU (Ireland)** region for English (UK), English (IN), German (DE), Spanish (ES) or French (FR) skills
- * **US West (Oregon)** region for Japanese and English (AU) skills.
+ * **US West (Oregon)** region for Japanese and English (AU) skills.
- Click `Functions` in the left navigation bar, display list of your Lambda functions.
- Click `Create function`, select `Author from scratch`, then input a `Function name`.
- Select *Python 3.6* or *Python 3.7* as `Runtime`.
@@ -100,13 +112,13 @@ Next you need create a Lambda function.
- Click `Create function`, then you can config detail of Lambda function.
- Under `Configuration` tab, expand `Designer`, then click `Alexa Smart Home` in the left part of the panel to add a Alexa Smart Home trigger to your Lambda function.
- Scroll down little bit, you need input the `Skill ID` from the skill you created in previous step. (tips: you may need switch back to Alexa Developer Console to copy the `Skill ID`.
-- Click your Lambda Function icon in the middle of the diagram, scroll down you will see a `Function code` window.
+- Click your Lambda function icon in the middle of the diagram, scroll down you will see a `Function code` window.
- Clear the example code, copy the Python script from: [https://gist.github.com/matt2005/744b5ef548cc13d88d0569eea65f5e5b](https://gist.github.com/matt2005/744b5ef548cc13d88d0569eea65f5e5b) (modified code to support Alexa's proactive mode, see details below)
- Scroll down a little bit, you will find `Environment variables`, you need add 4 environment variables:
* BASE_URL *(required)*: your Home Assistant instance's Internet accessible URL with port if needed. *Do not include the trailing `/`*.
* NOT_VERIFY_SSL *(optional)*: you can set it to *True* to ignore the SSL issue, if you don't have a valid SSL certificate or you are using self-signed certificate.
* DEBUG *(optional)*: set to *True* to log the debug message
- * LONG_LIVED_ACCESS_TOKEN *(optional, not recommend)*: you will connect your Alexa Smart Home skill with your Home Assistant user account in the later steps, so that you don't need to use long-lived access token here. However, the access token you got from login flow is only valid for 30 minutes. It will be hard for you to test lambda function with the access token in test data. So for your convinces, you can remove the access token from the test data, [generate a long-lived access token][generate-long-lived-access-token] put here, then the function will fall back to read token from environment variables. (tips: You did not enable the security storage for your environment variables, so your token saved here is not that safe. You should only use it for debugging and testing purpose. You should remove and delete the long-lived access token after you finish the debugging.)
+ * LONG_LIVED_ACCESS_TOKEN *(optional, not recommend)*: you will connect your Alexa Smart Home skill with your Home Assistant user account in the later steps, so that you don't need to use long-lived access token here. However, the access token you got from login flow is only valid for 30 minutes. It will be hard for you to test lambda function with the access token in test data. So for your convinces, you can remove the access token from the test data, [generate a long-lived access token][generate-long-lived-access-token] put here, then the function will fall back to read token from environment variables. (tips: You did not enable the security storage for your environment variables, so your token saved here is not that safe. You should only use it for debugging and testing purpose. You should remove and delete the long-lived access token after you finish the debugging.)
@@ -115,9 +127,9 @@ Next you need create a Lambda function.
- Now scroll up to the top, click `Save` button.
- You need copy the ARN displayed in the top of the page, which is the identify of this Lambda function. You will need this ARN to continue Alexa Smart Home skill configuration later.
-#### Test the Lambda function
+### Test the Lambda Function
-Now, you have created the Lambda function, before you can test it, you have to set up your Home Assistant. Put following minimal configuration to your configuration.yaml, it will exposures all of your supported device and automation to Alexa. Check the [configuration section](#alexa-component-configuration) if you want more control of the exposure.
+Now, you have created the Lambda function, before you can test it, you have to set up your Home Assistant. Put following minimal configuration to your configuration.yaml, it will exposures all of your supported device and automation to Alexa. Check the [configuration section](#alexa-smart-home-component-configuration) if you want more control of the exposure.
```yaml
alexa:
@@ -152,9 +164,9 @@ Click `Test` button. If you don't have `LONG_LIVED_ACCESS_TOKEN`, you will get a
Now, you can login to your Home Assistant and [generate a long-lived access token][generate-long-lived-access-token]. After you put your long-lived access token to the `Environment variable`, do not forget click `Save` button before you `Test` again.
-This time, you will get a list of your devices as the response. 🎉
+This time, you will get a list of your devices in the response. 🎉
-### Config the Smart Home Service Endpoint
+## Configure the Smart Home Service Endpoint
Now removed the long-lived access token if you want, copied the ARN of your Lambda function, then back to [Alexa Developer Console][alexa-dev-console]. You will finish the configuration of the Smart Home skill.
@@ -163,7 +175,7 @@ Now removed the long-lived access token if you want, copied the ARN of your Lamb
- Click `SMART HOME` in the left navigation bar of build page.
- Fill in `Default endpoint` under `2. Smart Home service endpoint` using the `ARN` you copied from your Lambda function configuration.
-### Account Linking
+## Account Linking
Alexa can link your Amazon account to your Home Assistant account. Therefore Home Assistant can make sure only authenticated Alexa request be able to access your home's devices. In order to link the account, you have to make sure your Home Assistant can be accessed from Internet.
@@ -178,7 +190,7 @@ Alexa can link your Amazon account to your Home Assistant account. Therefore Hom
- https://pitangui.amazon.com/ if you are in US
- https://layla.amazon.com/ if you are in EU
- https://alexa.amazon.co.jp/ if you are in JP and AU (not verified yet)
-
+
The trailing slash is important here.
* `Client Secret`: input anything you like, Home Assistant does not check this field
@@ -197,10 +209,10 @@ Alexa can link your Amazon account to your Home Assistant account. Therefore Hom
* Click `Enable`.
* A new window will open to direct you to your Home Assistant's login screen.
* After you success login, you will be redirected back to Alexa app.
- * You can discovery your devices now.
-- Now, you can ask your Echo or in Alexa App, *turn on bedroom* 🎉
+ * You can discovery your devices now.
+- Now, you can ask your Echo or in Alexa App, _"Alexa, turn on bedroom"_ 🎉
-### Alexa Component Configuration
+## Alexa Smart Home Component Configuration
Example configuration:
@@ -209,8 +221,8 @@ alexa:
smart_home:
locale: en-US
endpoint: https://api.amazonalexa.com/v3/events
- client_id: !secret alexa_client_id
- client_secret: !secret alexa_client_secret
+ client_id: YOUR_SKILL_CLIENT_ID
+ client_secret: YOUR_SKILL_CLIENT_SECRET
filter:
include_entities:
- light.kitchen
@@ -221,13 +233,110 @@ alexa:
- switch.outside
entity_config:
light.kitchen:
- name: Custom Name for Alexa
- description: The light in the kitchen
+ name: "Custom Name for Alexa"
+ description: "The light in the kitchen"
switch.stairs:
display_categories: LIGHT
```
+{% configuration %}
+alexa:
+ description: Alexa configuration
+ required: true
+ type: map
+ keys:
+ smart_home:
+ description: Alexa Smart Home configuration
+ required: true
+ type: map
+ keys:
+ locale:
+ description: The locale of your Alexa devices. Supported locales are `de-DE`, `en-AU`, `en-CA`, `en-GB`, `en-IN`, `en-US`, `es-ES`, `es-MX`, `fr-CA`, `fr-FR`, `it-IT`, `ja-JP`. See [Alexa Locale](#alexa-locale) for additional information.
+ required: false
+ type: string
+ default: en-US
+ endpoint:
+ description: >-
+ To enable proactive events, you send a message to the Alexa event gateway, send it to the event endpoint that aligns with the geographic availability of your smart home skill. Following is the list of endpoints and the regions they cover. See [Proactive Events](#proactive-events) for more information.
+ * North America: `https://api.amazonalexa.com/v3/events`
+ * Europe: `https://api.eu.amazonalexa.com/v3/events`
+ * Far East: `https://api.fe.amazonalexa.com/v3/events`
+ required: false
+ type: string
+ client_id:
+ description: See [Proactive Events](#proactive-events) for more information.
+ required: false
+ type: string
+ client_secret:
+ description: See [Proactive Events](#proactive-events) for more information.
+ required: false
+ type: string
+ filter:
+ description: Filter domains and entities for Alexa.
+ required: true
+ type: map
+ keys:
+ include_domains:
+ description: List of domains to include (e.g., `light`).
+ required: false
+ type: list
+ exclude_domains:
+ description: List of domains to exclude (e.g., `light`).
+ required: false
+ type: list
+ include_entities:
+ description: List of entities to include (e.g., `light.attic`).
+ required: false
+ type: list
+ exclude_entities:
+ description: List of entities to include (e.g., `light.attic`).
+ required: false
+ type: list
+ entity_config:
+ description: Configuration for specific entities. All subordinate keys are the corresponding entity ids or the domains, e.g., `alarm_control_panel.woowoo`.
+ required: false
+ type: map
+ keys:
+ '``':
+ description: Additional options for specific entities.
+ required: false
+ type: map
+ keys:
+ name:
+ description: Name of the entity to show in Amazon Alexa App.
+ required: false
+ type: string
+ description:
+ description: Description of the entity to show in Amazon Alexa App.
+ required: false
+ type: string
+ display_categories:
+ description: >-
+ Display category and iconography each entity is shown in the Alexa app. Separate each category with a comma. First category is primary. e.g., `MUSIC_SYSTEM,STREAMING_DEVICE,SPEAKER`. See [Alexa Display Categories](#alexa-display-categories) for a list of available categories.
+ required: false
+ type: string
+{% endconfiguration %}
-Set the `locale` to the locale of your Alexa devices. Supported locales are: `de-DE`, `en-AU`, `en-CA`, `en-GB`, `en-IN`, `en-US`, `es-ES`, `es-MX`, `fr-CA`, `fr-FR`, `it-IT`, `ja-JP`. Default is `en-US`.
+### Alexa Locale
+
+The `locale` should match the location and language used for your Amazon echo devices.
+
+The supported locales are:
+- `de-DE`
+- `en-AU`
+- `en-CA`
+- `en-GB`
+- `en-IN`
+- `en-US`
+- `es-ES`
+- `es-MX`
+- `fr-CA`
+- `fr-FR`
+- `it-IT`
+- `ja-JP`
+
+See [List of Capability Interfaces and Supported Locales][alexa-supported-locales].
+
+### Proactive Events
The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode (i.e. "Send Alexa Events" enabled). Please note the following if you want to enable proactive mode:
@@ -235,19 +344,575 @@ The `endpoint`, `client_id` and `client_secret` are optional, and are only requi
- The `client_id` and `client_secret` are not the ones used by the skill that have been set up using "Login with Amazon" (in the [Alexa Developer Console][amazon-dev-console]: Build > Account Linking), but rather from the "Alexa Skill Messaging" (in the Alexa Developer Console: Build > Permissions > Alexa Skill Messaging). To get them, you need to enable the "Send Alexa Events" permission.
- If the "Send Alexa Events" permission was not enabled previously, you need to unlink and relink the skill using the Alexa App, or else Home Assistant will show the following error: "Token invalid and no refresh token available. Also, you need to restart your Home Assistant after each disabling/enabling the skill in Alexa."
-### Alexa web-based app
+### Configure Filter
+
+By default, no entity will be excluded. To limit which entities are being exposed to Alexa, you can use the `filter` parameter. Keep in mind that only [supported components](#supported-integrations) can be added.
+
+{% raw %}
+```yaml
+# Example filter to include specified domains and exclude specified entities
+alexa:
+ smart_home:
+ filter:
+ include_domains:
+ - alarm_control_panel
+ - light
+ exclude_entities:
+ - light.kitchen_light
+```
+{% endraw %}
+
+Filters are applied as follows:
+
+1. No includes or excludes - pass all entities
+2. Includes, no excludes - only include specified entities
+3. Excludes, no includes - only exclude specified entities
+4. Both includes and excludes:
+ * Include domain specified
+ - if domain is included, and entity not excluded, pass
+ - if domain is not included, and entity not included, fail
+ * Exclude domain specified
+ - if domain is excluded, and entity not included, fail
+ - if domain is not excluded, and entity not excluded, pass
+ - if both include and exclude domains specified, the exclude domains are ignored
+ * Neither include or exclude domain specified
+ - if entity is included, pass (as #2 above)
+ - if entity include and exclude, the entity exclude is ignored
+
+See the [troubleshooting](#troubleshooting) if for issues setting up the integration.
+
+### Alexa Display Categories
+
+Configure a display category to override the display category and iconography each entity is shown in the Alexa app. This makes it easier to find and monitor devices.
+
+```yaml
+light.kitchen_light:
+ display_categories: LIGHT,SWITCH
+```
+
+
+Devices such as cameras, doorbells, garage doors, and alarm control panels require specific display categories to provide all available features from Amazon Alexa. Overriding the default display category will limit features provided by Amazon Alexa.
+
+
+See [Alexa Display Categories][alexa-display-categories] for a complete list
+
+## Supported Platforms
+
+Home Assistant supports the following integrations through Alexa using a Smart Home Skill. For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/amazon_alexa/).
+
+The following integrations are currently supported:
+- [Alarm Control Panel](#alarm-control-panel)
+- [Alert](#alert-automation-group-input-boolean)
+- [Automation](#alert-automation-group-input-boolean)
+- [Binary Sensor](#binary-sensor)
+ - [Doorbell Announcement](#doorbell-announcement)
+ - [Presence Detection](#presence-detection-with-binary-sensor)
+- [Climate](#climate)
+- [Cover](#cover)
+ - [Garage Doors](#garage-doors)
+- [Fan](#fan)
+ - [Fan Speed](#fan-speed)
+ - [Fan Direction](#fan-direction)
+ - [Fan Oscillation](#fan-oscillation)
+- [Group](#alert-automation-group-input-boolean)
+- [Input Boolean](#alert-automation-group-input-boolean)
+- [Input Number](#input-number)
+- [Image Processing](#image-processing)
+- [Light](#light)
+- [Lock](#lock)
+- [Media Player](#media-player)
+ - [Channels](#change-channel)
+ - [Speakers](#speaker-volume)
+ - [Sound Mode & Equalizers](#equalizer-mode)
+ - [Inputs](#inputs)
+ - [Payback Control](#seek)
+- [Scene](#scene)
+- [Script](#script)
+- [Sensor](#sensor)
+- [Switch](#switch)
+- [Timer](#timer)
+- [Vacuum](#vacuum)
+
+### Alarm Control Panel
+
+Arm and disarm Alarm Control Panel entities. Ask Alexa for the state of the Alarm Control Panel entity.
+
+* _"Alexa, arm my home in away mode."_
+* _"Alexa, arm my home."_
+* _"Alexa, disarm my home."_
+* _"Alexa, is my home armed?"_
+
+#### Arming
+
+The Alarm Control Panel state must be in the `disarmed` state before arming. Alexa does not support switching from an armed state without first disarming, e.g., switching from `armed_home` to `armed_night`.
+
+The Alarm Control Panel state `armed_custom_bypass` isn't supported by Alexa and is treated as `armed_home`.
+
+
+
+Alexa does not support arming with voice PIN at this time. Therefore if the Alarm Control Panel requires a `code` for arming or the `code_arm_required` attribute is `true`, the entity will not be exposed during discovery.
+The Alarm Control Panel may default the `code_arm_required` attribute to `true` even if the platform does not support or require it. Use the [Entity Customization Tool](/docs/configuration/customizing-devices/#customization-using-the-ui) to override `code_arm_required` to `false` and expose the Alarm Control Panel during discovery.
+
+
+
+#### Disarming
+
+Users must opt-in to the disarm by voice feature in the Alexa App. Alexa will require a 4 digit voice personal identification number (PIN) for disarming. Configure a 4 digit PIN in the Alexa app, or use an existing 4 digit PIN code configured for the Alarm Control Panel.
+
+
+
+ 
+
+
+To use the exiting code configured for the Alarm Control Panel the `code` must be 4 digits and the `code_format` attribute must be `FORMAT_NUMBER`. After discovery, the Alexa app will offer the ability to use the existing `code`, or create an additional 4 digit PIN to use with Alexa.
+
+The existing code is never communicated to Alexa from Home Assistant. During disarming, Alexa will ask for a PIN. The PIN spoken to Alexa is relayed to Home Assistant and passed to the `alarm_control_panel.alarm_disarm` service. If the `alarm_control_panel.alarm_disarm` service fails for any reason, it is assumed the PIN was incorrect and reported to Alexa as an invalid PIN.
+
+### Alert, Automation, Group, Input Boolean
+
+Turn on and off Alerts, Automations, Groups, and Input Boolean entities as switches.
+
+* _"Alexa, turn on the front door alert."_
+* _"Alexa, turn off energy saving automations."_
+* _"Alexa, Downstairs to on."_
+
+### Binary Sensor
+
+Requires [Proactive Events](#proactive-events) enabled.
+
+Binary Sensors with a [`device_class`](/integrations/binary_sensor/#device-class) attribute of `door` `garage_door` `opening` `window` `motion` `presense` are supported.
+
+|`device_class`|Alexa Sensor Type|
+| :---: | :---: |
+|`door`|Contact|
+|`garage_door`|Contact|
+|`opening`|Contact|
+|`window`|Contact|
+|`motion`|Motion|
+|`presense`|Motion|
+
+Ask Alexa for the state of a contact sensor.
+
+* _"Alexa, is the bedroom window open?"_
+
+#### Routines
+
+Requires [Proactive Events](#proactive-events) enabled.
+
+Alexa Routines can be triggered with Binary Sensors exposed as contact or motion sensors.
+
+Use the [Entity Customization Tool](/docs/configuration/customizing-devices/#customization-using-the-ui) to override the `device_class` attribute to expose a `binary_sensor` to Alexa.
+
+#### Doorbell Announcement
+
+Requires [Proactive Events](#proactive-events) enabled.
+
+Configure a `binary_sensor` with `display_category` of `DOORBELL` in the [`entity_config`](#entity_config) to gain access to the doorbell notification settings in the Alexa App.
+```yaml
+alexa:
+ smart_home:
+ entity_config:
+ binary_sensor.alexa_doorbell:
+ name: "Front Door"
+ description: "Doorbell Binary Sensor"
+ display_categories: DOORBELL
+```
+
+Alexa will announce on all echo devices _"Someone is at the [entity name]"_ when a `binary_sensor` state changes from `off` to `on`.
+
+
+Each Amazon Echo device will need the communication and announcements setting enabled, and the Do Not Disturb feature turned off.
+
+
+
+
+ 
+
+
+#### Presence Detection with Binary Sensor
+
+Requires [Proactive Events](#proactive-events) enabled.
+
+Configure a `binary_sensor` that has a `device_class` attribute of `motion` or `presence` and configure `display_category` to `CAMERA` in the [`entity_config`](#entity_config) to gain access the presence detected notification settings in the Alexa App.
+
+```yaml
+alexa:
+ smart_home:
+ entity_config:
+ binary_sensor.driveway_presence:
+ name: "Driveway"
+ description: "Driveway Presence Sensor"
+ display_categories: CAMERA
+```
+
+Alexa will announce on all echo devices _"Person detected at [entity name]"_.
+
+
+
+Each Echo device will need the communication and Announcements setting enabled, and the Do Not Disturb feature turned off.
+
+
+
+
+
+ 
+
+
+[Image Processing](#image-processing) entities also support this notification.
+
+### Climate
+
+Single, double, and triple set-point thermostats are supported. The temperature value from the thermostat will also be exposed at a separate [temperature sensor](#sensor).
+#### Set Thermostat Temperature
+
+* _"Alexa, set thermostat to 20."_
+* _"Alexa, set the AC to 75."_
+* _"Alexa, make it warmer in here."_
+* _"Alexa, make it cooler in here."_
+
+#### Thermostat Mode
+
+* _"Alexa, set living room thermostat to automatic."_
+
+- `DRY` is shown in Alexa app as `DEHUMIDIFY`
+- `ECO` is handled as a `preset` in Home Assistant, and will not display in the Alexa app.
+- `FAN_ONLY` is not supported by the Alexa voice model and is shown as `OFF` in the Alexa App.
+
+To change the thermostat mode, the exact utterance must be used:
+
+* _"Alexa, set [entity name] to [mode utterance]."_
+
+If the climate entity supports on/off, use _"turn on"_ and _"turn off"_ utterances with the entity name or the mode utterance.
+
+* _"Alexa, turn on the [mode utterance]."_
+* _"Alexa, turn off the [entity name]."_
+
+Alexa supports the following utterances value for climate thermostat mode:
+
+|HA Climate Mode | Alexa Mode Utterances |
+|--- |--- |
+|`AUTO` | _"auto"_, _"automatic"_|
+|`COOL` | _"cool"_, _"cooling"_|
+|`HEAT` | _"heat"_, _"heating"_|
+|`ECO` | _"eco"_, _"economical"_|
+|`DRY` | _"dry"_, _"dehumidify"_|
+|`OFF` | _"off"_|
+
+### Cover
+
+Covers should be configured with the appropriate `device_class`.
+
+Covers with a `device_class` of `blind`, `shade`, `curtin` are shown as an Interior Blind in the Alexa App and Covers with a `window`, `awning`, or `shutter` will show as an Exterior Blind.
+
+Covers with the `device_class` of `garage` are shown as a [Garage Door](#garage-doors) and support the Open by Voice PIN feature.
+
+Use the [Entity Customization Tool](/docs/configuration/customizing-devices/#customization-using-the-ui) to override the `device_class` attribute to correctly expose a `cover` to Alexa.
+
+#### Open/Close/Raise/Lower
+
+Home Assistant configures covers with semantics that provide _"raise"_, _"lower"_, _"open"_, _"close"_ utterances for covers. In addition to semantics _"turn on"_ / _"turn off"_ utterances will also work.
+
+* _"Alexa, open the garage door."_
+* _"Alexa, close the curtain."_
+* _"Alexa, lower the shades."_
+* _"Alexa, raise the roof!"_
+
+Semantics are assigned based on the features supported by the cover. If the cover supports tilt functionality, the semantics _"open"_ and _"close"_ are assigned to the tilt functionality, and the semantics _"raise"_ and _"lower"_ are assigned to the position functionality.
+
+If the cover does not support tilt, all semantics _"raise"_, _"lower"_, _"open"_, _"close"_ are assigned to the position functionality.
+
+#### Set Cover Position
+
+Covers that support a set position can be controlled using percentages.
+
+* _"Alexa, set the [entity name] position to thirty percent."_
+* _"Alexa, increase [entity name] position by ten percent."_
+* _"Alexa, decrease [entity name] position by twenty percent."_
+
+|Locale|Friendly Name Synonyms|
+|---|---|
+|`en-US`|_"position"_, _"opening"_|
+
+Currently, Alexa only supports friendly name synonyms for the `en-US` locale.
+
+#### Set Cover Tilt
+
+Covers that support tilt position can be controlled using percentages.
+
+* _"Alexa, set the [entity name] tilt to thirty percent."_
+* _"Alexa, increase [entity name] tilt by ten percent."_
+* _"Alexa, decrease [entity name] tilt by twenty percent."_
+
+|Locale|Friendly Name Synonyms|
+|---|---|
+|`en-US`|_"tilt"_, _"angle"_, _"direction"_|
+
+Currently, Alexa only supports friendly name synonyms for the `en-US` locale.
+
+#### Garage Doors
+
+Covers with a `device_class` of `garage` support the Open by Voice PIN feature in the Alexa app. Configure a 4 digit PIN code to open the garage door in the Alexa app.
+
+
+
+ 
+
+
+### Fan
+
+Control fan speed, direction, and oscillation.
+
+#### Fan Speed
+
+The fan device must support the `speed` attribute. `speed` can be set using a percentage or a range value determined from the `speed_list` attribute.
+
+* _"Alexa, set the fan speed to three."_
+* _"Alexa, set the fan speed to fifty percent."_
+* _"Alexa, set the fan power level to fifty percent."_
+* _"Alexa, turn up the speed on the tower fan."_
+* _"Alexa, set the air speed on the tower fan to maximum."_
+
+The `speed_list` attribute is used to determine the range value. For example, using a `speed_list` consisting of `[off, low, medium, high]` the range values would be `0:off`, `1:low`, `2:medium`, `3:high`.
+
+The following table lists the possible friendly name synonyms available for a fan with `speed_list: [off, low, medium, high]`.
+
+|Fan Range|Friendly Name Synonyms|
+|---|---|
+|0|_"zero"_, _"off"_|
+|1|_"one"_, _"thirty-three percent"_, _"low"_, _"minimum"_, _"min"_|
+|2|_"two"_, _"sixty-six percent"_, _"medium"_|
+|3|_"three"_, _"one hundred percent"_, _"high"_, _"maximum"_, _"max"_|
+
+The following synonyms can be used for _"fan speed"_
+
+|Locale|Friendly Name Synonyms|
+|---|---|
+|`en-US`|_"fan speed"_, _"airflow speed"_, _"wind speed"_, _"air speed"_, _"air velocity"_, _"power level"_|
+
+Currently, Alexa only supports friendly name synonyms for the `en-US` locale.
+
+#### Fan Direction
+
+The fan device must support the `direction` attribute.
+
+* _"Alexa, set the fan direction to forward."_
+* _"Alexa, set the fan direction to reverse."_
+
+#### Fan Oscillation
+
+The fan device must support the `oscillating` attribute.
+
+* _"Alexa, is oscillate on for the tower fan?"_
+* _"Alexa, turn on swivel for the tower fan."_
+* _"Alexa, turn on oscillation mode for the table fan."_
+
+|Locale|Friendly Name Synonyms|
+|---|---|
+|`en-US`|_"oscillate"_, _"swivel"_, _"oscillation"_, _"spin"_, _"back and forth"_|
+
+Currently, Alexa only supports friendly name synonyms for the `en-US` locale.
+
+### Image Processing
+
+Requires [Proactive Events](#proactive-events) enabled.
+
+#### Presence Detection Notification
+
+All `image_processing` entities support the presence detected notification settings in the Alexa App. Any state change will trigger the notification.
+
+Alexa will announce on all echo devices _"Person detected at [entity name]"_.
+
+
+
+
+
+
+
+
+Display category will default to `CAMERA` to enable presence detected notification settings in the Alexa App. Each Echo device will need the communication and Announcements setting enabled, and the Do Not Disturbed feature turned off.
+
+
+
+### Input Number
+
+Control an `input_number` entity with Alexa. Configures Alexa with the `min`, `max`, `step`, and `unit_of_measurement` attributes for the entity.
+
+* _"Alexa, set [entity name] to forty five [unit of measurement]."_
+* _"Alexa, increase the [entity name] by two."_
+* _"Alexa, set the [entity name] to maximum."_
+
+The following table lists the possible friendly name synonyms available for a Input Number with `min: -90, max: 90, step: 45, unit_of_measurement: degrees`.
+
+|Fan Range|Friendly Name Synonyms|
+|---|---|
+|-90|_"negative ninety"_, _"minimum"_, _"min"_|
+|-45|_"negative forty five"_|
+|0|_"zero"_|
+|45|_"forty five"_|
+|90|_"ninety"_, _"maximum"_, _"max"_|
+
+### Light
+
+* _"Alexa, dim the bathroom light."_
+* _"Alexa, set the bedroom light to fifty percent."_
+
+### Lock
+
+* _"Alexa, lock my front door."_
+* _"Alexa, unlock the dungeon."_
+
+#### Unlocking
+
+To unlock, Alexa will require a 4 digit voice personal identification number (PIN) for unlocking. Configure a 4 digit PIN in the Alexa app to unlock locks.
+
+### Media Player
+
+#### Change Channel
+
+* _"Alexa, change the channel to 200 on the Living Room TV."_
+* _"Alexa, change the channel to PBS on the TV."_
+* _"Alexa, next channel on the Living Room TV."_
+* _"Alexa, channel up on the TV."_
+* _"Alexa, channel down on the TV."_
+
+#### Speaker Volume
+
+* _"Alexa, set the volume of the speakers to 50."_
+* _"Alexa, turn the volume down on the stereo by 20."_
+* _"Alexa, turn the volume down on Living Room TV."_
+* _"Alexa, mute speakers."_
+* _"Alexa, unmute speakers."_
+* _"Alexa, lower the volume on the stereo."_
+* _"Alexa, volume up 20 on the speakers."_
+
+#### Equalizer Mode
+
+Supports changing the Media Player `sound_mode` from the preset `sound_mode_list`.
+
+* _"Alexa, set mode to movie on the TV."_
+
+Alexa only supports the following modes: `movie`, `music`, `night`, `sport`, `tv`.
+
+#### Inputs
+
+Supports changing the Media Player `source` from the preset `source_list`.
+
+* _"Alexa, change the input to DVD on the Living Room TV."_
+
+Home Assistant will attempt to translate the the `media_player` `source_list` into a valid `source` name for Alexa. Alexa only supports the following input names:
+
+`AUX 1`, `AUX 2`, `AUX 3`, `AUX 4`, `AUX 5`, `AUX 6`, `AUX 7`, `BLURAY`, `CABLE`, `CD`, `COAX 1`, `COAX 2`, `COMPOSITE 1`, `DVD`, `GAME`, `HD RADIO`, `HDMI 1`, `HDMI 2`, `HDMI 3`, `HDMI 4`, `HDMI 5`, `HDMI 6`, `HDMI 7`, `HDMI 8`, `HDMI 9`, `HDMI 10`, `HDMI ARC`, `INPUT 1`, `INPUT 2`, `INPUT 3`, `INPUT 4`, `INPUT 5`, `INPUT 6`, `INPUT 7`, `INPUT 8`, `INPUT 9`, `INPUT 10`, `IPOD`, `LINE 1`, `LINE 2`, `LINE 3`, `LINE 4`, `LINE 5`, `LINE 6`, `LINE 7`, `MEDIA PLAYER`, `OPTICAL 1`, `OPTICAL 2`, `PHONO`, `PLAYSTATION`, `PLAYSTATION 3`, `PLAYSTATION 4`, `SATELLITE`, `SMARTCAST`, `TUNER`, `TV`, `USB DAC`, `VIDEO 1`, `VIDEO 2`, `VIDEO 3`, `XBOX`
+
+#### Playback State
+
+Requires [Proactive Events](#proactive-events) enabled.
+
+#### Seek
+
+* _"Alexa, skip 30 seconds on device."_
+* _"Alexa, go back 10 seconds on device."_
+
+### Scene
+
+Activate scenes with scene name, or _"turn on"_ utterance. Home Assistant does not support deactivate or _"turn off"_ for scenes at this time.
+
+* _"Alexa, Party Time."_
+* _"Alexa, turn on Party Time."_
+
+### Script
+
+Run script with script name, or _"turn on"_ utterance. Deactivate a running script with _"turn off"_ utterance.
+
+* _"Alexa, Party Time."_
+* _"Alexa, turn on Party Time."_
+* _"Alexa, turn off Party Time."_
+
+### Sensor
+
+Requires [Proactive Events](#proactive-events) enabled.
+
+Only temperature sensors are configured at this time.
+
+* _"Alexa, what's the temperature in the kitchen?"_
+* _"Alexa, what's the upstairs temperature?"_
+* _"Alexa, what's the temperature of my ex-girlfriend's heart?"_
+
+### Switch
+
+Support _"turn on"_ and _"turn off"_ utterances.
+
+* _"Alexa, turn on the vacuum."_
+* _"Alexa, turn off the lights."_
+
+### Timer
+
+Start, Pause, and Restart Timer entities in Home Assistant.
+
+* _"Alexa, pause the microwave."_
+* _"Alexa, hold the sous vide."_
+* _"Alexa, restart the microwave."_
+
+
+To avoid issues with Alexa built in timer functionality. The timer entity can not include the word "timer" in the friendly name.
+
+
+### Vacuum
+
+Support _"turn on"_ and _"turn off"_ utterances. Pause and Resume
+
+* _"Alexa, turn on the vacuum."_
+* _"Alexa, pause the vacuum."_
+* _"Alexa, restart the vacuum."_
+
+## Alexa Web-Based App
The following is a list of regions and the corresponding URL for the web-based Alexa app:
+ * United States: `https://alexa.amazon.com`
+ * United Kingdom: `https://alexa.amazon.co.uk`
+ * Germany: `https://alexa.amazon.de`
+ * Japan: `https://alexa.amazon.co.jp`
+ * Canada: `https://alexa.amazon.ca`
+ * Australia: `https://alexa.amazon.com.au`
+ * India: `https://alexa.amazon.in`
+ * Spain: `https://alexa.amazon.es`
-* United States:
-* United Kingdom:
-* Germany:
-* Japan:
-* Canada:
-* Australia:
-* India:
-* Spain:
+## Troubleshooting
+
+### Binary Sensor not available in Routine Trigger
+
+Binary Sensors with a [`device_class`](/integrations/binary_sensor/#device-class) attribute of `door` `garage_door` `opening` `window` `motion` `presense` are supported.
+
+Use the [Entity Customization Tool](/docs/configuration/customizing-devices/#customization-using-the-ui) to override the `device_class` attribute to expose a `binary_sensor` to Alexa.
+
+### Token Invalid and no Refresh Token Available
+
+Disable and re-enable the skill using the Alexa App; then restart Home Assistant.
+
+## Debugging
+
+The Alexa integration will log additional information about state updates and other messages when the log level is set to `debug`. Add the relevant line below to the `configuration.yaml`:
+
+If using Alexa with an Alexa Smart Home Skill and Lambda function such as haaska:
+
+```yaml
+logger:
+ default: info
+ logs:
+ homeassistant.components.alexa: debug
+```
+
+If using Home Assistant Cloud you also need to debug `hass_nubucasa.iot`:
+
+```yaml
+logger:
+ default: info
+ logs:
+ homeassistant.components.alexa: debug
+ hass_nabucasa.iot: debug
+```
[alexa-dev-console]: https://developer.amazon.com/alexa/console/ask
[emulated-hue-component]: /integrations/emulated_hue/
[generate-long-lived-access-token]: https://developers.home-assistant.io/docs/en/auth_api.html#long-lived-access-token
+[alexa-display-categories]: https://developer.amazon.com/docs/alexa/device-apis/alexa-discovery.html#display-categories
+[alexa-supported-locales]: https://developer.amazon.com/docs/alexa/device-apis/list-of-interfaces.html
diff --git a/source/_integrations/apcupsd.markdown b/source/_integrations/apcupsd.markdown
index b7572a5ec51..27052df885a 100644
--- a/source/_integrations/apcupsd.markdown
+++ b/source/_integrations/apcupsd.markdown
@@ -19,9 +19,9 @@ There is currently support for the following device types within Home Assistant:
## Hass.io Installation
-Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/) to use this integration with Hass.io. Keep in mind that we can't give you support for this add-on.
+Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/) to use this integration with Hass.io. Keep in mind that we can't give you support for this add-on.
-After installation, follow the instructions on the Github page to configure the plugin. Then continue to follow the integration configurations below.
+After installation, follow the instructions on the GitHub page to configure the plugin. Then continue to follow the integration configurations below.
## Configuration
@@ -97,7 +97,7 @@ resources:
type: list
{% endconfiguration %}
-### Example
+### Example
Given the following output from `apcaccess`:
diff --git a/source/_integrations/apple_tv.markdown b/source/_integrations/apple_tv.markdown
index a06ec891a1d..0428288424a 100644
--- a/source/_integrations/apple_tv.markdown
+++ b/source/_integrations/apple_tv.markdown
@@ -26,7 +26,7 @@ Currently, you must have Home Sharing enabled for this to work. Support for pair
To use this component, you must first install some system libraries and a compiler. For Debian or a similar system, this should be enough:
```shell
-$ sudo apt-get install build-essential libssl-dev libffi-dev python-dev
+sudo apt-get install build-essential libssl-dev libffi-dev python-dev
```
If you want to discover new devices automatically, just make sure you have `discovery:` in your `configuration.yaml` file. To manually add one or more Apple TVs to your installation, add the following to your `configuration.yaml` file:
@@ -78,7 +78,7 @@ In order to connect to the device, you need a *login id*. The easiest way to obt
Make sure Home Sharing is enabled on the Apple TV.
-To scan for devices and determine the `login_id`, open the developer tools by selecting the hammer icon in the sidebar. Once in the developer tools select **services**.
+To scan for devices and determine the `login_id`, open the developer tools by selecting the hammer icon in the sidebar. Once in the developer tools select **services**.
@@ -106,9 +106,9 @@ Just copy and paste the `login_id` from the device you want to add. For more det
If you, when playing media with `play_url`, get the following error message:
-*“This AirPlay connection requires iOS 7.1 or later, OS X 10.10 or later, or iTunes 11.2 or later.”*
+“This AirPlay connection requires iOS 7.1 or later, macOS 10.10 or later, or iTunes 11.2 or later.”
-then device authentication is required, open the developer tools by selecting the hammer icon in the sidebar. Once in the developer tools select **services**.
+then device authentication is required, open the developer tools by selecting the hammer icon in the sidebar. Once in the developer tools select **services**.
diff --git a/source/_integrations/beewi_smartclim.markdown b/source/_integrations/beewi_smartclim.markdown
index b83c9908929..9380153b7a7 100644
--- a/source/_integrations/beewi_smartclim.markdown
+++ b/source/_integrations/beewi_smartclim.markdown
@@ -21,7 +21,7 @@ Depending on the operating system you're running, you have to configure the prop
- On other Linux systems:
- Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one.
- Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`.
-- Windows and MacOS are currently not supported by the `btlewrap` library.
+- Windows and macOS are currently not supported by the `btlewrap` library.
## Configuration
diff --git a/source/_integrations/binary_sensor.mysensors.markdown b/source/_integrations/binary_sensor.mysensors.markdown
index 8b42a3c5504..28f19636164 100644
--- a/source/_integrations/binary_sensor.mysensors.markdown
+++ b/source/_integrations/binary_sensor.mysensors.markdown
@@ -9,31 +9,31 @@ ha_release: 0.14
ha_iot_class: Local Push
---
-Integrates MySensors binary sensors into Home Assistant. See the [main component] for configuration instructions.
+Integrates MySensors binary sensors into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions.
The following sensor types are supported:
-#### MySensors version 1.4 and higher
+## MySensors version 1.4 and higher
-S_TYPE | V_TYPE
--------------------|---------------------------------------
-S_DOOR | V_TRIPPED
-S_MOTION | V_TRIPPED
-S_SMOKE | V_TRIPPED
+| S_TYPE | V_TYPE |
+| -------- | --------- |
+| S_DOOR | V_TRIPPED |
+| S_MOTION | V_TRIPPED |
+| S_SMOKE | V_TRIPPED |
-#### MySensors version 1.5 and higher
+## MySensors version 1.5 and higher
-S_TYPE | V_TYPE
----------------|----------------------------------
-S_SPRINKLER | V_TRIPPED
-S_WATER_LEAK | V_TRIPPED
-S_SOUND | V_TRIPPED
-S_VIBRATION | V_TRIPPED
-S_MOISTURE | V_TRIPPED
+| S_TYPE | V_TYPE |
+| ------------ | --------- |
+| S_SPRINKLER | V_TRIPPED |
+| S_WATER_LEAK | V_TRIPPED |
+| S_SOUND | V_TRIPPED |
+| S_VIBRATION | V_TRIPPED |
+| S_MOISTURE | V_TRIPPED |
-For more information, visit the [serial api] of MySensors.
+For more information, visit the [serial API](https://www.mysensors.org/download) of MySensors.
-### Example sketch
+## Example sketch
```cpp
/**
@@ -80,6 +80,3 @@ void loop()
}
}
```
-
-[main component]: /integrations/mysensors/
-[serial api]: https://www.mysensors.org/download
diff --git a/source/_integrations/broadlink.markdown b/source/_integrations/broadlink.markdown
index 359d32d0c68..541dcf93595 100644
--- a/source/_integrations/broadlink.markdown
+++ b/source/_integrations/broadlink.markdown
@@ -362,7 +362,7 @@ slots:
Information about how to install on Windows can be found [here](/integrations/broadlink#sensor#microsoft-windows-installation).
-### How to obtain IR/RF packets?
+### How to obtain IR/RF packets
Choose Call Service from the Developer Tools. Choose the service `broadlink.learn` from the list of **Available services:**, write in "Service Data" JSON with 1 field "host":"your_broadlink_IP" and hit **CALL SERVICE**. Press the button on your remote with in 20 seconds. The packet will be printed as a persistent notification in the States page of the web interface.
@@ -524,7 +524,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro
- Download and install Python 2.7 on your windows PC.
- Run `pip install simplejson`. You must install simplejson in the same python version you will use to run the scripts. You can ensure that the current version is installed by attempting to install again and confirming that you see "Requirement already satisfied".
- Download and install [iBackup Viewer](https://www.imactools.com/iphonebackupviewer/).
- - Download [these](https://github.com/NightRang3r/Broadlink-e-control-db-dump) github files. Make sure you place them in the \Python27 path in Windows. Be sure that the getBroadlinkSharedData.py from the download is in this directory.
+ - Download [these](https://github.com/NightRang3r/Broadlink-e-control-db-dump) GitHub files. Make sure you place them in the \Python27 path in Windows. Be sure that the getBroadlinkSharedData.py from the download is in this directory.
3. Plug your iphone into your windows PC, open iTunes and create a non-encrypted backup of your device.
@@ -570,12 +570,12 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro
3. Hit "Learn New Command" and follow instructions on screen.
4. The "OnRawData Base64" is the value to be used with Home Assistant.
-
### Using Node-RED to obtain codes
1. Install the Broadlink Control palette in Node-RED (click the Hamburger menu at top right corner> Settings> Palette> Install and type Broadlink. Click install on the node-red-contrib-broadlink-control.
2. Once installed, verify that the new palette titled broadlink is available in the nodes menu.
3. Drag the RM node to an empty flow and double click to configure the node.
+
```bash
a. give your RM device a name for easy identification
b. click on the pencil to edit the device information
@@ -583,29 +583,36 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro
d. enter the IP address of the Broadlink RM PRO or RM mini
e. leave the Catalog field empty.
```
+
4. Click Update, and the device field should show the MAC address of the newly added device. If not, just select it.
5. In the Action field, select Learn, then click Done.
6. Drag an Inject node to the left of the RM node and link them. The type of inject doesn't matter. Leave it to the defaults.
7. Drag a Template node on the Flow to the right of the RM node and link it to the RM node.
8. Double click the Template node to edit it, select:
+
```bash
Property: msg.payload
Format: Mustache template
Template field: enter '{% raw %}{{payload.data}}{% endraw %}'.
Output as: Plain text
```
+
9. Drag a Debug node to the right of the Template node and link them.
10. Show the debug messages, deploy the flow and click on the inject button.
11. A message will show in the debug window:
+
```bash
3/23/2019, 9:56:53 AMnode: RM_Mini1
msg : string[47]
"Please tap the remote button within 30 seconds."
```
+
12. Point the IR remote control at the RM device and click the desired button for about 2 seconds. An array of numbers will show in the debug window. For example:
+
```bash
'38,0,132,3,19,18,19,18,19,18,19,17,20,54,20,54,20,54,19,18,19,18,19,18,19,17,20,17,20,17,20,54,20,17,19,18,19,18,19,18,19,17,20,17,20,54,20,17,20,54,19,55,19,54,20,54,20,54,19,55,19,0,6,6,150,146,20,54,20,54,20,54,19,18,19,18,19,18,19,17,20,17,20,54,20,54,19,55,19,18,19,17,20,17,20,17,20,17,20,17,20,54,19,18,19,18,19,18,19,17,20,17,20,17,20,54,19,18,19,55,19,54,20,54,20,54,20,54,19,55,19,0,6,6,150,146,20,54,20,54,19,55,19,18,19,17,20,17,20,17,20,17,20,54,19,55,19,54,20,17,20,17,20,17,20,17,20,17,19,18,19,55,19,17,20,17,20,17,20,17,20,17,19,18,19,55,19,18,19,54,20,54,20,54,19,55,19,54,20,54,20,0,6,5,150,146,20,54,20,54,20,54,19,18,19,18,19,18,19,17,20,17,20,54,20,54,19,55,19,18,19,17,20,17,20,17,20,17,20,17,20,54,19,18,19,18,19,18,19,17,20,17,20,17,20,54,19,18,19,55,19,54,20,54,20,54,19,55,19,54,20,0,6,6,149,147,20,54,19,55,19,54,20,17,20,17,20,17,20,17,20,17,19,55,19,54,20,54,20,17,20,17,20,17,19,18,19,18,19,18,19,54,20,17,20,17,20,17,20,17,19,18,19,18,19,54,20,17,20,54,20,54,20,54,19,...'
```
+
This is the code we need to transmit again to replicate the same remote function.
### Using Node red to Transmit Codes
@@ -614,6 +621,7 @@ This is the code we need to transmit again to replicate the same remote function
2. In the Action field, select - Set from msg.payload -.
3. Drag an Inject node and give it a meaningful name relevant to the remote control button function, like "TV On" or "TV Source".
4. Drag a template node and double click it to configure:
+
```bash
Property: msg.payload
Format: Mustache template
@@ -624,13 +632,16 @@ This is the code we need to transmit again to replicate the same remote function
}'
In the Output as field, "select Parsed JSON".
```
+
5. Click Done.
6. Drag a debug node and connect it to the output of the RM node.
7. Connect the Inject node to the Template node, and the template node to the RM node.
8. Click Deploy to activate the flow, and then click the inject button. The debug window should show a debug message. For example:
+
```bash
{"action":"send","data": [38,0,152,0,0,1,39,148,19,18,18,19,18,55,19,18,18,19,18,19,18,19,18,55,18,56,18,19,18,55,18,19,18,56,18,18,19,55,18,19,18,19,18,18,18,56,18,19,18,18,19,55,18,56,18,18,19,18,18,19,18,19,18,55,19,18,18,19,18,19,18,19,18,18,18,19,18,19,18,55,19,55,18,19,18,19,18,18,19,18,18,56,18,19,18,18,19,55,18,56,18,18,19,18,18,19,18,19,18,19,18,18,19,18,18,56,18,55,18,19,18,19,18,19,18,18,19,55,18,19,18,55,19,18,18,56,18,19,18,18,19,18,18,19,18,19,18,19,18,18,18,56,18,0,13,5],"status":"OK"}
```
+
The "status" : "OK" at the end is a feedback that the Broadlink RM device is connected and has transmitted the payload.
Now you can add as many template nodes, each having a specific code, and add any type of input nodes to activate the template and transmit the code.
@@ -641,12 +652,12 @@ It is also possible to obtain codes using `broadlink_cli` from [python-broadlink
First use discovery to find your Broadlink device:
```bash
-./broadlink_discovery
+$ ./broadlink_discovery
Discovering...
###########################################
RM2
# broadlink_cli --type 0x2737 --host 192.168.1.137 --mac 36668342f7c8
-Device file data (to be used with --device @filename in broadlink_cli) :
+Device file data (to be used with --device @filename in broadlink_cli) :
0x2737 192.168.1.137 36668342nnnn
temperature = 0.0
```
@@ -671,7 +682,7 @@ For old/awkward devices another possibility is to try to get codes by using data
Assuming that your (or similar) device is in one of these databases:
-- https://sourceforge.net/p/lirc-remotes/code/ci/master/tree/
-- https://github.com/probonopd/irdb/tree/master/
+-
+-
You can grab `irdb2broadlinkha.sh` from [irdb2broadlinkha](https://github.com/molexx/irdb2broadlinkha) project and try to convert codes to format suitable for Home Assistant.
diff --git a/source/_integrations/climate.mysensors.markdown b/source/_integrations/climate.mysensors.markdown
index 542e21a4d56..9200dffac11 100644
--- a/source/_integrations/climate.mysensors.markdown
+++ b/source/_integrations/climate.mysensors.markdown
@@ -9,24 +9,24 @@ ha_release: 0.29
ha_iot_class: Local Push
---
-Integrates MySensors HVAC into Home Assistant. See the [main component] for configuration instructions.
+Integrates MySensors HVAC into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions.
The following actuator types are supported:
-##### MySensors version 1.5 and higher
+## MySensors version 1.5 and higher
-S_TYPE | V_TYPE
--------|-----------------------------------------------------------------------------
-S_HVAC | V_HVAC_FLOW_STATE*, V_HVAC_SETPOINT_HEAT, V_HVAC_SETPOINT_COOL, V_HVAC_SPEED, V_TEMP
+| S_TYPE | V_TYPE |
+| ------ | ------------------------------------------------------------------------------------ |
+| S_HVAC | V_HVAC_FLOW_STATE*, V_HVAC_SETPOINT_HEAT, V_HVAC_SETPOINT_COOL, V_HVAC_SPEED, V_TEMP |
V_HVAC_FLOW_STATE is mapped to the state of the Climate integration in Home Assistant as follows:
-Home Assistant State | MySensors State
----------------------|----------------
-HVAC_MODE_COOL | CoolOn
-HVAC_MODE_HEAT | HeatOn
-HVAC_MODE_AUTO | AutoChangeOver
-HVAC_MODE_OFF | Off
+| Home Assistant State | MySensors State |
+| -------------------- | --------------- |
+| HVAC_MODE_COOL | CoolOn |
+| HVAC_MODE_HEAT | HeatOn |
+| HVAC_MODE_AUTO | AutoChangeOver |
+| HVAC_MODE_OFF | Off |
Currently humidity, away_mode, aux_heat, swing_mode is not supported. This will be included in later versions as feasible.
@@ -36,9 +36,9 @@ You can use V_HVAC_SPEED to control the Speed setting of the Fan in the HVAC.
You can use V_TEMP to send the current temperature from the node to Home Assistant.
-For more information, visit the [serial api] of MySensors.
+For more information, visit the [serial API](https://www.mysensors.org/download) of MySensors.
-### Example sketch for MySensors 2.x
+## Example sketch for MySensors 2.x
```cpp
/*
@@ -183,7 +183,7 @@ void sendHeatpumpCommand() {
}
```
-### Example sketch for MySensors 1.x
+## Example sketch for MySensors 1.x
```cpp
/*
@@ -255,6 +255,3 @@ void incomingMessage(const MyMessage &message) {
}
}
```
-
-[main component]: /integrations/mysensors/
-[serial api]: https://www.mysensors.org/download
diff --git a/source/_integrations/cover.mysensors.markdown b/source/_integrations/cover.mysensors.markdown
index 075f99a2e10..917983aae89 100644
--- a/source/_integrations/cover.mysensors.markdown
+++ b/source/_integrations/cover.mysensors.markdown
@@ -9,27 +9,27 @@ ha_release: "0.30"
ha_iot_class: Local Push
---
-Integrates MySensors covers into Home Assistant. See the [main component] for configuration instructions.
+Integrates MySensors covers into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions.
The following actuator types are supported:
-##### MySensors version 1.4
+## MySensors version 1.4
-S_TYPE | V_TYPE
---------|--------------------------------------------
-S_COVER | V_UP, V_DOWN, V_STOP, [V_DIMMER or V_LIGHT]
+| S_TYPE | V_TYPE |
+| ------- | ------------------------------------------- |
+| S_COVER | V_UP, V_DOWN, V_STOP, [V_DIMMER or V_LIGHT] |
-##### MySensors version 1.5 and higher
+## MySensors version 1.5 and higher
-S_TYPE | V_TYPE
---------|-------------------------------------------------
-S_COVER | V_UP, V_DOWN, V_STOP, [V_PERCENTAGE or V_STATUS]
+| S_TYPE | V_TYPE |
+| ------- | ------------------------------------------------ |
+| S_COVER | V_UP, V_DOWN, V_STOP, [V_PERCENTAGE or V_STATUS] |
All V_TYPES above are required. Use V_PERCENTAGE (or V_DIMMER) if you know the exact position of the cover in percent, use V_STATUS (or V_LIGHT) if you don't.
-For more information, visit the [serial api] of MySensors.
+For more information, visit the [serial API](https://www.mysensors.org/download/serial_api_20) of MySensors.
-### Example sketch
+## Example sketch
```cpp
/*
@@ -149,6 +149,3 @@ void receive(const MyMessage &message) {
}
}
```
-
-[main component]: /integrations/mysensors/
-[serial api]: https://www.mysensors.org/download/serial_api_20
diff --git a/source/_integrations/deconz.markdown b/source/_integrations/deconz.markdown
index f552501aa31..cb72d42e125 100644
--- a/source/_integrations/deconz.markdown
+++ b/source/_integrations/deconz.markdown
@@ -63,7 +63,7 @@ logger:
## Troubleshooting
-If you are having issues and want to report a problem, always start with making sure that you're on the latest [deCONZ software version](https://github.com/dresden-elektronik/deconz-rest-plugin/releases) and [latest firmware for hardware](http://deconz.dresden-elektronik.de/deconz-firmware/?C=M;O=D).
+If you are having issues and want to report a problem, always start with making sure that you're on the latest [deCONZ software version](https://github.com/dresden-elektronik/deconz-rest-plugin/releases) and [latest firmware for hardware](http://deconz.dresden-elektronik.de/deconz-firmware/?C=M;O=D).
## Device services
@@ -73,11 +73,11 @@ Available services: `configure` and `deconz.device_refresh`.
Set attribute of device in deCONZ using [REST-API](https://dresden-elektronik.github.io/deconz-rest-doc/rest/).
-| Service data attribute | Optional | Description |
-|-----------|----------|-------------|
-| `field` | No | String representing a specific device in deCONZ. |
-| `entity` | No | String representing a specific Home Assistant entity of a device in deCONZ. |
-| `data` | No | Data is a JSON object with what data you want to alter. |
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | --------------------------------------------------------------------------- |
+| `field` | No | String representing a specific device in deCONZ. |
+| `entity` | No | String representing a specific Home Assistant entity of a device in deCONZ. |
+| `data` | No | Data is a JSON object with what data you want to alter. |
Either `entity` or `field` must be provided. If both are present, `field` will be interpreted as a subpath under the device path corresponding to the specified `entity`:
@@ -109,12 +109,12 @@ Remote controls (ZHASwitch category) will not be exposed as regular entities, bu
Typical values for switches, the event codes are 4 numbers where the first and last number are of interest here.
-| Switch code | Description |
-|-------------|-------------|
-| 1XXX | Button #1 up to #8 |
-| XXX1 | Button hold |
-| XXX2 | Button short release |
-| XXX3 | Button long release |
+| Switch code | Description |
+| ----------- | -------------------- |
+| 1XXX | Button #1 up to #8 |
+| XXX1 | Button hold |
+| XXX2 | Button short release |
+| XXX3 | Button long release |
Where for example on a Philips Hue Dimmer, 2001 would be holding the dim up button.
@@ -122,17 +122,17 @@ For the IKEA Tradfri remote the first digit equals, 1 for the middle button, 2 f
Specific gestures for the Aqara Magic Cube are:
-| Gesture | Description |
-|---------|-------------|
-| 0 | Awake |
-| 1 | Shake |
-| 2 | Free fall |
-| 3 | Flip 90 |
-| 4 | Flip 180 |
-| 5 | Move on any side |
-| 6 | Double tap on any side |
-| 7 | Turn clockwise |
-| 8 | Turn counter clockwise |
+| Gesture | Description |
+| ------- | ---------------------- |
+| 0 | Awake |
+| 1 | Shake |
+| 2 | Free fall |
+| 3 | Flip 90 |
+| 4 | Flip 180 |
+| 5 | Move on any side |
+| 6 | Double tap on any side |
+| 7 | Turn clockwise |
+| 8 | Turn counter clockwise |
### Finding your events
@@ -313,7 +313,7 @@ class RemoteControl(hass.Hass):
{% endraw %}
-#### Appdaemon remote template
+#### Appdaemon Ikea Tradfri remote template
Community app from [Teachingbirds](https://community.home-assistant.io/u/teachingbirds/summary). This app uses an Ikea Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track.
@@ -402,7 +402,7 @@ Note that devices in the climate platform identify as sensors, so there is a man
The `entity_id` name will be `climate.device_name`, where `device_name` is defined in deCONZ.
-#### Verified supported climate devices
+### Verified supported climate devices
- Bitron Thermostat 902010/32
- Eurotronic SPZB0001
@@ -443,8 +443,8 @@ The `entity_id` names will be `light.device_name`, where `device_name` is define
- Philips Hue White Ambiance A19
- Philips Hue Hue White ambiance Milliskin (recessed spotlight) LTW013
- Philips Hue LightStrip Plus
-- Busch Jaeger ZigBee Light Link univ. relai (6711 U) with ZigBee Light Link control element 6735-84
-- Xiaomi Aqara Smart Led Bulb (white) E27 ZNLDP12LM
+- Busch Jaeger Zigbee Light Link univ. relai (6711 U) with Zigbee Light Link control element 6735-84
+- Xiaomi Aqara Smart Led Bulb (white) E27 ZNLDP12LM
## Scene
@@ -484,24 +484,24 @@ The `entity_id` name will be `sensor.device_name`, where `device_name` is define
### deCONZ Daylight Sensor
-The deCONZ Daylight sensor is a special sensor built into the deCONZ software since version 2.05.12. It is represented in Home Assistant as a sensor called sensor.daylight. The sensor's state value is a string corresponding to the phase of daylight (descriptions below taken from https://github.com/mourner/suncalc, on which the deCONZ implementation is based):
+The deCONZ Daylight sensor is a special sensor built into the deCONZ software since version 2.05.12. It is represented in Home Assistant as a sensor called sensor.daylight. The sensor's state value is a string corresponding to the phase of daylight (descriptions below taken from , on which the deCONZ implementation is based):
-| Sensor State | Description |
-|--------------|-------------|
-| sunrise_start | sunrise (top edge of the sun appears on the horizon) |
-| sunrise_end | sunrise ends (bottom edge of the sun touches the horizon) |
-| golden_hour_1 | morning golden hour (soft light, the best time for photography) |
-| solar_noon | solar noon (sun is in the highest position) |
-| golden_hour_2 | evening golden hour |
-| sunset_start | sunset starts (bottom edge of the sun touches the horizon) |
-| sunset_end | sunset (sun disappears below the horizon, evening civil twilight starts) |
-| dusk | dusk (evening nautical twilight starts) |
-| nautical_dusk | nautical dusk (evening astronomical twilight starts) |
-| night_start | night starts (dark enough for astronomical observations) |
-| nadir | nadir (darkest moment of the night, the sun is in the lowest position) |
-| night_end | night ends (morning astronomical twilight starts) |
-| nautical_dawn | nautical dawn (morning nautical twilight starts) |
-| dawn | dawn (morning nautical twilight ends, morning civil twilight starts) |
+| Sensor State | Description |
+| ------------- | ------------------------------------------------------------------------ |
+| sunrise_start | sunrise (top edge of the sun appears on the horizon) |
+| sunrise_end | sunrise ends (bottom edge of the sun touches the horizon) |
+| golden_hour_1 | morning golden hour (soft light, the best time for photography) |
+| solar_noon | solar noon (sun is in the highest position) |
+| golden_hour_2 | evening golden hour |
+| sunset_start | sunset starts (bottom edge of the sun touches the horizon) |
+| sunset_end | sunset (sun disappears below the horizon, evening civil twilight starts) |
+| dusk | dusk (evening nautical twilight starts) |
+| nautical_dusk | nautical dusk (evening astronomical twilight starts) |
+| night_start | night starts (dark enough for astronomical observations) |
+| nadir | nadir (darkest moment of the night, the sun is in the lowest position) |
+| night_end | night ends (morning astronomical twilight starts) |
+| nautical_dawn | nautical dawn (morning nautical twilight starts) |
+| dawn | dawn (morning nautical twilight ends, morning civil twilight starts) |
The sensor also has an attribute called "daylight" that has the value `true` when the sensor's state is `golden_hour_1`, `solar_noon`, or `golden_hour_2`, and `false` otherwise.
diff --git a/source/_integrations/device_tracker.mysensors.markdown b/source/_integrations/device_tracker.mysensors.markdown
index 88d645f68b6..20f477790f0 100644
--- a/source/_integrations/device_tracker.mysensors.markdown
+++ b/source/_integrations/device_tracker.mysensors.markdown
@@ -9,19 +9,19 @@ ha_release: 0.38
ha_iot_class: Local Push
---
-Integrates MySensors device trackers into Home Assistant. See the [main component] for configuration instructions.
+Integrates MySensors device trackers into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions.
The following sensor types are supported:
-##### MySensors version 2.0 and higher
+## MySensors version 2.0 and higher
-S_TYPE | V_TYPE
--------------------|---------------------------------------
-S_GPS | V_POSITION
+| S_TYPE | V_TYPE |
+| ------ | ---------- |
+| S_GPS | V_POSITION |
-For more information, visit the [serial api] of MySensors.
+For more information, visit the [serial API](https://www.mysensors.org/download) of MySensors.
-### MySensors 2.x example sketch
+## MySensors 2.x example sketch
```cpp
/**
@@ -95,6 +95,3 @@ void loop()
}
}
```
-
-[main component]: /integrations/mysensors/
-[serial api]: https://www.mysensors.org/download
diff --git a/source/_integrations/envisalink.markdown b/source/_integrations/envisalink.markdown
index 129e921eb4e..96b4bece4d1 100644
--- a/source/_integrations/envisalink.markdown
+++ b/source/_integrations/envisalink.markdown
@@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant:
This is a fully event-based component. Any event sent by the Envisalink device will be immediately reflected within Home Assistant.
-As of 0.29, the alarm_trigger service is supported. It is possible to fire off an envisalink-based alarm directly from Home Assistant. For example, a newer zwave/zigbee sensor can now be integrated into a legacy alarm system using a Home Assistant automation.
+As of 0.29, the alarm_trigger service is supported. It is possible to fire off an envisalink-based alarm directly from Home Assistant. For example, a newer Z-Wave / Zigbee sensor can now be integrated into a legacy alarm system using a Home Assistant automation.
An `envisalink` section must be present in the `configuration.yaml` file and contain the following options as required:
@@ -136,6 +136,6 @@ The following services are supported by Envisalink and can be used to script or
- **alarm_arm_home**: Arms the alarm in home mode.
- **alarm_arm_away**: Arms the alarm in standard away mode.
- **alarm_arm_night**: Arms the alarm in night mode.
-- **alarm_trigger**: Trigger an alarm on the Envisalink connected alarm system. For example, a newer zwave/zigbee sensor can now be integrated into a legacy alarm system using a Home Assistant automation.
+- **alarm_trigger**: Trigger an alarm on the Envisalink connected alarm system. For example, a newer Z-Wave / Zigbee sensor can now be integrated into a legacy alarm system using a Home Assistant automation.
- **alarm_keypress**: Sends a string of up to 6 characters to the alarm. *Works with DSC panels, and confirmed to work with Honeywell Vista-20P (aka First Alert FA-168)*
- **invoke_custom_function**: Invokes a custom PGM function. *DSC alarms only*
diff --git a/source/_integrations/flic.markdown b/source/_integrations/flic.markdown
index 0e8cfe4eb9f..a7bc8d284d9 100644
--- a/source/_integrations/flic.markdown
+++ b/source/_integrations/flic.markdown
@@ -12,13 +12,13 @@ The `flic` platform allows you to receive click events from [flic](https://flic.
The platform does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine.
-#### Service setup
+## Service setup
If you are using Hass.io, you can run the service locally by [installing](/hassio/installing_third_party_addons/) the flicd add-on from [pschmitt's repository](https://github.com/pschmitt/hassio-addons).
-For instructions on how to install the service manually, visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [OS X](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows).
+For instructions on how to install the service manually, visit the GitHub repository of the service for [Linux](https://github.com/50ButtonsEach/fliclib-linux-hci), [macOS](https://github.com/50ButtonsEach/flic-service-osx) or [Windows](https://github.com/50ButtonsEach/fliclib-windows).
-#### Configuration
+## Configuration
To use your flic buttons in your installation, add the following to your `configuration.yaml` file:
@@ -55,15 +55,15 @@ timeout:
default: 3
{% endconfiguration %}
-#### Discovery
+## Discovery
If discovery is enabled, you can add a new button by pressing it for at least 7 seconds. The button will be paired with the flic service and added to Home Assistant. Otherwise, you have to manually pair it with the flic service. The Home Assistant platform will not scan for new buttons and will only connect to buttons already paired.
-#### Timeout
+## Timeout
- When the flic button is triggered while disconnected from flic service, it will queue all events and try to connect and transmit them as soon as possible. The timeout variable can be used to stop events from triggering if too much time passed between the action and the notification in Home Assistant.
+When the flic button is triggered while disconnected from flic service, it will queue all events and try to connect and transmit them as soon as possible. The timeout variable can be used to stop events from triggering if too much time passed between the action and the notification in Home Assistant.
-#### Events
+## Events
The flic integration fires `flic_click` events on the bus. You can capture the events and respond to them in automation scripts like this:
@@ -104,6 +104,6 @@ automation:
message: {% raw %}"flic {{ trigger.event.data.button_name }} was {{ trigger.event.data.click_type }} clicked"{% endraw %}
```
-##### Ignoring Click Types
+### Ignoring Click Types
For some purposes it might make sense to exclude a specific click type from triggering click events. For example when ignoring double clicks, pressing the button twice fast results in two `single` instead of a `double` click event. This is very useful for applications where you want to click fast.
diff --git a/source/_integrations/foursquare.markdown b/source/_integrations/foursquare.markdown
index 0a8c8b863d2..41dd04d2e7d 100644
--- a/source/_integrations/foursquare.markdown
+++ b/source/_integrations/foursquare.markdown
@@ -30,7 +30,7 @@ push_secret:
type: string
{% endconfiguration %}
-#### Getting the access token ####
+## Getting the access token
After you have registered your APP on your [My Apps Page](https://foursquare.com/developers/apps) you get a `CLIENT_ID` and you have specified a
`REDIRECT_URL` which can be any URL you like, but since it will get your access token via an HTTP GET request, it should be a URL which will ignore the `access_token` HTTP GET variable. A good idea is to choose the URL of your Home Assistant.
@@ -71,7 +71,7 @@ Parameters:
- **eventId** (*Optional*): The event the user is checking in to.
- **shout** (*Optional*): A message about your check-in. The maximum length of this field is 140 characters.
- **mentions** (*Optional*): Mentions in your check-in. This parameter is a semicolon-delimited list of mentions. A single mention is of the form "start,end,userid", where start is the index of the first character in the shout representing the mention, end is the index of the first character in the shout after the mention, and userid is the userid of the user being mentioned. If userid is prefixed with "fbu-", this indicates a Facebook userid that is being mention. Character indices in shouts are 0-based.
-- **broadcast** (*Optional*): "Who to broadcast this check-in to. Accepts a comma-delimited list of values: private (off the grid) or public (share with friends), Facebook share on Facebook, twitter share on twitter, followers share with followers (celebrity mode users only), If no valid value is found, the default is public."
+- **broadcast** (*Optional*): "Who to broadcast this check-in to. Accepts a comma-delimited list of values: private (off the grid) or public (share with friends), Facebook share on Facebook, Twitter share on twitter, followers share with followers (celebrity mode users only), If no valid value is found, the default is public."
- **ll** (*Optional*): Latitude and longitude of the user's location. Only specify this field if you have a GPS or other device reported location for the user at the time of check-in.
- **llAcc** (*Optional*): Accuracy of the user's latitude and longitude, in meters.
- **alt** (*Optional*): Altitude of the user's location, in meters.
diff --git a/source/_integrations/knx.markdown b/source/_integrations/knx.markdown
index 056ad86f69b..fd722ff0fa7 100644
--- a/source/_integrations/knx.markdown
+++ b/source/_integrations/knx.markdown
@@ -43,6 +43,7 @@ Optional, recommended for large KNX installations (>100 devices) and/or if you w
knx:
config_file: '/path/to/xknx.yaml'
```
+
{% configuration %}
config_file:
description: The path for XKNX configuration file.
@@ -108,7 +109,7 @@ fire_event:
type: boolean
default: false
fire_event_filter:
- description: If `fire_event` is set `fire_event_filter` has to be specified. `fire_event_filter` defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HOme Assistant event bus.
+ description: If `fire_event` is set `fire_event_filter` has to be specified. `fire_event_filter` defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the Home Assistant event bus.
required: inclusive
type: [list, string]
state_updater:
diff --git a/source/_integrations/light.mysensors.markdown b/source/_integrations/light.mysensors.markdown
index 4cfa6de1403..8d3ff74d05e 100644
--- a/source/_integrations/light.mysensors.markdown
+++ b/source/_integrations/light.mysensors.markdown
@@ -9,31 +9,31 @@ ha_release: 0.13
ha_iot_class: Local Push
---
-Integrates MySensors lights into Home Assistant. See the [main component] for configuration instructions.
+Integrates MySensors lights into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions.
The following actuator types are supported:
-##### MySensors version 1.4
+## MySensors version 1.4
-S_TYPE | V_TYPE
----------|--------------
-S_DIMMER | V_DIMMER\*, V_LIGHT\*
+| S_TYPE | V_TYPE |
+| -------- | --------------------- |
+| S_DIMMER | V_DIMMER\*, V_LIGHT\* |
-##### MySensors version 1.5 and higher
+## MySensors version 1.5 and higher
-S_TYPE | V_TYPE
-------------|-------------
-S_DIMMER | [V_DIMMER\* or V_PERCENTAGE\*], [V_LIGHT\* or V_STATUS\*]
-S_RGB_LIGHT | V_RGB*, [V_LIGHT\* or V_STATUS\*], [V_DIMMER or V_PERCENTAGE]
-S_RGBW_LIGHT | V_RGBW*, [V_LIGHT\* or V_STATUS\*], [V_DIMMER or V_PERCENTAGE]
+| S_TYPE | V_TYPE |
+| ------------ | -------------------------------------------------------------- |
+| S_DIMMER | [V_DIMMER\* or V_PERCENTAGE\*], [V_LIGHT\* or V_STATUS\*] |
+| S_RGB_LIGHT | V_RGB*, [V_LIGHT\* or V_STATUS\*], [V_DIMMER or V_PERCENTAGE] |
+| S_RGBW_LIGHT | V_RGBW*, [V_LIGHT\* or V_STATUS\*], [V_DIMMER or V_PERCENTAGE] |
V_TYPES with a star (\*) denote V_TYPES that should be sent at sketch startup. For an S_DIMMER, send both a V_DIMMER/V_PERCENTAGE and a V_LIGHT/V_STATUS message. For an S_RGB_LIGHT, send both a V_RGB and a V_LIGHT/V_STATUS message with a V_DIMMER/V_PERCENTAGE message being optional. Same principal applies for S_RGBW_LIGHT and V_RGBW.
Sketch should acknowledge a command sent from controller with the same type. If command invokes a change to off state (including a V_PERCENTAGE, V_RGB, or V_RGBW message of zero), only a V_STATUS of zero message should be sent. See sketches below for examples.
-For more information, visit the [serial api] of MySensors.
+For more information, visit the [serial API](https://www.mysensors.org/download) of MySensors.
-### MySensors 1.x example sketch
+## MySensors 1.x example sketch
```cpp
/*
@@ -108,7 +108,7 @@ void incomingMessage(const MyMessage &message) {
}
```
-### MySensors 2.x example sketch
+## MySensors 2.x example sketch
```cpp
/*
@@ -241,6 +241,3 @@ void send_status_message()
}
}
```
-
-[main component]: /integrations/mysensors/
-[serial api]: https://www.mysensors.org/download
diff --git a/source/_integrations/limitlessled.markdown b/source/_integrations/limitlessled.markdown
index 48292275fe4..59597a5494f 100644
--- a/source/_integrations/limitlessled.markdown
+++ b/source/_integrations/limitlessled.markdown
@@ -16,9 +16,9 @@ Note: you can assign an `rgbw`, `rgbww`, `white` and `dimmer` group to the same
An archive of the extensive API can be found [here](https://github.com/Fantasmos/LimitlessLED-DevAPI).
-### Setup
+## Setup
-Before configuring Home Assistant, make sure you can control your bulbs or LEDs with the MiLight mobile application. Next, discover your bridge(s) IP address. You can do this via your router or a mobile application like Fing ([android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en) or [iTunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)).
+Before configuring Home Assistant, make sure you can control your bulbs or LEDs with the MiLight mobile application. Next, discover your bridge(s) IP address. You can do this via your router or a mobile application like Fing ([Android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en) or [iTunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)).
To add `limitlessled` to your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_integrations/miflora.markdown b/source/_integrations/miflora.markdown
index 390adfaa6d5..d37335c10a5 100644
--- a/source/_integrations/miflora.markdown
+++ b/source/_integrations/miflora.markdown
@@ -24,7 +24,7 @@ Before configuring Home Assistant you need a Bluetooth backend and the MAC addre
- On other Linux systems:
- Preferred solution: Install the `bluepy` library (via pip). When using a virtual environment, make sure to install the library in the right one.
- Fallback solution: Install `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth`, `bluez-deprecated`
-- On Windows and MacOS there is currently no support for the [miflora library](https://github.com/open-homeautomation/miflora/).
+- On Windows and macOS there is currently no support for the [miflora library](https://github.com/open-homeautomation/miflora/).
## Scan for devices
@@ -120,7 +120,7 @@ sensor:
- platform: miflora
mac: 'xx:xx:xx:xx:xx:xx'
name: Flower 1
- force_update: true
+ force_update: true
median: 3
monitored_conditions:
- moisture
diff --git a/source/_integrations/mikrotik.markdown b/source/_integrations/mikrotik.markdown
index d84184b76e6..1a44836b1a6 100644
--- a/source/_integrations/mikrotik.markdown
+++ b/source/_integrations/mikrotik.markdown
@@ -27,11 +27,10 @@ set api disabled=no port=8728
Web Frontend:
-Go to **IP** -> **Services** -> **api** and enable it.
+Go to **IP** -> **Services** -> **API** and enable it.
Make sure that port 8728 or the port you choose is accessible from your network.
-
To use a MikroTik router in your installation, add the following to your `configuration.yaml` file:
```yaml
@@ -85,7 +84,7 @@ arp_ping:
As of version 6.43 of RouterOS Mikrotik introduced a new login method (`plain`) in addition to the old login method (`token`). With Version 6.45.1 the old `token` login method got deprecated.
- In order to support both login mechanisms, the new config option `login_method` has been introduced.
+ In order to support both login mechanisms, the new configuration option `login_method` has been introduced.
@@ -118,7 +117,7 @@ To use this device tracker you need restricted privileges only. To enhance the s
/user set password="YOUR_PASSWORD" homeassistant
```
-## Using the additional configuration to the `mikrotik` entry in your `configuration.yaml` file:
+## Using the additional configuration to the `mikrotik` entry in your `configuration.yaml` file
```yaml
mikrotik:
diff --git a/source/_integrations/mitemp_bt.markdown b/source/_integrations/mitemp_bt.markdown
index 64d736ea20c..cea293437fe 100644
--- a/source/_integrations/mitemp_bt.markdown
+++ b/source/_integrations/mitemp_bt.markdown
@@ -19,7 +19,7 @@ Depending on the operating system you're running, you have to configure the prop
- On other Linux systems:
- Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one.
- Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`.
-- Windows and MacOS are currently not supported by the `btlewrap` library.
+- Windows and macOS are currently not supported by the `btlewrap` library.
## Configuration
diff --git a/source/_integrations/mysensors.markdown b/source/_integrations/mysensors.markdown
index 8cc7bc5cbcf..86849fcc0c7 100644
--- a/source/_integrations/mysensors.markdown
+++ b/source/_integrations/mysensors.markdown
@@ -12,7 +12,7 @@ ha_codeowners:
The [MySensors](https://www.mysensors.org) project combines devices like Arduino, ESP8266, Raspberry Pi, NRF24L01+ and RFM69 to build affordable sensor networks. This integration will automatically add all available devices to Home Assistant, after [presentation](#presentation) is done. That is, you do not need to add anything to your configuration for the devices for them to be added. Go to the **states** section of the developer tools to find the devices that have been identified.
-### Configuration
+## Configuration
Integrate your Serial, Ethernet (LAN) or MQTT MySensors Gateway by adding the following to your `configuration.yaml` file:
@@ -96,7 +96,7 @@ Not all features of MySensors 2.x are supported by Home Assistant yet. As more f
If you are using an original Arduino as a serial gateway, the port will be named `ttyACM*`. The exact number can be determined with the command shown below.
```bash
-$ ls /dev/ttyACM*
+ls /dev/ttyACM*
```
If you are using the MQTT gateway, you also need to have the [MQTT component](/integrations/mqtt/) configured in Home Assistant. See below for a minimum MQTT configuration:
@@ -249,7 +249,8 @@ Message validation was introduced in version 0.52 of Home Assistant.
### Debug logging
-If you experience dropped messages or that a device is not added to Home Assistant, please turn on debug logging for the `mysensors` integration and the `mysensors` package. This will help you see what is going on. Make sure you use these logging settings to collect a log sample if you report an issue about the `mysensors` integration in our github issue tracker.
+If you experience dropped messages or that a device is not added to Home Assistant, please turn on debug logging for the `mysensors` integration and the `mysensors` package. This will help you see what is going on. Make sure you use these logging settings to collect a log sample if you report an issue about the `mysensors` integration in our GitHub issue tracker.
+
```yaml
logger:
default: info
@@ -258,7 +259,6 @@ logger:
mysensors: debug
```
-
Visit the [library API][MySensors library api] of MySensors for more information.
[MySensors library API]: https://www.mysensors.org/download
diff --git a/source/_integrations/notify.mysensors.markdown b/source/_integrations/notify.mysensors.markdown
index 7dc8aeac619..b5f9628e0ed 100644
--- a/source/_integrations/notify.mysensors.markdown
+++ b/source/_integrations/notify.mysensors.markdown
@@ -9,11 +9,11 @@ ha_release: 0.36
ha_iot_class: Local Push
---
-Integrates MySensors notifications into Home Assistant. See the [main component] for configuration instructions.
+Integrates MySensors notifications into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions.
Setting the `target` key in the service call will target the name of the MySensors device in Home Assistant. MySensors device names follow the notation: "[Sketch name] [Node id] [Child id]".
-### Automation example
+## Automation example
```yaml
...
@@ -28,11 +28,11 @@ The following sensor types are supported:
##### MySensors version 2.0 and higher
-S_TYPE | V_TYPE
-----------------|--------------------------
-S_INFO | V_TEXT
+| S_TYPE | V_TYPE |
+| ------ | ------ |
+| S_INFO | V_TEXT |
-For more information, visit the [api] page of MySensors.
+For more information, visit the [API](https://www.mysensors.org/download/) page of MySensors.
### Example sketch
@@ -91,6 +91,3 @@ For more information, visit the [api] page of MySensors.
}
}
```
-
-[main component]: /integrations/mysensors/
-[api]: https://www.mysensors.org/download/
diff --git a/source/_integrations/opencv.markdown b/source/_integrations/opencv.markdown
index b234fd2a2b1..97107e7eae6 100644
--- a/source/_integrations/opencv.markdown
+++ b/source/_integrations/opencv.markdown
@@ -30,7 +30,7 @@ image_processing:
- **source** array (*Required*): List of image sources.
- **entity_id** (*Required*): A camera entity id to get picture from.
- **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity.
-- **classifier** (*Optional*): Dictionary of name to path to the classifier xml file. If this field is not provided, a face classifier will be downloaded from OpenCV's Github repo.
+- **classifier** (*Optional*): Dictionary of name to path to the classifier xml file. If this field is not provided, a face classifier will be downloaded from OpenCV's GitHub repo.
**classifier** may also be defined as a dictionary of names to classifier configurations:
diff --git a/source/_integrations/roku.markdown b/source/_integrations/roku.markdown
index f640d668d8b..b11c0569b9e 100644
--- a/source/_integrations/roku.markdown
+++ b/source/_integrations/roku.markdown
@@ -90,7 +90,7 @@ data:
When the Home Assistant Roku integration is enabled and has found a Roku device, in the Home Assistant GUI the Roku media player will show a listing of the installed channels, or apps, under “source”. Select one and it will attempt to launch the channel on your Roku device. This action can also be automated, but it requires you to acquire an extra piece of information; the ```appID``` for the channel specific to your Roku. Although this information is gathered by the Roku integration, at the moment it is not exposed to the end user. This item might be added in a future release. For now though, you can easily get the information yourself. All you need to do is a simple GET API call on the same network as your device.
-The api calls are like this:
+The API calls are like this:
```txt
GET http:// ROKU_IP:8060/query/apps
@@ -102,7 +102,7 @@ POST http://YOUR_ROKU_IP:8060/launch/837?contentID=YOUR_YOUTUBE_VIDEOS_CONTENT_I
More details can be found on the [Roku dev pages](https://developer.roku.com/docs/developer-program/discovery/external-control-api.md)
-To use this in Home Assistant, for instance in an automation, the format is as follows. Note that ```source: ``` is the appID you discovered in the API call:
+To use this in Home Assistant, for instance in an automation, the format is as follows. Note that `source:` is the appID you discovered in the API call:
```yaml
action:
diff --git a/source/_integrations/rpi_gpio.markdown b/source/_integrations/rpi_gpio.markdown
index 1c9b00e7526..b84ef02f1aa 100644
--- a/source/_integrations/rpi_gpio.markdown
+++ b/source/_integrations/rpi_gpio.markdown
@@ -17,7 +17,7 @@ The `rpi_gpio` integration is the base for all related GPIO platforms in Home As
The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
-## Configuration
+### Configuration
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
@@ -72,7 +72,7 @@ It uses two pins on the Raspberry Pi.
Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup).
-## Configuration
+### Configuration
To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file:
@@ -145,13 +145,13 @@ cover:
## Remote Raspberry Pi Cover
-If you don't have Home Assistant running on your Raspberry Pi and you want to use it as a remote cover instead, there is a project called [GarageQTPi](https://github.com/Jerrkawz/GarageQTPi) that will work remotely with the [MQTT Cover Component](/integrations/cover.mqtt/). Follow the Github instructions to install and configure GarageQTPi and once configured follow the Home Assistant instructions to configure the MQTT Cover.
+If you don't have Home Assistant running on your Raspberry Pi and you want to use it as a remote cover instead, there is a project called [GarageQTPi](https://github.com/Jerrkawz/GarageQTPi) that will work remotely with the [MQTT Cover Component](/integrations/cover.mqtt/). Follow the GitHub instructions to install and configure GarageQTPi and once configured follow the Home Assistant instructions to configure the MQTT Cover.
## Switch
The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).
-## Configuration
+### Configuration
To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_integrations/samsungtv.markdown b/source/_integrations/samsungtv.markdown
index beb5dab6927..fc19ce42b18 100644
--- a/source/_integrations/samsungtv.markdown
+++ b/source/_integrations/samsungtv.markdown
@@ -142,6 +142,7 @@ For example: for model `UN55NU7100`, the `UN55` would mean it's an LED, North Am
- MU6125 - Unable to see state and unable to control (Tested on UE58MU6125 on port 8001 and 8801)
- MU6300 - Port set to 8001, turning on works, status not working reliably, turning off is not permanent (it comes back on)
- MU6400 - Unable to see state and unable to control (using latest 1270 firmware. Had limited functionality on previous firmware)
+- RU8000 - Turning on works, turning off does not work. State is correct but says on periodically but in reality is not. Nothing else works via port 8001.
- Q60 – Turning on works, turning off does not work, State is always "off".
- Q6F – Port set to 8001, turning on works, turning off does not work, status not working reliably.
- Q7F - State is always "off" and unable to control via port 8001.
diff --git a/source/_integrations/sensibo.markdown b/source/_integrations/sensibo.markdown
index 35627385e29..70dce13f6e1 100644
--- a/source/_integrations/sensibo.markdown
+++ b/source/_integrations/sensibo.markdown
@@ -23,7 +23,7 @@ climate:
{% configuration %}
api_key:
- description: Your Sensibo API key (To get your API key visit ).
+ description: Your Sensibo API key (To get your API key visit `https://home.sensibo.com/me/api`).
required: true
type: string
id:
@@ -38,7 +38,8 @@ then in the Sensibo app log you will be able to distinguish between actions
done in the app and actions done by Home Assistant.
