+
+- 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.
+
+### {% linkable_title Create Your 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 component in Home Assistant will process the request and send back the response. Your Lambda function will delivery the response back to Alexa.
+
+
+
+- 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.
+
+#### {% linkable_title Create a Lambda function and add code %}
+
+Next you need create a Lambda function.
+
+- Click `Service` in top navigation bar, expand the menu to display all AWS services, click `Lambda` under `Compute` section to navigate to Lambda console. Or you may use this [link](https://console.aws.amazon.com/lambda/home)
+- **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 or French (FR) 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`.
+- Make sure select *Use an existing role* as `Execution role`, then select the role you just created from `Existing role` list.
+- 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.
+- Clear the example code, copy the Python script from: 
+
+- 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.
+
+#### {% linkable_title 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.
+
+```yaml
+alexa:
+ smart_home:
+```
+
+After your Home Assistant restarted, back to `AWS Lambda Console`, you are going to do some tests.
+
+On the top of your Lambda function configuration page, there is a `Test` button, click the drop down button at left of `Test` button, click `Configure test events`, you can `Create new test event` using following data:
+
+```json
+{
+ "directive": {
+ "header": {
+ "namespace": "Alexa.Discovery",
+ "name": "Discover",
+ "payloadVersion": "3",
+ "messageId": "1bd5d003-31b9-476f-ad03-71d471922820"
+ },
+ "payload": {
+ "scope": {
+ "type": "BearerToken"
+ }
+ }
+ }
+}
+```
+
+This test event is a `Discovery` directive, Home Assistant will response with a list of your devices Alexa can interact with. This test data is lack of `token` in `payload.scope`, your Lambda function will read the `LONG_LIVED_ACCESS_TOKEN` from environment variable.
+
+Click `Test` button. If you don't have `LONG_LIVED_ACCESS_TOKEN`, you will get a `INVALID_AUTHORIZATION_CREDENTIAL` response as the execution result.
+
+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. 🎉
+
+### {% linkable_title Config 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.
+
+- Sign in [Alexa Developer Console][alexa-dev-console], go to `Alexa Skills` page if you are not.
+- Find the skill you just created, click `Edit` link in the `Actions` column.
+- 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.
+
+### {% linkable_title 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.
+
+- Sign in [Alexa Developer Console][alexa-dev-console], go to `Alexa Skills` page if you are not.
+- Find the skill you just created, click `Edit` link in the `Actions` column.
+- Click `ACCOUNT LINKING` in the left navigation bar of build page
+- Input all information required. Assuming your Home Assistant can be accessed by https://[YOUR HOME ASSISTANT URL:PORT]
+ * `Authorization URI`: https://[YOUR HOME ASSISTANT URL:PORT]/auth/authorize
+ * `Access Token URI`: https://[YOUR HOME ASSISTANT URL:PORT]/auth/token
+ * `Client ID`:
+ - https://pitangui.amazon.com/ if you are in US
+ - https://layla.amazon.com/ if you are in EU (not verified yet)
+ - 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
+ * `Client Authentication Scheme`: make sure you selected *Credentials in request body*. Home Assistant does not support *HTTP Basic*.
+ * `Scope`: input `smart_home`, Home Assistant is not using it yet, we may use it in the future when we allow more fine-grained access control.
+- You can leave `Domain List` and `Default Access Token Expiration Time` as empty.
+
+ 
+
+- Click `Save` button in the top right corner.
+- Next, you will use Alexa Mobile App or [Alexa web-based app](#alexa-web-based-app) to link your account.
+ * Open the Alexa app, navigate to `Skills` -> `Your Skills` -> `Dev Skills`
+ * Click the Smart Home skill you just created.
+ * 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* 🎉
+
+### {% linkable_title Alexa Component Configuration %}
+
+Example configuration:
```yaml
alexa:
@@ -57,12 +217,6 @@ alexa:
switch.stairs:
display_categories: LIGHT
```
-This exposes an HTTP POST endpoint at `http://your_hass_ip/api/alexa/smart_home`
-which accepts and returns messages conforming to the
-[Smart Home v3 payload](https://developer.amazon.com/docs/smarthome/smart-home-skill-api-message-reference.html).
-You must then create an Amazon developer account with an Alexa skill and Lambda function to integrate this endpoint.
-
-[Haaska](https://github.com/mike-grant/haaska/wiki) provides a step-by-step guide and necessary assets to help you create the Alexa skill and AWS Lambda.
The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode. Please note the following if you want to enable proactive mode:
@@ -70,5 +224,19 @@ 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."
-[amazon-dev-console]: https://developer.amazon.com
+
+### {% linkable_title Alexa web-based app %}
+
+The following is a list of regions and the corresponding URL for the web-based Alexa app:
+
+* United States: - If you do not download them you will lose them and will have to recreate a new user. -
- -- Copy/Paste the two keys that you are provided here in your `configuration.yaml` file respectively. -- On the left hand side of the screen go back to "Users" and select the user you just created. On the "Permissions" tab click the "Attach Policy" icon. Search for "SNS" and attach the policy "AmazonSNSFUullAccess". -- Back to the AWS Console you now need to find "SNS" and click in to that service. It is under the Mobile Services group. -- On the left hand side, select "Topics" then "Create new topic". -- Choose a Topic Name and Display Name. -- Now check the box next to the Topic you just created and under Actions, select "Subscribe to topic". -- In the box that pops up, select the Protocol = SMS and enter in the phone number next to "Endpoint" you wish to SMS. Now click "Create". -- Repeat for additional numbers. -- Back in the "Users" section you will see a long alphanumeric line that starts with "arn:" and ends with the Topic Name you choose previously. This is what your "target" in Home Assistant will be. diff --git a/source/_components/aws_sqs.markdown b/source/_components/aws_sqs.markdown deleted file mode 100644 index 824c1c26cab..00000000000 --- a/source/_components/aws_sqs.markdown +++ /dev/null @@ -1,77 +0,0 @@ ---- -layout: page -title: "AWS SQS" -description: "Instructions on how to publish messages to AWS SQS from Home Assistant." -date: 2016-05-14 16:35 -sidebar: true -comments: false -sharing: true -footer: true -logo: aws_sqs.png -ha_category: Notifications -ha_release: "0.20" -redirect_from: - - /components/notify.aws_sqs/ ---- - -The `aws_sqs` notification platform enables publishing to an [AWS SQS](https://aws.amazon.com/sqs/) message queue. - -## {% linkable_title Setup %} - -For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) to get the needed details. Also, check the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) about the profiles and the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions. - -## {% linkable_title Configuration %} - -To use this notification platform in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -notify: - - name: NOTIFIER_NAME - platform: aws_sqs - aws_access_key_id: AWS_ACCESS_KEY_ID - aws_secret_access_key: AWS_SECRET_ACCESS_KEY - region_name: 'us-east-1' -``` - -{% configuration %} -aws_access_key_id: - description: Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`. - required: Required if aws_secret_access_key is provided - type: string -aws_secret_access_key: - description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`. - required: Required if aws_access_key_id is provided - type: string -profile_name: - description: A credentials profile name. - required: false - type: string -region_name: - description: The region identifier to connect to. - required: true - default: us-east-1 - type: string -name: - description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. - required: false - default: notify - type: string -{% endconfiguration %} - -### {% linkable_title Usage %} - -AWS SQS is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the [SQS docs](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html). - -The SQS event payload will contain everything passed in the service call payload. SQS payloads will be published as stringified JSON. All attributes from the payload except message will also be sent as stringified message attributes. Here is an example message that would be published to the SQS queue: - -```json -{ - "title": "Test message!", - "target": "http://sqs.us-east-1.amazonaws.com/123456789012/queue2", - "data": { - "test": "okay" - }, - "message": "Hello world!" -} -``` diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown index 6be6f03c507..8652dc0d616 100644 --- a/source/_components/binary_sensor.mqtt.markdown +++ b/source/_components/binary_sensor.mqtt.markdown @@ -90,7 +90,7 @@ device_class: required: false type: string value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. Available variables: `entity_id`." + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. Available variables: `entity_id`. Remove this option when 'payload_on' and 'payload_off' are sufficient to match your payloads." required: false type: string force_update: diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index 4fbb5a6bae4..3d9d17c7b71 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -60,7 +60,7 @@ sensors: type: device_class default: None value_template: - description: Defines a template to set the state of the sensor. + description: The sensor is `on` if the template evaluates as `True` and `off` otherwise. The actual appearance in the frontend (`Open`/`Closed`, `Detected`/`Clear` etc) depends on the sensor’s device_class value required: true type: template icon_template: diff --git a/source/_components/binary_sensor.xiaomi_aqara.markdown b/source/_components/binary_sensor.xiaomi_aqara.markdown index d79c2a580a6..7d43dc7d2e5 100644 --- a/source/_components/binary_sensor.xiaomi_aqara.markdown +++ b/source/_components/binary_sensor.xiaomi_aqara.markdown @@ -30,6 +30,7 @@ The requirement is that you have setup the [`xiaomi aqara` component](/component | Water Leak Sensor | sensor_wleak.aq1 | SJCGQ11LM | on, off | | | | | Button (1st gen) | switch | WXKG01LM | on (through long_click_press), off | `xiaomi_aqara.click`| `click_type`| `long_click_press`, `long_click_release`, `hold`, `single`, `double` | | Button (2nd gen) | sensor_switch.aq2, remote.b1acn01 | WXKG11LM | off (always) | `xiaomi_aqara.click` | `click_type` | `single`, `double` | +| Button (2nd gen, model b) | sensor_switch.aq3 | WXKG12LM | off (always) | `xiaomi_aqara.click` | `click_type` | `single`, `double`, `long_click_press`, `shake` | | Aqara Wireless Switch (Single) | 86sw1 | WXKG03LM | off (always) | `xiaomi_aqara.click` | `click_type` | `single` | | Aqara Wireless Switch (Double) | 86sw2 | WXKG02LM | off (always) | `xiaomi_aqara.click` | `click_type` | `single`, `both` | | Aqara Wireless Switch (Single) (2nd gen) | remote.b186acn01 | WXKG03LM | off (always) | `xiaomi_aqara.click` | `click_type` | `single`, `double`, `long` | @@ -144,7 +145,7 @@ The requirement is that you have setup the [`xiaomi aqara` component](/component #### {% linkable_title Xiaomi Wireless Button %} -Available events are `single`, `double`, `hold`, `long_click_press` and `long_click_release`. For Square version (Aqara brand) only `single` and `double` events are supported. Furthermore the space between two clicks to generate a double click must be quite large now. +As indicated in the table on top of this page there are 3 versions of the button. For the round shaped button the available events are `single`, `double`, `hold`, `long_click_press` and `long_click_release`. Aqara branded buttons are square shaped. Model WXKG11LM only supports `single` and `double` events. WXKG12LM supports `single`, `double`, `long_click_press` and `shake` events. For the Aqara versions the delay between two clicks to generate a double click must be larger than with the round button. Clicking too quickly generates a single click event. ```yaml - alias: Toggle dining light on single press diff --git a/source/_components/bom.markdown b/source/_components/bom.markdown index f9265b83145..dd1fbfcd7cd 100644 --- a/source/_components/bom.markdown +++ b/source/_components/bom.markdown @@ -250,7 +250,7 @@ monitored_conditions: air_temp: description: Air temperature in C. dewpt: - description: Drew point in C. + description: Dew point in C. press: description: Pressure in mbar. press_qnh: diff --git a/source/_components/broadlink.markdown b/source/_components/broadlink.markdown index 91bc57e07e2..61aee2d9d1d 100644 --- a/source/_components/broadlink.markdown +++ b/source/_components/broadlink.markdown @@ -210,7 +210,7 @@ Information about how to install on Windows can be found [here](/components/sens ### {% linkable_title How to obtain IR/RF packets? %} -Choose Call Service from the Developer Tools. Choose the service `broadlink.learn` from the list of **Available services:** 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. +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. Example config for `rm`, `rm2`, `rm_mini`, `rm_pro_phicomm`, `rm2_home_plus`, `rm2_home_plus_gdt`, `rm2_pro_plus`, `rm2_pro_plus2`, `rm2_pro_plus_bl` and `rm_mini_shate` devices: @@ -435,7 +435,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro ```bash Property: msg.payload Format: Mustache template - Template field: enter '{{payload.data}}'. + 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. diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown index 205e50be6ce..5052a6e3edf 100644 --- a/source/_components/cover.mqtt.markdown +++ b/source/_components/cover.mqtt.markdown @@ -163,7 +163,7 @@ tilt_opened_value: required: false type: integer default: 100 -tilt_status_optimistic: +tilt_optimistic: description: Flag that determines if tilt works in optimistic mode. required: false type: boolean diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown index b927240b3aa..c01d5d8dff3 100644 --- a/source/_components/daikin.markdown +++ b/source/_components/daikin.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Daikin AC" -description: "Instructions on how to integrate Hive devices with Home Assistant." +description: "Instructions on how to integrate Daikin AC devices with Home Assistant." date: 2017-12-10 21:00 sidebar: true comments: false @@ -30,17 +30,17 @@ There is currently support for the following device types within Home Assistant: ## {% linkable_title Supported hardware %} -This component supports the European versions of Daikin AC (BRP069A[41,42,43,45]) and AU AirBase units (BRP15B61). - -The Australian version of the Daikin Wifi Controller Unit BRP072A42. Confirmed working on a Daikin Cora Series Reverse Cycle Split System Air Conditioner 2.5kW Cooling FTXM25QVMA with operation mode, temp, fan swing (3d, horizontal, vertical) which is powered by the [DAIKIN Mobile Controller](https://itunes.apple.com/au/app/daikin-mobile-controller/id917168708?mt=8) - -Some models do not support setting of fan speed or fan swing mode. - -Please note that some AC devices may report outside temperature only when they are turned on. +- The European versions of the Wifi Controller Unit (BRP069A41, 42, 43, 45), which is powered by the [Daikin Online Controller](https://play.google.com/store/apps/details?id=eu.daikin.remoapp) application. +- The Australian version of the Daikin Wifi Controller Unit BRP072A42. Confirmed working on a Daikin Cora Series Reverse Cycle Split System Air Conditioner 2.5kW Cooling FTXM25QVMA with operation mode, temp, fan swing (3d, horizontal, vertical) which is powered by the [DAIKIN Mobile Controller](https://itunes.apple.com/au/app/daikin-mobile-controller/id917168708?mt=8) ([Android version](https://play.google.com/store/apps/details?id=eu.daikin.remoapp)) application. +- The Australian version of the Daikin Wifi Controller for **AirBase** units (BRP15B61), which is powered by the [Daikin Airbase](https://play.google.com/store/apps/details?id=au.com.daikin.airbase) application. ## {% linkable_title Configuration %} -To automatically add all your Daikin devices (ACs and associated sensors) into your Home Assistant installation, add the following to your `configuration.yaml` file: +The Daikin component can be configured in three ways. + +- Automatically via the [discovery]({{site_root}}/components/discovery/) component. +- Via the Home Assistant user interface where it will let you enter the IP-address of your Daikin AC. +- Or via the `configuration.yaml` file by adding the following: ```yaml # Full manual example configuration.yaml entry @@ -62,11 +62,15 @@ hosts: The `daikin` climate platform integrates Daikin air conditioning systems into Home Assistant, enabling control of setting the following parameters: - **mode** (cool, heat, dry, fan only or auto) -- **fan speed** (on supported models) - **target temperature** -- **swing mode** (on supported models) +- **fan speed** +- **swing mode** -Current temperature is displayed. +Current inside temperature is displayed. + ++Some models do not support setting of **fan speed** or **swing mode**. +
## {% linkable_title Sensor %} @@ -75,6 +79,14 @@ The `daikin` sensor platform integrates Daikin air conditioning systems into Hom - Inside temperature - Outside temperature ++Some models only report outside temperature when they are turned on. +
+ ## {% linkable_title Switch %} Daikin AirBase units exposes zones (typically rooms) that can be switched on/off individually. + ++Zones with the name `-` will be ignored, just as the AirBase application is working. +
\ No newline at end of file diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index aa04bd3228d..68037c57594 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -75,7 +75,7 @@ logger: ## {% linkable_title Device services %} -Available services: `configure` and `deconz.refresh_devices`. +Available services: `configure` and `deconz.device_refresh`. ### {% linkable_title Service `deconz.configure` %} @@ -97,7 +97,7 @@ Either `entity` or `field` must be provided. If both are present, `field` will b { "field": "/config", "data": {"permitjoin": 60} } -#### {% linkable_title Service `deconz.refresh_devices` %} +#### {% linkable_title Service `deconz.device_refresh` %} Refresh with devices added to deCONZ after Home Assistants latest restart. diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown index 6f63703e70f..351cf4a37eb 100644 --- a/source/_components/device_tracker.markdown +++ b/source/_components/device_tracker.markdown @@ -115,3 +115,17 @@ If you want to track whether either your GPS based tracker or your local network ## {% linkable_title Device states %} The state of your tracked device will be `'home'` if it is in the [home zone](/components/zone#home-zone), detected by your network or Bluetooth based presence detection. If you're using a presence detection method that includes coordinates then when it's in a zone the state will be the name of the zone (in lower case). When a device isn't at home and isn't in any zone, the state will be `'not_home'`. + +## {% linkable_title `device_tracker.see` service %} + +The `device_tracker.see` service can be used to manually update the state of a device tracker: + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `dev_id` | no | The second half of the `entity_id`, for example `tardis` for `device_tracker.tardis` | +| `location_name` | no | The location, `home`, `not_home`, or the name of the zone | +| `host_name` | yes | The hostname of the device tracker | +| `mac` | yes | The MAC address of the entity (only specify if you're updating a network based tracker) | +| `gps` | yes | If you're providing a location, for example `[51.513845, -0.100539]` | +| `gps_accuracy` | yes | The accuracy of the GPS fix | +| `battery` | yes | The battery level of the device | diff --git a/source/_components/epsonprinter.markdown b/source/_components/epsonworkforce.markdown similarity index 73% rename from source/_components/epsonprinter.markdown rename to source/_components/epsonworkforce.markdown index 6f94796352b..61c4e62b28a 100644 --- a/source/_components/epsonprinter.markdown +++ b/source/_components/epsonworkforce.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Epson Printer" +title: "Epson Workforce" description: "Instructions on how to integrate Epson Workforce Printer into Home Assistant." date: 2019-04-09 16:00 sidebar: true @@ -13,15 +13,15 @@ ha_release: 0.92 ha_iot_class: Local Polling --- -The `epson printer` platform allows you to monitor the ink levels of a Epson Workforce printer from Home +The `epson workforce` platform allows you to monitor the ink levels of a Epson Workforce printer from Home Assistant. -To add Epson Printer to your installation, add the following to your `configuration.yaml` file: +To add Epson Workforce to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry sensor: - - platform: epsonprinter + - platform: epsonworkforce host: IP_ADDRESS monitored_conditions: - black @@ -33,7 +33,7 @@ sensor: {% configuration %} host: - description: The host name or address of the Epson printer + description: The host name or address of the Epson workforce printer required: true type: string monitored_conditions: @@ -62,4 +62,4 @@ Tested devices: - Epson WF3540 To make this module work you need to connect your printer to your LAN. -The best is to navigate to the IP of the printer to check. +The best is to navigate to the IP of the printer to check if it shows a status page. diff --git a/source/_components/google_translate.markdown b/source/_components/google_translate.markdown index cb052015c4a..7dc9826f101 100644 --- a/source/_components/google_translate.markdown +++ b/source/_components/google_translate.markdown @@ -18,7 +18,7 @@ redirect_from: The `google_translate` text-to-speech platform uses unofficial [Google Translate Text-to-Speech engine](https://translate.google.com/) to read a text with natural sounding voices.-This platform renamed to `google_translate` from `google` since release 0.92 +This platform renamed to `google_translate` from `google` since release 0.92.
## {% linkable_title Configuration %} @@ -40,7 +40,7 @@ language: {% endconfiguration %} Check the [complete list of supported languages](https://translate.google.com/intl/en_ALL/about/languages/) (languages where "Talk" feature is enabled in Google Translate) for allowed values. -Use the 2 digit language code which you can find at the end of url when you click on Language name. +Use the 2 digit language code which you can find at the end of URL when you click on Language name. ## {% linkable_title Full configuration example %} @@ -60,5 +60,3 @@ If you are using SSL certificate or Docker, you may need to add the `base_url` c http: base_url: example.duckdns.org ``` - -The `base_url` configuration variable was added in 0.35.1, so make sure your Home Assistant version is **0.35.1 or above.** diff --git a/source/_components/hue.markdown b/source/_components/hue.markdown index 01e012f6b39..60d5ba0f198 100644 --- a/source/_components/hue.markdown +++ b/source/_components/hue.markdown @@ -71,19 +71,6 @@ hue: allow_hue_groups: true ``` -### {% linkable_title Migrating from older configuration %} - -In previous versions of the `hue` component the configuration looked different: - -```yaml -# Example configuration.yaml entry -light: - - platform: hue - host: DEVICE_IP_ADDRESS -``` - -You will need to convert each bridge into an entry in the new configuration style. See above for an example. - ### {% linkable_title Multiple Hue bridges %} Multiple Hue bridges work transparently with discovery, you don't have to do anything. If you prefer to configure them manually and use multiple Hue bridges then it's needed that you provide a configuration file for every bridge. The bridges can't share a single configuration file. diff --git a/source/_components/introduction.markdown b/source/_components/introduction.markdown index aa5bc3ced48..012bd24c055 100644 --- a/source/_components/introduction.markdown +++ b/source/_components/introduction.markdown @@ -8,11 +8,12 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Other ha_qa_scale: internal ha_release: 0.7 --- +This integration has been removed in Home Assistant 0.92. The UI will now take care of this text.
+ The introduction component will show a card in the UI with 'Welcome Home!' and steps on how to get started. It will also print the same message to the console when starting up. The introduction component is loaded by default on a new Home Assistant instance. diff --git a/source/_components/local_file.markdown b/source/_components/local_file.markdown index 7a59c9acdd2..d5cdd4e298c 100644 --- a/source/_components/local_file.markdown +++ b/source/_components/local_file.markdown @@ -32,7 +32,7 @@ camera: {% configuration %} file_path: - description: File to serve as the camera. + description: "File to serve as the camera. Use a full path, e.g., `/config/www/images/image.jpg `." required: true type: string name: diff --git a/source/_components/logger.markdown b/source/_components/logger.markdown index 4f4daf1e73a..50d6b8394fc 100644 --- a/source/_components/logger.markdown +++ b/source/_components/logger.markdown @@ -34,6 +34,7 @@ logger: logs: homeassistant.components.device_tracker: critical homeassistant.components.camera: critical + custom_components.my_integration: critical ``` To ignore all messages lower than critical and log event for specified @@ -48,6 +49,7 @@ logger: homeassistant.components.rfxtrx: debug homeassistant.components.device_tracker: critical homeassistant.components.camera: critical + custom_components.my_integration: debug ``` {% configuration %} @@ -106,6 +108,7 @@ service: logger.set_level data: homeassistant.components: warning homeassistant.components.media_player.yamaha: debug + custom_components.my_integration: debug ``` The log information are stored in the diff --git a/source/_components/media_player.markdown b/source/_components/media_player.markdown index e11273a4750..5bfb1c3fd08 100644 --- a/source/_components/media_player.markdown +++ b/source/_components/media_player.markdown @@ -42,7 +42,7 @@ Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, | `entity_id` | yes | Target a specific media player. Defaults to all. | | `seek_position` | no | Position to seek to. The format is platform dependent. | -#### {% linkable_title Service `media_player.media_play` %} +#### {% linkable_title Service `media_player.play_media` %} | Service data attribute | Optional | Description | | -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/source/_components/mqtt_room.markdown b/source/_components/mqtt_room.markdown index fe18eb216b4..3ee3c59c805 100644 --- a/source/_components/mqtt_room.markdown +++ b/source/_components/mqtt_room.markdown @@ -40,8 +40,7 @@ name: type: string state_topic: description: The topic that contains all subtopics for the rooms. - required: false - default: room_presence + required: true type: string timeout: description: "The time in seconds after which a room presence state is considered old. An example: device1 is reported at scanner1 with a distance of 1. No further updates are sent from scanner1. After 5 seconds scanner2 reports device1 with a distance of 2. The old location info is discarded in favor of the new scanner2 information as the timeout has passed." diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index a373f5f04f9..bd5861b72aa 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -76,7 +76,7 @@ mysensors: type: integer default: true version: - description: Specifies the MySensors protocol version to use. Supports 1.4, 1.5 and 2.0. + description: Specifies the MySensors protocol version to use. Supports versions 1.4 to 2.3. required: false type: string default: '1.4' @@ -93,7 +93,7 @@ mysensors: {% endconfiguration %}-Not all features of MySensors 2.0 are supported by Home Assistant yet. As more features are added, they will be described here in the documentation. Go to the MySensors platform pages under "related components" to see what message types are currently supported. +Not all features of MySensors 2.x are supported by Home Assistant yet. As more features are added, they will be described here in the documentation. Go to the MySensors platform pages under "related components" to see what message types are currently supported.
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. @@ -110,7 +110,7 @@ mqtt: ```-The MQTT gateway requires MySensors version 2.0 and only the MQTT client gateway is supported. +The MQTT gateway requires MySensors version 2.0+ and only the MQTT client gateway is supported.
### {% linkable_title Extended configuration example %} @@ -153,7 +153,7 @@ Present a MySensors sensor or actuator, by following these steps: 4. Write and upload your MySensors sketch to the sensor. Make sure you: - Send sketch name. - Present the sensor's `S_TYPE`. - - Send at least one initial value per `V_TYPE`. In version 2.0 of MySensors, this has to be done in the loop function. See below for an example in 2.0 of how to make sure the initial value has been received by the controller. + - Send at least one initial value per `V_TYPE`. In version 2.x of MySensors, this has to be done in the loop function. See below for an example in 2.0 of how to make sure the initial value has been received by the controller. 5. Start the sensor. ```cpp diff --git a/source/_components/n26.markdown b/source/_components/n26.markdown index f54370ddab7..b4ea134c675 100644 --- a/source/_components/n26.markdown +++ b/source/_components/n26.markdown @@ -14,7 +14,7 @@ ha_category: - Switch ha_release: 0.92 featured: false -ha_iot_class: "Local Polling" +ha_iot_class: Cloud Polling --- The [N26](https://n26.com) integration for Home Assistant allows you to track your N26 account. diff --git a/source/_components/scrape.markdown b/source/_components/scrape.markdown index f427b7de3ef..458e8876e1f 100644 --- a/source/_components/scrape.markdown +++ b/source/_components/scrape.markdown @@ -118,7 +118,8 @@ sensor: - platform: scrape resource: http://www.bfs.de/DE/themen/opt/uv/uv-index/prognose/prognose_node.html name: Coast Ostsee - select: 'p:nth-of-type(19)' + select: 'p' + index: 19 unit_of_measurement: 'UV Index' ``` @@ -145,7 +146,8 @@ sensor: - platform: scrape resource: https://hasspodcast.io/feed/podcast name: Home Assistant Podcast - select: 'enclosure:nth-of-type(1)' + select: 'enclosure' + index: 1 attribute: url ``` diff --git a/source/_components/speedtestdotnet.markdown b/source/_components/speedtestdotnet.markdown index 6ff3c58da95..285897846b3 100644 --- a/source/_components/speedtestdotnet.markdown +++ b/source/_components/speedtestdotnet.markdown @@ -90,7 +90,7 @@ action: This component uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display. -When Home Assistant first starts up, the values of the speed test will show as `Unknown`. You can use the service `sensor.update_speedtest` to run a manual speed test and populate the data or just wait for the next regularly scheduled test. You can turn on manual mode to disable the scheduled speed tests. +When Home Assistant first starts up, the values of the speed test will show as `Unknown`. You can use the service `speedtestdotnet.speedtest` to run a manual speed test and populate the data or just wait for the next regularly scheduled test. You can turn on manual mode to disable the scheduled speed tests. ## {% linkable_title Examples %} diff --git a/source/_components/stream.markdown b/source/_components/stream.markdown index 8858938527e..f96e12ebe5c 100644 --- a/source/_components/stream.markdown +++ b/source/_components/stream.markdown @@ -45,16 +45,22 @@ Both `duration` and `lookback` options are suggestions, but should be consistent The path part of `filename` must be an entry in the `whitelist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file. -For example, the following action in an automation would take a recording from `rtsp://my.stream.feed:554` and save it to `/tmp`. +For example, the following action in an automation would take a recording from `rtsp://my.stream.feed:554` and save it to `/config/www`. ```yaml action: service: camera.record data: - stream_source: rtsp://my.stream.feed:554 - filename: '/tmp/my_stream.mp4' + entity_id: camera.quintal + filename: '/config/www/my_stream.mp4' + duration: 30 ``` +## {% linkable_title Streaming in Lovelace %} + +As of Homeassistant version 0.92 you can now live-stream a camera feed directly in lovelace. +To do this add either [picture-entity](/lovelace/picture-entity/), [picture-glance](/lovelace/picture-glance/) or [picture-elements](/lovelace/picture-elements/), set `camera_image` to a stream-ready camera entity and set `camera_view` to `live` in one of your lovelace views. + ## {% linkable_title Troubleshooting %} Some users on manual installs may see the following error in their logs after restarting: diff --git a/source/_components/tts.markdown b/source/_components/tts.markdown index f6f727c2013..85b775d1ba9 100644 --- a/source/_components/tts.markdown +++ b/source/_components/tts.markdown @@ -49,18 +49,24 @@ base_url: required: false type: string default: value of ``http.base_url`` +service_name: + description: Define the service name. + required: false + type: string + default: The service name default set to@@ -91,7 +97,7 @@ The Google cast devices (Google Home, Chromecast, etc.) present the following pr ## {% linkable_title Service say %} -The `say` service support `language` and on some platforms also `options` for set, i.e., *voice, motion, speed, etc*. The text for speech is set with `message`. +The `say` service support `language` and on some platforms also `options` for set, i.e., *voice, motion, speed, etc*. The text for speech is set with `message`. Since release 0.92, service name can be defined in configuration `service_name` option. Say to all `media_player` device entities: diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index ddabec52c3d..43cdf5fdb97 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -129,7 +129,7 @@ automation: - service: vacuum.xiaomi_clean_zone data_template: entity_id: vacuum.xiaomi_vacuum - repeats_template: '{{states.input_number.vacuum_passes.state|int}}' + repeats: '{{states.input_number.vacuum_passes.state|int}}' zone: [[30914,26007,35514,28807], [20232,22496,26032,26496]] ``` Array with inline zone: @@ -144,7 +144,7 @@ automation: - service: vacuum.xiaomi_clean_zone data_template: entity_id: vacuum.xiaomi_vacuum - repeats_template: '{{states.input_number.vacuum_passes.state|int}}' + repeats: '{{states.input_number.vacuum_passes.state|int}}' zone: - [30914,26007,35514,28807] - [20232,22496,26032,26496] diff --git a/source/_docs/installation/raspberry-pi.markdown b/source/_docs/installation/raspberry-pi.markdown index 2e412cf0756..a8a9c858923 100644 --- a/source/_docs/installation/raspberry-pi.markdown +++ b/source/_docs/installation/raspberry-pi.markdown @@ -45,7 +45,7 @@ $ sudo apt-get upgrade -y Install the dependencies. ```bash -$ sudo apt-get install python3 python3-venv python3-pip libffi-dev +$ sudo apt-get install python3 python3-venv python3-pip libffi-dev libssl-dev ``` Add an account for Home Assistant called `homeassistant`. diff --git a/source/_docs/mqtt/broker.markdown b/source/_docs/mqtt/broker.markdown index a7cf4a08b5c..1160ed99887 100644 --- a/source/_docs/mqtt/broker.markdown +++ b/source/_docs/mqtt/broker.markdown @@ -12,54 +12,10 @@ logo: mqtt.png The MQTT component needs you to run an MQTT broker for Home Assistant to connect to. There are four options, each with various degrees of ease of setup and privacy. -### {% linkable_title Embedded broker %} - -Home Assistant contains an embedded MQTT broker called [HBMQTT](https://pypi.python.org/pypi/hbmqtt). If you don't have an MQTT broker, you can configure this one to be used. If configured, Home Assistant will automatically connect to it. - -| Setting | Value | -| -------------- | ----- | -| Host | localhost | -| Port | 1883 | -| Protocol | 3.1.1 | -| User | homeassistant | -| Password | _password set under mqtt settings_ | -| Websocket port | 8080 | - -```yaml -# Example configuration.yaml entry -mqtt: - password: hello -``` - -
-Before release 0.76, the embedded broker would use your API password as a password to the MQTT user. This is no longer the case. -
- --There is [an issue](https://github.com/beerfactory/hbmqtt/issues/62) with the HBMQTT broker and the WebSocket connection that is causing a memory leak. If you experience this issue, consider using another broker like Mosquitto. -
- -### {% linkable_title Owntracks%} - -To use Owntracks with the internal broker a small configuration change must be made in order for the app to use MQTT protocol 3.1.1 (Protocol Level 4). - -In the Owntracks preferences (Android: v1.2.3+, iOS: v9.5.1+) open **Configuration Management**; Find the value named `mqttProtocolLevel` and set the value to `4`. The application will now use MQTT 3.1.1 to connect, which is compatible with the embedded broker. - -### {% linkable_title Settings %} - -If you want to customize the settings of the embedded broker, use `embedded:` and the values shown in the [HBMQTT Broker configuration](http://hbmqtt.readthedocs.org/en/latest/references/broker.html#broker-configuration). This will replace the default configuration. - -```yaml -# Example configuration.yaml entry -mqtt: - embedded: - # Your HBMQTT config here. Example at: - # http://hbmqtt.readthedocs.org/en/latest/references/broker.html#broker-configuration -``` - ### {% linkable_title Run your own %} -Along with the embedded broker this is the most private option, but it requires a bit more work. There are multiple free and open-source brokers to pick from: e.g., [Mosquitto](http://mosquitto.org/), [EMQ](https://github.com/emqx/emqx) or [Mosca](http://www.mosca.io/). +This is the most private option, but it requires a little bit of work to setup. There are multiple free and open-source brokers to pick from: e.g., [Mosquitto](http://mosquitto.org/), [EMQ](https://github.com/emqx/emqx) or [Mosca](http://www.mosca.io/). +For hass.io users, the recommended setup method is to use the [Mosquitto MQTT broker addon](/addons/mosquitto). ```yaml # Example configuration.yaml entry @@ -177,3 +133,51 @@ Home Assistant will automatically load the correct certificate if you connect to If you experience an error message like `Failed to connect due to exception: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed`, then add `certificate: auto` to your broker configuration and restart Home Assistant. +### {% linkable_title Embedded broker (Deprecated)%} + +Home Assistant contains an embedded MQTT broker called [HBMQTT](https://pypi.python.org/pypi/hbmqtt). If you don't have an MQTT broker, you can configure this one to be used. If configured, Home Assistant will automatically connect to it. + +| Setting | Value | +| -------------- | ----- | +| Host | localhost | +| Port | 1883 | +| Protocol | 3.1.1 | +| User | homeassistant | +| Password | _password set under mqtt settings_ | +| Websocket port | 8080 | + +```yaml +# Example configuration.yaml entry +mqtt: + password: hello +``` + ++As of release 0.92, the embedded broker has been marked as deprecated. This means bugs may not be fixed, and the functionality may be removed in a future release. +
+ ++Before release 0.76, the embedded broker would use your API password as a password to the MQTT user. This is no longer the case. +
+ ++There is [an issue](https://github.com/beerfactory/hbmqtt/issues/62) with the HBMQTT broker and the WebSocket connection that is causing a memory leak. If you experience this issue, consider using another broker like Mosquitto. +
+ +#### {% linkable_title Owntracks%} + +To use Owntracks with the internal broker a small configuration change must be made in order for the app to use MQTT protocol 3.1.1 (Protocol Level 4). + +In the Owntracks preferences (Android: v1.2.3+, iOS: v9.5.1+) open **Configuration Management**; Find the value named `mqttProtocolLevel` and set the value to `4`. The application will now use MQTT 3.1.1 to connect, which is compatible with the embedded broker. + +#### {% linkable_title Settings %} + +If you want to customize the settings of the embedded broker, use `embedded:` and the values shown in the [HBMQTT Broker configuration](http://hbmqtt.readthedocs.org/en/latest/references/broker.html#broker-configuration). This will replace the default configuration. + +```yaml +# Example configuration.yaml entry +mqtt: + embedded: + # Your HBMQTT config here. Example at: + # http://hbmqtt.readthedocs.org/en/latest/references/broker.html#broker-configuration +``` diff --git a/source/_docs/z-wave/device-specific.markdown b/source/_docs/z-wave/device-specific.markdown index 845dc0fa1d9..aacb9b3da27 100644 --- a/source/_docs/z-wave/device-specific.markdown +++ b/source/_docs/z-wave/device-specific.markdown @@ -624,4 +624,46 @@ switch: value_id: "{{ state_attr('sensor.scene_contrl_indicator','value_id') }}" value: "{{ states('sensor.scene_contrl_indicator')|int - 16 }}" ``` + +### {% linkable_title HeatIt/ThermoFloor Z-Push Button 2/8 Wall Switch %} + +To get the Z-Push Button 2 or the Z-Push Button 8 working in Home Assistant, you must first edit the `COMMAND_CLASS_CENTRAL_SCENE` in your `zwcfg` file. + +1. Go the Z-Wave control panel in Home Assistant and make a note of the node number your wall switch has been assigned. +2. *Stop* Home Assistant. +3. Make a backup of your `zwfcg` file, just in case. +4. In the `zwcfg` file, find the `Node id` that corresponds to the number you noted in the first step. +5. Within the `Node id` you identified, highlight everything between `Home Assistant is sponsored by
-
-
