+
+- 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 +218,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 +225,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/baidu.markdown b/source/_components/baidu.markdown index 93db86cc285..0bc6c21bf65 100644 --- a/source/_components/baidu.markdown +++ b/source/_components/baidu.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: baiducloud.png -ha_category: Text-to-speech +ha_category: + - Text-to-speech ha_release: 0.59 redirect_from: - /components/tts.baidu/ diff --git a/source/_components/bayesian.markdown b/source/_components/bayesian.markdown index 700287f582b..8b62aa14653 100644 --- a/source/_components/bayesian.markdown +++ b/source/_components/bayesian.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Utility +ha_category: + - Utility ha_iot_class: Local Polling ha_release: 0.53 ha_qa_scale: internal diff --git a/source/_components/bh1750.markdown b/source/_components/bh1750.markdown index 90486f74cb3..4bd83fa5ce4 100644 --- a/source/_components/bh1750.markdown +++ b/source/_components/bh1750.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: DIY +ha_category: + - DIY ha_release: 0.48 ha_iot_class: Local Push redirect_from: diff --git a/source/_components/binary_sensor.knx.markdown b/source/_components/binary_sensor.knx.markdown index 74f531994ee..f144ff47952 100644 --- a/source/_components/binary_sensor.knx.markdown +++ b/source/_components/binary_sensor.knx.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: knx.png -ha_category: Binary Sensor +ha_category: + - Binary Sensor ha_release: 0.24 ha_iot_class: Local Polling --- diff --git a/source/_components/binary_sensor.modbus.markdown b/source/_components/binary_sensor.modbus.markdown index f278a9edb3d..4fd3dd2ffca 100644 --- a/source/_components/binary_sensor.modbus.markdown +++ b/source/_components/binary_sensor.modbus.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: modbus.png -ha_category: Binary Sensor +ha_category: + - Binary Sensor ha_release: 0.28 ha_iot_class: Local Push --- diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown index 6be6f03c507..7cccd22aa10 100644 --- a/source/_components/binary_sensor.mqtt.markdown +++ b/source/_components/binary_sensor.mqtt.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mqtt.png -ha_category: Binary Sensor +ha_category: + - Binary Sensor ha_release: 0.9 ha_iot_class: Configurable --- @@ -90,7 +91,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.netatmo.markdown b/source/_components/binary_sensor.netatmo.markdown deleted file mode 100644 index 8ef50d8737f..00000000000 --- a/source/_components/binary_sensor.netatmo.markdown +++ /dev/null @@ -1,82 +0,0 @@ ---- -layout: page -title: "Netatmo Binary Sensor" -description: "Instructions on how to integrate Netatmo binary sensor into Home Assistant." -date: 2016-09-19 15:10 -sidebar: true -comments: false -sharing: true -footer: true -logo: netatmo.png -ha_category: Binary Sensor -ha_release: 0.31 ---- - -The `netatmo` binary sensor platform is consuming the information provided by a -[Netatmo](https://www.netatmo.com) camera. -This component allows you to get the latest event seen by the camera. - -### {% linkable_title Basic Configuration %} - -To enable the Netatmo binary sensor, you have to set up -[netatmo](/components/netatmo/), -this will use discovery to add your binary sensor. - -### {% linkable_title Advanced configuration %} - -If you want to select a specific sensor, -set discovery to `false` for [netatmo](/components/netatmo/) -and add the following lines to your `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -binary_sensor: - platform: netatmo - home: home_name - timeout: 90 - cameras: - - camera_name1 - welcome_sensors: - - Someone known - - Someone unknown - - Motion - presence_sensors: - - Outdoor motion - - Outdoor human - - Outdoor animal - - Outdoor vehicle -``` - -{% configuration %} -home: - description: Will use the cameras of this home only. - required: false - type: string -timeout: - description: > - The Welcome/Presence binary sensors will - stay on for X seconds after detection. - required: false - type: integer - default: 90 -cameras: - description: List of cameras entity IDs to display. - required: false - type: list -welcome_sensors: - description: > - List of monitored conditions. Possible values are - 'Someone known', 'Someone unknown' and 'Motion'. - required: false - type: list -presence_sensors: - description: > - List of monitored conditions. Possible values are 'Outdoor motion', - 'Outdoor human', 'Outdoor animal' and 'Outdoor vehicle'. - required: false - type: list -{% endconfiguration %} - -If **home** and **cameras** is not provided, all cameras will be used. -If multiple cameras are available then each monitored conditions -will create a specific sensor for each camera diff --git a/source/_components/binary_sensor.rest.markdown b/source/_components/binary_sensor.rest.markdown index f7949e2771e..46ece211e90 100644 --- a/source/_components/binary_sensor.rest.markdown +++ b/source/_components/binary_sensor.rest.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: restful.png -ha_category: Binary Sensor +ha_category: + - Binary Sensor ha_release: "0.10" ha_iot_class: Local Polling --- diff --git a/source/_components/binary_sensor.rflink.markdown b/source/_components/binary_sensor.rflink.markdown index d15cee62bb7..bfc0979f0a8 100644 --- a/source/_components/binary_sensor.rflink.markdown +++ b/source/_components/binary_sensor.rflink.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: rflink.png -ha_category: Binary Sensor +ha_category: + - Binary Sensor ha_iot_class: Local Push ha_release: 0.81 --- diff --git a/source/_components/binary_sensor.rfxtrx.markdown b/source/_components/binary_sensor.rfxtrx.markdown index ab95973988d..571af036e8d 100644 --- a/source/_components/binary_sensor.rfxtrx.markdown +++ b/source/_components/binary_sensor.rfxtrx.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: rfxtrx.png -ha_category: Binary Sensor +ha_category: + - Binary Sensor ha_release: 0.48 --- diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index 4fbb5a6bae4..a5648394bca 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Binary Sensor +ha_category: + - Binary Sensor ha_release: 0.12 ha_iot_class: Local Push logo: home-assistant.png @@ -60,7 +61,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..30ee1d358cd 100644 --- a/source/_components/binary_sensor.xiaomi_aqara.markdown +++ b/source/_components/binary_sensor.xiaomi_aqara.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: xiaomi.png -ha_category: Binary Sensor +ha_category: + - Binary Sensor ha_release: "0.50" ha_iot_class: Local Push --- @@ -30,6 +31,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 +146,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/bitcoin.markdown b/source/_components/bitcoin.markdown index 634540f8cd9..b5c3ad70b6b 100644 --- a/source/_components/bitcoin.markdown +++ b/source/_components/bitcoin.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: bitcoin.png -ha_category: Finance +ha_category: + - Finance ha_release: pre 0.7 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/bizkaibus.markdown b/source/_components/bizkaibus.markdown new file mode 100644 index 00000000000..e496d3f6071 --- /dev/null +++ b/source/_components/bizkaibus.markdown @@ -0,0 +1,50 @@ +--- +layout: page +title: "Bizkaibus next bus tracking sensor" +description: "Instructions on how to integrate timetable data for traveling on Bizkaibus within Home Assistant." +date: 2019-04-22 14:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: bizkaibus.png +ha_category: + - Transport + - Sensor +ha_iot_class: Cloud Polling +ha_release: 0.93 +--- + +The `bizkaibus` sensor will give you the time until the next bus in the selected stop. + +The next website can help to determine the id of your bus stop. You can check if this is correct by going to [next link](http://apli.bizkaia.net/APPS/DANOK/TQ/DATOS_PARADAS/DATOS_Paradas.xml) and look the PR_CODE for the STOP_ID. + +For a correct use of the sensor the selected route must stop in the selected stop. + +Then add the data to your `configuration.yaml` file as shown in the example: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: bizkaibus + stopid: STOP_ID + route: ROUTE_ID +``` + +{% configuration %} +stopid: + description: The ID of the bus stop to get the information for. + required: true + type: string +route: + description: The ID of the bus route to get information for. This is the same as the bus number, e.g., `A3641`. + required: true + type: string +name: + description: A friendly name for this sensor. + required: false + default: Next Bus + type: string +{% endconfiguration %} + +The public RTPI information is coming from [Bizkaibus API](http://apli.bizkaia.net/APPS/DANOK/TQWS/TQ.ASMX). diff --git a/source/_components/blackbird.markdown b/source/_components/blackbird.markdown index 2e01dec6cc3..aaca513c055 100644 --- a/source/_components/blackbird.markdown +++ b/source/_components/blackbird.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: monoprice.svg -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.68 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/blinksticklight.markdown b/source/_components/blinksticklight.markdown index 36e57210ecc..84549b1edc1 100644 --- a/source/_components/blinksticklight.markdown +++ b/source/_components/blinksticklight.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: blinkstick.png -ha_category: DIY +ha_category: + - DIY ha_release: 0.7.5 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/blinkt.markdown b/source/_components/blinkt.markdown index 33eb2d842a8..82e8c0899b8 100644 --- a/source/_components/blinkt.markdown +++ b/source/_components/blinkt.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: DIY +ha_category: + - DIY ha_iot_class: Local Push ha_release: 0.44 redirect_from: diff --git a/source/_components/blockchain.markdown b/source/_components/blockchain.markdown index 5f749b427f8..aea54943db0 100644 --- a/source/_components/blockchain.markdown +++ b/source/_components/blockchain.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: blockchain.png -ha_category: Finance +ha_category: + - Finance ha_release: 0.47 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/bluesound.markdown b/source/_components/bluesound.markdown index 85cf62cd9e7..8e1b4f1b972 100644 --- a/source/_components/bluesound.markdown +++ b/source/_components/bluesound.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: bluesound.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.51 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/bluetooth_le_tracker.markdown b/source/_components/bluetooth_le_tracker.markdown index d5c27e1e6f8..c02b89fc100 100644 --- a/source/_components/bluetooth_le_tracker.markdown +++ b/source/_components/bluetooth_le_tracker.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: bluetooth.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_iot_class: Local Polling ha_release: 0.27 redirect_from: diff --git a/source/_components/bluetooth_tracker.markdown b/source/_components/bluetooth_tracker.markdown index 97596b9c23b..26ee8eae907 100644 --- a/source/_components/bluetooth_tracker.markdown +++ b/source/_components/bluetooth_tracker.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: bluetooth.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_iot_class: Local Polling ha_release: 0.18 redirect_from: diff --git a/source/_components/bme280.markdown b/source/_components/bme280.markdown index 4f2949eca6c..097b46240f5 100644 --- a/source/_components/bme280.markdown +++ b/source/_components/bme280.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: DIY +ha_category: + - DIY ha_release: 0.48 ha_iot_class: Local Push redirect_from: diff --git a/source/_components/bme680.markdown b/source/_components/bme680.markdown index fb06b1ae37d..579da0493fa 100644 --- a/source/_components/bme680.markdown +++ b/source/_components/bme680.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: DIY +ha_category: + - DIY ha_release: 0.62 ha_iot_class: Local Push redirect_from: 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/braviatv.markdown b/source/_components/braviatv.markdown index c2d09b6b11a..15ca122bfdf 100644 --- a/source/_components/braviatv.markdown +++ b/source/_components/braviatv.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: bravia.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.23 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/broadcast.markdown b/source/_components/broadcast.markdown index 633556693ba..5c865eeac30 100644 --- a/source/_components/broadcast.markdown +++ b/source/_components/broadcast.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: telegram.png -ha_category: Notifications +ha_category: + - Notifications ha_release: 0.48 redirect_from: - /components/telegram_bot.broadcast/ diff --git a/source/_components/broadlink.markdown b/source/_components/broadlink.markdown index 91bc57e07e2..55efe41007b 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. @@ -478,3 +478,18 @@ This is the code we need to transmit again to replicate the same remote function 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. + +### {% linkable_title Using broadlink_cli to obtain codes %} + +It is also possible to obtain codes using `broadlink_cli` from [python-broadlink](https://github.com/mjg59/python-broadlink) project. + +### {% linkable_title Conversion of codes from other projects %} + +For old/awkward devices another possibility is to try to get codes by using data gathered by the LIRC project. + +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/_components/brottsplatskartan.markdown b/source/_components/brottsplatskartan.markdown index 7333aabc47a..9844385f1d8 100644 --- a/source/_components/brottsplatskartan.markdown +++ b/source/_components/brottsplatskartan.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Social +ha_category: + - Social logo: brottsplatskartan.png ha_release: 0.85 ha_iot_class: Cloud Polling diff --git a/source/_components/browser.markdown b/source/_components/browser.markdown index ddb68dda653..c0a1501a0f6 100644 --- a/source/_components/browser.markdown +++ b/source/_components/browser.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Utility +ha_category: + - Utility ha_qa_scale: internal ha_release: pre 0.7 --- diff --git a/source/_components/brunt.markdown b/source/_components/brunt.markdown index e8fd9d8f421..f1b62530d9d 100644 --- a/source/_components/brunt.markdown +++ b/source/_components/brunt.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: brunt.png -ha_category: Cover +ha_category: + - Cover ha_release: 0.75 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/bt_home_hub_5.markdown b/source/_components/bt_home_hub_5.markdown index c2482d7decd..3b18f59ce59 100644 --- a/source/_components/bt_home_hub_5.markdown +++ b/source/_components/bt_home_hub_5.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: bt.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: 0.22 redirect_from: - /components/device_tracker.bt_home_hub_5/ diff --git a/source/_components/bt_smarthub.markdown b/source/_components/bt_smarthub.markdown index 8b58068c49b..4c60da14f48 100644 --- a/source/_components/bt_smarthub.markdown +++ b/source/_components/bt_smarthub.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: bt.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: 0.82 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/buienradar.markdown b/source/_components/buienradar.markdown index 396ca454e29..67056c84e15 100644 --- a/source/_components/buienradar.markdown +++ b/source/_components/buienradar.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: buienradar.png -ha_category: Weather +ha_category: + - Weather ha_release: 0.47 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/caldav.markdown b/source/_components/caldav.markdown index cda8f15c19a..4116c6122a7 100644 --- a/source/_components/caldav.markdown +++ b/source/_components/caldav.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Calendar +ha_category: + - Calendar ha_iot_class: Cloud Polling ha_release: "0.60" redirect_from: diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown index 62495dca086..82502250b31 100644 --- a/source/_components/calendar.google.markdown +++ b/source/_components/calendar.google.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: google_calendar.png -ha_category: Calendar +ha_category: + - Calendar ha_iot_class: Cloud Polling ha_release: 0.33 --- diff --git a/source/_components/camera.ffmpeg.markdown b/source/_components/camera.ffmpeg.markdown index 739ba765621..f47dcef0de6 100644 --- a/source/_components/camera.ffmpeg.markdown +++ b/source/_components/camera.ffmpeg.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: ffmpeg.png -ha_category: Camera +ha_category: + - Camera ha_release: 0.26 ha_iot_class: Local Polling --- diff --git a/source/_components/camera.mqtt.markdown b/source/_components/camera.mqtt.markdown index a058e15b055..54d3a965af5 100644 --- a/source/_components/camera.mqtt.markdown +++ b/source/_components/camera.mqtt.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mqtt.png -ha_category: Camera +ha_category: + - Camera ha_release: 0.43 ha_iot_class: Configurable --- diff --git a/source/_components/camera.netatmo.markdown b/source/_components/camera.netatmo.markdown deleted file mode 100644 index 0d9c6e98a80..00000000000 --- a/source/_components/camera.netatmo.markdown +++ /dev/null @@ -1,56 +0,0 @@ ---- -layout: page -title: "Netatmo Camera" -description: "Instructions on how to integrate Netatmo cameras into Home Assistant." -date: 2016-06-02 08:10 -sidebar: true -comments: false -sharing: true -footer: true -logo: netatmo.png -ha_category: Camera -ha_release: 0.22 -ha_iot_class: Local Polling ---- - -The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This component allows you to view the current photo created by the Camera. - -### {% linkable_title Basic configuration %} - -To enable the Netatmo camera, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your camera. - -### {% linkable_title Advanced configuration %} - -If you want to select a specific camera, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -camera: - - platform: netatmo -``` - -{% configuration %} -home: - description: Will display the cameras of this home only. - required: false - type: string -cameras: - description: Cameras to use. Multiple entities allowed. - required: false - type: list - keys: - camera_name: - description: Name of the camera to display. -{% endconfiguration %} - -If **home** and **cameras** are not provided, all cameras will be displayed. For more control over your cameras check the configuration sample below. - -```yaml -# Example configuration.yaml entry -camera: - platform: netatmo - home: home_name - cameras: - - camera_name1 - - camera_name2 -``` diff --git a/source/_components/cast.markdown b/source/_components/cast.markdown index d595b9e7741..8bec9f32f5b 100644 --- a/source/_components/cast.markdown +++ b/source/_components/cast.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: google_cast.png -ha_category: Media Player +ha_category: + - Media Player featured: true ha_release: pre 0.7 ha_iot_class: Local Polling diff --git a/source/_components/cert_expiry.markdown b/source/_components/cert_expiry.markdown index bb61a611841..a4dc3144eb0 100644 --- a/source/_components/cert_expiry.markdown +++ b/source/_components/cert_expiry.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Network +ha_category: + - Network ha_release: 0.44 ha_iot_class: Configurable redirect_from: diff --git a/source/_components/channels.markdown b/source/_components/channels.markdown index 1840bf0f11b..f5a79bdb99a 100644 --- a/source/_components/channels.markdown +++ b/source/_components/channels.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: channels.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.65 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/cisco_ios.markdown b/source/_components/cisco_ios.markdown index 9514aa7417c..a51701b2de4 100644 --- a/source/_components/cisco_ios.markdown +++ b/source/_components/cisco_ios.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: cisco.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: 0.33 redirect_from: - /components/device_tracker.cisco_ios/ diff --git a/source/_components/cisco_mobility_express.markdown b/source/_components/cisco_mobility_express.markdown index 075bdbbe1d5..8260e3d26c5 100644 --- a/source/_components/cisco_mobility_express.markdown +++ b/source/_components/cisco_mobility_express.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: cisco.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: "0.90" --- diff --git a/source/_components/cisco_webex_teams.markdown b/source/_components/cisco_webex_teams.markdown index 3dd7b40764d..a2d49717d66 100644 --- a/source/_components/cisco_webex_teams.markdown +++ b/source/_components/cisco_webex_teams.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: cisco_webex_teams.png -ha_category: Notifications +ha_category: + - Notifications ha_release: "0.40" --- diff --git a/source/_components/ciscospark.markdown b/source/_components/ciscospark.markdown index 52d429b7633..d7e95ef19a9 100644 --- a/source/_components/ciscospark.markdown +++ b/source/_components/ciscospark.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: ciscospark.png -ha_category: Notifications +ha_category: + - Notifications ha_release: "0.40" redirect_from: - /components/notify.ciscospark/ diff --git a/source/_components/citybikes.markdown b/source/_components/citybikes.markdown index 316d61b9fd8..ef003ed52d8 100644 --- a/source/_components/citybikes.markdown +++ b/source/_components/citybikes.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: citybikes.png -ha_category: Transport +ha_category: + - Transport ha_release: 0.49 redirect_from: - /components/sensor.citybikes/ diff --git a/source/_components/clementine.markdown b/source/_components/clementine.markdown index 612929aa0f3..2d5f57bd85d 100644 --- a/source/_components/clementine.markdown +++ b/source/_components/clementine.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: clementine.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.39 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/clickatell.markdown b/source/_components/clickatell.markdown index 559319a4f5e..15718dab4b3 100644 --- a/source/_components/clickatell.markdown +++ b/source/_components/clickatell.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: clickatell.png -ha_category: Notifications +ha_category: + - Notifications ha_release: 0.56 redirect_from: - /components/notify.clickatell/ diff --git a/source/_components/clicksend.markdown b/source/_components/clicksend.markdown index edcc4a361eb..406de2dd060 100644 --- a/source/_components/clicksend.markdown +++ b/source/_components/clicksend.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: clicksend.png -ha_category: Notifications +ha_category: + - Notifications ha_release: 0.48 redirect_from: - /components/notify.clicksend/ diff --git a/source/_components/clicksend_tts.markdown b/source/_components/clicksend_tts.markdown index 70b2738cbd3..2f3d9a74e1e 100644 --- a/source/_components/clicksend_tts.markdown +++ b/source/_components/clicksend_tts.markdown @@ -12,8 +12,7 @@ ha_category: - Notifications ha_release: 0.55 redirect_from: - - /components/notify.clicksendaudio/ -redirect_from: + - /components/notify.clicksendaudio/ - /components/notify.clicksend_tts/ --- diff --git a/source/_components/climate.knx.markdown b/source/_components/climate.knx.markdown index 6cfe8f565e4..f99b2b3bd38 100644 --- a/source/_components/climate.knx.markdown +++ b/source/_components/climate.knx.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: knx.png -ha_category: Climate +ha_category: + - Climate ha_release: 0.25 ha_iot_class: Local Polling --- diff --git a/source/_components/climate.modbus.markdown b/source/_components/climate.modbus.markdown index 916bb77e312..74838e0d420 100644 --- a/source/_components/climate.modbus.markdown +++ b/source/_components/climate.modbus.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: modbus.png -ha_category: Climate +ha_category: + - Climate ha_release: 0.68 ha_iot_class: Local Polling --- diff --git a/source/_components/climate.mqtt.markdown b/source/_components/climate.mqtt.markdown index 4d62105e01b..bc4204808be 100644 --- a/source/_components/climate.mqtt.markdown +++ b/source/_components/climate.mqtt.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mqtt.png -ha_category: Climate +ha_category: + - Climate ha_release: 0.55 ha_iot_class: Local Polling --- diff --git a/source/_components/climate.netatmo.markdown b/source/_components/climate.netatmo.markdown deleted file mode 100644 index 6d71ba0b796..00000000000 --- a/source/_components/climate.netatmo.markdown +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: page -title: "Netatmo Thermostat" -description: "Instructions on how to integrate Netatmo thermostat into Home Assistant." -date: 2016-10-11 08:10 -sidebar: true -comments: false -sharing: true -footer: true -logo: netatmo.png -ha_category: Climate -ha_release: 0.31 -ha_iot_class: Cloud Polling ---- - - -The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) thermostat. This component allows you to view the current temperature and setpoint. - -To enable the Netatmo thermostat, you first have to set up [netatmo](/components/netatmo/), this will use discovery to add your thermostat. - -If you want to select specific homes or specific rooms, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -climate: - - platform: netatmo -``` - -{% configuration %} -homes: - description: Will display the thermostats of the homes listed. - required: false - type: list - keys: - name: - required: true - description: The home name. - rooms: - description: Rooms to be displayed. Multiple entities allowed. - required: false - type: [list, string] - description: List of the names of the rooms to be displayed. -{% endconfiguration %} - -If **homes** and **rooms** are not provided, all thermostats will be displayed. - -```yaml -# Example configuration.yaml entry -climate: - platform: netatmo - homes: - - name: home1_name - rooms: - - room1_name - - room2_name - - name: home2_name - rooms: - - room3_name - - room4_name - - room5_name -``` diff --git a/source/_components/cloud.markdown b/source/_components/cloud.markdown index 0f7b2a61b7c..57aa21a6988 100644 --- a/source/_components/cloud.markdown +++ b/source/_components/cloud.markdown @@ -9,7 +9,8 @@ sharing: true footer: true logo: nabu-casa.svg ha_release: "0.60" -ha_category: Voice +ha_category: + - Voice ha_iot_class: Cloud Push --- diff --git a/source/_components/cloudflare.markdown b/source/_components/cloudflare.markdown index c085413ad05..548db436602 100644 --- a/source/_components/cloudflare.markdown +++ b/source/_components/cloudflare.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: cloudflare.png -ha_category: Network +ha_category: + - Network ha_release: 0.74 --- diff --git a/source/_components/cmus.markdown b/source/_components/cmus.markdown index 96edada65c8..6950fbb2dcf 100644 --- a/source/_components/cmus.markdown +++ b/source/_components/cmus.markdown @@ -8,7 +8,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Media Player +ha_category: + - Media Player ha_iot_class: Local Polling ha_release: 0.23 redirect_from: diff --git a/source/_components/co2signal.markdown b/source/_components/co2signal.markdown index 26b855070c7..4c283286897 100644 --- a/source/_components/co2signal.markdown +++ b/source/_components/co2signal.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: co2signal.png -ha_category: Environment +ha_category: + - Environment ha_release: 0.87 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/coinmarketcap.markdown b/source/_components/coinmarketcap.markdown index 31b35511540..86190bc4be4 100644 --- a/source/_components/coinmarketcap.markdown +++ b/source/_components/coinmarketcap.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: coinmarketcap.png -ha_category: Finance +ha_category: + - Finance ha_release: 0.28 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/comed_hourly_pricing.markdown b/source/_components/comed_hourly_pricing.markdown index dac7229a7b0..0128b33836b 100644 --- a/source/_components/comed_hourly_pricing.markdown +++ b/source/_components/comed_hourly_pricing.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: comed.png -ha_category: Energy +ha_category: + - Energy ha_release: "0.40" ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/command_line.markdown b/source/_components/command_line.markdown index 7dee888b9a6..3fe4193a592 100644 --- a/source/_components/command_line.markdown +++ b/source/_components/command_line.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: command_line.png -ha_category: Utility +ha_category: + - Utility ha_release: 0.12 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/config.markdown b/source/_components/config.markdown index b697cec5e82..46613b40517 100644 --- a/source/_components/config.markdown +++ b/source/_components/config.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Front end +ha_category: + - Front end ha_release: 0.39 ha_qa_scale: internal --- diff --git a/source/_components/configurator.markdown b/source/_components/configurator.markdown index 27c9bfde146..bb862023a4c 100644 --- a/source/_components/configurator.markdown +++ b/source/_components/configurator.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Other +ha_category: + - Other ha_qa_scale: internal ha_release: 0.7 --- diff --git a/source/_components/conversation.markdown b/source/_components/conversation.markdown index a6a459873b3..511a5de5aae 100644 --- a/source/_components/conversation.markdown +++ b/source/_components/conversation.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: "Voice" +ha_category: + - "Voice" ha_qa_scale: internal ha_release: 0.7 --- diff --git a/source/_components/coolmaster.markdown b/source/_components/coolmaster.markdown index 77d58d15a93..e11d76da089 100644 --- a/source/_components/coolmaster.markdown +++ b/source/_components/coolmaster.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: coolautomation.png -ha_category: Climate +ha_category: + - Climate ha_release: 0.88 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown index f7fef491b14..db9702990c4 100644 --- a/source/_components/counter.markdown +++ b/source/_components/counter.markdown @@ -8,13 +8,16 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Automation +ha_category: + - Automation ha_release: 0.53 ha_qa_scale: internal --- The `counter` component allows one to count occurrences fired by automations. +## {% linkable_title Configuration %} + To add a counter to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/cover.command_line.markdown b/source/_components/cover.command_line.markdown index 3d1429c223d..3ebb35ddc3f 100644 --- a/source/_components/cover.command_line.markdown +++ b/source/_components/cover.command_line.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: command_line.png -ha_category: Cover +ha_category: + - Cover ha_release: 0.14 ha_iot_class: Local Polling --- diff --git a/source/_components/cover.group.markdown b/source/_components/cover.group.markdown index 581cddc4b1b..5512be8fefb 100644 --- a/source/_components/cover.group.markdown +++ b/source/_components/cover.group.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Cover +ha_category: + - Cover ha_release: 0.66 ha_iot_class: Local Push logo: home-assistant.png diff --git a/source/_components/cover.knx.markdown b/source/_components/cover.knx.markdown index d7861c41429..77c17dd6d3d 100644 --- a/source/_components/cover.knx.markdown +++ b/source/_components/cover.knx.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: knx.png -ha_category: Cover +ha_category: + - Cover ha_release: 0.48 ha_iot_class: Local Polling --- diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown index 205e50be6ce..acf37e99e42 100644 --- a/source/_components/cover.mqtt.markdown +++ b/source/_components/cover.mqtt.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mqtt.png -ha_category: Cover +ha_category: + - Cover ha_iot_class: Configurable ha_release: 0.18 --- @@ -163,7 +164,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/cover.rflink.markdown b/source/_components/cover.rflink.markdown index 72cecf77daf..5ad0066782a 100644 --- a/source/_components/cover.rflink.markdown +++ b/source/_components/cover.rflink.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: rflink.png -ha_category: Cover +ha_category: + - Cover ha_release: 0.55 --- diff --git a/source/_components/cover.rfxtrx.markdown b/source/_components/cover.rfxtrx.markdown index f5e366efbcc..c098a1d9bf9 100644 --- a/source/_components/cover.rfxtrx.markdown +++ b/source/_components/cover.rfxtrx.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: rfxtrx.png -ha_category: Cover +ha_category: + - Cover ha_release: 0.27 --- diff --git a/source/_components/cover.template.markdown b/source/_components/cover.template.markdown index 6d6a61030df..e4813769784 100644 --- a/source/_components/cover.template.markdown +++ b/source/_components/cover.template.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Cover +ha_category: + - Cover ha_release: 0.48 ha_iot_class: Local Push logo: home-assistant.png diff --git a/source/_components/cover.xiaomi_aqara.markdown b/source/_components/cover.xiaomi_aqara.markdown index ea54bf27449..ea8de2ac3fe 100644 --- a/source/_components/cover.xiaomi_aqara.markdown +++ b/source/_components/cover.xiaomi_aqara.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: xiaomi.png -ha_category: Cover +ha_category: + - Cover ha_release: "0.50" ha_iot_class: Local Push --- diff --git a/source/_components/cppm.markdown b/source/_components/cppm.markdown index 9b6f86e9f71..db74e277978 100644 --- a/source/_components/cppm.markdown +++ b/source/_components/cppm.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: aruba.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: "0.90" ha_iot_class: Local Polling --- diff --git a/source/_components/cpuspeed.markdown b/source/_components/cpuspeed.markdown index 5fd749415e2..af09719b0df 100644 --- a/source/_components/cpuspeed.markdown +++ b/source/_components/cpuspeed.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: cpu.png -ha_category: System Monitor +ha_category: + - System Monitor ha_release: pre 0.7 ha_iot_class: Local Push redirect_from: diff --git a/source/_components/crimereports.markdown b/source/_components/crimereports.markdown index eb99649977f..da79b588027 100644 --- a/source/_components/crimereports.markdown +++ b/source/_components/crimereports.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Social +ha_category: + - Social logo: crimereports.png ha_release: 0.42 ha_iot_class: Cloud Polling diff --git a/source/_components/cups.markdown b/source/_components/cups.markdown index ff4602f55a6..e9caecc22cc 100644 --- a/source/_components/cups.markdown +++ b/source/_components/cups.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: cups.png -ha_category: System Monitor +ha_category: + - System Monitor ha_iot_class: Local Polling ha_release: 0.32 redirect_from: diff --git a/source/_components/currencylayer.markdown b/source/_components/currencylayer.markdown index a789f462ff8..d4ad7c6dc9b 100644 --- a/source/_components/currencylayer.markdown +++ b/source/_components/currencylayer.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Finance +ha_category: + - Finance logo: currencylayer.png ha_iot_class: Cloud Polling ha_release: 0.32 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/danfoss_air.markdown b/source/_components/danfoss_air.markdown index fd93743b4d1..5b8ab36e70a 100644 --- a/source/_components/danfoss_air.markdown +++ b/source/_components/danfoss_air.markdown @@ -65,3 +65,5 @@ The following sensors are supported. The following switches are supported. - **Boost:** Switch to manually activate boost. +- **Bypass:** Switch to manually activate bypass. +- **Automatic bypass:** Switch to enable automatic bypass. diff --git a/source/_components/darksky.markdown b/source/_components/darksky.markdown index 47429782a68..d1942794a56 100644 --- a/source/_components/darksky.markdown +++ b/source/_components/darksky.markdown @@ -8,12 +8,13 @@ comments: false sharing: true footer: true logo: dark_sky.png -ha_category: Weather +ha_category: + - Weather ha_release: "0.30" -redirect_from: /components/sensor.forecast/ ha_iot_class: Cloud Polling redirect_from: - /components/sensor.darksky/ + - /components/sensor.forecast/ --- The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as a source for meteorological data for your location. The location is based on the `longitude` and `latitude` coordinates configured in your `configuration.yaml` file. The coordinates are auto-detected but to take advantage of the hyper-local weather reported by Dark Sky, you can refine them down to your exact home address. GPS coordinates can be found by using [Google Maps](https://www.google.com/maps) and clicking on your home or [Openstreetmap](http://www.openstreetmap.org/). diff --git a/source/_components/datadog.markdown b/source/_components/datadog.markdown index c78a0c8bd46..e2e5eaed0a6 100644 --- a/source/_components/datadog.markdown +++ b/source/_components/datadog.markdown @@ -8,7 +8,8 @@ comments: false sharing: true logo: datadog.png footer: true -ha_category: History +ha_category: + - History ha_release: 0.45 --- diff --git a/source/_components/ddwrt.markdown b/source/_components/ddwrt.markdown index 83a717068fb..fd83c351c4f 100644 --- a/source/_components/ddwrt.markdown +++ b/source/_components/ddwrt.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: ddwrt.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: pre 0.7 redirect_from: - /components/device_tracker.ddwrt/ 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/decora.markdown b/source/_components/decora.markdown index 4207d98f333..cb9a96aaef8 100644 --- a/source/_components/decora.markdown +++ b/source/_components/decora.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Light +ha_category: + - Light ha_iot_class: Local Polling logo: leviton.png ha_release: 0.37 diff --git a/source/_components/decora_wifi.markdown b/source/_components/decora_wifi.markdown index 8f39f571fa0..cfd60b0dcdc 100644 --- a/source/_components/decora_wifi.markdown +++ b/source/_components/decora_wifi.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Light +ha_category: + - Light ha_iot_class: Cloud Polling logo: leviton.png ha_release: 0.51 diff --git a/source/_components/default_config.markdown b/source/_components/default_config.markdown index 37f13fac5bf..94da14c0739 100644 --- a/source/_components/default_config.markdown +++ b/source/_components/default_config.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Other +ha_category: + - Other ha_release: 0.88 --- diff --git a/source/_components/demo.markdown b/source/_components/demo.markdown index 1048aa1c236..ed6d3f8844c 100644 --- a/source/_components/demo.markdown +++ b/source/_components/demo.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Other +ha_category: + - Other ha_qa_scale: internal ha_release: 0.7 --- diff --git a/source/_components/denon.markdown b/source/_components/denon.markdown index 5c4d5ed7c8f..41d886f922b 100644 --- a/source/_components/denon.markdown +++ b/source/_components/denon.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: denon.png -ha_category: Media Player +ha_category: + - Media Player ha_iot_class: Local Polling ha_release: 0.7.2 redirect_from: diff --git a/source/_components/denonavr.markdown b/source/_components/denonavr.markdown index 95bd30fcc7a..b910bfa5066 100644 --- a/source/_components/denonavr.markdown +++ b/source/_components/denonavr.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: denon.png -ha_category: Media Player +ha_category: + - Media Player ha_iot_class: Local Polling ha_release: 0.7.2 redirect_from: @@ -25,6 +26,7 @@ Supported devices: - Denon AVR-X2100W - Denon AVR-X4100W - Denon AVR-X4300H +- Denon AVR-X4500H - Denon AVR-1912 - Denon AVR-2312CI - Denon AVR-3311CI diff --git a/source/_components/deutsche_bahn.markdown b/source/_components/deutsche_bahn.markdown index 126f60bf1fb..cc653756249 100644 --- a/source/_components/deutsche_bahn.markdown +++ b/source/_components/deutsche_bahn.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Transport +ha_category: + - Transport logo: db.png ha_iot_class: Cloud Polling ha_release: 0.14 diff --git a/source/_components/device_sun_light_trigger.markdown b/source/_components/device_sun_light_trigger.markdown index fd037b48c40..71e98fc27fc 100644 --- a/source/_components/device_sun_light_trigger.markdown +++ b/source/_components/device_sun_light_trigger.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Automation +ha_category: + - Automation ha_qa_scale: internal ha_release: pre 0.7 --- diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown index 6f63703e70f..d4f699982b4 100644 --- a/source/_components/device_tracker.markdown +++ b/source/_components/device_tracker.markdown @@ -114,4 +114,18 @@ 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'`. +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 (case sensitive). 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/device_tracker.mqtt.markdown b/source/_components/device_tracker.mqtt.markdown index a370e6f10e2..459ea2e3a48 100644 --- a/source/_components/device_tracker.mqtt.markdown +++ b/source/_components/device_tracker.mqtt.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mqtt.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_iot_class: Configurable ha_release: 0.7.3 --- diff --git a/source/_components/device_tracker.xiaomi.markdown b/source/_components/device_tracker.xiaomi.markdown index 7f9494c2af5..5bf0ab35e72 100644 --- a/source/_components/device_tracker.xiaomi.markdown +++ b/source/_components/device_tracker.xiaomi.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: xiaomi.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: 0.36 --- diff --git a/source/_components/dht.markdown b/source/_components/dht.markdown index 752a988f636..153956e1234 100644 --- a/source/_components/dht.markdown +++ b/source/_components/dht.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: DIY +ha_category: + - DIY ha_release: 0.7 logo: dht.png ha_iot_class: Local Polling diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown index c1f384b73cd..b3596b1f561 100644 --- a/source/_components/dialogflow.markdown +++ b/source/_components/dialogflow.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: dialogflow.png -ha_category: Voice +ha_category: + - Voice ha_release: 0.56 redirect_from: /components/apiai/ --- diff --git a/source/_components/digitalloggers.markdown b/source/_components/digitalloggers.markdown index aac007f2c68..8270bef0e13 100644 --- a/source/_components/digitalloggers.markdown +++ b/source/_components/digitalloggers.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: digitalloggers.png -ha_category: Switch +ha_category: + - Switch ha_release: 0.35 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/directv.markdown b/source/_components/directv.markdown index 0864d461a99..97d6cc9b61c 100644 --- a/source/_components/directv.markdown +++ b/source/_components/directv.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: directv.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.25 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/discogs.markdown b/source/_components/discogs.markdown index a9aec0b8172..1fed3dfb5bf 100644 --- a/source/_components/discogs.markdown +++ b/source/_components/discogs.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Multimedia +ha_category: + - Multimedia ha_release: 0.61 logo: discogs.png ha_iot_class: Cloud Polling diff --git a/source/_components/discord.markdown b/source/_components/discord.markdown index d633db119e2..1cd00bab30e 100644 --- a/source/_components/discord.markdown +++ b/source/_components/discord.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: discord.png -ha_category: Notifications +ha_category: + - Notifications ha_release: 0.37 redirect_from: - /components/notify.discord/ diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown index eeb782a8b9c..90810424ea1 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Other +ha_category: + - Other ha_qa_scale: internal ha_release: 0.7 --- diff --git a/source/_components/dispatcher.markdown b/source/_components/dispatcher.markdown index 34cc5eb72e2..8b961db7b03 100644 --- a/source/_components/dispatcher.markdown +++ b/source/_components/dispatcher.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Camera +ha_category: + - Camera logo: camcorder.png ha_release: "0.40" ha_iot_class: Configurable diff --git a/source/_components/dlib_face_detect.markdown b/source/_components/dlib_face_detect.markdown index 5c39e38e8d8..5ba7c2ca0d9 100644 --- a/source/_components/dlib_face_detect.markdown +++ b/source/_components/dlib_face_detect.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: dlib.png -ha_category: Image Processing +ha_category: + - Image Processing ha_release: 0.44 redirect_from: - /components/image_processing.dlib_face_detect/ diff --git a/source/_components/dlib_face_identify.markdown b/source/_components/dlib_face_identify.markdown index 19b4eea5494..1a496513195 100644 --- a/source/_components/dlib_face_identify.markdown +++ b/source/_components/dlib_face_identify.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: dlib.png -ha_category: Image Processing +ha_category: + - Image Processing ha_release: 0.44 redirect_from: - /components/image_processing.dlib_face_identify/ diff --git a/source/_components/dlink.markdown b/source/_components/dlink.markdown index a8b80131d7f..c05b4db9056 100644 --- a/source/_components/dlink.markdown +++ b/source/_components/dlink.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: dlink.png -ha_category: Switch +ha_category: + - Switch ha_iot_class: Local Polling ha_release: 0.14 redirect_from: diff --git a/source/_components/dlna_dmr.markdown b/source/_components/dlna_dmr.markdown index f985145c58d..16b29ef8f03 100644 --- a/source/_components/dlna_dmr.markdown +++ b/source/_components/dlna_dmr.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: dlna.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.76 ha_iot_class: Local Push redirect_from: diff --git a/source/_components/dnsip.markdown b/source/_components/dnsip.markdown index e2950706cf1..117e5910e03 100644 --- a/source/_components/dnsip.markdown +++ b/source/_components/dnsip.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Network +ha_category: + - Network ha_iot_class: Cloud Polling ha_release: "0.40" redirect_from: diff --git a/source/_components/dominos.markdown b/source/_components/dominos.markdown index 20ea8157c4b..4fdd41e3bc3 100644 --- a/source/_components/dominos.markdown +++ b/source/_components/dominos.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: dominos.png -ha_category: Other +ha_category: + - Other ha_iot_class: Cloud Polling ha_release: 0.59 --- diff --git a/source/_components/downloader.markdown b/source/_components/downloader.markdown index 0e77a6bb719..37844a8da15 100644 --- a/source/_components/downloader.markdown +++ b/source/_components/downloader.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Downloading +ha_category: + - Downloading ha_release: pre 0.7 ha_qa_scale: internal --- diff --git a/source/_components/dsmr.markdown b/source/_components/dsmr.markdown index 464e30e8c5d..b5ab05cf326 100644 --- a/source/_components/dsmr.markdown +++ b/source/_components/dsmr.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: netbeheernederland.jpg -ha_category: Energy +ha_category: + - Energy ha_release: 0.34 ha_iot_class: Local Push redirect_from: diff --git a/source/_components/dte_energy_bridge.markdown b/source/_components/dte_energy_bridge.markdown index 06fc202d4df..3af953f521e 100644 --- a/source/_components/dte_energy_bridge.markdown +++ b/source/_components/dte_energy_bridge.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: dte_energy.png -ha_category: Energy +ha_category: + - Energy ha_release: 0.21 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/dublin_bus_transport.markdown b/source/_components/dublin_bus_transport.markdown index 467aab58e71..d59ce3e0ebd 100644 --- a/source/_components/dublin_bus_transport.markdown +++ b/source/_components/dublin_bus_transport.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: dublin_bus.png -ha_category: Transport +ha_category: + - Transport ha_iot_class: Cloud Polling ha_release: 0.36 redirect_from: diff --git a/source/_components/duckdns.markdown b/source/_components/duckdns.markdown index cb1ef278c8a..9e34593fdfc 100644 --- a/source/_components/duckdns.markdown +++ b/source/_components/duckdns.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: duckdns.png -ha_category: Network +ha_category: + - Network ha_release: 0.55 --- diff --git a/source/_components/duke_energy.markdown b/source/_components/duke_energy.markdown index fb5baf87888..27621e1a897 100644 --- a/source/_components/duke_energy.markdown +++ b/source/_components/duke_energy.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: duke_energy.png -ha_category: Energy +ha_category: + - Energy ha_release: 0.74 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/dunehd.markdown b/source/_components/dunehd.markdown index 4577a68abcd..8f99d50807c 100644 --- a/source/_components/dunehd.markdown +++ b/source/_components/dunehd.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: dunehd.png -ha_category: Media Player +ha_category: + - Media Player ha_iot_class: Local Polling ha_release: 0.34 redirect_from: diff --git a/source/_components/dwd_weather_warnings.markdown b/source/_components/dwd_weather_warnings.markdown index c60e8895b29..838ed29b4c2 100644 --- a/source/_components/dwd_weather_warnings.markdown +++ b/source/_components/dwd_weather_warnings.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true #logo: dwdwarnapp.png -ha_category: Weather +ha_category: + - Weather ha_release: 0.51 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/ebox.markdown b/source/_components/ebox.markdown index 3180ddb4803..130a7ef7a67 100644 --- a/source/_components/ebox.markdown +++ b/source/_components/ebox.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: ebox.png -ha_category: Network +ha_category: + - Network ha_release: 0.39 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/ebusd.markdown b/source/_components/ebusd.markdown index 3d178f26eed..7b33fd61eb8 100644 --- a/source/_components/ebusd.markdown +++ b/source/_components/ebusd.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: + - Sensor ha_iot_class: Local Polling ha_release: 0.88 redirect_from: diff --git a/source/_components/ecoal_boiler.markdown b/source/_components/ecoal_boiler.markdown index 24f9ba1d49b..1d963a80c02 100644 --- a/source/_components/ecoal_boiler.markdown +++ b/source/_components/ecoal_boiler.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true # logo: raspberry-pi.png -ha_category: Water heater +ha_category: + - Water heater ha_release: 0.87 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index e15c713c70f..50111254a4e 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -48,15 +48,7 @@ Now login to the regular consumer portal, and in the hamburger menu there will b Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the **X** to close the Developer section. -The first time you run Home Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar. - -The PIN can be found from the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in states in the portal. - -- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` component to your `default_view` and restart Home Assistant. - -Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the **I have authorized the app** link at the bottom of the ecobee pop-up window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view. - -To set it up, add the following information to your `configuration.yaml` file: +To add the Ecobee component to Home Assistant, add the following information to your [`configuration.yaml`](/docs/configuration/) file: ```yaml # Example configuration.yaml entry @@ -64,6 +56,16 @@ ecobee: api_key: YOUR_API_KEY ``` +[Restart Home Assistant](https://www.home-assistant.io/docs/configuration/#reloading-changes) for the changes to take effect. + +The first time you (re)run Home Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar. + +The PIN can be found from the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in states in the portal. + +- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` component to your `default_view` and restart Home Assistant. + +Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the **I have authorized the app** link at the bottom of the ecobee pop-up window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view. + {% configuration %} api_key: description: Your ecobee API key. This is only needed for the initial setup of the component. Once registered it can be removed. If you revoke the key in the ecobee portal you will need to update this again and remove the ecobee.conf file in the `.homeassistant` configuration path. diff --git a/source/_components/econet.markdown b/source/_components/econet.markdown index 52c5ec15596..9753313bd3d 100644 --- a/source/_components/econet.markdown +++ b/source/_components/econet.markdown @@ -8,12 +8,13 @@ comments: false sharing: true footer: true logo: econet.png -ha_category: Water heater +ha_category: + - Water heater ha_release: 0.61 ha_iot_class: Cloud Polling -redirect_from: /components/climate.econet/ redirect_from: - /components/water_heater.econet/ + - /components/climate.econet/ --- The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](http://www.rheem.com/EcoNet/Home). This platform allows you to set the temperature, the operation mode, and enable vacation mode. diff --git a/source/_components/eddystone_temperature.markdown b/source/_components/eddystone_temperature.markdown index 7df67a5eb5d..5fd1384f143 100644 --- a/source/_components/eddystone_temperature.markdown +++ b/source/_components/eddystone_temperature.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: eddystone.png -ha_category: DIY +ha_category: + - DIY ha_release: 0.42 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/edimax.markdown b/source/_components/edimax.markdown index be6f43f2df6..fa82a66b07b 100644 --- a/source/_components/edimax.markdown +++ b/source/_components/edimax.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: edimax.png -ha_category: Switch +ha_category: + - Switch ha_release: pre 0.7 redirect_from: - /components/switch.edimax/ diff --git a/source/_components/ee_brightbox.markdown b/source/_components/ee_brightbox.markdown index b53cfa99fa3..3af7fe694df 100644 --- a/source/_components/ee_brightbox.markdown +++ b/source/_components/ee_brightbox.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: ee.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: 0.87 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/efergy.markdown b/source/_components/efergy.markdown index 97bf5ea2515..e2ebb91456a 100644 --- a/source/_components/efergy.markdown +++ b/source/_components/efergy.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: efergy.png -ha_category: Energy +ha_category: + - Energy ha_release: pre 0.7 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/eliqonline.markdown b/source/_components/eliqonline.markdown index 7ca31176657..efa95897494 100644 --- a/source/_components/eliqonline.markdown +++ b/source/_components/eliqonline.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: eliq.png -ha_category: Energy +ha_category: + - Energy ha_release: "0.10" ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/emby.markdown b/source/_components/emby.markdown index c8768a47513..019fe8ad9a1 100644 --- a/source/_components/emby.markdown +++ b/source/_components/emby.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: emby.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.32 ha_iot_class: Local Push redirect_from: diff --git a/source/_components/emoncms.markdown b/source/_components/emoncms.markdown index 82fb5fa8a44..d25b2ae9740 100644 --- a/source/_components/emoncms.markdown +++ b/source/_components/emoncms.markdown @@ -8,7 +8,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: + - Sensor ha_release: 0.29 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/emoncms_history.markdown b/source/_components/emoncms_history.markdown index 0cc83e62982..aed353c14c9 100644 --- a/source/_components/emoncms_history.markdown +++ b/source/_components/emoncms_history.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: emoncms.png -ha_category: History +ha_category: + - History ha_release: 0.31 --- diff --git a/source/_components/emulated_hue.markdown b/source/_components/emulated_hue.markdown index d766b0604db..2eea6c16acd 100644 --- a/source/_components/emulated_hue.markdown +++ b/source/_components/emulated_hue.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Hub +ha_category: + - Hub ha_release: 0.27 ha_iot_class: Local Push ha_qa_scale: internal @@ -48,6 +49,9 @@ emulated_hue: ```yaml # Amazon Echo example configuration.yaml entry emulated_hue: +# Required for Echo Dot 3 + host_ip: YOUR.HASSIO.IP.ADDRESS + listen_port: 80 ``` {% configuration %} diff --git a/source/_components/emulated_roku.markdown b/source/_components/emulated_roku.markdown index 3a3bf3bd50a..ce3a6b14a85 100644 --- a/source/_components/emulated_roku.markdown +++ b/source/_components/emulated_roku.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Hub +ha_category: + - Hub ha_release: 0.86 ha_iot_class: Local Push --- diff --git a/source/_components/enigma2.markdown b/source/_components/enigma2.markdown index 867d219d12e..59d1498b3f4 100644 --- a/source/_components/enigma2.markdown +++ b/source/_components/enigma2.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: openwebif.png -ha_category: Media Player +ha_category: + - Media Player featured: false ha_release: "0.90" ha_iot_class: "Local Polling" diff --git a/source/_components/enphase_envoy.markdown b/source/_components/enphase_envoy.markdown index baca2f6a613..e34f48b633b 100644 --- a/source/_components/enphase_envoy.markdown +++ b/source/_components/enphase_envoy.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: enphase-logo.svg -ha_category: Energy +ha_category: + - Energy ha_release: 0.76 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/entur_public_transport.markdown b/source/_components/entur_public_transport.markdown index 2685aeddad3..1f618f85524 100644 --- a/source/_components/entur_public_transport.markdown +++ b/source/_components/entur_public_transport.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: entur.svg -ha_category: Transport +ha_category: + - Transport ha_release: 0.84 ha_iot_class: Cloud Polling redirect_from: @@ -122,17 +123,13 @@ The stop id is the content after `id=` parameter in the url. Copy paste this int **Q:** I have multiple stop ids and have added whitelisting of a line. Now some of the stop places are showing `unknown`. **A:** A whitelisting of lines takes affect on all of the stops. So you have to whitelist all lines you are interested in on all stop places. - -redirect_from: - - /components/sensor.entur_public_transport/ + --- **Q:** I have added whitelisting of lines, and everything has worked as fine before, but now it has stopped updating all of a sudden. **A:** Some transport companies, such as Kolumbus in Rogaland, have running numbers on the end of their line ids. These gets periodically updated and will make the whitelisting invalid. The new line ids needs to be added again. Most of the time it iterates by one. -redirect_from: - - /components/sensor.entur_public_transport/ --- **Q:** Where do I find a line id to add to the whitelisting? diff --git a/source/_components/envirophat.markdown b/source/_components/envirophat.markdown index 900417a6fa0..72c0c11bcc1 100644 --- a/source/_components/envirophat.markdown +++ b/source/_components/envirophat.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: DIY +ha_category: + - DIY ha_iot_class: Local Polling ha_release: 0.44 redirect_from: diff --git a/source/_components/ephember.markdown b/source/_components/ephember.markdown index e98d2d9ff1c..9d3d2cd9cdf 100644 --- a/source/_components/ephember.markdown +++ b/source/_components/ephember.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: ephcontrolsember.png -ha_category: Climate +ha_category: + - Climate ha_release: 0.57 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/epson.markdown b/source/_components/epson.markdown index 70acba4d7f7..edf50dfa218 100644 --- a/source/_components/epson.markdown +++ b/source/_components/epson.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: epson.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.72 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/epsonprinter.markdown b/source/_components/epsonworkforce.markdown similarity index 56% rename from source/_components/epsonprinter.markdown rename to source/_components/epsonworkforce.markdown index 6f94796352b..50cca9c1754 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 @@ -8,23 +8,25 @@ comments: false sharing: true footer: true logo: epson.png -ha_category: Sensor +ha_category: + - Sensor 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 + - photoblack - yellow - magenta - cyan @@ -33,7 +35,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: @@ -43,6 +45,8 @@ monitored_conditions: keys: black: description: The black ink cartridge + photoblack: + description: The photo black ink cartridge (not supported by all printers). yellow: description: The yellow ink cartridge. magenta: @@ -55,11 +59,14 @@ monitored_conditions: Supported devices: -- Epson Workforce printers who publish a HTTP page containing the ink cardridge levels +- Epson Workforce (and some EcoTank) printers who publish a HTTP page containing the ink cardridge levels Tested devices: - Epson WF3540 +- Epson WF3620 +- Epson WF3640 +- Epson EcoTank ET-77x0 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 status page of the printer to check if it shows the page with the ink levels on the URL http://-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 +41,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 +61,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/google_travel_time.markdown b/source/_components/google_travel_time.markdown index 0defe09f654..56838a2b52a 100644 --- a/source/_components/google_travel_time.markdown +++ b/source/_components/google_travel_time.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: google_maps.png -ha_category: Transport +ha_category: + - Transport ha_iot_class: Cloud Polling ha_release: 0.19 redirect_from: diff --git a/source/_components/google_wifi.markdown b/source/_components/google_wifi.markdown index dc9a38210dd..1c4bd6a8a85 100644 --- a/source/_components/google_wifi.markdown +++ b/source/_components/google_wifi.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: System Monitor +ha_category: + - System Monitor logo: google_wifi.png ha_iot_class: Local Polling ha_release: "0.50" diff --git a/source/_components/gpmdp.markdown b/source/_components/gpmdp.markdown index fc1387533eb..20a96fd89d1 100644 --- a/source/_components/gpmdp.markdown +++ b/source/_components/gpmdp.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: gpmdp.png -ha_category: Media Player +ha_category: + - Media Player ha_iot_class: Local Polling ha_release: "0.20" redirect_from: diff --git a/source/_components/gpsd.markdown b/source/_components/gpsd.markdown index fe1261145f8..4e51ca7adac 100644 --- a/source/_components/gpsd.markdown +++ b/source/_components/gpsd.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: gpsd.png -ha_category: Utility +ha_category: + - Utility ha_release: 0.26 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/graphite.markdown b/source/_components/graphite.markdown index a5ac12376b8..15dfbc74b05 100644 --- a/source/_components/graphite.markdown +++ b/source/_components/graphite.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: graphite.png -ha_category: History +ha_category: + - History ha_release: 0.13 --- diff --git a/source/_components/greenwave.markdown b/source/_components/greenwave.markdown index c0c4752e9c0..23f123b69fe 100644 --- a/source/_components/greenwave.markdown +++ b/source/_components/greenwave.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: greenwavereality.png -ha_category: Light +ha_category: + - Light ha_release: 0.61 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/group.markdown b/source/_components/group.markdown index 84be9fe3dbf..095b9522dae 100644 --- a/source/_components/group.markdown +++ b/source/_components/group.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Organization +ha_category: + - Organization ha_qa_scale: internal ha_release: pre 0.7 --- diff --git a/source/_components/gstreamer.markdown b/source/_components/gstreamer.markdown index 8cf3206ddfa..6221cd61178 100644 --- a/source/_components/gstreamer.markdown +++ b/source/_components/gstreamer.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Media Player +ha_category: + - Media Player logo: gstreamer.png ha_release: 0.39 ha_iot_class: Local Push diff --git a/source/_components/gtfs.markdown b/source/_components/gtfs.markdown index d69b79452db..2416c97cedb 100644 --- a/source/_components/gtfs.markdown +++ b/source/_components/gtfs.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: train.png -ha_category: Transport +ha_category: + - Transport ha_iot_class: Local Polling ha_release: 0.17 redirect_from: diff --git a/source/_components/gtt.markdown b/source/_components/gtt.markdown index 1cc91043c42..e72d52af96b 100644 --- a/source/_components/gtt.markdown +++ b/source/_components/gtt.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Transport +ha_category: + - Transport logo: gtt.png ha_iot_class: Cloud Polling ha_release: 0.85 diff --git a/source/_components/harman_kardon_avr.markdown b/source/_components/harman_kardon_avr.markdown index 0a35de92486..6d6d1a28ad9 100644 --- a/source/_components/harman_kardon_avr.markdown +++ b/source/_components/harman_kardon_avr.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: harman_kardon.png -ha_category: Media Player +ha_category: + - Media Player ha_iot_class: Local Polling ha_release: 0.85 redirect_from: diff --git a/source/_components/harmony.markdown b/source/_components/harmony.markdown index 764291714cd..2d492e009b1 100644 --- a/source/_components/harmony.markdown +++ b/source/_components/harmony.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: logitech.png -ha_category: Remote +ha_category: + - Remote ha_iot_class: Local Push ha_release: 0.34 redirect_from: diff --git a/source/_components/haveibeenpwned.markdown b/source/_components/haveibeenpwned.markdown index aaddab15622..cf7326d03ac 100644 --- a/source/_components/haveibeenpwned.markdown +++ b/source/_components/haveibeenpwned.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: haveibeenpwned.png -ha_category: Sensor +ha_category: + - Sensor ha_release: 0.31 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/hddtemp.markdown b/source/_components/hddtemp.markdown index 449e4c7ac8e..1577dbb8775 100644 --- a/source/_components/hddtemp.markdown +++ b/source/_components/hddtemp.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: System Monitor +ha_category: + - System Monitor ha_release: 0.32 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown index 9eae12c680f..4cb56e11a41 100644 --- a/source/_components/hdmi_cec.markdown +++ b/source/_components/hdmi_cec.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Automation +ha_category: + - Automation logo: hdmi.png ha_release: 0.23 ha_iot_class: Local Push diff --git a/source/_components/heatmiser.markdown b/source/_components/heatmiser.markdown index 06a6b78b939..7a3834a8bcd 100644 --- a/source/_components/heatmiser.markdown +++ b/source/_components/heatmiser.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: heatmiser.png -ha_category: Climate +ha_category: + - Climate ha_release: "0.10" ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/heos.markdown b/source/_components/heos.markdown index 135fedb45bd..ec870a19d39 100644 --- a/source/_components/heos.markdown +++ b/source/_components/heos.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: heos.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.92 ha_iot_class: Local Push --- @@ -21,7 +22,6 @@ The HEOS integration adds support for [HEOS](http://heosbydenon.denon.com) capab - Clear playlist - Select source from device physical inputs and HEOS favorites - ## {% linkable_title Configuration %} HEOS devices are discovered and setup automatically when the [discovery](/components/discovery) component is enabled. Alternatively, the component can be setup through the frontend control panel integrations page or manually by adding the following to your `configuration.yaml` file: @@ -45,8 +45,82 @@ A connection to a single device enables control for all devices on the network. ## {% linkable_title Services %} +### {% linkable_title Service `heos.sign_in` %} + +Use the sign-in service to sign the connected controller into a HEOS account so that it can retreive and play HEOS favorites and playlists. An error message is logged if sign-in is unsuccessful. Example service data payload: + +```json +{ + "username": "example@example.com", + "password": "password" +} +``` + +| Attribute | Description +| ---------------------- | ---------------------------------------------------------| +| `username` | The username or email of the HEOS account. [Required] +| `password` | The password of the HEOS account. [Required] + +### {% linkable_title Service `heos.sign_out` %} + +Use the sign-out service to sign the connected controller out of a HEOS account. An error message is logged if sign-out is unsuccessful. There are no parameters to this service. + ### {% linkable_title Service `media_player.play_media` %} +#### {% linkable_title Play Favorite %} + +You can play a HEOS favorite by number or name with the `media_player.play_media` service. Example service data payload: + +```json +{ + "entity_id": "media_player.office", + "media_content_type": "favorite", + "media_content_id": "1" +} +``` + +| Attribute | Description +| ---------------------- | ---------------------------------------------------------| +| `entity_id` | `entity_id` of the player +| `media_content_type` | Set to the value `playlist` +| `media_content_id` | The nubmer (i.e. `1`) or name (i.e. `Thumbprint Radio`) of the HEOS favorite + +#### {% linkable_title Play Playlist %} + +You can play a HEOS playlist with the `media_player.play_media` service. Example service data payload: + +```json +{ + "entity_id": "media_player.office", + "media_content_type": "playlist", + "media_content_id": "Awesome Music" +} +``` + +| Attribute | Description +| ---------------------- | ---------------------------------------------------------| +| `entity_id` | `entity_id` of the player +| `media_content_type` | Set to the value `playlist` +| `media_content_id` | The name of the HEOS playlist + +#### {% linkable_title Play Quick Select %} + +You can play a HEOS Quick Select by nubmer or name with the `media_player.play_media` service. Example service data payload: + +```json +{ + "entity_id": "media_player.office", + "media_content_type": "quick_select", + "media_content_id": "1" +} +``` + +| Attribute | Description +| ---------------------- | ---------------------------------------------------------| +| `entity_id` | `entity_id` of the player +| `media_content_type` | Set to the value `quick_select` +| `media_content_id` | The quick select number (i.e. `1`) or name (i.e. `Quick Select 1`) + #### {% linkable_title Play Url %} You can play a URL through a HEOS media player using the `media_player.play_media` service. The HEOS player must be able to reach the URL. Example service data payload: @@ -60,19 +134,19 @@ You can play a URL through a HEOS media player using the `media_player.play_medi ``` | Attribute | Description -| ---------------------- | ----------- | ----------- | +| ---------------------- | ---------------------------------------------------------| | `entity_id` | `entity_id` of the player to play the URL | `media_content_type` | Set to the value `url` | `media_content_id` | The full URL to the stream - ## {% linkable_title Notes %} - HEOS groups are not currently supported. - Receivers with multiple zones are represented as a single media player. They will be turned on when playback is started, but cannot be turned off by the integration at this time. +## {% linkable_title Troubleshooing %} -## {% linkable_title Debugging %} +### {% linkable_title Debugging %} The HEOS component will log additional information about commands, events, and other messages when the log level is set to `debug`. Add the the relevent line below to the `configuration.yaml` to enable debug logging: @@ -82,4 +156,11 @@ logger: logs: homeassistant.components.heos: debug pyheos: debug -``` \ No newline at end of file +``` + +### {% linkable_title Missing Favorites %} + +If the HEOS controller is not signed in to a HEOS account, HEOS favorites will not be populated in the media player source selection and the service `media_player.play_media` for `favorite` and `playlist` will fail. Additionally, the following warning will be logged at startup: +> IP_ADDRESS is not logged in to a HEOS account and will be unable to retrieve HEOS favorites: Use the 'heos.sign_in' service to sign-in to a HEOS account + +To resolve this issue, use the `heos.sign_out` service to sign the controller into an account as documented above. This only needs to be performed once, as the controller will remain signed in while the account credentails are valid. diff --git a/source/_components/hikvision.markdown b/source/_components/hikvision.markdown index 60a80a7c340..b59068d4517 100644 --- a/source/_components/hikvision.markdown +++ b/source/_components/hikvision.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: hikvision.png -ha_category: Binary Sensor +ha_category: + - Binary Sensor ha_release: 0.35 ha_iot_class: Local Push redirect_from: diff --git a/source/_components/hikvisioncam.markdown b/source/_components/hikvisioncam.markdown index be37e776ee0..e6c544b04d9 100644 --- a/source/_components/hikvisioncam.markdown +++ b/source/_components/hikvisioncam.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: hikvision.png -ha_category: Switch +ha_category: + - Switch ha_release: pre 0.7 redirect_from: - /components/switch.hikvisioncam/ diff --git a/source/_components/hipchat.markdown b/source/_components/hipchat.markdown index 966b7555284..7caba355984 100644 --- a/source/_components/hipchat.markdown +++ b/source/_components/hipchat.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: hipchat.png -ha_category: Notifications +ha_category: + - Notifications ha_release: 0.52 redirect_from: - /components/notify.hipchat/ diff --git a/source/_components/history.markdown b/source/_components/history.markdown index c2829753734..52bfedae60d 100644 --- a/source/_components/history.markdown +++ b/source/_components/history.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: History +ha_category: + - History ha_release: pre 0.7 ha_qa_scale: internal --- diff --git a/source/_components/history_graph.markdown b/source/_components/history_graph.markdown index 58ba97e9947..8d3dcfb083d 100644 --- a/source/_components/history_graph.markdown +++ b/source/_components/history_graph.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: History +ha_category: + - History logo: home-assistant.png ha_release: 0.55 ha_qa_scale: internal diff --git a/source/_components/history_stats.markdown b/source/_components/history_stats.markdown index 330acfc8704..17facd9a152 100644 --- a/source/_components/history_stats.markdown +++ b/source/_components/history_stats.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Utility +ha_category: + - Utility ha_iot_class: Local Polling ha_release: 0.39 ha_qa_scale: internal diff --git a/source/_components/hitron_coda.markdown b/source/_components/hitron_coda.markdown index ccd355b059f..379f44132a7 100644 --- a/source/_components/hitron_coda.markdown +++ b/source/_components/hitron_coda.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: hitron.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: 0.58 redirect_from: - /components/device_tracker.hitron_coda/ diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index 4a673620d6f..fece1ba1b39 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Voice +ha_category: + - Voice ha_release: 0.64 logo: apple-homekit.png --- @@ -341,6 +342,7 @@ The following components are currently supported: | light | Light | Support for `on / off`, `brightness` and `rgb_color`. | | lock | DoorLock | Support for `lock / unlock`. | | media_player | MediaPlayer | Represented as a series of switches which control `on / off`, `play / pause`, `play / stop`, or `mute` depending on `supported_features` of entity and the `mode` list specified in `entity_config`. | +| media_player | TelevisionMediaPlayer | All media players that have `tv` as their `device_class`. Represented as Television and Remote accessories in HomeKit to control `on / off`, `play / pause`, `select source`, or `volume increase / decrease`, depending on `supported_features` of entity. Requires iOS 12.2/macOS 10.14.4 or later. | | sensor | TemperatureSensor | All sensors that have `Celsius` or `Fahrenheit` as their `unit_of_measurement` or `temperature` as their `device_class`. | | sensor | HumiditySensor | All sensors that have `%` as their `unit_of_measurement` and `humidity` as their `device_class`. | | sensor | AirQualitySensor | All sensors that have `pm25` as part of their `entity_id` or `pm25` as their `device_class` | @@ -457,3 +459,11 @@ To fix this, you need to unpair the `Home Assistant Bridge`, delete the `.homeki #### {% linkable_title The linked battery sensor isn't recognized %} Try removing the entity from HomeKit and then adding it again. If you are adding this config option to an existing entity in HomeKit, any changes you make to this entity's config options won't appear until the accessory is removed from HomeKit and then re-added. + +#### {% linkable_title My media player is not showing up as a television accessory %} + +Media Player entities with `device_class: tv` will show up as Television accessories on devices running iOS 12.2/macOS 10.14.4 or later. If needed, try removing the entity from HomeKit and then adding it again, especially if the `media_player` was previously exposed as a series of switches. Any changes, including changed supported features, made to an existing accessory won't appear until the accessory is removed from HomeKit and then re-added. + +#### {% linkable_title Can't control volume of your TV media player? %} + +The volume and play/pause controls will show up on the Remote app or Control Center. If your TV supports volume control through Home Assistant, you will be able to control the volume using the side volume buttons on the device while having the remote selected on screen. diff --git a/source/_components/honeywell.markdown b/source/_components/honeywell.markdown index 6ba8a1bdec8..bab02288bdf 100644 --- a/source/_components/honeywell.markdown +++ b/source/_components/honeywell.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: honeywell.png -ha_category: Climate +ha_category: + - Climate ha_release: pre 0.7 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/hook.markdown b/source/_components/hook.markdown index 0ef60023221..d37cba8f1ae 100644 --- a/source/_components/hook.markdown +++ b/source/_components/hook.markdown @@ -7,7 +7,8 @@ comments: false sharing: true footer: true logo: hook.png -ha_category: Switch +ha_category: + - Switch ha_iot_class: Assumed State ha_release: 0.34 redirect_from: diff --git a/source/_components/horizon.markdown b/source/_components/horizon.markdown index 6c65aa6d619..61b49c76999 100644 --- a/source/_components/horizon.markdown +++ b/source/_components/horizon.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: unitymedia.png -ha_category: Media Player +ha_category: + - Media Player ha_iot_class: Local Polling ha_release: 0.72 redirect_from: diff --git a/source/_components/hp_ilo.markdown b/source/_components/hp_ilo.markdown index c2a1a672d29..da2dc4603ae 100644 --- a/source/_components/hp_ilo.markdown +++ b/source/_components/hp_ilo.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: hewlett_packard_enterprise.png -ha_category: System Monitor +ha_category: + - System Monitor ha_release: 0.27 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/html5.markdown b/source/_components/html5.markdown index bc698d07781..6e9035f00ce 100644 --- a/source/_components/html5.markdown +++ b/source/_components/html5.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: html5.png -ha_category: Notifications +ha_category: + - Notifications ha_release: 0.27 redirect_from: - /components/notify.html5/ @@ -144,7 +145,7 @@ data: #### {% linkable_title Data %} -Any parameters that you pass in the notify payload that aren't valid for use in the HTML5 notification (`actions`, `badge`, `body`, `dir`, `icon`, `image`, `lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`) will be sent back to you in the [callback events](#automating-notification-events). +Any parameters that you pass in the notify payload that aren't valid for use in the HTML5 notification (`actions`, `badge`, `body`, `dir`, `icon`, `image`, `lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`, `priority`, `ttl`) will be sent back to you in the [callback events](#automating-notification-events). ```yaml title: Front door @@ -219,6 +220,20 @@ data: If no URL or actions are provided, interacting with a notification will open your Home Assistant in the browser. You can use relative URLs to refer to Home Assistant, i.e. `/map` would turn into `https://192.168.1.2:8123/map`. +#### {% linkable_title TTL and Priority %} + +Newer Android versions introduced stronger battery optimization, so notifications by default are delivered only when phone is awake. +Options TTL and priority tries to help users solve those problems. Default value of TTL is `86400s` and priority is `normal`. +You can set priority to either `normal` or `high`. TTL is any integer value. + +```yaml +title: Front door +message: The front door is open +data: + ttl: 86400 + priority: high +``` + ### {% linkable_title Dismiss %} You can dismiss notifications by using service notify.html5_dismiss like so: diff --git a/source/_components/htu21d.markdown b/source/_components/htu21d.markdown index 48b1f91ff78..a7ffd731ea3 100644 --- a/source/_components/htu21d.markdown +++ b/source/_components/htu21d.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: DIY +ha_category: + - DIY ha_release: 0.48 ha_iot_class: Local Push redirect_from: diff --git a/source/_components/huawei_router.markdown b/source/_components/huawei_router.markdown index fad31c43f05..31ecacd2b4d 100644 --- a/source/_components/huawei_router.markdown +++ b/source/_components/huawei_router.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: huawei.svg -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: 0.51 redirect_from: - /components/device_tracker.huawei_router/ 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/hunterdouglas_powerview.markdown b/source/_components/hunterdouglas_powerview.markdown index f047bf62c2d..6dac3997625 100644 --- a/source/_components/hunterdouglas_powerview.markdown +++ b/source/_components/hunterdouglas_powerview.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: hunter-douglas-powerview.png -ha_category: Scene +ha_category: + - Scene ha_release: 0.15 redirect_from: - /components/scene.hunterdouglas_powerview/ diff --git a/source/_components/hydroquebec.markdown b/source/_components/hydroquebec.markdown index 62a69560686..8c061b92914 100644 --- a/source/_components/hydroquebec.markdown +++ b/source/_components/hydroquebec.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: hydroquebec.svg -ha_category: Energy +ha_category: + - Energy ha_release: 0.35 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/hyperion.markdown b/source/_components/hyperion.markdown index 6f780836b44..3d9397635b6 100644 --- a/source/_components/hyperion.markdown +++ b/source/_components/hyperion.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: hyperion.png -ha_category: Light +ha_category: + - Light ha_release: 0.7.6 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/ialarm.markdown b/source/_components/ialarm.markdown index 6be1758afcb..446f65cadcc 100644 --- a/source/_components/ialarm.markdown +++ b/source/_components/ialarm.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: antifurto365-ialarm.png -ha_category: Alarm +ha_category: + - Alarm ha_release: "0.60" redirect_from: - /components/alarm_control_panel.ialarm/ diff --git a/source/_components/icloud.markdown b/source/_components/icloud.markdown index f90fa283bd0..46da072f17d 100644 --- a/source/_components/icloud.markdown +++ b/source/_components/icloud.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: icloud.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: "0.10" redirect_from: - /components/device_tracker.icloud/ diff --git a/source/_components/idteck_prox.markdown b/source/_components/idteck_prox.markdown index 7899e7eb5f2..92145873a5d 100644 --- a/source/_components/idteck_prox.markdown +++ b/source/_components/idteck_prox.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: idteck.jpg -ha_category: Other +ha_category: + - Other ha_release: 0.85 ha_iot_class: Local Push --- diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown index a440d36053e..a926362e593 100644 --- a/source/_components/ifttt.markdown +++ b/source/_components/ifttt.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: ifttt.png -ha_category: Automation +ha_category: + - Automation featured: true ha_iot_class: Cloud Push ha_release: 0.80 diff --git a/source/_components/iglo.markdown b/source/_components/iglo.markdown index 9c5b5bf9ccb..2263ced9b8c 100644 --- a/source/_components/iglo.markdown +++ b/source/_components/iglo.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: iglo.png -ha_category: Light +ha_category: + - Light ha_iot_class: Local Polling ha_release: 0.61 redirect_from: diff --git a/source/_components/ign_sismologia.markdown b/source/_components/ign_sismologia.markdown index 193aa76d157..dab95336634 100644 --- a/source/_components/ign_sismologia.markdown +++ b/source/_components/ign_sismologia.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: ign-sismologia.png -ha_category: Geolocation +ha_category: + - Geolocation ha_iot_class: Cloud Polling ha_release: 0.92 --- diff --git a/source/_components/imap.markdown b/source/_components/imap.markdown index bcc364e3fd8..cd675022fe7 100644 --- a/source/_components/imap.markdown +++ b/source/_components/imap.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: smtp.png -ha_category: Mailbox +ha_category: + - Mailbox ha_release: 0.25 ha_iot_class: Cloud Push redirect_from: diff --git a/source/_components/imap_email_content.markdown b/source/_components/imap_email_content.markdown index 39a1ee111c1..8e2888bfe32 100644 --- a/source/_components/imap_email_content.markdown +++ b/source/_components/imap_email_content.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: smtp.png -ha_category: Mailbox +ha_category: + - Mailbox ha_iot_class: Cloud Push ha_release: 0.25 redirect_from: diff --git a/source/_components/incomfort.markdown b/source/_components/incomfort.markdown new file mode 100644 index 00000000000..d11846f4cd7 --- /dev/null +++ b/source/_components/incomfort.markdown @@ -0,0 +1,55 @@ +--- +layout: page +title: "Intergas InComfort" +description: "Instructions on how to integrate an Intergas Lan2RF gateway with Home Assistant." +date: 2019-03-03 16:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: incomfort.png +ha_category: + - Water heater +ha_release: 0.93 +ha_iot_class: Local Polling +--- + +The `incomfort` integration links Home Assistant with your Intergas Lan2RF gateway for controlling water_heater devices (the hub does not have to be in the same network as HA). + +The **Water Heater** device will report back the `state` and `temperature`. Other properties are available via the device's attributes. + +In the future, other entities will be added to this integration (e.g. a **Sensor** for CV pressure, and a **Climate** device for room temperature). + +### {% linkable_title Configuration %} + +To add your Lan2RF gateway into your Home Assistant installation, add one of the following to your `configuration.yaml` file. + +```yaml +# Example configuration.yaml entry, older firmware with no user credentials +incomfort: + host: IP_ADDRESS +``` +Alternatively, if a **username** & **password** is printed on the back of the gateway: + +```yaml +# Example configuration.yaml entry, newer firmware with user credentials +incomfort: + host: IP_ADDRESS + username: USERNAME + password: PASSWORD +``` + +{% configuration %} +host: + description: The hostname/IP address of the Lan2RF gateway + required: true + type: string +username: + description: The username of the Lan2RF gateway + required: inclusive + type: string +password: + description: The password of the Lan2RF gateway + required: inclusive + type: string +{% endconfiguration %} diff --git a/source/_components/input_boolean.markdown b/source/_components/input_boolean.markdown index 54785486fa8..711f800b147 100644 --- a/source/_components/input_boolean.markdown +++ b/source/_components/input_boolean.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Automation +ha_category: + - Automation ha_qa_scale: internal ha_release: 0.11 --- diff --git a/source/_components/input_datetime.markdown b/source/_components/input_datetime.markdown index 5a3d8aa005e..24af729cd29 100644 --- a/source/_components/input_datetime.markdown +++ b/source/_components/input_datetime.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Automation +ha_category: + - Automation ha_release: 0.55 ha_qa_scale: internal --- diff --git a/source/_components/input_number.markdown b/source/_components/input_number.markdown index 840803033f3..1fd23355f1f 100644 --- a/source/_components/input_number.markdown +++ b/source/_components/input_number.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Automation +ha_category: + - Automation ha_release: 0.55 redirect_from: /components/input_slider/ ha_qa_scale: internal diff --git a/source/_components/input_select.markdown b/source/_components/input_select.markdown index 92a27d6c851..9da10404134 100644 --- a/source/_components/input_select.markdown +++ b/source/_components/input_select.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Automation +ha_category: + - Automation ha_release: 0.13 ha_qa_scale: internal --- diff --git a/source/_components/input_text.markdown b/source/_components/input_text.markdown index 4907e82659a..2cfa1bd7686 100644 --- a/source/_components/input_text.markdown +++ b/source/_components/input_text.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Automation +ha_category: + - Automation ha_release: 0.53 ha_qa_scale: internal --- @@ -49,7 +50,7 @@ input_text: type: integer default: 0 max: - description: Maximum length for the text value. + description: Maximum length for the text value. 255 is the maximum number of characters allowed in an entity state. required: false type: integer default: 100 diff --git a/source/_components/intent_script.markdown b/source/_components/intent_script.markdown index f31d44d64c6..20a0c06074a 100644 --- a/source/_components/intent_script.markdown +++ b/source/_components/intent_script.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Intent +ha_category: + - Intent ha_release: "0.50" ha_qa_scale: internal --- 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/ios.markdown b/source/_components/ios.markdown index 213b7ac553a..bbad6b84642 100644 --- a/source/_components/ios.markdown +++ b/source/_components/ios.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: apple.png -ha_category: Hub +ha_category: + - Hub ha_release: 0.31 ha_iot_class: Configurable --- diff --git a/source/_components/iperf3.markdown b/source/_components/iperf3.markdown index 49d5d515bb2..7fe67b3e436 100644 --- a/source/_components/iperf3.markdown +++ b/source/_components/iperf3.markdown @@ -17,11 +17,13 @@ redirect_from: - /components/sensor.iperf3/ --- -The `iperf3` sensor component allows you to measure network bandwidth performance against a private or public Iperf3 server. +The `iperf3` sensor component allows you to measure network bandwidth performance against a private or public [Iperf3](http://software.es.net/iperf/index.html) server. -Enabling this component will automatically create the Iperf3 Sensors for the monitored conditions (below). +Enabling this component will automatically create the Iperf3 sensors for the monitored conditions (below). By default, it will run every hour. The user can change the update frequency in the config by defining the `scan_interval` for a Iperf3 test to run. -By default, it will run every hour. The user can change the update frequency in the config by defining the `scan_interval` for a iperf3 test to run. +## {% linkable_title Setup %} + +This component requires the `iperf3` command to be installed on your OS. Please, refer to the [official Iperf3 documentation](http://software.es.net/iperf/obtaining.html) for installation instructions. ## {% linkable_title Configuration %} @@ -43,9 +45,9 @@ iperf3: type: list keys: download: - description: Download speed (Mbit/s) + description: The download speed (Mbit/s). upload: - description: Upload speed (Mbit/s) + description: The upload speed (Mbit/s). hosts: description: A list of Iperf3 servers to perform the test against. required: true @@ -56,17 +58,17 @@ iperf3: default: 60 minutes type: time manual: - description: > - `true` or `false` to turn manual mode on or off. Manual mode will disable scheduled tests. + description: "`true` or `false` to turn manual mode on or off. Manual mode will disable scheduled tests." required: false type: boolean default: false {% endconfiguration %} Configuration variables (host): + {% configuration %} host: - description: Server name/ip address running Iperf3 to test against. + description: Server name/IP address running Iperf3 to test against. required: true type: string port: @@ -117,8 +119,12 @@ Once loaded, the `iperf3` component will expose a service (`iperf3.speedtest`) t | Service data attribute | Description | | `host` | String that point at a configured `host` from configuration.yaml. Otherwise, tests will be run against all configured hosts. +Example Service data: + +```json +{"host": "192.168.0.121"} +``` ## {% linkable_title Notes %} - When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter. -- This component requires the `iperf3` command to be installed on your OS. Please, refer to the [official Iperf3 documentation](http://software.es.net/iperf/obtaining.html) for installation instructions. diff --git a/source/_components/ipma.markdown b/source/_components/ipma.markdown index 901d6aa5f29..dfb2a64f705 100644 --- a/source/_components/ipma.markdown +++ b/source/_components/ipma.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: ipma.png -ha_category: Weather +ha_category: + - Weather ha_release: 0.72 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/pollen.markdown b/source/_components/iqvia.markdown similarity index 79% rename from source/_components/pollen.markdown rename to source/_components/iqvia.markdown index 85a84cfe030..cb04396076a 100644 --- a/source/_components/pollen.markdown +++ b/source/_components/iqvia.markdown @@ -1,23 +1,25 @@ --- layout: page -title: "Pollen.com" -description: "Instructions on how to use Pollen.com data within Home Assistant" +title: "IQVIA" +description: "Instructions on how to use IQVIA data within Home Assistant" date: 2018-01-10 19:20:00 sidebar: true comments: false sharing: true footer: true -logo: pollen.jpg -ha_category: Health +logo: iqvia.png +ha_category: + - Health ha_release: 0.63 ha_iot_class: Cloud Polling redirect_from: - /components/sensor.pollen/ + - /components/pollen/ --- -The `pollen` sensor platform collects and displays allergy, asthma, and disease -information (based on a U.S. ZIP code) from -[Pollen.com](https://www.pollen.com/). Data measured includes: +The `iqvia` sensor platform collects and displays allergy, asthma, and disease +information (based on a U.S. ZIP code) from [IQVIA](https://www.iqvia.com/). +Data measured includes: * Indicies for allergies, asthma and cold/flu indices * Trends @@ -26,26 +28,25 @@ information (based on a U.S. ZIP code) from ## {% linkable_title Configuring the Platform %} -To integrate `pollen` into Home Assistant, add the following section to your +To integrate `iqvia` into Home Assistant, add the following section to your `configuration.yaml` file (adjusting the `monitored_conditions` list to your liking): ```yaml -sensor: - platform: pollen +iqvia: zip_code: "00544" monitored_conditions: - allergy_average_forecasted - - allergy_average_historical - allergy_index_today - allergy_index_tomorrow - allergy_index_yesterday - asthma_average_forecasted - - asthma_average_historical - asthma_index_today - asthma_index_tomorrow - asthma_index_yesterday - disease_average_forecasted + - disease_index_today + - disease_index_yesterday ``` {% configuration %} @@ -69,16 +70,16 @@ ZIP codes that start with 0 will cause errors. The following metrics can be monitored: * Allergy Index: Forecasted Average (`allergy_average_forecasted`): the average forecasted allergy index over the next 5 days -* Allergy Index: Historical Average (`allergy_average_historical`): the average historical allergy index over the past 30 days * Allergy Index: Today (`allergy_index_today`): the allergy index for today * Allergy Index: Tomorrow (`allergy_index_tomorrow`): the allergy index for tomorrow * Allergy Index: Yesterday (`allergy_index_yesterday`): the allergy index for yesterday * Asthma Index: Forecasted Average (`asthma_average_forecasted`): the average forecasted asthma index over the next 5 days -* Asthma Index: Historical Average (`asthma_average_historical`): the average historical asthma index over the past 30 days * Asthma Index: Today (`asthma_index_today`): the asthma index for today * Asthma Index: Tomorrow (`asthma_index_tomorrow`): the asthma index for tomorrow * Asthma Index: Yesterday (`asthma_index_yesterday`): the asthma index for yesterday * Cold & Flu: Forecasted Average (`disease_average_forecasted`): the average forecasted cold/flu index over the next 5 days +* Cold & Flu Index: Today (`disease_index_today`): the cold/flu index for today +* Cold & Flu Index: Yesterday (`disease_index_yesterday`): the cold/flu index for yesterday ## {% linkable_title Understanding the Indices %} @@ -86,8 +87,6 @@ Any index-related sensor will have a value between 0.0 and 12.0. The values map to the following human-friendly ratings: Range | Rating -redirect_from: - - /components/sensor.pollen/ --------- | ----------- 0.0 - 2.4 | Low 2.5 - 4.8 | Low/Medium @@ -102,8 +101,6 @@ Several asthma-related sensors carry information regarding the top three Example values include: Pollutant | Symbol | More Info -redirect_from: - - /components/sensor.pollen/ --------- | ------ | --------- Particulate (<= 2.5 μm) | PM2.5 | [EPA: Particulate Matter (PM) Pollution](https://www.epa.gov/pm-pollution) Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution](https://www.epa.gov/pm-pollution) diff --git a/source/_components/irish_rail_transport.markdown b/source/_components/irish_rail_transport.markdown index 1a95369e73d..49328e6e658 100644 --- a/source/_components/irish_rail_transport.markdown +++ b/source/_components/irish_rail_transport.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: irishrail.png -ha_category: Transport +ha_category: + - Transport ha_iot_class: Cloud Polling ha_release: 0.57 redirect_from: diff --git a/source/_components/islamic_prayer_times.markdown b/source/_components/islamic_prayer_times.markdown index 3d9dc474c85..c66dde38efc 100644 --- a/source/_components/islamic_prayer_times.markdown +++ b/source/_components/islamic_prayer_times.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: + - Sensor ha_iot_class: Cloud Polling ha_release: 0.85 redirect_from: diff --git a/source/_components/iss.markdown b/source/_components/iss.markdown index c47ab913ebb..34d47020994 100644 --- a/source/_components/iss.markdown +++ b/source/_components/iss.markdown @@ -8,10 +8,11 @@ comments: false sharing: true footer: true logo: nasa.png -ha_category: Binary Sensor +ha_category: + - Binary Sensor ha_release: 0.36 -redirect_from: /components/sensor.iss/ redirect_from: + - /components/sensor.iss/ - /components/binary_sensor.iss/ --- diff --git a/source/_components/itach.markdown b/source/_components/itach.markdown index 2b3dc247ba2..9c39c7aeb99 100644 --- a/source/_components/itach.markdown +++ b/source/_components/itach.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: globalcache.png -ha_category: Remote +ha_category: + - Remote ha_iot_class: Assumed State ha_release: 0.39 redirect_from: diff --git a/source/_components/itunes.markdown b/source/_components/itunes.markdown index bdcff155e51..5a1c5fddbeb 100644 --- a/source/_components/itunes.markdown +++ b/source/_components/itunes.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: itunes.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.7.3 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/jewish_calendar.markdown b/source/_components/jewish_calendar.markdown index a141896c500..ae53869a010 100644 --- a/source/_components/jewish_calendar.markdown +++ b/source/_components/jewish_calendar.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Calendar +ha_category: + - Calendar ha_iot_class: Local Polling ha_release: 0.79 redirect_from: diff --git a/source/_components/joaoapps_join.markdown b/source/_components/joaoapps_join.markdown index 9355216b639..b2429628127 100644 --- a/source/_components/joaoapps_join.markdown +++ b/source/_components/joaoapps_join.markdown @@ -20,7 +20,7 @@ The `joaoapps_join` component exposes services from [Join](http://joaoapps.com/join). In Home Assistant, the Join features are divided up in two locations, the Join component, and the Join notify platform. The notify platform allows us to send messages to Join devices, the component -allows us to access the other special features that Join offers. +allows us to access the other special features that Join offers. When in doubt, you can reference the [API documentation](https://joaoapps.com/join/api/) this this is based on. In the `configuration.yaml` file you need to provide the api key and device id or name of the target device. You can find your device id and api key @@ -34,8 +34,8 @@ notify: - platform: joaoapps_join api_key: YOUR_API_KEY device_id: DEVICE_ID - device_ids: DEVICE_ID_1, DEVICE_ID_2 - device_names: DEVICE_1_NAME, DEVICE_2_NAME + device_ids: DEVICE_ID_1,DEVICE_ID_2 + device_names: DEVICE_1_NAME,DEVICE_2_NAME name: NAME joaoapps_join: - name: NAME_OF_GROUP @@ -49,20 +49,39 @@ api_key: required: true type: string device_id: - description: The id of your device. + description: The id of your device or group required: false type: string device_ids: - description: Comma separated list of device ids. + description: Comma separated list of device ids or groups. required: false type: string device_names: description: Comma separated list of device names. required: false type: string +name: + description: The name parameter is optional but needed if you want to use multiple notification platforms. The platform will be exposed as service `notify.+This component is not affiliated with MeteoAlarm and retrieves data from the website by using the XML feeds. Use it at your own risk. +
diff --git a/source/_components/metoffice.markdown b/source/_components/metoffice.markdown index 95fb7c50049..7a5e787a859 100644 --- a/source/_components/metoffice.markdown +++ b/source/_components/metoffice.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: metoffice.jpg -ha_category: Weather +ha_category: + - Weather ha_release: 0.42 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/mhz19.markdown b/source/_components/mhz19.markdown index 68d18bea3f3..c01ff9d43fb 100644 --- a/source/_components/mhz19.markdown +++ b/source/_components/mhz19.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mhz19_logo.png -ha_category: DIY +ha_category: + - DIY ha_release: 0.27 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/microsoft.markdown b/source/_components/microsoft.markdown index 85ff5e4b220..496a3513dec 100644 --- a/source/_components/microsoft.markdown +++ b/source/_components/microsoft.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: microsoft.png -ha_category: Text-to-speech +ha_category: + - Text-to-speech ha_release: 0.57 redirect_from: - /components/tts.microsoft/ diff --git a/source/_components/microsoft_face.markdown b/source/_components/microsoft_face.markdown index ee8554d0424..d26dffb6c0c 100644 --- a/source/_components/microsoft_face.markdown +++ b/source/_components/microsoft_face.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: microsoft.png -ha_category: Image Processing +ha_category: + - Image Processing ha_release: 0.37 --- diff --git a/source/_components/microsoft_face_detect.markdown b/source/_components/microsoft_face_detect.markdown index 7aa5fa5e79f..0391fb387b4 100644 --- a/source/_components/microsoft_face_detect.markdown +++ b/source/_components/microsoft_face_detect.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: microsoft.png -ha_category: Image Processing +ha_category: + - Image Processing ha_release: 0.38 redirect_from: - /components/image_processing.microsoft_face_detect/ diff --git a/source/_components/microsoft_face_identify.markdown b/source/_components/microsoft_face_identify.markdown index cf148a10447..f3408dbb8f5 100644 --- a/source/_components/microsoft_face_identify.markdown +++ b/source/_components/microsoft_face_identify.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: microsoft.png -ha_category: Image Processing +ha_category: + - Image Processing ha_release: 0.37 redirect_from: - /components/image_processing.microsoft_face_identify/ diff --git a/source/_components/miflora.markdown b/source/_components/miflora.markdown index 1f546b09233..72d157dee8a 100644 --- a/source/_components/miflora.markdown +++ b/source/_components/miflora.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: miflora.png -ha_category: Environment +ha_category: + - Environment ha_release: 0.29 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/mikrotik.markdown b/source/_components/mikrotik.markdown index 3f847c5eced..2ae7375363f 100644 --- a/source/_components/mikrotik.markdown +++ b/source/_components/mikrotik.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mikrotik.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: 0.44 redirect_from: - /components/device_tracker.mikrotik/ diff --git a/source/_components/mill.markdown b/source/_components/mill.markdown index 3a1f8c76431..b5efbaf4741 100644 --- a/source/_components/mill.markdown +++ b/source/_components/mill.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mill.png -ha_category: Climate +ha_category: + - Climate ha_release: 0.81 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/min_max.markdown b/source/_components/min_max.markdown index 5ea75b7473c..28a6ca136e5 100644 --- a/source/_components/min_max.markdown +++ b/source/_components/min_max.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Utility +ha_category: + - Utility ha_iot_class: Local Polling ha_release: 0.31 ha_qa_scale: internal diff --git a/source/_components/mitemp_bt.markdown b/source/_components/mitemp_bt.markdown index a70b76c3da6..93c8ead2496 100644 --- a/source/_components/mitemp_bt.markdown +++ b/source/_components/mitemp_bt.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: xiaomi.png -ha_category: DIY +ha_category: + - DIY ha_release: 0.69 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/mjpeg.markdown b/source/_components/mjpeg.markdown index f8fdad9f88b..428b710f2b7 100644 --- a/source/_components/mjpeg.markdown +++ b/source/_components/mjpeg.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Camera +ha_category: + - Camera ha_release: pre 0.7 ha_iot_class: Configurable redirect_from: diff --git a/source/_components/mobile_app.markdown b/source/_components/mobile_app.markdown index cdb7634c304..ef2ab766b9a 100644 --- a/source/_components/mobile_app.markdown +++ b/source/_components/mobile_app.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: "Other" +ha_category: + - "Other" ha_release: 0.89 ha_qa_scale: internal --- diff --git a/source/_components/modbus.markdown b/source/_components/modbus.markdown index 86b9232747b..77ddbcee795 100644 --- a/source/_components/modbus.markdown +++ b/source/_components/modbus.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: modbus.png -ha_category: Hub +ha_category: + - Hub ha_release: pre 0.7 ha_iot_class: Local Push --- diff --git a/source/_components/modem_callerid.markdown b/source/_components/modem_callerid.markdown index 91ce1fbb8e7..ca8a08b1964 100644 --- a/source/_components/modem_callerid.markdown +++ b/source/_components/modem_callerid.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: + - Sensor ha_release: "0.40" ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/mold_indicator.markdown b/source/_components/mold_indicator.markdown index d11ed34710b..65f3ac9d1a5 100644 --- a/source/_components/mold_indicator.markdown +++ b/source/_components/mold_indicator.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Environment +ha_category: + - Environment ha_release: "0.20" ha_iot_class: Local Polling ha_qa_scale: internal diff --git a/source/_components/monoprice.markdown b/source/_components/monoprice.markdown index 408eb69a48e..5fe57db0fc9 100644 --- a/source/_components/monoprice.markdown +++ b/source/_components/monoprice.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: monoprice.svg -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.56 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/moon.markdown b/source/_components/moon.markdown index 1c143d9e5f2..fc14c92ca13 100644 --- a/source/_components/moon.markdown +++ b/source/_components/moon.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Environment +ha_category: + - Environment ha_iot_class: Local Polling ha_release: 0.38 ha_qa_scale: internal diff --git a/source/_components/mpchc.markdown b/source/_components/mpchc.markdown index 32849e0f8c9..6793fe01e97 100644 --- a/source/_components/mpchc.markdown +++ b/source/_components/mpchc.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mpchc.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.25 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/mpd.markdown b/source/_components/mpd.markdown index 6c95687b98a..c17885ebf74 100644 --- a/source/_components/mpd.markdown +++ b/source/_components/mpd.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mpd.png -ha_category: Media Player +ha_category: + - Media Player ha_release: pre 0.7 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/mqtt.markdown b/source/_components/mqtt.markdown index fe98b223e87..58be848946c 100644 --- a/source/_components/mqtt.markdown +++ b/source/_components/mqtt.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mqtt.png -ha_category: Hub +ha_category: + - Hub featured: true ha_release: pre 0.7 ha_iot_class: Local Push diff --git a/source/_components/mqtt_eventstream.markdown b/source/_components/mqtt_eventstream.markdown index 4ea0c5439ad..b35a2e57d49 100644 --- a/source/_components/mqtt_eventstream.markdown +++ b/source/_components/mqtt_eventstream.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mqtt.png -ha_category: Other +ha_category: + - Other ha_release: 0.11 ha_iot_class: Configurable --- diff --git a/source/_components/mqtt_json.markdown b/source/_components/mqtt_json.markdown index 0a0413c3dfc..9d4494d5b8a 100644 --- a/source/_components/mqtt_json.markdown +++ b/source/_components/mqtt_json.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mqtt.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_iot_class: Configurable ha_release: 0.44 redirect_from: diff --git a/source/_components/mqtt_room.markdown b/source/_components/mqtt_room.markdown index fe18eb216b4..362edcb75db 100644 --- a/source/_components/mqtt_room.markdown +++ b/source/_components/mqtt_room.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mqtt.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: 0.27 ha_iot_class: Configurable redirect_from: @@ -40,8 +41,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/mqtt_statestream.markdown b/source/_components/mqtt_statestream.markdown index 822187cbb48..14ea333bc5b 100644 --- a/source/_components/mqtt_statestream.markdown +++ b/source/_components/mqtt_statestream.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mqtt.png -ha_category: Other +ha_category: + - Other ha_release: 0.54 ha_iot_class: Configurable --- diff --git a/source/_components/mvglive.markdown b/source/_components/mvglive.markdown index 433b45ddaac..fcec67914b8 100644 --- a/source/_components/mvglive.markdown +++ b/source/_components/mvglive.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mvg.png -ha_category: Transport +ha_category: + - Transport ha_release: 0.42 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/mychevy.markdown b/source/_components/mychevy.markdown index 3f91dbdc9e3..5d681a94199 100644 --- a/source/_components/mychevy.markdown +++ b/source/_components/mychevy.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: chevy.png -ha_category: Car +ha_category: + - Car ha_release: 0.62 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/myq.markdown b/source/_components/myq.markdown index e8aed2020cf..4eba68ac803 100644 --- a/source/_components/myq.markdown +++ b/source/_components/myq.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: myq.png -ha_category: Cover +ha_category: + - Cover ha_release: 0.39 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index a373f5f04f9..b7fc620ea8d 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: DIY +ha_category: + - DIY ha_iot_class: Local Push ha_release: 0.73 --- @@ -76,7 +77,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 +94,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 +111,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 +154,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 @@ -246,7 +247,13 @@ In MySensors version 2.2 the serial API changed from using `I_HEARTBEAT_RESPONSE Messages sent to or from Home Assistant from or to a MySensors device will be validated according to the MySensors [serial API](https://www.mysensors.org/download/serial_api_20). If a message doesn't pass validation, it will be dropped and not be passed forward either to or from Home Assistant. Make sure you follow the serial API for your version of MySensors when writing your Arduino sketch. -If you experience dropped messages or that a device is not added to Home Assistant, please turn on debug logging for the `mysensors` component and the `mysensors` package. +The log should warn you of messages that failed validation or if a child value is missing that is required for a certain child type. Home Assistant will log failed validations of child values at warning level if e.g. one required value type for a platform has been received, but other required value types are missing. + +Message validation was introduced in version 0.52 of Home Assistant. + +### {% linkable_title 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` component 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 @@ -254,9 +261,6 @@ logger: homeassistant.components.mysensors: debug mysensors: debug ``` -The log should inform you of messages that failed validation or if a child value is missing that is required for a certain child type. Note that the log will log all possible combinations of platforms for a child type that failed validation. It is normal to see some platforms fail validation if the child type supports multiple platforms and your sketch doesn't send all corresponding value types. e.g., the `S_BARO` child type supports both `V_PRESSURE` and `V_FORECAST` value types. If you only send a `V_PRESSURE` value, an `S_BARO` entity with `V_PRESSURE` value will be set up for the sensor platform. However, the log will inform of a sensor platform that failed validation due to missing `V_FORECAST` value type for the `S_BARO` child. Home Assistant will log failed validations of child values at warning level if one required value type for a platform has been received, but other required value types are missing. Most failed validations are logged at debug level. - -Message validation was introduced in version 0.52 of Home Assistant. Visit the [library API][MySensors library api] of MySensors for more information. diff --git a/source/_components/mythicbeastsdns.markdown b/source/_components/mythicbeastsdns.markdown index b12e0b95ffc..b5db1384f6b 100644 --- a/source/_components/mythicbeastsdns.markdown +++ b/source/_components/mythicbeastsdns.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Network +ha_category: + - Network ha_release: 0.85 ha_iot_class: Cloud Push logo: mythic_beasts.png 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/nad.markdown b/source/_components/nad.markdown index 8e838d591c9..bcdec4b48ca 100644 --- a/source/_components/nad.markdown +++ b/source/_components/nad.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: nad.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.36 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/namecheapdns.markdown b/source/_components/namecheapdns.markdown index 95ebe8e032b..b0798ab5004 100644 --- a/source/_components/namecheapdns.markdown +++ b/source/_components/namecheapdns.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: namecheap.png -ha_category: Network +ha_category: + - Network ha_release: 0.56 --- diff --git a/source/_components/nanoleaf.markdown b/source/_components/nanoleaf.markdown index a3c614a99fc..2a404a0e267 100644 --- a/source/_components/nanoleaf.markdown +++ b/source/_components/nanoleaf.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: nanoleaf_light.png -ha_category: Light +ha_category: + - Light ha_iot_class: Local Polling ha_release: 0.67 redirect_from: diff --git a/source/_components/nederlandse_spoorwegen.markdown b/source/_components/nederlandse_spoorwegen.markdown index b0030317a09..7849eb5abdd 100644 --- a/source/_components/nederlandse_spoorwegen.markdown +++ b/source/_components/nederlandse_spoorwegen.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: nederlandse_spoorwegen.png -ha_category: Transport +ha_category: + - Transport ha_iot_class: Cloud Polling ha_release: 0.57 redirect_from: diff --git a/source/_components/nello.markdown b/source/_components/nello.markdown index d8dedd33761..4dc7c326c53 100644 --- a/source/_components/nello.markdown +++ b/source/_components/nello.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: nello.png -ha_category: Lock +ha_category: + - Lock ha_release: 0.52 ha_iot_class: Cloud Polling @@ -54,8 +55,6 @@ password: Every time someone rings the bell, a `nello_bell_ring` event will be fired. Field | Description -redirect_from: - - /components/lock.nello/ ----- | ----------- `address` | Postal address of the lock. `date` | Date when the event occurred. diff --git a/source/_components/nest.markdown b/source/_components/nest.markdown index c8b22981416..55a8da55918 100644 --- a/source/_components/nest.markdown +++ b/source/_components/nest.markdown @@ -14,7 +14,7 @@ ha_category: - Camera - Climate - Sensor -featured: true +featured: false ha_iot_class: Cloud Push redirect_from: - /components/binary_sensor.nest/ diff --git a/source/_components/netatmo.markdown b/source/_components/netatmo.markdown index 9797d3f08fa..19281f38514 100644 --- a/source/_components/netatmo.markdown +++ b/source/_components/netatmo.markdown @@ -8,13 +8,35 @@ comments: false sharing: true footer: true logo: netatmo.png -ha_category: Hub +ha_category: + - Hub + - Environment + - Weather + - Binary Sensor + - Sensor + - Climate + - Camera ha_release: "0.20" ha_iot_class: Cloud Polling +redirect_from: + - /components/binary_sensor.netatmo/ + - /components/camera.netatmo/ + - /components/climate.netatmo/ + - /components/sensor.netatmo/ + - /components/public_sensor.netatmo/ --- The `netatmo` component platform is the main component to integrate all Netatmo related platforms. +There is currently support for the following device types within Home Assistant: + +- [Binary Sensor](#binary-sensor) +- [Camera](#camera) +- [Climate](#climate) +- [Sensor](#sensor) + +## {% linkable_title Configuration %} + To enable the Netatmo component, add the following lines to your `configuration.yaml`: ```yaml @@ -129,3 +151,309 @@ There are two services to manually add and drop the webhooks. This might be usef | ------- | ----------- | | addwebhook | Subscribe to webhooks. By default the automatically generated URL will be used. But you can pass `{"url": "https://yourdomain.com/yourwebhook/"}` as service data to the service call if you want to use a manually created [webhook trigger](https://www.home-assistant.io/docs/automation/trigger/#webhook-trigger). In this case you have to manually process the data that is sent by Netatmo. | dropwebhook | Unsubscribe existing webhooks. + +## {% linkable_title Binary Sensor %} + +This component allows you to get the latest event seen by the camera. + +### {% linkable_title Binary Sensor Advanced configuration %} + +If you want to select a specific sensor, +set discovery to `false` for [netatmo](/components/netatmo/) +and add the following lines to your `configuration.yaml`: + +{% configuration %} +home: + description: Will use the cameras of this home only. + required: false + type: string +timeout: + description: > + The Welcome/Presence binary sensors will + stay on for X seconds after detection. + required: false + type: integer + default: 90 +cameras: + description: List of cameras entity IDs to display. + required: false + type: list +welcome_sensors: + description: > + List of monitored conditions. Possible values are + 'Someone known', 'Someone unknown' and 'Motion'. + required: false + type: list +presence_sensors: + description: > + List of monitored conditions. Possible values are 'Outdoor motion', + 'Outdoor human', 'Outdoor animal' and 'Outdoor vehicle'. + required: false + type: list +{% endconfiguration %} + +```yaml +# Example configuration.yaml entry +binary_sensor: + platform: netatmo + home: home_name + timeout: 90 + cameras: + - camera_name1 + welcome_sensors: + - Someone known + - Someone unknown + - Motion + presence_sensors: + - Outdoor motion + - Outdoor human + - Outdoor animal + - Outdoor vehicle +``` + +If **home** and **cameras** is not provided, all cameras will be used. +If multiple cameras are available then each monitored conditions +will create a specific sensor for each camera + +## {% linkable_title Camera %} + +The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This component allows you to view the current photo created by the Camera. + +### {% linkable_title Camera Advanced configuration %} + +If you want to select a specific camera, +set discovery to `false` for [netatmo](/components/netatmo/) +and add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +camera: + - platform: netatmo +``` + +{% configuration %} +home: + description: Will display the cameras of this home only. + required: false + type: string +cameras: + description: Cameras to use. Multiple entities allowed. + required: false + type: list + keys: + camera_name: + description: Name of the camera to display. +quality: + description: Quality of the live stream. (`'high'`, `'medium'`, `'low'` or `'poor'`) + required: false + type: string + default: high +{% endconfiguration %} + +If **home** and **cameras** are not provided, all cameras will be displayed. For more control over your cameras check the configuration sample below. + +```yaml +# Example configuration.yaml entry +camera: + platform: netatmo + home: home_name + quality: medium + cameras: + - camera_name1 + - camera_name2 +``` + +## {% linkable_title Climate %} + +The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) thermostat. This component allows you to view the current temperature and setpoint. + +### {% linkable_title Camera Advanced configuration %} + +If you want to select specific homes or specific rooms, +set discovery to `false` for [netatmo](/components/netatmo/) +and add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +climate: + - platform: netatmo +``` + +{% configuration %} +homes: + description: Will display the thermostats of the homes listed. + required: false + type: list + keys: + name: + required: true + description: The home name. + rooms: + description: Rooms to be displayed. Multiple entities allowed. + required: false + type: [list, string] + description: List of the names of the rooms to be displayed. +{% endconfiguration %} + +If **homes** and **rooms** are not provided, all thermostats will be displayed. + +```yaml +# Example configuration.yaml entry +climate: + platform: netatmo + homes: + - name: home1_name + rooms: + - room1_name + - room2_name + - name: home2_name + rooms: + - room3_name + - room4_name + - room5_name +``` + +## {% linkable_title Sensor %} + +The `netatmo` sensor platform is consuming the information provided by a [Netatmo Weather Station](https://www.netatmo.com/en-us/weather/weatherstation), a +[Netatmo Home Coach](https://www.netatmo.com/en-us/aircare/homecoach) [Netatmo](https://www.netatmo.com) device or the public sensors of others available via the [Netatmo API](https://weathermap.netatmo.com/) even if you don't own a Netatmo device. + +Public sensors have to be set up manually. Currently the following conditions are supported for the public sensors: + +* temperature +* pressure +* humidity +* rain +* windstrength +* guststrength + +## {% linkable_title Advanced sensor configuration %} + +If you want to select a specific sensor, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +sensor: + # Personal sensors + - platform: netatmo + station: STATION_NAME + modules: + module_name1: + - temperature + module_name2: + - temperature + - battery_vp + + # Public sensor + - platform: netatmo + areas: + - lat_ne: 40.719 + lon_ne: -73.735 + lat_sw: 40.552 + lon_sw: -74.105 + monitored_conditions: + - temperature + - pressure + - humidity + - rain + - windstrength + - guststrength +``` + +{% configuration %} +station: + required: false + description: The name of the weather station. Needed if several stations are associated with the account. + type: string +modules: + required: false + description: Modules to use. Multiple entries allowed. Please check the next section about how to retrieve the module names. + type: list + keys: + module_name: + type: list + required: true + description: Name of the module. + keys: + temperature: + description: Current temperature. + co2: + description: CO2 concentration in ppm. + pressure: + description: Pressure in mbar. + noise: + description: Noise level in dB. + humidity: + description: "Humidity in %." + health_idx: + description: "Air health as one of the values Healthy, Fine, Fair, Poor, Unhealthy." + rain: + description: Estimated rainfall for today in mm. + sum_rain_1: + description: Rainfall in the last hour in mm. + sum_rain_24: + description: "Rainfall in mm from 00:00am - 23:59pm." + windangle: + description: Wind angle + windstrength: + description: Wind strength + gustangle: + description: Wind gust angle + guststrength: + description: Wind gust strength + min_temp: + description: Min temperature for today + max_temp: + description: Max temperature for today + rf_status: + description: "Current radio status per module. (90=low, 60=highest)" + wifi_status: + description: Wifi status per Base station + battery_vp: + description: Current battery status per module. + battery_percent: + description: Percentage of battery remaining per module. +areas: + description: The list contains one or more areas to add as sensors. + required: false + type: map + keys: + lat_ne: + description: Latitude of north-eastern corner of area. + required: true + type: string + lon_ne: + description: Longitude of north-eastern corner of area. + required: true + type: string + lat_sw: + description: Latitude of south-western corner of area. + required: true + type: string + lon_sw: + description: Longitude of south-western corner of area. + required: true + type: string + monitored_conditions: + description: List of environment conditions to monitor. + required: true + type: list + name: + description: Name of the sensor. + required: false + type: string + default: Netatmo Public Data + mode: + description: "How to calculate the value of the sensor if there are multiple stations reporting data. Accepts `max` or `avg`." + required: false + type: string + default: avg +{% endconfiguration %} + +## {% linkable_title Find your modules name %} + +You can find your modules name in your [online NetAtmo account](https://my.netatmo.com/app/station). These names can be found and changed in parameters. You have to provide these name in your Home Assistant `configuration.yaml` file. + +
+
+
+Please be aware that the product ORVIBO WIFI SMART SOCKET S20 (LGS-20) has been recalled by the European authorities due to safety concerns. For more information, please visit [RAPEX information](https://ec.europa.eu/consumers/consumers_safety/safety_products/rapex/alerts/?event=viewProduct&reference=A12/1577/15&lng=en). +
+ + The `orvibo` switch platform allows you to toggle your Orvibo S20 Wifi Smart Sockets. To automatically discover Orvibo sockets on your network: diff --git a/source/_components/osramlightify.markdown b/source/_components/osramlightify.markdown index e2cb6836873..d67ee99b32f 100644 --- a/source/_components/osramlightify.markdown +++ b/source/_components/osramlightify.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: osramlightify.png -ha_category: Light +ha_category: + - Light ha_release: 0.21 redirect_from: - /components/light.osramlightify/ diff --git a/source/_components/otp.markdown b/source/_components/otp.markdown index e1d32861079..204925a2a2b 100644 --- a/source/_components/otp.markdown +++ b/source/_components/otp.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Utility +ha_category: + - Utility ha_iot_class: Local Polling ha_release: 0.49 ha_qa_scale: internal diff --git a/source/_components/owntracks.markdown b/source/_components/owntracks.markdown index b48c1116893..7dc33ac5b0e 100644 --- a/source/_components/owntracks.markdown +++ b/source/_components/owntracks.markdown @@ -8,14 +8,15 @@ comments: false sharing: true footer: true logo: owntracks.png -ha_category: Presence Detection +ha_category: + - Presence Detection ha_release: 0.7.4 redirect_from: - /components/device_tracker.owntracks/ - /components/device_tracker.owntracks_http/ --- -OwnTracks is a free and open source application for iOS and Android that allow you to track your location and send it directly to Home Assistant. It can be set up via the integrations panel in the configuration screen. +[OwnTracks](https://owntracks.org/) is a free and open source application for iOS and Android that allow you to track your location and send it directly to Home Assistant. It can be set up via the integrations panel in the configuration screen. By default the integration will listen for incoming messages from OwnTracks via HTTP. It will also listen for MQTT messages if Home Assistant is configured to use MQTT. @@ -42,14 +43,14 @@ By default the integration will listen for incoming messages from OwnTracks via In the OwnTracks app, open sidebar and click on preferences, then on connection. Change the following settings: - Mode: Private HTTP - - Host: `
-If you don't know your token, see [Finding your account token / X-Plex-Token](https://support.plex.tv/hc/en-us/articles/204059436).
+To authorize your device, you'll first need to [click here to claim a token](https://plex.tv/claim).
If your server enforces SSL connections, write "`on`" or "`true`" in the _"Use SSL"_ field. If it does not have a valid SSL certificate available but you still want to use it, write "`on`" or "`true`" in the _"Do not verify SSL"_ field as well.
@@ -265,4 +265,4 @@ verify_ssl:
required: false
default: true
type: boolean
-{% endconfiguration %}
\ No newline at end of file
+{% endconfiguration %}
diff --git a/source/_components/plum_lightpad.markdown b/source/_components/plum_lightpad.markdown
index 43105d8ebda..59b3314b18d 100644
--- a/source/_components/plum_lightpad.markdown
+++ b/source/_components/plum_lightpad.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Switch
+ha_category:
+ - Switch
ha_iot_class: Local Push
logo: plum.png
ha_release: 0.85
diff --git a/source/_components/pocketcasts.markdown b/source/_components/pocketcasts.markdown
index b0c16009109..b39cae4a855 100644
--- a/source/_components/pocketcasts.markdown
+++ b/source/_components/pocketcasts.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: pocketcasts.png
-ha_category: Multimedia
+ha_category:
+ - Multimedia
ha_release: 0.39
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/polling.markdown b/source/_components/polling.markdown
index be5e970d5fa..0108a7bf825 100644
--- a/source/_components/polling.markdown
+++ b/source/_components/polling.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: telegram.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: 0.42
redirect_from:
- /components/telegram_bot.polling/
diff --git a/source/_components/postnl.markdown b/source/_components/postnl.markdown
index 26d0aac22f8..d38f4e3d181 100644
--- a/source/_components/postnl.markdown
+++ b/source/_components/postnl.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: postnl.png
-ha_category: Postal Service
+ha_category:
+ - Postal Service
ha_release: 0.69
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/prezzibenzina.markdown b/source/_components/prezzibenzina.markdown
index ff386498a1a..fa5affd3061 100644
--- a/source/_components/prezzibenzina.markdown
+++ b/source/_components/prezzibenzina.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: prezzibenzina.png
-ha_category: Energy
+ha_category:
+ - Energy
ha_release: 0.85
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/proliphix.markdown b/source/_components/proliphix.markdown
index c72e56f3773..ce5e25e1d76 100644
--- a/source/_components/proliphix.markdown
+++ b/source/_components/proliphix.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: proliphix.png
-ha_category: Climate
+ha_category:
+ - Climate
ha_release: 0.11
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/prometheus.markdown b/source/_components/prometheus.markdown
index f6e09c07ba3..1d31b5affa2 100644
--- a/source/_components/prometheus.markdown
+++ b/source/_components/prometheus.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
logo: prometheus.png
footer: true
-ha_category: "History"
+ha_category:
+ - "History"
ha_release: 0.49
---
diff --git a/source/_components/prowl.markdown b/source/_components/prowl.markdown
index bee530edee5..59d427b5446 100644
--- a/source/_components/prowl.markdown
+++ b/source/_components/prowl.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: prowl.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: 0.52
redirect_from:
- /components/notify.prowl/
diff --git a/source/_components/proximity.markdown b/source/_components/proximity.markdown
index 1c2cc0563cc..1c708cdac4a 100644
--- a/source/_components/proximity.markdown
+++ b/source/_components/proximity.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Automation
+ha_category:
+ - Automation
ha_release: 0.13
ha_qa_scale: internal
---
diff --git a/source/_components/proxy.markdown b/source/_components/proxy.markdown
index 766681c613c..1b958e342bc 100644
--- a/source/_components/proxy.markdown
+++ b/source/_components/proxy.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Camera
+ha_category:
+ - Camera
ha_release: 0.65
redirect_from:
- /components/camera.proxy/
diff --git a/source/_components/ps4.markdown b/source/_components/ps4.markdown
index 299673e4b8e..24a360a73c8 100644
--- a/source/_components/ps4.markdown
+++ b/source/_components/ps4.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: ps4.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_release: 0.89
ha_iot_class: Local Polling
---
diff --git a/source/_components/ptvsd.markdown b/source/_components/ptvsd.markdown
new file mode 100644
index 00000000000..d47a02605a4
--- /dev/null
+++ b/source/_components/ptvsd.markdown
@@ -0,0 +1,118 @@
+---
+layout: page
+title: "PTVSD Debugger (Visual Studio Code)"
+description: "Debugging from Visual Studio Code."
+date: 2019-04-24 09:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: visual-studio.png
+ha_category:
+ - Utility
+ha_release: 0.93
+---
+
+The `ptvsd` component allows you to use the Visual Studio Code PTVSD debugger with Home Assistant.
+
+This is useful in testing changes on a local development install, or connecting to a production server to debug issues.
+
+To enable the `ptvsd` component add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+ptvsd:
+```
+
+By default this will listen on all local interfaces, on port 5678, and will not wait for a connection.
+
+{% configuration %}
+host:
+ description: The local interface to listen on.
+ required: false
+ default: 0.0.0.0 (all interfaces).
+ type: string
+port:
+ description: Port to listen on.
+ required: false
+ default: 5678
+ type: port
+wait:
+ description: If true, wait for the debugger to connect before starting up home assistant.
+ required: false
+ default: false
+ type: boolean
+{% endconfiguration %}
+
+### {% linkable_title Security %}
+
+Ensure if this is a public-facing server, that the port is secured. Anyone who is able to access the debugger port can *execute arbitary code* on the home assistant server, which is very unsafe.
+
+If the home assistant server is behind your firewall with only the http(s) port exposed, then this is safe from outside connections.
+
+Another way of securing the port is to set `host` to localhost and have a secured SSH TCP tunnel with a client certificate for access from the outside internet.
+
+### {% linkable_title Waiting at startup %}
+
+If you want to debug something in the boot-up sequence, configure the component to wait for a connection first:
+
+```yaml
+# Example configuration.yaml entry
+ptvsd:
+ wait: True
+```
+
+The ptvsd debugger is loaded quite early on in the boot-up sequence, before any other components. This will allow you to set breakpoints in `async_setup` or similar and debug the loading of the component.
+
+### {% linkable_title Alternate host and port %}
+
+You can also listen on a different server address or port:
+
+```yaml
+# Example configuration.yaml entry
+ptvsd:
+ host: localhost
+ port: 6789
+```
+
+This is useful for multi-homed servers, or for localhost only access
+
+### {% linkable_title Example Visual Studio Code configuration %}
+
+This can be copied into your `launch.json` in the `.vscode` subdirectory in your Visual Studio Code project to connect to the debugger.
+
+```json
+{
+ "version": "0.2.0",
+ "configurations": [
+ {
+ // Example of attaching to local debug server running on WSL
+ "name": "Python: Attach Local",
+ "type": "python",
+ "request": "attach",
+ "port": 5678,
+ "host": "localhost",
+ "pathMappings": [
+ {
+ "localRoot": "c:\\Users\\Penny\\Documents\\Software\\home-assistant\\",
+ "remoteRoot": "/mnt/c/Users/Penny/Documents/Software/home-assistant"
+ }
+ ],
+ },
+ {
+ // Example of attaching to my production server
+ "name": "Python: Attach Brontosarus",
+ "type": "python",
+ "request": "attach",
+ "port": 5678,
+ "host": "10.0.0.3", // Within my firewall so I don't need to secure the port.
+ "pathMappings": [
+ {
+ "localRoot": "c:\\Users\\Penny\\Documents\\Software\\home-assistant\\",
+ "remoteRoot": "/usr/src/app" // setup for docker container.
+ }
+ ],
+ }
+ ]
+}
+```
diff --git a/source/_components/pulseaudio_loopback.markdown b/source/_components/pulseaudio_loopback.markdown
index e9c70439655..5d60c9f99e7 100644
--- a/source/_components/pulseaudio_loopback.markdown
+++ b/source/_components/pulseaudio_loopback.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: pulseaudio.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: 0.16
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/push.markdown b/source/_components/push.markdown
index 7e3e61d3d1d..fe5596fe4d6 100644
--- a/source/_components/push.markdown
+++ b/source/_components/push.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: camcorder.png
-ha_category: Camera
+ha_category:
+ - Camera
ha_iot_class: Local Push
ha_release: 0.74
redirect_from:
diff --git a/source/_components/pushetta.markdown b/source/_components/pushetta.markdown
index 2229b595531..40c729e7d8b 100644
--- a/source/_components/pushetta.markdown
+++ b/source/_components/pushetta.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: pushetta.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: pre 0.7
redirect_from:
- /components/notify.pushetta/
diff --git a/source/_components/pushover.markdown b/source/_components/pushover.markdown
index 2d5b6371fd2..0371d118917 100644
--- a/source/_components/pushover.markdown
+++ b/source/_components/pushover.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: pushover.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: pre 0.7
redirect_from:
- /components/notify.pushover/
diff --git a/source/_components/pushsafer.markdown b/source/_components/pushsafer.markdown
index 793ad2ae473..426ebc631a7 100644
--- a/source/_components/pushsafer.markdown
+++ b/source/_components/pushsafer.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: pushsafer.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: 0.39
redirect_from:
- /components/notify.pushsafer/
diff --git a/source/_components/pvoutput.markdown b/source/_components/pvoutput.markdown
index 13213ce5610..82993d2b07f 100644
--- a/source/_components/pvoutput.markdown
+++ b/source/_components/pvoutput.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: pvoutput.png
-ha_category: Energy
+ha_category:
+ - Energy
ha_release: 0.33
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/pyload.markdown b/source/_components/pyload.markdown
index e79ea449a1b..b3e6a833ba2 100644
--- a/source/_components/pyload.markdown
+++ b/source/_components/pyload.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: pyload.png
-ha_category: Downloading
+ha_category:
+ - Downloading
ha_release: 0.58
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/python_script.markdown b/source/_components/python_script.markdown
index 58f17ee1c31..b6ff87d258e 100644
--- a/source/_components/python_script.markdown
+++ b/source/_components/python_script.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Automation
+ha_category:
+ - Automation
ha_release: 0.47
ha_qa_scale: internal
---
diff --git a/source/_components/qbittorrent.markdown b/source/_components/qbittorrent.markdown
index 09003f1f861..d25d73eba57 100644
--- a/source/_components/qbittorrent.markdown
+++ b/source/_components/qbittorrent.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: qbittorrent.png
-ha_category: Downloading
+ha_category:
+ - Downloading
ha_release: 0.84
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/qnap.markdown b/source/_components/qnap.markdown
index a65727a0038..bfdc37cfb56 100644
--- a/source/_components/qnap.markdown
+++ b/source/_components/qnap.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: qnap.png
-ha_category: System Monitor
+ha_category:
+ - System Monitor
ha_release: 0.38
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/qrcode.markdown b/source/_components/qrcode.markdown
index e0d9aa500b6..b19a820cd4f 100644
--- a/source/_components/qrcode.markdown
+++ b/source/_components/qrcode.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Image Processing
+ha_category:
+ - Image Processing
ha_release: 0.87
redirect_from:
- /components/image_processing.qrcode/
diff --git a/source/_components/quantum_gateway.markdown b/source/_components/quantum_gateway.markdown
index 8d43cfb24fd..2747c206742 100644
--- a/source/_components/quantum_gateway.markdown
+++ b/source/_components/quantum_gateway.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
logo: fios.svg
ha_release: 0.81
redirect_from:
diff --git a/source/_components/radarr.markdown b/source/_components/radarr.markdown
index 1b78fdfbec3..877bb163ceb 100644
--- a/source/_components/radarr.markdown
+++ b/source/_components/radarr.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: radarr.png
-ha_category: Downloading
+ha_category:
+ - Downloading
ha_release: 0.47
redirect_from:
- /components/sensor.radarr/
diff --git a/source/_components/radiotherm.markdown b/source/_components/radiotherm.markdown
index 1d9d12d4134..2bf1be5021a 100644
--- a/source/_components/radiotherm.markdown
+++ b/source/_components/radiotherm.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: radiotherm.png
-ha_category: Climate
+ha_category:
+ - Climate
ha_iot_class: Local Polling
ha_release: 0.7.6
redirect_from:
diff --git a/source/_components/rainmachine.markdown b/source/_components/rainmachine.markdown
index 7bba33402bb..132313647ce 100644
--- a/source/_components/rainmachine.markdown
+++ b/source/_components/rainmachine.markdown
@@ -88,7 +88,7 @@ binary_sensors:
description: The conditions to create sensors from.
required: false
type: list
- default: all (`extra_water_on_hot_days`, `freeze`, `freeze_protection`, `hourly`, `month`, `raindelay`, `rainsensor`, `weekday`)
+ default: all (`extra_water_on_hot_days`, `flow_sensor`, `freeze`, `freeze_protection`, `hourly`, `month`, `raindelay`, `rainsensor`, `weekday`)
sensors:
description: Sensor-related configuration options.
required: false
@@ -98,7 +98,7 @@ sensors:
description: The conditions to create sensors from.
required: false
type: list
- default: all (`freeze_protect_temp`)
+ default: all (`flow_sensor_clicks_cubic_meter`, `flow_sensor_consumed_liters`, `flow_sensor_start_index`, `flow_sensor_watering_clicks`,`freeze_protect_temp`)
switches:
description: Switch-related configuration options.
required: false
diff --git a/source/_components/random.markdown b/source/_components/random.markdown
index 7ef5040dce2..764623cac64 100644
--- a/source/_components/random.markdown
+++ b/source/_components/random.markdown
@@ -20,9 +20,13 @@ redirect_from:
- /components/binary_sensor.random/
---
+The `random` integration simply creates random values or state. This can be useful if you want to test automation rules or run an interactive demo. It generates a new state every time it is polled.
+
## {% linkable_title Binary Sensor %}
-The `random` binary sensor platform is creating random states (`true`, 1, `on` or `false`, 0, `off`). This can be useful if you want to test automation rules. It generates a new state every time it is polled.
+The `random` binary sensor platform is creating random states (`true`, 1, `on` or `false`, 0, `off`).
+
+### {% linkable_title Configuration %}
To enable the random binary sensor, add the following lines to your `configuration.yaml` file:
@@ -42,7 +46,9 @@ name:
## {% linkable_title Sensor %}
-The `random` sensor platform is creating random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn. This can be useful if you want to test automation rules. It generates a new value every time it is polled.
+The `random` sensor platform is creating random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn.
+
+### {% linkable_title Configuration %}
To enable the random sensor, add the following lines to your `configuration.yaml` file:
@@ -72,4 +78,4 @@ unit_of_measurement:
description: Defines the units of measurement of the sensor, if any.
required: false
type: string
-{% endconfiguration %}
\ No newline at end of file
+{% endconfiguration %}
diff --git a/source/_components/raspyrfm.markdown b/source/_components/raspyrfm.markdown
index 771620b5016..4c7c3180a9e 100644
--- a/source/_components/raspyrfm.markdown
+++ b/source/_components/raspyrfm.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: seegelsysteme.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: 0.85
ha_iot_class: Assumed State
redirect_from:
diff --git a/source/_components/recollect_waste.markdown b/source/_components/recollect_waste.markdown
index 2650dcbedf9..0b75a4cdf98 100644
--- a/source/_components/recollect_waste.markdown
+++ b/source/_components/recollect_waste.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: recollect-waste.png
-ha_category: Sensor
+ha_category:
+ - Sensor
ha_release: 0.87
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown
index 86b3963f12b..6035c987ee8 100644
--- a/source/_components/recorder.markdown
+++ b/source/_components/recorder.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: "History"
+ha_category:
+ - "History"
ha_release: pre 0.7
ha_qa_scale: internal
---
diff --git a/source/_components/recswitch.markdown b/source/_components/recswitch.markdown
index 4b15b1672af..f6bc3102354 100644
--- a/source/_components/recswitch.markdown
+++ b/source/_components/recswitch.markdown
@@ -9,7 +9,8 @@ sharing: true
footer: true
logo: "ankuoo_recswitch.png"
ha_release: 0.81
-ha_category: Switch
+ha_category:
+ - Switch
ha_iot_class: Local Polling
redirect_from:
- /components/switch.recswitch/
diff --git a/source/_components/reddit.markdown b/source/_components/reddit.markdown
index d9946b33037..608f1b1d4a7 100644
--- a/source/_components/reddit.markdown
+++ b/source/_components/reddit.markdown
@@ -1,6 +1,6 @@
---
layout: page
-title: "Reddit Sensor"
+title: "Reddit"
description: "How to integrate the Reddit sensor into Home Assistant."
date: 2018-02-21 20:00
sidebar: true
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: reddit.png
-ha_category: Sensor
+ha_category:
+ - Sensor
ha_release: 0.89
ha_iot_class: Cloud Polling
redirect_from:
@@ -19,7 +20,7 @@ The Reddit sensor integrates data from [Reddit](https://reddit.com/) to monitor
## {% linkable_title Setup %}
-To set up this sensor, you will need to generate a `client_id` and `client_secret` for the user account you will use to connect. Follow the first steps in [this wiki](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example).
+To set up this sensor, you will need to generate a `client_id` and `client_secret` for the user account you will use to connect. Follow the first steps in [this Wiki page](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example).
## {% linkable_title Configuration %}
@@ -27,14 +28,15 @@ To enable this platform, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
-- platform: reddit
- username: !secret reddit_username
- password: !secret reddit_password
- client_id: !secret reddit_client_id
- client_secret: !secret reddit_client_secret
- subreddits:
- - news
- - worldnews
+sensor:
+ - platform: reddit
+ username: !secret reddit_username
+ password: !secret reddit_password
+ client_id: !secret reddit_client_id
+ client_secret: !secret reddit_client_secret
+ subreddits:
+ - news
+ - worldnews
```
{% configuration %}
@@ -47,11 +49,11 @@ password:
required: true
type: string
client_id:
- description: Your Reddit account client_id generated from the wiki above.
+ description: Your Reddit account client ID.
required: true
type: string
client_secret:
- description: Your Reddit account client_secret generated from the wiki above.
+ description: Your Reddit account client secret
required: true
type: string
subreddits:
@@ -59,7 +61,7 @@ subreddits:
required: true
type: list
sort_by:
- description: Sort reddit posts by new, top, controversial, and hot.
+ description: "Sort reddit posts by `new`, `top`, `controversial` and `hot`."
required: false
type: string
default: hot
diff --git a/source/_components/rejseplanen.markdown b/source/_components/rejseplanen.markdown
index b1c1946d3be..c25a921d1ac 100644
--- a/source/_components/rejseplanen.markdown
+++ b/source/_components/rejseplanen.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: rejseplanen.png
-ha_category: Transport
+ha_category:
+ - Transport
ha_iot_class: Cloud Polling
ha_release: 0.88
redirect_from:
diff --git a/source/_components/remember_the_milk.markdown b/source/_components/remember_the_milk.markdown
index f27a0bbcc99..890c7fed736 100644
--- a/source/_components/remember_the_milk.markdown
+++ b/source/_components/remember_the_milk.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: rememberthemilk.png
-ha_category: Calendar
+ha_category:
+ - Calendar
ha_release: 0.57
---
diff --git a/source/_components/remote.xiaomi_miio.markdown b/source/_components/remote.xiaomi_miio.markdown
index 31b3e45d135..8f46fce2d06 100644
--- a/source/_components/remote.xiaomi_miio.markdown
+++ b/source/_components/remote.xiaomi_miio.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: xiaomi.png
-ha_category: Remote
+ha_category:
+ - Remote
ha_release: 0.63
ha_iot_class: Local Polling
---
diff --git a/source/_components/rest.markdown b/source/_components/rest.markdown
index 3ff473c8b47..835a7b98218 100644
--- a/source/_components/rest.markdown
+++ b/source/_components/rest.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: restful.png
-ha_category: Sensor
+ha_category:
+ - Sensor
ha_release: 0.7.4
ha_iot_class: Local Polling
redirect_from:
@@ -190,6 +191,22 @@ Content-Type: application/json
User-Agent: Home Assistant
```
+If you are accessing a resource protected by a `Bearer` token in an `Authorization` header, you can either put the token in the header field of the sensor configuration (not recommended) or store the token in your [`secrets.yaml`](/docs/configuration/secrets/) file. In that case, be sure to include the word `Bearer` in the `secrets` file.
+
+```yaml
+sensor:
+ - platform: rest
+ resource: http://IP_ADDRESS:5000/sensor
+ headers:
+ Authorization: !secret my_sensor_secret_token
+```
+
+Example entry for the `secrets.yaml` file:
+
+```yaml
+my_sensor_secret_token: Bearer gh_DHQIXKVf6Pr4H8Yqz8uhApk_mnV6Zje6Pr4H8Yqz8A8nCxz6SBghQdS51
+```
+
### {% linkable_title Use GitHub to get the latest release of Home Assistant %}
This sample is very similar to the [`updater`](/components/updater/) component but the information is received from GitHub.
diff --git a/source/_components/rest_command.markdown b/source/_components/rest_command.markdown
index 19dcf7049cd..bde8f82b077 100644
--- a/source/_components/rest_command.markdown
+++ b/source/_components/rest_command.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: restful.png
-ha_category: Automation
+ha_category:
+ - Automation
ha_release: 0.36
ha_iot_class: Local Push
---
diff --git a/source/_components/rflink.markdown b/source/_components/rflink.markdown
index 7be07531702..8ab36707493 100644
--- a/source/_components/rflink.markdown
+++ b/source/_components/rflink.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: rflink.png
-ha_category: Hub
+ha_category:
+ - Hub
ha_release: 0.38
---
diff --git a/source/_components/rfxtrx.markdown b/source/_components/rfxtrx.markdown
index 2215c2f171e..2c933f81c1e 100644
--- a/source/_components/rfxtrx.markdown
+++ b/source/_components/rfxtrx.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: rfxtrx.png
-ha_category: Hub
+ha_category:
+ - Hub
ha_release: pre 0.7
---
diff --git a/source/_components/ripple.markdown b/source/_components/ripple.markdown
index 935913f93ad..71d7d66d372 100644
--- a/source/_components/ripple.markdown
+++ b/source/_components/ripple.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: ripple.png
-ha_category: Finance
+ha_category:
+ - Finance
ha_release: 0.47
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/ritassist.markdown b/source/_components/ritassist.markdown
index edaf92965ef..81cad07f613 100644
--- a/source/_components/ritassist.markdown
+++ b/source/_components/ritassist.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: ritassist.png
-ha_category: Car
+ha_category:
+ - Car
ha_iot_class: Cloud Polling
ha_release: 0.76
redirect_from:
diff --git a/source/_components/rmvtransport.markdown b/source/_components/rmvtransport.markdown
index b74debf957c..a133f813677 100644
--- a/source/_components/rmvtransport.markdown
+++ b/source/_components/rmvtransport.markdown
@@ -8,14 +8,19 @@ comments: false
sharing: true
footer: true
logo: RMV.png
-ha_category: Transport
+ha_category:
+ - Transport
ha_release: 0.76
ha_iot_class: Cloud Polling
redirect_from:
- /components/sensor.rmvtransport/
---
-The `rvmtransport` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Rhein-Main area public transport network. Additional details such as the line number and destination are present in the attributes.
+The `rvmtransport` sensor will give you the departure time of the next bus, tram, subway or train at the next station or stop in the Rhein-Main area public transport network. Additional details such as the line number and destination are present in the attributes.
+
+## {% linkable_title Setup %}
+
+Visit the [RMV OpenData web site](https://opendata.rmv.de) to find a list of valid station IDs.
## {% linkable_title Configuration %}
@@ -46,7 +51,7 @@ next_departure:
default: The default is the station name.
type: string
station:
- description: "ID of the stop or station, e.g. `3000010`. Visit [the RMV OpenData web site](https://opendata.rmv.de) to find a list of valid IDs."
+ description: "ID of the stop or station, e.g. `3000010`."
required: true
type: string
destinations:
diff --git a/source/_components/rocketchat.markdown b/source/_components/rocketchat.markdown
index b63421203b2..19c07d7e10a 100644
--- a/source/_components/rocketchat.markdown
+++ b/source/_components/rocketchat.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: rocketchat.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: 0.56
redirect_from:
- /components/notify.rocketchat/
diff --git a/source/_components/roomba.markdown b/source/_components/roomba.markdown
index 7ad11fab00b..4633d20ca54 100644
--- a/source/_components/roomba.markdown
+++ b/source/_components/roomba.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: irobot_roomba.png
-ha_category: Vacuum
+ha_category:
+ - Vacuum
ha_release: 0.51
redirect_from:
- /components/vacuum.roomba/
diff --git a/source/_components/route53.markdown b/source/_components/route53.markdown
index 9eb7e2485cb..a69cf2f170b 100644
--- a/source/_components/route53.markdown
+++ b/source/_components/route53.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: route53.png
-ha_category: Network
+ha_category:
+ - Network
ha_release: 0.81
---
diff --git a/source/_components/rova.markdown b/source/_components/rova.markdown
index 5dcaa1e3be2..c0b810a0939 100644
--- a/source/_components/rova.markdown
+++ b/source/_components/rova.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: rova.jpg
-ha_category: Sensor
+ha_category:
+ - Sensor
ha_release: 0.87
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/rpi_camera.markdown b/source/_components/rpi_camera.markdown
index d15eb9f5baa..1af3b0db255 100644
--- a/source/_components/rpi_camera.markdown
+++ b/source/_components/rpi_camera.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
-ha_category: DIY
+ha_category:
+ - DIY
ha_iot_class: Local Polling
ha_release: 0.17
redirect_from:
diff --git a/source/_components/rpi_gpio.markdown b/source/_components/rpi_gpio.markdown
index 3bb34d35080..ed21af54d40 100644
--- a/source/_components/rpi_gpio.markdown
+++ b/source/_components/rpi_gpio.markdown
@@ -191,7 +191,7 @@ invert_logic:
type: boolean
{% endconfiguration %}
-For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.
+For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#General_purpose_input-output_(GPIO)_connector) about the Raspberry Pi.
Note that a pin managed by HASS is expected to be exclusive to HASS. diff --git a/source/_components/rpi_gpio_pwm.markdown b/source/_components/rpi_gpio_pwm.markdown index 7f9b0183c03..d84a84c54fe 100644 --- a/source/_components/rpi_gpio_pwm.markdown +++ b/source/_components/rpi_gpio_pwm.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: DIY +ha_category: + - DIY ha_iot_class: Local Push ha_release: 0.43 logo: raspberry-pi.png diff --git a/source/_components/rpi_rf.markdown b/source/_components/rpi_rf.markdown index f833eb3edf0..09873b3b4fe 100644 --- a/source/_components/rpi_rf.markdown +++ b/source/_components/rpi_rf.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: DIY +ha_category: + - DIY ha_release: 0.19 ha_iot_class: Assumed State redirect_from: diff --git a/source/_components/rss_feed_template.markdown b/source/_components/rss_feed_template.markdown index 4c8612ae2e1..31ebb4251cc 100644 --- a/source/_components/rss_feed_template.markdown +++ b/source/_components/rss_feed_template.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Front end +ha_category: + - Front end ha_release: 0.44 ha_qa_scale: internal --- diff --git a/source/_components/rtorrent.markdown b/source/_components/rtorrent.markdown index a1065d75418..6c94690f97f 100644 --- a/source/_components/rtorrent.markdown +++ b/source/_components/rtorrent.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: rtorrent.png -ha_category: Downloading +ha_category: + - Downloading ha_release: 0.81 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/russound_rio.markdown b/source/_components/russound_rio.markdown index 744e767e898..582c37d959f 100644 --- a/source/_components/russound_rio.markdown +++ b/source/_components/russound_rio.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: russound.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.49 ha_iot_class: Local Push redirect_from: diff --git a/source/_components/russound_rnet.markdown b/source/_components/russound_rnet.markdown index 17b0ac98865..e1f75962433 100644 --- a/source/_components/russound_rnet.markdown +++ b/source/_components/russound_rnet.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: russound.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.25 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/ruter.markdown b/source/_components/ruter.markdown index facb56a8537..c43758a4c90 100644 --- a/source/_components/ruter.markdown +++ b/source/_components/ruter.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: ruter.png -ha_category: Transport +ha_category: + - Transport ha_iot_class: Cloud Polling ha_release: 0.83 redirect_from: diff --git a/source/_components/samsungtv.markdown b/source/_components/samsungtv.markdown index 87fbd0703a5..f1368c96cad 100644 --- a/source/_components/samsungtv.markdown +++ b/source/_components/samsungtv.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: samsung.png -ha_category: Media Player +ha_category: + - Media Player ha_release: 0.13 ha_iot_class: Local Polling redirect_from: diff --git a/source/_components/scene.knx.markdown b/source/_components/scene.knx.markdown index 80789b6a566..e53322c85d2 100644 --- a/source/_components/scene.knx.markdown +++ b/source/_components/scene.knx.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: knx.png -ha_category: Scene +ha_category: + - Scene ha_release: 0.63 --- diff --git a/source/_components/scene.markdown b/source/_components/scene.markdown index ca1cd569cf9..96b29b24cff 100644 --- a/source/_components/scene.markdown +++ b/source/_components/scene.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Organization +ha_category: + - Organization ha_qa_scale: internal ha_release: 0.15 --- diff --git a/source/_components/scrape.markdown b/source/_components/scrape.markdown index f427b7de3ef..e4e88648cb1 100644 --- a/source/_components/scrape.markdown +++ b/source/_components/scrape.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Sensor +ha_category: + - Sensor ha_release: 0.31 ha_iot_class: Cloud Polling redirect_from: @@ -118,7 +119,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 +147,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/script.markdown b/source/_components/script.markdown index 53ff27c05f5..901f7dcf579 100644 --- a/source/_components/script.markdown +++ b/source/_components/script.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Automation +ha_category: + - Automation ha_qa_scale: internal ha_release: 0.7 --- diff --git a/source/_components/season.markdown b/source/_components/season.markdown index 162301e095d..8a9ed712437 100644 --- a/source/_components/season.markdown +++ b/source/_components/season.markdown @@ -7,7 +7,8 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Utility +ha_category: + - Utility logo: home-assistant.png ha_iot_class: Local Polling ha_release: 0.53 diff --git a/source/_components/sendgrid.markdown b/source/_components/sendgrid.markdown index 08ceedf5b25..93d4a98bbf2 100644 --- a/source/_components/sendgrid.markdown +++ b/source/_components/sendgrid.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: sendgrid.png -ha_category: Notifications +ha_category: + - Notifications ha_release: 0.14 redirect_from: - /components/notify.sendgrid/ diff --git a/source/_components/sensibo.markdown b/source/_components/sensibo.markdown index 9c9afc789ea..3a91fafc777 100644 --- a/source/_components/sensibo.markdown +++ b/source/_components/sensibo.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: sensibo.png -ha_category: Climate +ha_category: + - Climate ha_release: 0.44 ha_iot_class: Cloud Polling redirect_from: diff --git a/source/_components/sensor.buienradar.markdown b/source/_components/sensor.buienradar.markdown index e6c19423742..7c1b0022237 100644 --- a/source/_components/sensor.buienradar.markdown +++ b/source/_components/sensor.buienradar.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: buienradar.png -ha_category: Weather +ha_category: + - Weather ha_release: 0.47 ha_iot_class: Cloud Polling --- diff --git a/source/_components/sensor.command_line.markdown b/source/_components/sensor.command_line.markdown index c18ed199c6c..502e7175b96 100644 --- a/source/_components/sensor.command_line.markdown +++ b/source/_components/sensor.command_line.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: command_line.png -ha_category: Utility +ha_category: + - Utility ha_release: pre 0.7 ha_iot_class: Local Polling --- diff --git a/source/_components/sensor.ios.markdown b/source/_components/sensor.ios.markdown index 42ccc3cbbe7..a263e1bba78 100644 --- a/source/_components/sensor.ios.markdown +++ b/source/_components/sensor.ios.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: apple.png -ha_category: Sensor +ha_category: + - Sensor ha_release: 0.31 ha_iot_class: Local Push --- diff --git a/source/_components/sensor.knx.markdown b/source/_components/sensor.knx.markdown index 6ccfb5f3521..88b5a2239f5 100644 --- a/source/_components/sensor.knx.markdown +++ b/source/_components/sensor.knx.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: knx.png -ha_category: Sensor +ha_category: + - Sensor ha_release: 0.29 ha_iot_class: Local Push --- diff --git a/source/_components/sensor.metoffice.markdown b/source/_components/sensor.metoffice.markdown index 04d8f610bc2..478f9029645 100644 --- a/source/_components/sensor.metoffice.markdown +++ b/source/_components/sensor.metoffice.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: metoffice.jpg -ha_category: Weather +ha_category: + - Weather ha_release: 0.42 ha_iot_class: Cloud Polling --- diff --git a/source/_components/sensor.modbus.markdown b/source/_components/sensor.modbus.markdown index 81ab438079b..e0218005bdd 100644 --- a/source/_components/sensor.modbus.markdown +++ b/source/_components/sensor.modbus.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: modbus.png -ha_category: Sensor +ha_category: + - Sensor ha_release: pre 0.7 ha_iot_class: Local Push --- diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index 278e206c2e5..f9a79d23cce 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -8,7 +8,8 @@ comments: false sharing: true footer: true logo: mqtt.png -ha_category: Sensor +ha_category: + - Sensor ha_release: 0.7 ha_iot_class: Configurable --- diff --git a/source/_components/sensor.netatmo.markdown b/source/_components/sensor.netatmo.markdown deleted file mode 100644 index b7312eb8ba8..00000000000 --- a/source/_components/sensor.netatmo.markdown +++ /dev/null @@ -1,103 +0,0 @@ ---- -layout: page -title: "Netatmo Sensor" -description: "Instructions on how to integrate Netatmo sensors into Home Assistant." -date: 2016-06-23 11:10 -sidebar: true -comments: false -sharing: true -footer: true -logo: netatmo.png -ha_category: Weather -ha_iot_class: Cloud Polling -ha_release: 0.11 ---- - -The `netatmo` sensor platform is consuming the information provided by a [Netatmo Weather Station](https://www.netatmo.com/en-us/weather/weatherstation) or a -[Netatmo Home Coach](https://www.netatmo.com/en-us/aircare/homecoach) [Netatmo](https://www.netatmo.com) devices. - -To enable the Netatmo sensor, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your sensor. - -## {% linkable_title Advanced configuration %} - -If you want to select a specific sensor, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`: - -The `netatmo` sensor platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) device. - -To enable the Netatmo sensor, you first have to set up [netatmo](/components/netatmo/), and add the following lines to your `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -sensor: - - platform: netatmo - station: STATION_NAME - modules: - module_name1: - - temperature - module_name2: - - temperature - - battery_vp -``` - -{% configuration %} -station: - required: false - description: The name of the weather station. Needed if several stations are associated with the account. - type: string -modules: - required: true - description: Modules to use. Multiple entries allowed. Please check the next section about how to retrieve the module names. - type: list - keys: - module_name: - type: list - required: true - description: Name of the module. - keys: - temperature: - description: Current temperature. - co2: - description: CO2 concentration in ppm. - pressure: - description: Pressure in mbar. - noise: - description: Noise level in dB. - humidity: - description: "Humidity in %." - health_idx: - description: "Air health as one of the values Healthy, Fine, Fair, Poor, Unhealthy." - rain: - description: Estimated rainfall for today in mm. - sum_rain_1: - description: Rainfall in the last hour in mm. - sum_rain_24: - description: "Rainfall in mm from 00:00am - 23:59pm." - windangle: - description: Wind angle - windstrength: - description: Wind strength - gustangle: - description: Wind gust angle - guststrength: - description: Wind gust strength - min_temp: - description: Min temperature for today - max_temp: - description: Max temperature for today - rf_status: - description: "Current radio status per module. (90=low, 60=highest)" - wifi_status: - description: Wifi status per Base station - battery_vp: - description: Current battery status per module. - battery_percent: - description: Percentage of battery remaining per module. -{% endconfiguration %} - -## {% linkable_title Find your modules name %} - -You can find your modules name in your [online NetAtmo account](https://my.netatmo.com/app/station). These names can be found and changed in parameters. You have to provide these name in your Home Assistant `configuration.yaml` file. - -
-
-
-The playing queue is not snapshotted. Using `media_player.sonos_restore` on a speaker that has replaced its queue will restore the playing position, but in the new queue! +The playing queue is not snapshotted. Using `sonos.restore` on a speaker that has replaced its queue will restore the playing position, but in the new queue!
@@ -54,24 +55,24 @@ A cloud queue cannot be restarted. This includes queues started from within Spot
| `entity_id` | yes | String or list of `entity_id`s that should have their snapshot restored.
| `with_group` | yes | Should we also restore the group layout and the state of other speakers in the group.
-### {% linkable_title Service `media_player.sonos_join` %}
+### {% linkable_title Service `sonos.join` %}
Group players together under a single coordinator. This will make a new group or join to an existing group.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `master` | no | A single `entity_id` that will become/stay the coordinator speaker.
-| `entity_id` | no | String or list of `entity_id`s to join to the master.
+| `entity_id` | yes | String or list of `entity_id`s to join to the master.
-### {% linkable_title Service `media_player.sonos_unjoin` %}
+### {% linkable_title Service `sonos.unjoin` %}
Remove one or more speakers from their group of speakers. If no `entity_id` is provided, all speakers are unjoined.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
-| `entity_id` | no | String or list of `entity_id`s to separate from their coordinator speaker.
+| `entity_id` | yes | String or list of `entity_id`s to separate from their coordinator speaker.
-### {% linkable_title Service `media_player.sonos_set_sleep_timer` %}
+### {% linkable_title Service `sonos.set_sleep_timer` %}
Sets a timer that will turn off a speaker by tapering the volume down to 0 after a certain amount of time. Protip: If you set the sleep_time value to 0, then the speaker will immediately start tapering the volume down.
@@ -80,7 +81,7 @@ Sets a timer that will turn off a speaker by tapering the volume down to 0 after
| `entity_id` | no | String or list of `entity_id`s that will have their timers set.
| `sleep_time` | no | Integer number of seconds that the speaker should wait until it starts tapering. Cannot exceed 86399 (one day).
-### {% linkable_title Service `media_player.sonos_clear_sleep_timer` %}
+### {% linkable_title Service `sonos.clear_sleep_timer` %}
Clear the sleep timer on a speaker, if one is set.
@@ -88,7 +89,7 @@ Clear the sleep timer on a speaker, if one is set.
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s that will have their timers cleared. Must be a coordinator speaker.
-### {% linkable_title Service `media_player.sonos_update_alarm` %}
+### {% linkable_title Service `sonos.update_alarm` %}
Update an existing Sonos alarm.
@@ -101,7 +102,7 @@ Update an existing Sonos alarm.
| `enabled` | yes | Boolean for whether or not to enable this alarm.
| `include_linked_zones` | yes | Boolean that defines if the alarm also plays on grouped players.
-### {% linkable_title Service `media_player.sonos_set_option` %}
+### {% linkable_title Service `sonos.set_option` %}
Set Sonos speaker options.
diff --git a/source/_components/sony_projector.markdown b/source/_components/sony_projector.markdown
index be90ed9660a..cb02338527c 100644
--- a/source/_components/sony_projector.markdown
+++ b/source/_components/sony_projector.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: sony.png
-ha_category: Multimedia
+ha_category:
+ - Multimedia
ha_iot_class: Local Polling
ha_release: 0.89
redirect_from:
diff --git a/source/_components/soundtouch.markdown b/source/_components/soundtouch.markdown
index 233ba358756..3dd4f119d5d 100644
--- a/source/_components/soundtouch.markdown
+++ b/source/_components/soundtouch.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: soundtouch.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_release: 0.34
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/spaceapi.markdown b/source/_components/spaceapi.markdown
index 1df0800feb5..8f83f10ab3c 100644
--- a/source/_components/spaceapi.markdown
+++ b/source/_components/spaceapi.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: spaceapi.png
-ha_category: Social
+ha_category:
+ - Social
ha_release: "0.70"
---
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/splunk.markdown b/source/_components/splunk.markdown
index d7efdaa556d..3446eaf791f 100644
--- a/source/_components/splunk.markdown
+++ b/source/_components/splunk.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: splunk.png
-ha_category: "History"
+ha_category:
+ - "History"
ha_release: 0.13
---
diff --git a/source/_components/spotify.markdown b/source/_components/spotify.markdown
index 701c583ffb9..605ed0dbac0 100644
--- a/source/_components/spotify.markdown
+++ b/source/_components/spotify.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: spotify.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_release: 0.43
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/sql.markdown b/source/_components/sql.markdown
index 1f634e8fc22..bf3ba0cfb08 100644
--- a/source/_components/sql.markdown
+++ b/source/_components/sql.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: sql.png
-ha_category: Utility
+ha_category:
+ - Utility
ha_release: 0.63
redirect_from:
- /components/sensor.sql/
diff --git a/source/_components/squeezebox.markdown b/source/_components/squeezebox.markdown
index 2c43677c73c..674a263874c 100644
--- a/source/_components/squeezebox.markdown
+++ b/source/_components/squeezebox.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: squeezebox.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_release: pre 0.7
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/srp_energy.markdown b/source/_components/srp_energy.markdown
index 7d29f97cd86..87f6f8b9978 100644
--- a/source/_components/srp_energy.markdown
+++ b/source/_components/srp_energy.markdown
@@ -5,7 +5,8 @@ description: "How to integrate SRP Energy within Home Assistant."
date: 2018-10-30 08:00
sidebar: true
comments: false
-ha_category: Energy
+ha_category:
+ - Energy
ha_release: 0.83
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/starlingbank.markdown b/source/_components/starlingbank.markdown
index 01a3bb99406..5ea9169ea2e 100644
--- a/source/_components/starlingbank.markdown
+++ b/source/_components/starlingbank.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: starlingbank.png
-ha_category: Finance
+ha_category:
+ - Finance
ha_release: 0.79
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/startca.markdown b/source/_components/startca.markdown
index 29170335231..437ae5cc9d4 100644
--- a/source/_components/startca.markdown
+++ b/source/_components/startca.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: startca.png
-ha_category: Network
+ha_category:
+ - Network
ha_release: 0.64
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/statistics.markdown b/source/_components/statistics.markdown
index 16673f8328f..81183439949 100644
--- a/source/_components/statistics.markdown
+++ b/source/_components/statistics.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Utility
+ha_category:
+ - Utility
ha_iot_class: Local Polling
ha_release: "0.30"
ha_qa_scale: internal
diff --git a/source/_components/statsd.markdown b/source/_components/statsd.markdown
index dedf0772f65..467d6f60acf 100644
--- a/source/_components/statsd.markdown
+++ b/source/_components/statsd.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
logo: statsd.png
footer: true
-ha_category: "History"
+ha_category:
+ - "History"
ha_release: 0.12
---
diff --git a/source/_components/steam_online.markdown b/source/_components/steam_online.markdown
index 227635bb72c..b95a00d4c19 100644
--- a/source/_components/steam_online.markdown
+++ b/source/_components/steam_online.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: steam.png
-ha_category: Social
+ha_category:
+ - Social
ha_iot_class: Cloud Polling
ha_release: 0.14
redirect_from:
diff --git a/source/_components/stream.markdown b/source/_components/stream.markdown
index 8858938527e..85f31bf63a7 100644
--- a/source/_components/stream.markdown
+++ b/source/_components/stream.markdown
@@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category:
+ha_category:
- Other
ha_release: "0.90"
ha_iot_class: Local Push
@@ -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/stride.markdown b/source/_components/stride.markdown
index 944d4e099a4..d1523623514 100644
--- a/source/_components/stride.markdown
+++ b/source/_components/stride.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: stride.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: 0.66
redirect_from:
- /components/notify.stride/
diff --git a/source/_components/sun.markdown b/source/_components/sun.markdown
index 90b2597b266..1ed1d0c9a98 100644
--- a/source/_components/sun.markdown
+++ b/source/_components/sun.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Environment
+ha_category:
+ - Environment
ha_qa_scale: internal
ha_release: pre 0.7
---
diff --git a/source/_components/supervisord.markdown b/source/_components/supervisord.markdown
index cb164022eec..a1d76c1fdfb 100644
--- a/source/_components/supervisord.markdown
+++ b/source/_components/supervisord.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: supervisord.png
-ha_category: System Monitor
+ha_category:
+ - System Monitor
ha_release: "0.20"
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/swiss_hydrological_data.markdown b/source/_components/swiss_hydrological_data.markdown
index 267624174ad..a4e78697812 100644
--- a/source/_components/swiss_hydrological_data.markdown
+++ b/source/_components/swiss_hydrological_data.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: swiss-hydrological-data.png
-ha_category: Environment
+ha_category:
+ - Environment
ha_iot_class: Cloud Polling
ha_release: 0.22
redirect_from:
diff --git a/source/_components/swiss_public_transport.markdown b/source/_components/swiss_public_transport.markdown
index 29b31cd1284..b465c957129 100644
--- a/source/_components/swiss_public_transport.markdown
+++ b/source/_components/swiss_public_transport.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: train.png
-ha_category: Transport
+ha_category:
+ - Transport
ha_iot_class: Cloud Polling
ha_release: pre 0.7
redirect_from:
diff --git a/source/_components/swisscom.markdown b/source/_components/swisscom.markdown
index 1c8e608943b..b96a664655b 100644
--- a/source/_components/swisscom.markdown
+++ b/source/_components/swisscom.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: swisscom.png
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
ha_release: 0.32
redirect_from:
- /components/device_tracker.swisscom/
diff --git a/source/_components/switch.command_line.markdown b/source/_components/switch.command_line.markdown
index 24ad7147c01..48de3f155ed 100644
--- a/source/_components/switch.command_line.markdown
+++ b/source/_components/switch.command_line.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: command_line.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: pre 0.7
ha_iot_class: Local Polling
---
diff --git a/source/_components/switch.knx.markdown b/source/_components/switch.knx.markdown
index 6e23cbed541..0d3139db41d 100644
--- a/source/_components/switch.knx.markdown
+++ b/source/_components/switch.knx.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: knx.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: 0.24
ha_iot_class: Local Polling
---
diff --git a/source/_components/switch.modbus.markdown b/source/_components/switch.modbus.markdown
index 1b0c5bda964..1d181b0e5b2 100644
--- a/source/_components/switch.modbus.markdown
+++ b/source/_components/switch.modbus.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: modbus.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: pre 0.7
ha_iot_class: Local Push
---
diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown
index 768d268f0a9..c9979e3a802 100644
--- a/source/_components/switch.mqtt.markdown
+++ b/source/_components/switch.mqtt.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: mqtt.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: 0.7
ha_iot_class: Configurable
---
diff --git a/source/_components/switch.rest.markdown b/source/_components/switch.rest.markdown
index 01cd704e6db..c0cc52e102d 100644
--- a/source/_components/switch.rest.markdown
+++ b/source/_components/switch.rest.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: restful.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: 0.7.6
ha_iot_class: Local Polling
---
diff --git a/source/_components/switch.rflink.markdown b/source/_components/switch.rflink.markdown
index 10d6625ed1e..b69378cdd89 100644
--- a/source/_components/switch.rflink.markdown
+++ b/source/_components/switch.rflink.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: rflink.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: 0.38
---
diff --git a/source/_components/switch.rfxtrx.markdown b/source/_components/switch.rfxtrx.markdown
index 669ee3770f7..900c7e76d1a 100644
--- a/source/_components/switch.rfxtrx.markdown
+++ b/source/_components/switch.rfxtrx.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: rfxtrx.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: 0.7.5
---
diff --git a/source/_components/switch.template.markdown b/source/_components/switch.template.markdown
index 69dc4392bfc..32eaa1cf798 100644
--- a/source/_components/switch.template.markdown
+++ b/source/_components/switch.template.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: 0.13
ha_iot_class: Local Push
logo: home-assistant.png
diff --git a/source/_components/switch.xiaomi_aqara.markdown b/source/_components/switch.xiaomi_aqara.markdown
index b4c01732435..de158bec3c4 100644
--- a/source/_components/switch.xiaomi_aqara.markdown
+++ b/source/_components/switch.xiaomi_aqara.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: xiaomi.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: "0.50"
ha_iot_class: Local Push
---
diff --git a/source/_components/switch.xiaomi_miio.markdown b/source/_components/switch.xiaomi_miio.markdown
index f8c56c887ec..49be3065841 100644
--- a/source/_components/switch.xiaomi_miio.markdown
+++ b/source/_components/switch.xiaomi_miio.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: xiaomi.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_iot_class: Local Polling
ha_release: 0.56
---
diff --git a/source/_components/switchbot.markdown b/source/_components/switchbot.markdown
index f752e7cca9e..3d837dfc0d0 100644
--- a/source/_components/switchbot.markdown
+++ b/source/_components/switchbot.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: switchbot.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: 0.78
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/switchmate.markdown b/source/_components/switchmate.markdown
index 2307af0fa4f..202c794df46 100644
--- a/source/_components/switchmate.markdown
+++ b/source/_components/switchmate.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: switchmate-logo-rgb.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: 0.78
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/syncthru.markdown b/source/_components/syncthru.markdown
index 0a6f214eda5..4d2e98fc55a 100644
--- a/source/_components/syncthru.markdown
+++ b/source/_components/syncthru.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: samsung.png
-ha_category: System Monitor
+ha_category:
+ - System Monitor
ha_iot_class: Local Polling
ha_release: 0.66
redirect_from:
diff --git a/source/_components/synology.markdown b/source/_components/synology.markdown
index cfb0ddc373c..d1a04f3390c 100644
--- a/source/_components/synology.markdown
+++ b/source/_components/synology.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: synology.png
-ha_category: Camera
+ha_category:
+ - Camera
ha_release: 0.31
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/synology_chat.markdown b/source/_components/synology_chat.markdown
index cf20a62bf91..0c000a2f0b7 100644
--- a/source/_components/synology_chat.markdown
+++ b/source/_components/synology_chat.markdown
@@ -9,7 +9,8 @@ sharing: true
footer: true
ha_release: 0.65
logo: synology.png
-ha_category: Notifications
+ha_category:
+ - Notifications
redirect_from:
- /components/notify.synology_chat/
---
diff --git a/source/_components/synology_srm.markdown b/source/_components/synology_srm.markdown
index 8ccb312abf2..6a01e496875 100644
--- a/source/_components/synology_srm.markdown
+++ b/source/_components/synology_srm.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: synology.png
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
ha_release: 0.87
redirect_from:
- /components/device_tracker.synology_srm/
diff --git a/source/_components/synologydsm.markdown b/source/_components/synologydsm.markdown
index ee5e36f859e..9102d78f213 100644
--- a/source/_components/synologydsm.markdown
+++ b/source/_components/synologydsm.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: synology.png
-ha_category: System Monitor
+ha_category:
+ - System Monitor
ha_release: 0.32
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/syslog.markdown b/source/_components/syslog.markdown
index d25f3a25584..037f53e8660 100644
--- a/source/_components/syslog.markdown
+++ b/source/_components/syslog.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: syslog.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: pre 0.7
redirect_from:
- /components/notify.syslog/
diff --git a/source/_components/system_health.markdown b/source/_components/system_health.markdown
index 1b7416d890d..e226efd2a16 100644
--- a/source/_components/system_health.markdown
+++ b/source/_components/system_health.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: "Other"
+ha_category:
+ - "Other"
ha_qa_scale: internal
ha_release: 0.87
---
diff --git a/source/_components/system_log.markdown b/source/_components/system_log.markdown
index 2f0befb2c99..79229d5cdc8 100644
--- a/source/_components/system_log.markdown
+++ b/source/_components/system_log.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Other
+ha_category:
+ - Other
ha_release: 0.58
ha_qa_scale: internal
---
diff --git a/source/_components/systemmonitor.markdown b/source/_components/systemmonitor.markdown
index 97446a4d269..dff45f1b268 100644
--- a/source/_components/systemmonitor.markdown
+++ b/source/_components/systemmonitor.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: system_monitor.png
-ha_category: System Monitor
+ha_category:
+ - System Monitor
ha_release: pre 0.7
ha_iot_class: Local Push
redirect_from:
diff --git a/source/_components/sytadin.markdown b/source/_components/sytadin.markdown
index 17da8090b68..cd38ab5f977 100644
--- a/source/_components/sytadin.markdown
+++ b/source/_components/sytadin.markdown
@@ -9,7 +9,8 @@ sharing: true
footer: true
logo: sytadin.png
ha_release: 0.57
-ha_category: Transport
+ha_category:
+ - Transport
ha_iot_class: Cloud Polling
redirect_from:
- /components/sensor.sytadin/
diff --git a/source/_components/tank_utility.markdown b/source/_components/tank_utility.markdown
index 2a2a695e8b1..0259811b20a 100644
--- a/source/_components/tank_utility.markdown
+++ b/source/_components/tank_utility.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: tank_utility.png
-ha_category: Energy
+ha_category:
+ - Energy
ha_release: 0.53
redirect_from:
- /components/sensor.tank_utility/
diff --git a/source/_components/tapsaff.markdown b/source/_components/tapsaff.markdown
index 9cc6e85072d..98a9a50ecf9 100644
--- a/source/_components/tapsaff.markdown
+++ b/source/_components/tapsaff.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: tapsaff.png
-ha_category: Weather
+ha_category:
+ - Weather
ha_release: 0.47
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/tautulli.markdown b/source/_components/tautulli.markdown
index 33e2f13817e..7515b594edf 100644
--- a/source/_components/tautulli.markdown
+++ b/source/_components/tautulli.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: tautulli.png
-ha_category: Sensor
+ha_category:
+ - Sensor
ha_release: 0.82
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/ted5000.markdown b/source/_components/ted5000.markdown
index f0e674189ee..7360d97d651 100644
--- a/source/_components/ted5000.markdown
+++ b/source/_components/ted5000.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: ted.png
-ha_category: Energy
+ha_category:
+ - Energy
ha_release: "0.30"
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/teksavvy.markdown b/source/_components/teksavvy.markdown
index 6eac86d26d1..f6fc4523a94 100644
--- a/source/_components/teksavvy.markdown
+++ b/source/_components/teksavvy.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: teksavvy.png
-ha_category: Network
+ha_category:
+ - Network
ha_release: 0.62
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/telegram.markdown b/source/_components/telegram.markdown
index d7fbf2d8c1b..9f490fe0ae1 100644
--- a/source/_components/telegram.markdown
+++ b/source/_components/telegram.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: telegram.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: 0.7.5
redirect_from:
- /components/notify.telegram/
diff --git a/source/_components/telegram_bot.markdown b/source/_components/telegram_bot.markdown
index 167b2ae2674..524977f5263 100644
--- a/source/_components/telegram_bot.markdown
+++ b/source/_components/telegram_bot.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: telegram.png
-ha_category: Hub
+ha_category:
+ - Hub
ha_release: 0.42
ha_iot_class: Cloud Push
---
@@ -35,7 +36,7 @@ Send a notification.
| `parse_mode` | yes | Parser for the message text: `html` or `markdown`. |
| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. |
| `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. |
-| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. Example: `["/command1, /command2", "/command3"]` |
+| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` |
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` |
### {% linkable_title Service `telegram_bot.send_photo` and `telegram_bot.send_sticker` %}
@@ -51,9 +52,9 @@ Send a photo.
| `password` | yes | Password for a URL which requires HTTP basic authentication. |
| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication. Defaults to `basic`. |
| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. |
-| `disable_notification | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. |
+| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. |
| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. |
-| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. Example: `["/command1, /command2", "/command3"]` |
+| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` |
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` |
### {% linkable_title Service `telegram_bot.send_video` %}
@@ -71,7 +72,7 @@ Send a video.
| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. |
| `disable_notification` | yes | True/false to send the message silently. iOS users and web users will not receive a notification. Android users will receive a notification with no sound. Defaults to False. |
| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. |
-| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. Example: `["/command1, /command2", "/command3"]` |
+| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` |
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` |
### {% linkable_title Service `telegram_bot.send_document` %}
@@ -89,7 +90,7 @@ Send a document.
| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. |
| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. |
| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. |
-| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. Example: `["/command1, /command2", "/command3"]` |
+| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` |
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` |
### {% linkable_title Service `telegram_bot.send_location` %}
@@ -102,7 +103,7 @@ Send a location.
| `longitude` | no | The longitude to send. |
| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed `chat_id`. |
| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. |
-| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. Example: `["/command1, /command2", "/command3"]` |
+| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` |
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` |
### {% linkable_title Service `telegram_bot.edit_message` %}
diff --git a/source/_components/telnet.markdown b/source/_components/telnet.markdown
index dcaeab255d4..21befb2743b 100644
--- a/source/_components/telnet.markdown
+++ b/source/_components/telnet.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: 0.54
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/temper.markdown b/source/_components/temper.markdown
index a6c32e3d943..2a20bc3d79f 100644
--- a/source/_components/temper.markdown
+++ b/source/_components/temper.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: DIY
+ha_category:
+ - DIY
ha_iot_class: Local Push
ha_release: pre 0.7
redirect_from:
diff --git a/source/_components/template.markdown b/source/_components/template.markdown
index 564fe2cb061..21c2bca30d4 100644
--- a/source/_components/template.markdown
+++ b/source/_components/template.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Sensor
+ha_category:
+ - Sensor
ha_release: 0.12
ha_iot_class: Local Push
logo: home-assistant.png
@@ -245,7 +246,7 @@ sensor:
Power Consumption
{% else %}
Power Production
- {% end %}
+ {% endif %}
value_template: "{{ states('sensor.power_consumption') }}"
unit_of_measurement: 'kW'
```
diff --git a/source/_components/tensorflow.markdown b/source/_components/tensorflow.markdown
index 53c8bb44582..ee8c2680d73 100644
--- a/source/_components/tensorflow.markdown
+++ b/source/_components/tensorflow.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: tensorflow.png
-ha_category: Image Processing
+ha_category:
+ - Image Processing
ha_iot_class: Local Polling
ha_release: 0.82
redirect_from:
diff --git a/source/_components/tfiac.markdown b/source/_components/tfiac.markdown
index ed7797911f6..f0d1e330dfa 100644
--- a/source/_components/tfiac.markdown
+++ b/source/_components/tfiac.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: tfiac.png
-ha_category: Climate
+ha_category:
+ - Climate
ha_release: 0.91
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/thermoworks_smoke.markdown b/source/_components/thermoworks_smoke.markdown
index fd307a471ba..215dbacd589 100644
--- a/source/_components/thermoworks_smoke.markdown
+++ b/source/_components/thermoworks_smoke.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: thermoworks.png
-ha_category: Sensor
+ha_category:
+ - Sensor
ha_release: 0.81
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/thingspeak.markdown b/source/_components/thingspeak.markdown
index 6bcabe6fe9e..d8864c4d2d3 100644
--- a/source/_components/thingspeak.markdown
+++ b/source/_components/thingspeak.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: thingspeak.png
-ha_category: "History"
+ha_category:
+ - "History"
ha_release: 0.32
---
diff --git a/source/_components/thomson.markdown b/source/_components/thomson.markdown
index 76253968912..3eca5dd99bc 100644
--- a/source/_components/thomson.markdown
+++ b/source/_components/thomson.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: technicolor.png
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
ha_release: 0.7
redirect_from:
- /components/device_tracker.thomson/
diff --git a/source/_components/threshold.markdown b/source/_components/threshold.markdown
index 451178c2283..4e679a2930a 100644
--- a/source/_components/threshold.markdown
+++ b/source/_components/threshold.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Utility
+ha_category:
+ - Utility
ha_iot_class: Local Polling
ha_release: 0.34
ha_qa_scale: internal
diff --git a/source/_components/tikteck.markdown b/source/_components/tikteck.markdown
index c904eaf9491..2054dbf2b85 100644
--- a/source/_components/tikteck.markdown
+++ b/source/_components/tikteck.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Light
+ha_category:
+ - Light
ha_iot_class: Local Polling
logo: tikteck.png
ha_release: 0.36
diff --git a/source/_components/tile.markdown b/source/_components/tile.markdown
index 5e4934ce18b..5fd85c3412a 100644
--- a/source/_components/tile.markdown
+++ b/source/_components/tile.markdown
@@ -9,7 +9,8 @@ sharing: true
footer: true
logo: tile.png
ha_release: 0.58
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
ha_iot_class: Cloud Polling
redirect_from:
- /components/device_tracker.tile/
diff --git a/source/_components/time_date.markdown b/source/_components/time_date.markdown
index e621ad72dee..bd0a514ca3c 100644
--- a/source/_components/time_date.markdown
+++ b/source/_components/time_date.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Calendar
+ha_category:
+ - Calendar
ha_iot_class: Local Push
ha_release: pre 0.7
ha_qa_scale: internal
diff --git a/source/_components/timer.markdown b/source/_components/timer.markdown
index 3e914d73130..6e214503133 100644
--- a/source/_components/timer.markdown
+++ b/source/_components/timer.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Automation
+ha_category:
+ - Automation
ha_release: 0.57
ha_qa_scale: internal
---
diff --git a/source/_components/tod.markdown b/source/_components/tod.markdown
index 93a03d59448..1443df092da 100644
--- a/source/_components/tod.markdown
+++ b/source/_components/tod.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Binary Sensor
+ha_category:
+ - Binary Sensor
ha_release: 0.89
ha_iot_class: Local Push
logo: home-assistant.png
diff --git a/source/_components/todoist.markdown b/source/_components/todoist.markdown
index 308ae263b3c..bf27c18791c 100644
--- a/source/_components/todoist.markdown
+++ b/source/_components/todoist.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: todoist.png
-ha_category: Calendar
+ha_category:
+ - Calendar
ha_iot_class: Cloud Polling
ha_release: 0.54
redirect_from:
diff --git a/source/_components/tof.markdown b/source/_components/tof.markdown
index bf5c68a3674..cb33bacbd81 100644
--- a/source/_components/tof.markdown
+++ b/source/_components/tof.markdown
@@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: raspberry-pi.png
-ha_category:
+ha_category:
- DIY
- Sensor
ha_release: "0.90"
diff --git a/source/_components/tomato.markdown b/source/_components/tomato.markdown
index 94a41d4239e..14d08f2847f 100644
--- a/source/_components/tomato.markdown
+++ b/source/_components/tomato.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: tomato.png
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
ha_release: pre 0.7
redirect_from:
- /components/device_tracker.tomato/
diff --git a/source/_components/torque.markdown b/source/_components/torque.markdown
index 3c2ed1647f2..f7018ebd70a 100644
--- a/source/_components/torque.markdown
+++ b/source/_components/torque.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: torque.png
-ha_category: Car
+ha_category:
+ - Car
ha_release: "0.10"
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/totalconnect.markdown b/source/_components/totalconnect.markdown
index f7aea202e2a..7d97bf463f3 100644
--- a/source/_components/totalconnect.markdown
+++ b/source/_components/totalconnect.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: honeywell-tc.png
-ha_category: Alarm
+ha_category:
+ - Alarm
ha_release: 0.42
redirect_from:
- /components/alarm_control_panel.totalconnect/
diff --git a/source/_components/touchline.markdown b/source/_components/touchline.markdown
index df49a42fb6b..4c76af10075 100644
--- a/source/_components/touchline.markdown
+++ b/source/_components/touchline.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: roth.png
-ha_category: Climate
+ha_category:
+ - Climate
ha_release: 0.61
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/traccar.markdown b/source/_components/traccar.markdown
index 589177f32fa..ab4a4d6f8ae 100644
--- a/source/_components/traccar.markdown
+++ b/source/_components/traccar.markdown
@@ -9,7 +9,8 @@ sharing: true
footer: true
logo: traccar.png
ha_release: 0.83
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
ha_iot_class: Local Polling
redirect_from:
- /components/device_tracker.traccar/
diff --git a/source/_components/trackr.markdown b/source/_components/trackr.markdown
index dc80419df8a..761f770bbc2 100644
--- a/source/_components/trackr.markdown
+++ b/source/_components/trackr.markdown
@@ -9,7 +9,8 @@ sharing: true
footer: true
logo: trackr.png
ha_release: 0.36
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
ha_iot_class: Cloud Polling
redirect_from:
- /components/device_tracker.trackr/
diff --git a/source/_components/trafikverket_weatherstation.markdown b/source/_components/trafikverket_weatherstation.markdown
index 68371512a23..f2e2dfc95e5 100644
--- a/source/_components/trafikverket_weatherstation.markdown
+++ b/source/_components/trafikverket_weatherstation.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: trafikverket.png
-ha_category: Weather
+ha_category:
+ - Weather
ha_release: 0.66
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/transport_nsw.markdown b/source/_components/transport_nsw.markdown
index 966c6184d9b..cac249d8553 100644
--- a/source/_components/transport_nsw.markdown
+++ b/source/_components/transport_nsw.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: transport_nsw.png
-ha_category: Transport
+ha_category:
+ - Transport
ha_iot_class: Cloud Polling
ha_release: 0.81
redirect_from:
diff --git a/source/_components/travisci.markdown b/source/_components/travisci.markdown
index d4c0c9d5922..a94c83faf1e 100644
--- a/source/_components/travisci.markdown
+++ b/source/_components/travisci.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: travisci.svg
-ha_category: Sensor
+ha_category:
+ - Sensor
ha_release: 0.56
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/trend.markdown b/source/_components/trend.markdown
index 9c9dbcd42fa..78c22c87c7b 100644
--- a/source/_components/trend.markdown
+++ b/source/_components/trend.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Utility
+ha_category:
+ - Utility
logo: home-assistant.png
ha_release: 0.28
ha_iot_class: Local Push
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/twilio.markdown b/source/_components/twilio.markdown
index f4f60e7cf7e..2485193b7d6 100644
--- a/source/_components/twilio.markdown
+++ b/source/_components/twilio.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: twilio.png
-ha_category: Hub
+ha_category:
+ - Hub
ha_release: "0.40"
---
diff --git a/source/_components/twilio_call.markdown b/source/_components/twilio_call.markdown
index 65a5e84e79c..6f4566ad60e 100644
--- a/source/_components/twilio_call.markdown
+++ b/source/_components/twilio_call.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: twilio.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: 0.37
redirect_from:
- /components/notify.twilio_call/
@@ -53,7 +54,7 @@ automation:
platform: sun
event: sunset
action:
- service: notify.twilio_sms
+ service: notify.twilio_call
data:
message: 'The sun has set'
target:
diff --git a/source/_components/twilio_sms.markdown b/source/_components/twilio_sms.markdown
index 3dfcaf43568..4390e447191 100644
--- a/source/_components/twilio_sms.markdown
+++ b/source/_components/twilio_sms.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: twilio.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: "0.20"
redirect_from:
- /components/notify.twilio_sms/
diff --git a/source/_components/twitch.markdown b/source/_components/twitch.markdown
index 0f450b358b6..3b39152bf56 100644
--- a/source/_components/twitch.markdown
+++ b/source/_components/twitch.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: twitch.png
-ha_category: Social
+ha_category:
+ - Social
ha_release: "0.10"
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/twitter.markdown b/source/_components/twitter.markdown
index 3e199f4c122..96a8e27d3e6 100644
--- a/source/_components/twitter.markdown
+++ b/source/_components/twitter.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: twitter.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: 0.12
redirect_from:
- /components/notify.twitter/
diff --git a/source/_components/ubee.markdown b/source/_components/ubee.markdown
index f58f42d2b22..9c8fb469b24 100644
--- a/source/_components/ubee.markdown
+++ b/source/_components/ubee.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: ubee.png
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
ha_release: 0.89
redirect_from:
- /components/device_tracker.ubee/
diff --git a/source/_components/uber.markdown b/source/_components/uber.markdown
index f607a84fdfe..fc98e5173be 100644
--- a/source/_components/uber.markdown
+++ b/source/_components/uber.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: uber.png
-ha_category: Transport
+ha_category:
+ - Transport
ha_iot_class: Cloud Polling
ha_release: 0.16
redirect_from:
diff --git a/source/_components/ubus.markdown b/source/_components/ubus.markdown
index d965db0bb3d..0a637ff158a 100644
--- a/source/_components/ubus.markdown
+++ b/source/_components/ubus.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: openwrt.png
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
ha_release: 0.7.6
redirect_from:
- /components/device_tracker.ubus/
diff --git a/source/_components/ue_smart_radio.markdown b/source/_components/ue_smart_radio.markdown
index 48d4a55f6d4..4910304a65c 100644
--- a/source/_components/ue_smart_radio.markdown
+++ b/source/_components/ue_smart_radio.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: ueradio.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_release: "0.60"
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/uk_transport.markdown b/source/_components/uk_transport.markdown
index afba90b9175..b8b3967d42a 100644
--- a/source/_components/uk_transport.markdown
+++ b/source/_components/uk_transport.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: train.png
-ha_category: Transport
+ha_category:
+ - Transport
ha_iot_class: Cloud Polling
ha_release: "0.50"
redirect_from:
diff --git a/source/_components/unifi_direct.markdown b/source/_components/unifi_direct.markdown
index ba15621b29a..3f3335b46bd 100644
--- a/source/_components/unifi_direct.markdown
+++ b/source/_components/unifi_direct.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: ubiquiti.png
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
ha_iot_class: Local Polling
ha_release: 0.59
redirect_from:
diff --git a/source/_components/universal.markdown b/source/_components/universal.markdown
index 8015c69eb16..f54e50b2752 100644
--- a/source/_components/universal.markdown
+++ b/source/_components/universal.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_qa_scale: internal
ha_release: 0.11
redirect_from:
diff --git a/source/_components/upc_connect.markdown b/source/_components/upc_connect.markdown
index e483d5b9b27..7a9a36fed15 100644
--- a/source/_components/upc_connect.markdown
+++ b/source/_components/upc_connect.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: upc.png
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
ha_release: 0.36
redirect_from:
- /components/device_tracker.upc_connect/
diff --git a/source/_components/updater.markdown b/source/_components/updater.markdown
index 91019e670d2..17453c0308d 100644
--- a/source/_components/updater.markdown
+++ b/source/_components/updater.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Other
+ha_category:
+ - Other
ha_qa_scale: internal
ha_release: 0.8
---
diff --git a/source/_components/ups.markdown b/source/_components/ups.markdown
index 06797853006..4d6cf80c610 100644
--- a/source/_components/ups.markdown
+++ b/source/_components/ups.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: ups.png
-ha_category: Postal Service
+ha_category:
+ - Postal Service
ha_release: 0.39
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/uptime.markdown b/source/_components/uptime.markdown
index ffd79222b2c..847c3692a61 100644
--- a/source/_components/uptime.markdown
+++ b/source/_components/uptime.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Utility
+ha_category:
+ - Utility
ha_iot_class: Local Push
logo: home-assistant.png
ha_release: 0.56
diff --git a/source/_components/uptimerobot.markdown b/source/_components/uptimerobot.markdown
index 06bb9d7f36f..984a72e2805 100644
--- a/source/_components/uptimerobot.markdown
+++ b/source/_components/uptimerobot.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: uptimerobot.png
-ha_category: System Monitor
+ha_category:
+ - System Monitor
ha_release: 0.72
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/uscis.markdown b/source/_components/uscis.markdown
index f38cf3c9435..3fe075065a1 100644
--- a/source/_components/uscis.markdown
+++ b/source/_components/uscis.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: uscis.png
-ha_category: Sensor
+ha_category:
+ - Sensor
ha_release: 0.68
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/usgs_earthquakes_feed.markdown b/source/_components/usgs_earthquakes_feed.markdown
index 7fb2b50e4b9..6f6ef781028 100644
--- a/source/_components/usgs_earthquakes_feed.markdown
+++ b/source/_components/usgs_earthquakes_feed.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: us-geological-survey.png
-ha_category: Geolocation
+ha_category:
+ - Geolocation
ha_iot_class: Cloud Polling
ha_release: 0.84
redirect_from:
diff --git a/source/_components/utility_meter.markdown b/source/_components/utility_meter.markdown
index 3dfb3852605..a186c0ad8e1 100644
--- a/source/_components/utility_meter.markdown
+++ b/source/_components/utility_meter.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Sensor
+ha_category:
+ - Sensor
ha_release: 0.87
ha_iot_class: Local Push
logo: energy_meter.png
diff --git a/source/_components/uvc.markdown b/source/_components/uvc.markdown
index e7edc160cf3..1f691d6ac5d 100644
--- a/source/_components/uvc.markdown
+++ b/source/_components/uvc.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: ubiquiti.png
-ha_category: Camera
+ha_category:
+ - Camera
ha_release: 0.13
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/vacuum.mqtt.markdown b/source/_components/vacuum.mqtt.markdown
index 7090042bf23..c02f97422c2 100644
--- a/source/_components/vacuum.mqtt.markdown
+++ b/source/_components/vacuum.mqtt.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: mqtt.png
-ha_category: Vacuum
+ha_category:
+ - Vacuum
ha_release: 0.54
---
@@ -103,7 +104,7 @@ battery_level_topic:
required: false
type: string
battery_level_template:
- description: Defines a [template](/topics/templating/) to define the battery level of the vacuum.
+ description: Defines a [template](/topics/templating/) to define the battery level of the vacuum. This is required if `battery_level_topic` is set.
required: false
type: string
charging_topic:
@@ -111,7 +112,7 @@ charging_topic:
required: false
type: string
charging_template:
- description: Defines a [template](/topics/templating/) to define the charging state of the vacuum.
+ description: Defines a [template](/topics/templating/) to define the charging state of the vacuum. This is required if `charging_topic` is set.
required: false
type: string
cleaning_topic:
@@ -119,7 +120,7 @@ cleaning_topic:
required: false
type: string
cleaning_template:
- description: Defines a [template](/topics/templating/) to define the cleaning state of the vacuum.
+ description: Defines a [template](/topics/templating/) to define the cleaning state of the vacuum. This is required if `cleaning_topic` is set.
required: false
type: string
docked_topic:
@@ -127,7 +128,7 @@ docked_topic:
required: false
type: string
docked_template:
- description: Defines a [template](/topics/templating/) to define the docked state of the vacuum.
+ description: Defines a [template](/topics/templating/) to define the docked state of the vacuum. This is required if `docked_topic` is set.
required: false
type: string
error_topic:
@@ -135,7 +136,7 @@ error_topic:
required: false
type: string
error_template:
- description: Defines a [template](/topics/templating/) to define potential error messages emitted by the vacuum.
+ description: Defines a [template](/topics/templating/) to define potential error messages emitted by the vacuum. This is required if `error_topic` is set.
required: false
type: string
fan_speed_topic:
@@ -143,7 +144,7 @@ fan_speed_topic:
required: false
type: string
fan_speed_template:
- description: Defines a [template](/topics/templating/) to define the fan speed of the vacuum.
+ description: Defines a [template](/topics/templating/) to define the fan speed of the vacuum. This is required if `fan_speed_topic` is set.
required: false
type: string
set_fan_speed_topic:
diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown
index ddabec52c3d..1d956cfcdd4 100644
--- a/source/_components/vacuum.xiaomi_miio.markdown
+++ b/source/_components/vacuum.xiaomi_miio.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: xiaomi.png
-ha_category: Vacuum
+ha_category:
+ - Vacuum
ha_release: 0.51
ha_iot_class: Local Polling
---
@@ -129,7 +130,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 +145,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/_components/vasttrafik.markdown b/source/_components/vasttrafik.markdown
index 64d5e85963d..95c269f938e 100644
--- a/source/_components/vasttrafik.markdown
+++ b/source/_components/vasttrafik.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: vasttrafik.png
-ha_category: Transport
+ha_category:
+ - Transport
ha_iot_class: Cloud Polling
ha_release: "0.30"
redirect_from:
diff --git a/source/_components/venstar.markdown b/source/_components/venstar.markdown
index 91571846acb..cb1b8b56a8a 100644
--- a/source/_components/venstar.markdown
+++ b/source/_components/venstar.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: venstar.png
-ha_category: Climate
+ha_category:
+ - Climate
ha_release: 0.62
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/version.markdown b/source/_components/version.markdown
index 1a9612247ab..52b86941114 100644
--- a/source/_components/version.markdown
+++ b/source/_components/version.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Utility
+ha_category:
+ - Utility
ha_iot_class: Local Push
logo: home-assistant.png
ha_release: 0.52
diff --git a/source/_components/vesync.markdown b/source/_components/vesync.markdown
index d26a867d88c..8ee93812f05 100644
--- a/source/_components/vesync.markdown
+++ b/source/_components/vesync.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: vesync.png
-ha_category: Switch
+ha_category:
+ - Switch
ha_release: 0.66
redirect_from:
- /components/switch.vesync/
diff --git a/source/_components/viaggiatreno.markdown b/source/_components/viaggiatreno.markdown
index 7167193ac3e..9bc03a976ef 100644
--- a/source/_components/viaggiatreno.markdown
+++ b/source/_components/viaggiatreno.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: train.png
-ha_category: Transport
+ha_category:
+ - Transport
ha_iot_class: Cloud Polling
ha_release: 0.58
redirect_from:
diff --git a/source/_components/vizio.markdown b/source/_components/vizio.markdown
index 8cbc7cb1643..abe9e5996b7 100644
--- a/source/_components/vizio.markdown
+++ b/source/_components/vizio.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: vizio-smartcast.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_release: 0.49
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/vlc.markdown b/source/_components/vlc.markdown
index c0929c03cc4..222767e648e 100644
--- a/source/_components/vlc.markdown
+++ b/source/_components/vlc.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: videolan.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_release: 0.35
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/voicerss.markdown b/source/_components/voicerss.markdown
index fd7279bd299..49eb1d2b884 100644
--- a/source/_components/voicerss.markdown
+++ b/source/_components/voicerss.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: voicerss.png
-ha_category: Text-to-speech
+ha_category:
+ - Text-to-speech
ha_release: 0.35
redirect_from:
- /components/tts.voicerss/
diff --git a/source/_components/volkszaehler.markdown b/source/_components/volkszaehler.markdown
index e0fb0e3c82d..68b163843ba 100644
--- a/source/_components/volkszaehler.markdown
+++ b/source/_components/volkszaehler.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: volkszaehler.png
-ha_category: System Monitor
+ha_category:
+ - System Monitor
ha_iot_class: Local Polling
ha_release: 0.78
redirect_from:
diff --git a/source/_components/volumio.markdown b/source/_components/volumio.markdown
index 2619b8ff54f..7b7ce7f8ee6 100644
--- a/source/_components/volumio.markdown
+++ b/source/_components/volumio.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: volumio.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_release: 0.41
redirect_from:
- /components/media_player.volumio/
diff --git a/source/_components/volvooncall.markdown b/source/_components/volvooncall.markdown
index b778d9e7c78..eeed03ca4c1 100644
--- a/source/_components/volvooncall.markdown
+++ b/source/_components/volvooncall.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: volvo.png
-ha_category: Car
+ha_category:
+ - Car
ha_release: 0.39
ha_iot_class: Cloud Polling
redirect_from:
@@ -75,7 +76,7 @@ mutable:
default: true
type: boolean
name:
- description: Make it possible to provide a name for the vehicles.
+ description: "Make it possible to provide a name for the vehicles. Note: Use all lower case letters when inputing your VIN number."
required: false
type: string
resources:
@@ -140,7 +141,7 @@ volvooncall:
username: YOUR_USERNAME
password: YOUR_PASSWORD
name:
- abc123: 'Batmobile'
+ YOUR_VIN_NUMBER: 'NEW_NAME'
resources:
- odometer
- lock
diff --git a/source/_components/waqi.markdown b/source/_components/waqi.markdown
index f9a0ecb18c0..b95de81d5ee 100644
--- a/source/_components/waqi.markdown
+++ b/source/_components/waqi.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: waqi.png
-ha_category: Health
+ha_category:
+ - Health
ha_release: 0.34
ha_iot_class: Cloud Polling
redirect_from:
@@ -48,8 +49,6 @@ stations:
The value reported is an overall AQ index for the location. The values of the index can be interpreted as following:
AQI | Status | Description
-redirect_from:
- - /components/sensor.waqi/
------- | :----------------: | ----------
0 - 50 | **Good** | Air quality is considered satisfactory, and air pollution poses little or no risk
51 - 100 | **Moderate** | Air quality is acceptable; however, for some pollutants there may be a moderate health concern for a very small number of people who are unusually sensitive to air pollution
diff --git a/source/_components/waterfurnace.markdown b/source/_components/waterfurnace.markdown
index face090bf46..322349760e7 100644
--- a/source/_components/waterfurnace.markdown
+++ b/source/_components/waterfurnace.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: waterfurnace.png
-ha_category: Sensor
+ha_category:
+ - Sensor
ha_release: 0.62
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/watson_iot.markdown b/source/_components/watson_iot.markdown
index a13ef02fc63..dffff86af55 100644
--- a/source/_components/watson_iot.markdown
+++ b/source/_components/watson_iot.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: ibm.png
-ha_category: History
+ha_category:
+ - History
ha_release: 0.72
---
diff --git a/source/_components/waze_travel_time.markdown b/source/_components/waze_travel_time.markdown
index 50e8cbe20c2..1f3577aa22a 100644
--- a/source/_components/waze_travel_time.markdown
+++ b/source/_components/waze_travel_time.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: waze.png
-ha_category: Transport
+ha_category:
+ - Transport
ha_iot_class: Cloud Polling
ha_release: 0.67
redirect_from:
diff --git a/source/_components/weather.darksky.markdown b/source/_components/weather.darksky.markdown
index 3f199d33dbf..d3fda0301c6 100644
--- a/source/_components/weather.darksky.markdown
+++ b/source/_components/weather.darksky.markdown
@@ -9,7 +9,8 @@ sharing: true
footer: true
featured: true
logo: dark_sky.png
-ha_category: Weather
+ha_category:
+ - Weather
ha_release: 0.61
ha_iot_class: Cloud Polling
---
diff --git a/source/_components/webhooks.markdown b/source/_components/webhooks.markdown
index 3ae94b9dad9..b9e015982fe 100644
--- a/source/_components/webhooks.markdown
+++ b/source/_components/webhooks.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: telegram.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: 0.42
redirect_from:
- /components/telegram_bot.webhooks/
diff --git a/source/_components/weblink.markdown b/source/_components/weblink.markdown
index 4e05396cdf1..b957a3ee5d4 100644
--- a/source/_components/weblink.markdown
+++ b/source/_components/weblink.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Front end
+ha_category:
+ - Front end
ha_release: 0.13
ha_qa_scale: internal
---
diff --git a/source/_components/websocket_api.markdown b/source/_components/websocket_api.markdown
index 5eb414dc6cc..41befadad65 100644
--- a/source/_components/websocket_api.markdown
+++ b/source/_components/websocket_api.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: "Other"
+ha_category:
+ - "Other"
ha_qa_scale: internal
ha_release: 0.34
---
diff --git a/source/_components/whois.markdown b/source/_components/whois.markdown
index 562d9149073..80b543d4411 100644
--- a/source/_components/whois.markdown
+++ b/source/_components/whois.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: icann.png
-ha_category: Network
+ha_category:
+ - Network
ha_release: 0.57
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/workday.markdown b/source/_components/workday.markdown
index 4539171c3ea..e592c788e00 100644
--- a/source/_components/workday.markdown
+++ b/source/_components/workday.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Utility
+ha_category:
+ - Utility
ha_iot_class: Local Polling
ha_release: 0.41
ha_qa_scale: internal
diff --git a/source/_components/worldclock.markdown b/source/_components/worldclock.markdown
index 3c4cfddf87e..8bec30c3106 100644
--- a/source/_components/worldclock.markdown
+++ b/source/_components/worldclock.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Calendar
+ha_category:
+ - Calendar
ha_iot_class: Local Push
ha_release: pre 0.7
ha_qa_scale: internal
diff --git a/source/_components/worldtidesinfo.markdown b/source/_components/worldtidesinfo.markdown
index 7ab15dd3bf2..a9124dba2ce 100644
--- a/source/_components/worldtidesinfo.markdown
+++ b/source/_components/worldtidesinfo.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: worldtidesinfo.png
-ha_category: Environment
+ha_category:
+ - Environment
ha_release: 0.52
redirect_from:
- /components/sensor.worldtidesinfo/
diff --git a/source/_components/worxlandroid.markdown b/source/_components/worxlandroid.markdown
index 172f93e1c89..155b88001ae 100644
--- a/source/_components/worxlandroid.markdown
+++ b/source/_components/worxlandroid.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: worx.png
-ha_category: DIY
+ha_category:
+ - DIY
ha_release: 0.54
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/wsdot.markdown b/source/_components/wsdot.markdown
index 4c1a9706437..11e40f13db5 100644
--- a/source/_components/wsdot.markdown
+++ b/source/_components/wsdot.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: wsdot.png
-ha_category: Transport
+ha_category:
+ - Transport
ha_iot_class: Cloud Polling
ha_release: 0.37
redirect_from:
diff --git a/source/_components/wunderground.markdown b/source/_components/wunderground.markdown
index ee9c6b45b92..6dccff79097 100644
--- a/source/_components/wunderground.markdown
+++ b/source/_components/wunderground.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: wunderground.png
-ha_category: Weather
+ha_category:
+ - Weather
ha_release: 0.27
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/wunderlist.markdown b/source/_components/wunderlist.markdown
index aed87d67f49..fd754d35d3b 100644
--- a/source/_components/wunderlist.markdown
+++ b/source/_components/wunderlist.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: wunderlist.png
-ha_category: Calendar
+ha_category:
+ - Calendar
ha_release: 0.84
---
diff --git a/source/_components/x10.markdown b/source/_components/x10.markdown
index a4252a53e3c..5e12ae41ff1 100644
--- a/source/_components/x10.markdown
+++ b/source/_components/x10.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: x10.gif
-ha_category: Light
+ha_category:
+ - Light
ha_iot_class: Local Polling
ha_release: 0.25
redirect_from:
diff --git a/source/_components/xbox_live.markdown b/source/_components/xbox_live.markdown
index 0c5b05df1a3..234a18c22e0 100644
--- a/source/_components/xbox_live.markdown
+++ b/source/_components/xbox_live.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: xbox-live.png
-ha_category: Social
+ha_category:
+ - Social
ha_iot_class: Cloud Polling
ha_release: 0.28
redirect_from:
diff --git a/source/_components/xeoma.markdown b/source/_components/xeoma.markdown
index b0b2b5d55c4..a9c212a14b3 100644
--- a/source/_components/xeoma.markdown
+++ b/source/_components/xeoma.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: xeoma.png
-ha_category: Camera
+ha_category:
+ - Camera
ha_iot_class: Local Polling
ha_release: 0.62
redirect_from:
diff --git a/source/_components/xfinity.markdown b/source/_components/xfinity.markdown
index 4b1e59d55cc..f29fbffc0ab 100644
--- a/source/_components/xfinity.markdown
+++ b/source/_components/xfinity.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
logo: xfinity.svg
ha_release: 0.90
ha_iot_class: "Local Polling"
diff --git a/source/_components/xiaomi.markdown b/source/_components/xiaomi.markdown
index 22935402dae..be9d746a5a4 100644
--- a/source/_components/xiaomi.markdown
+++ b/source/_components/xiaomi.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: xiaomi.png
-ha_category: Camera
+ha_category:
+ - Camera
ha_release: 0.72
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown
index ee8729d4b9e..0e31f5a0a88 100644
--- a/source/_components/xiaomi_aqara.markdown
+++ b/source/_components/xiaomi_aqara.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: xiaomi.png
-ha_category: Hub
+ha_category:
+ - Hub
ha_release: 0.57
ha_iot_class: Local Push
redirect_from: /components/xiaomi/
@@ -287,6 +288,6 @@ That means that Home Assistant is not getting any response from your Xiaomi gate
- Open a serial terminal application (e.g. PuTTY) and connect to the serial port assigned to the USB-UART module (baudrate: 115200).
- Wait until the gateway is booted up, connect the RX, TX and GND wires to the UART module (don't connect the Vcc (power) wire!).
- You will see all the messages from the gateway.
- - Send the command `psm-set network.open_pf 3` (the command has to end with a `CR` newline character).
- - Check your settings executing the command `psm-get network.open_pf` to be sure it's OK.
+ - Send the command `psm-set network open_pf 3` (the command has to end with a `CR` newline character).
+ - Check your settings executing the command `psm-get network open_pf` to be sure it's OK.
- Restart the gateway.
diff --git a/source/_components/xiaomi_miio.markdown b/source/_components/xiaomi_miio.markdown
index 3589c9c3cba..68182ac05e0 100644
--- a/source/_components/xiaomi_miio.markdown
+++ b/source/_components/xiaomi_miio.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: xiaomi.png
-ha_category: Presence Detection
+ha_category:
+ - Presence Detection
ha_iot_class: Local Polling
ha_release: 0.67
redirect_from:
diff --git a/source/_components/xiaomi_tv.markdown b/source/_components/xiaomi_tv.markdown
index ac402d90d77..bb871cd98ae 100644
--- a/source/_components/xiaomi_tv.markdown
+++ b/source/_components/xiaomi_tv.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: xiaomi.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_release: 0.64
ha_iot_class: Assumed State
redirect_from:
diff --git a/source/_components/xmpp.markdown b/source/_components/xmpp.markdown
index ae1c44a4b9c..aabadd64375 100644
--- a/source/_components/xmpp.markdown
+++ b/source/_components/xmpp.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: xmpp.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: pre 0.7
redirect_from:
- /components/notify.xmpp/
diff --git a/source/_components/yale_smart_alarm.markdown b/source/_components/yale_smart_alarm.markdown
index ae1b8852bdf..de7233966c1 100644
--- a/source/_components/yale_smart_alarm.markdown
+++ b/source/_components/yale_smart_alarm.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: yale.png
-ha_category: Alarm
+ha_category:
+ - Alarm
ha_release: 0.78
redirect_from:
- /components/alarm_control_panel.yale_smart_alarm/
diff --git a/source/_components/yamaha.markdown b/source/_components/yamaha.markdown
index 953f6b252db..c361bfa79af 100644
--- a/source/_components/yamaha.markdown
+++ b/source/_components/yamaha.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: yamaha.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_release: 0.16
redirect_from:
- /components/media_player.yamaha/
diff --git a/source/_components/yamaha_musiccast.markdown b/source/_components/yamaha_musiccast.markdown
index e5fda40c6a3..ea4796b76c7 100644
--- a/source/_components/yamaha_musiccast.markdown
+++ b/source/_components/yamaha_musiccast.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: yamaha.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_release: 0.53
redirect_from:
- /components/media_player.yamaha_musiccast/
diff --git a/source/_components/yandextts.markdown b/source/_components/yandextts.markdown
index fb36d45ede4..15141fdb705 100644
--- a/source/_components/yandextts.markdown
+++ b/source/_components/yandextts.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: yandex.png
-ha_category: Text-to-speech
+ha_category:
+ - Text-to-speech
ha_release: 0.36
redirect_from:
- /components/tts.yandextts/
diff --git a/source/_components/yeelight.markdown b/source/_components/yeelight.markdown
index 9a04f4be256..8fab6bffae1 100644
--- a/source/_components/yeelight.markdown
+++ b/source/_components/yeelight.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: yeelight.png
-ha_category: Light
+ha_category:
+ - Light
ha_release: 0.32
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/yeelightsunflower.markdown b/source/_components/yeelightsunflower.markdown
index 53aec0ef7f5..f5099a57d4b 100644
--- a/source/_components/yeelightsunflower.markdown
+++ b/source/_components/yeelightsunflower.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: yeelight.png
-ha_category: Light
+ha_category:
+ - Light
ha_release: 0.39
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/yessssms.markdown b/source/_components/yessssms.markdown
index b5e6e6b6b9b..2c959a985f4 100644
--- a/source/_components/yessssms.markdown
+++ b/source/_components/yessssms.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: yesssat.png
-ha_category: Notifications
+ha_category:
+ - Notifications
ha_release: 0.57
redirect_from:
- /components/notify.yessssms/
diff --git a/source/_components/yi.markdown b/source/_components/yi.markdown
index f36e5fb246f..388f2ef8b20 100644
--- a/source/_components/yi.markdown
+++ b/source/_components/yi.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: yi.png
-ha_category: Camera
+ha_category:
+ - Camera
ha_release: 0.56
ha_iot_class: Local Polling
redirect_from:
diff --git a/source/_components/yr.markdown b/source/_components/yr.markdown
index a5153bc87d7..2e453a680c6 100644
--- a/source/_components/yr.markdown
+++ b/source/_components/yr.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: yr.png
-ha_category: Weather
+ha_category:
+ - Weather
ha_release: 0.11
ha_iot_class: Cloud Polling
redirect_from:
diff --git a/source/_components/zengge.markdown b/source/_components/zengge.markdown
index 40fb6e98989..868a29b23ef 100644
--- a/source/_components/zengge.markdown
+++ b/source/_components/zengge.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: zengge.png
-ha_category: Light
+ha_category:
+ - Light
ha_iot_class: Local Polling
ha_release: 0.36
redirect_from:
diff --git a/source/_components/zeroconf.markdown b/source/_components/zeroconf.markdown
index be29f6e6d84..b44c5f60f7d 100644
--- a/source/_components/zeroconf.markdown
+++ b/source/_components/zeroconf.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: avahi.png
-ha_category: Network
+ha_category:
+ - Network
ha_release: 0.18
---
diff --git a/source/_components/zestimate.markdown b/source/_components/zestimate.markdown
index 5aa2d378de2..22e26652ccb 100644
--- a/source/_components/zestimate.markdown
+++ b/source/_components/zestimate.markdown
@@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
-ha_category: Sensor
+ha_category:
+ - Sensor
logo: zillow.png
ha_release: 0.65
ha_iot_class: Cloud Polling
diff --git a/source/_components/zhong_hong.markdown b/source/_components/zhong_hong.markdown
index cae13a76308..6f12502010d 100644
--- a/source/_components/zhong_hong.markdown
+++ b/source/_components/zhong_hong.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: zhong_hong.png
-ha_category: Climate
+ha_category:
+ - Climate
ha_release: 0.72
ha_iot_class: Local Push
redirect_from:
diff --git a/source/_components/ziggo_mediabox_xl.markdown b/source/_components/ziggo_mediabox_xl.markdown
index d721ed81a69..cef854b4770 100644
--- a/source/_components/ziggo_mediabox_xl.markdown
+++ b/source/_components/ziggo_mediabox_xl.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: ziggo.png
-ha_category: Media Player
+ha_category:
+ - Media Player
ha_iot_class: Local Polling
ha_release: "0.60"
redirect_from:
diff --git a/source/_components/zone.markdown b/source/_components/zone.markdown
index 20b6fe3b251..269492938dd 100644
--- a/source/_components/zone.markdown
+++ b/source/_components/zone.markdown
@@ -8,7 +8,8 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
-ha_category: Organization
+ha_category:
+ - Organization
ha_qa_scale: internal
ha_release: 0.69
---
diff --git a/source/_cookbook/configuration_yaml_by_jonathan_adams.markdown b/source/_cookbook/configuration_yaml_by_jonathan_adams.markdown
new file mode 100644
index 00000000000..4edd17b938f
--- /dev/null
+++ b/source/_cookbook/configuration_yaml_by_jonathan_adams.markdown
@@ -0,0 +1,12 @@
+---
+layout: page
+title: "Configuration.yaml by Jonathan Adams"
+description: ""
+date: 2019-05-07 15:30
+sidebar: true
+comments: false
+sharing: true
+footer: true
+ha_category: Example configuration.yaml
+ha_external_link: https://github.com/jonathanadams/Home-Assistant-Configuration
+---
diff --git a/source/_cookbook/configuration_yaml_by_silvrrgit.markdow b/source/_cookbook/configuration_yaml_by_silvrrgit.markdown
similarity index 100%
rename from source/_cookbook/configuration_yaml_by_silvrrgit.markdow
rename to source/_cookbook/configuration_yaml_by_silvrrgit.markdown
diff --git a/source/_cookbook/configuration_yaml_by_skalavala.markdown b/source/_cookbook/configuration_yaml_by_skalavala.markdown
new file mode 100644
index 00000000000..9ead3e1f233
--- /dev/null
+++ b/source/_cookbook/configuration_yaml_by_skalavala.markdown
@@ -0,0 +1,12 @@
+---
+layout: page
+title: "Configuration.yaml by Mahasri Kalavala (@skalavala)"
+description: ""
+date: 2016-10-25 10:45
+sidebar: true
+comments: false
+sharing: true
+footer: true
+ha_category: Example configuration.yaml
+ha_external_link: https://github.com/skalavala/mysmarthome
+---
diff --git a/source/_cookbook/sonos_say.markdown b/source/_cookbook/sonos_say.markdown
index fd4b04b402f..65c58fb6c4a 100644
--- a/source/_cookbook/sonos_say.markdown
+++ b/source/_cookbook/sonos_say.markdown
@@ -19,10 +19,10 @@ script:
sonos_say:
alias: "Sonos TTS script"
sequence:
- - service: media_player.sonos_snapshot
+ - service: sonos.snapshot
data_template:
entity_id: {% raw %}"{{ sonos_entity }}"{% endraw %}
- - service: media_player.sonos_unjoin
+ - service: sonos.unjoin
data_template:
entity_id: {% raw %}"{{ sonos_entity }}"{% endraw %}
- service: media_player.volume_set
@@ -34,7 +34,7 @@ script:
entity_id: {% raw %}"{{ sonos_entity }}"{% endraw %}
message: {% raw %}"{{ message }}"{% endraw %}
- delay: {% raw %}"{{ delay }}"{% endraw %}
- - service: media_player.sonos_restore
+ - service: sonos.restore
data_template:
entity_id: {% raw %}"{{ sonos_entity }}"{% endraw %}
```
diff --git a/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown b/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown
index c4f7c536741..5efe94ec42e 100644
--- a/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown
+++ b/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown
@@ -44,4 +44,11 @@ http:
A restart of Home Assistant is required for the changes to take effect.
+If you get any log error about *ssl_key* or *ssl_certificate* that is **not a file for dictionary value** when run Home Assistant, you need to change owner or access permission of the `.pem` files as following:
+
+```bash
+$ sudo chown homeassistant:homeassistant certificate.pem privkey.pem
+$ sudo chmod 755 certificate.pem privkey.pem
+```
+
A tutorial "[Working with SSL Certificates, Private Keys and CSRs](https://www.digitalocean.com/community/tutorials/openssl-essentials-working-with-ssl-certificates-private-keys-and-csrs)" could give you some insight about special cases.
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.markdown b/source/_docs/mqtt.markdown
index 072561f9912..30a57287968 100644
--- a/source/_docs/mqtt.markdown
+++ b/source/_docs/mqtt.markdown
@@ -11,14 +11,15 @@ footer: true
MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things" connectivity protocol on top of TCP/IP. It allows extremely lightweight publish/subscribe messaging transport.
-To integrate MQTT into Home Assistant, add the following section to your `configuration.yaml` file. Keep in mind that the minimal setup will run with [an embedded MQTT broker](/docs/mqtt/broker#embedded-broker):
+To integrate MQTT into Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
mqtt:
+ broker: IP_ADDRESS
```
-For other setup methods, please refer to the [MQTT broker](/docs/mqtt/broker) documentation.
+For detailed setup instructions, please refer to the [MQTT broker](/docs/mqtt/broker) documentation.
## {% linkable_title Additional features %}
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.
-
+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/mqtt/discovery.markdown b/source/_docs/mqtt/discovery.markdown index 0be6a1714b5..04dfa8af4fd 100644 --- a/source/_docs/mqtt/discovery.markdown +++ b/source/_docs/mqtt/discovery.markdown @@ -55,15 +55,16 @@ The [embedded MQTT broker](/docs/mqtt/broker#embedded-broker) does not save any The discovery topic need to follow a specific format: ```text -
-Screenshot of the history graph card, when no `unit_of_measurement` is defined.
+Screenshot of the history graph card, when the sensor has no `unit_of_measurement` defined.
-Screenshot of the history graph card, when a `unit_of_measurement` is defined.
+Screenshot of the history graph card, when the sensor has a `unit_of_measurement` defined.
+ +This month marked a year since Ubiquiti got involved, and also their last month, as they have decided to end their involvement as their plans have changed. We left on friendly terms and I want to thank Ubiquiti for this tremendous opportunity, it has given the Home Assistant project a significant boost. Moving forward, I will be paid by Nabu Casa, so that I can continue my work on Home Assistant. + +## {% linkable_title The Focus %} + +For the last year, the Home Assistant community has been working on building a user-friendly version of Home Assistant, also known as Home Assistant 1.0. + +We’re aiming to release Home Assistant 1.0 this year. With Home Assistant 1.0, installation and basic functionality can be done via a user interface. Advanced options will require entering an advanced mode or set up via `configuration.yaml`. Check out last year’s [state of the union](https://www.home-assistant.io/blog/2018/11/16/state-of-the-union/) for more details. We have started using [this project board](https://github.com/orgs/home-assistant/projects/1) to keep track of our progress. + +While we’re working hard on Home Assistant 1.0, we have also started working on the next goal for post 1.0 launch: a better story for manufacturers and integrations. + +We have started certifying our integrations with partners and are working on making it easier for manufacturers to improve or maintain their own integrations. If you are a manufacturer and want to join early, reach out to us at [partner@nabucasa.com](mailto:partner@nabucasa.com). We’re planning on launching more information about this soon. + +## {% linkable_title Finally %} + +These are exciting times and I am stoked for what is ahead of us. Home Assistant is growing, our community is growing, and our reach is growing. Just this week there was [a testimony about how Home Assistant saves lives](https://news.ycombinator.com/item?id=19806159) and we discovered that the [Living Computers Museum](https://livingcomputers.org/) in Seattle is using Home Assistant to teach people about the internet of things: + +A huge THANK YOU! to the @NabuCasa team for their support of Let's Encrypt! We are happy to have you on board as sponsors of a more secure Web. pic.twitter.com/jUU7a2HU0K
— Let's Encrypt (@letsencrypt) April 30, 2019 +
+ diff --git a/source/_posts/2019-05-08-nest-data-bye-bye.markdown b/source/_posts/2019-05-08-nest-data-bye-bye.markdown new file mode 100644 index 00000000000..ce0a0a5886e --- /dev/null +++ b/source/_posts/2019-05-08-nest-data-bye-bye.markdown @@ -0,0 +1,43 @@ +--- +layout: post +title: "[Update: new users only] Nest to turn off their API" +description: "Nest has announced that they will shut down their API in August, no longer allowing you to access your data." +date: 2019-05-08 00:01:00 +date_formatted: "May 8, 2019" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Public-Service-Announcement +og_image: /images/blog/2019-05-nest-data-bye-bye/notice.png +--- + +**Update May 16:** Nest just announced [in a blog post](https://blog.google/products/google-nest/updates-works-with-nest/) that they changed their plan. It will still retire the Works with Nest program at the end of August, but it will no longer cut off existing users of the API. It will however still stop accepting new users at the end of August. + +Currently each Home Assistant user is required to create their own developer account to configure their Nest integration. We will reach out to Nest to see if we can become a partner so that users joining Home Assistant after August can still use Nest. + +--- + +Sigh. Another one. This time it's not a small one either: Nest is disabling their APIs. + +We already saw [the writing on the wall in January](/blog/2019/01/24/nest-cannot-access-data/), but now [it's official](https://developers.nest.com/): Google announced that the Nest API will be turned off at the end of August, 2019. This means that in a little over three months, you will no longer be able to get your own data, that Google has collected in your home, and use it like you see fit. + +Cool! There’s a @home_assistant exhibit at the living computers museum pic.twitter.com/fAfYBu9CAQ
— Stephen Vanterpool (@sjvanterpool) May 2, 2019 +
+
+Notice posted on the Nest developer website.
+
+
+FAQ Nest developer website.
+
+ +Our advice (as always): buy devices that communicate locally. diff --git a/source/_posts/2019-05-16-release-93.markdown b/source/_posts/2019-05-16-release-93.markdown new file mode 100644 index 00000000000..bae22fde63f --- /dev/null +++ b/source/_posts/2019-05-16-release-93.markdown @@ -0,0 +1,856 @@ +--- +layout: post +title: "0.93: Essent, AmbiClimate, VS Code debugging" +description: "This release improves our onboarding experience and our automation page." +date: 2019-05-16 04:11:03 +date_formatted: "May 16, 2019" +author: Paulus Schoutsen +author_twitter: balloob +comments: true +categories: Release-Notes +og_image: /images/blog/2019-05-release-93/components.png +--- + +Well that's reassuring https://t.co/SKFkE8cAyR pic.twitter.com/zmjMjm23h0
— David Meyer (@superglaze) May 8, 2019 +
+
+It's time for our 0.93 release and it is a whopping cool one. It's a day later than usual as I am travelling. [Frenck](https://www.github.com/frenck) streams his work on Home Assistant / Hass.io each Tuesday and Friday, and last Tuesday I decided to surprise him and visit his house during the stream 😛. We ended up talking about everything Home Assistant with the viewers for over 3 hours. For the full conversation, check out [Frenck's blog](https://frenck.dev/home-assistant-paulus-invaded-my-live-stream/). Clip of me walking into the stream:
+
+
+
+
+
+Last week we also wrote about [our updated plans](/blog/2019/05/03/update-from-the-field/) for Home Assistant for this year. If you haven't read it yet, worth the read!
+
+If you are a Nest user, we have some sad news: Google announced that they are [shutting down the Nest API](/blog/2019/05/08/nest-data-bye-bye/) at the end of August. This will cause Nest hardware to no longer work with Home Assistant (╯°□°）╯︵ ┻━┻. **Update:** they have changed their plans, will only impact new users.
+
+As always, this release is accompanied by [a new episode of the Home Assistant podcast](https://hasspodcast.io/ha050/). Rohan and Phil discuss the new release, the Nest API and a lot more. This episode is their 50th episode already, congratulations on this milestone!
+
+Pascal has updated the way we are building Hass.io. It is now keeping the build up to date while we develop Home Assistant, which means that the Hass.io build was ready before the release blog post was up!
+
++ +## {% linkable_title Home Assistant 1.0 %} + +As we mentioned in [our updated plans post](/blog/2019/05/03/update-from-the-field/), we're working hard on Home Assistant 1.0. Over the next releases we will work on polishing the UI, the backend architecture, and everything in between. + +One of the new things that we introduced is a new step in our onboarding allowing users to set up integrations. We will automatically highlight discovered integrations. Once the user finishes the onboarding flow, entities will be automatically grouped by the areas that they are in. Neat! + +What is that?
— Pascal Vizeli (@pvizeli) May 16, 2019 +
🤪 pic.twitter.com/hRb60sSDeK
+
+
+
+We've also been working on polishing parts of our config UI. The automation editor will now show all automations, the last time they got triggered, and allow users to enable/disable them.
+
+
+
+Screenshot of the updated automation editor.
+
';
@@ -216,8 +216,8 @@ allComponents.pop(); // remove placeholder element at the end
* update the browser location hash. This enables users to use the browser-history
*/
function updateHash(newHash) {
- if ('replaceState' in history) {
- history.replaceState('', '', newHash);
+ if ('pushState' in history) {
+ history.pushState('', '', newHash);
} else {
location.hash = newHash;
}
@@ -265,9 +265,11 @@ allComponents.pop(); // remove placeholder element at the end
$('.component-search input').keyup(debounce(function() {
var text = $(this).val();
// sanitize input
- text = text.replace(/[(\?|\&\{\}\(\))]/gi, '');
- updateHash('#search/' + text);
- applyFilter();
+ text = text.replace(/[(\?|\&\{\}\(\))]/gi, '').trim();
+ if (typeof text === "string" && text.length !== 0) {
+ updateHash('#search/' + text);
+ applyFilter();
+ }
}, 500));
window.addEventListener('hashchange', applyFilter);
diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown
index eb0fb7f2dd8..bef555bf76c 100644
--- a/source/hassio/installation.markdown
+++ b/source/hassio/installation.markdown
@@ -147,19 +147,19 @@ A detailed guide about running Hass.io as a virtual machine is available in the
[balenaEtcher]: https://www.balena.io/etcher
[Virtual Appliance]: https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/ova.md
[hassos-network]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md
-[pi0-w]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_rpi0-w-2.11.img.gz
-[pi1]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_rpi-2.11.img.gz
-[pi2]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_rpi2-2.11.img.gz
-[pi3-32]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_rpi3-2.11.img.gz
-[pi3-64]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_rpi3-64-2.11.img.gz
-[tinker]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_tinker-2.11.img.gz
-[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_odroid-c2-2.11.img.gz
-[odroid-xu4]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_odroid-xu4-2.11.img.gz
-[opi-prime]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_opi-prime-2.11.img.gz
-[intel-nuc]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_intel-nuc-2.11.img.gz
-[vmdk]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_ova-2.11.vmdk.gz
-[vhdx]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_ova-2.11.vhdx.gz
-[vdi]: https://github.com/home-assistant/hassos/releases/download/2.11/hassos_ova-2.11.vdi.gz
+[pi0-w]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_rpi0-w-2.12.img.gz
+[pi1]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_rpi-2.12.img.gz
+[pi2]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_rpi2-2.12.img.gz
+[pi3-32]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_rpi3-2.12.img.gz
+[pi3-64]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_rpi3-64-2.12.img.gz
+[tinker]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_tinker-2.12.img.gz
+[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_odroid-c2-2.12.img.gz
+[odroid-xu4]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_odroid-xu4-2.12.img.gz
+[opi-prime]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_opi-prime-2.12.img.gz
+[intel-nuc]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_intel-nuc-2.12.img.gz
+[vmdk]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_ova-2.12.vmdk.gz
+[vhdx]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_ova-2.12.vhdx.gz
+[vdi]: https://github.com/home-assistant/hassos/releases/download/2.12/hassos_ova-2.12.vdi.gz
[linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio
[local]: http://hassio.local:8123
[samba]: /addons/samba/
diff --git a/source/images/blog/2019-05-nest-data-bye-bye/faq.png b/source/images/blog/2019-05-nest-data-bye-bye/faq.png
new file mode 100644
index 00000000000..0ae0898ab6b
Binary files /dev/null and b/source/images/blog/2019-05-nest-data-bye-bye/faq.png differ
diff --git a/source/images/blog/2019-05-nest-data-bye-bye/notice.png b/source/images/blog/2019-05-nest-data-bye-bye/notice.png
new file mode 100644
index 00000000000..114db07e155
Binary files /dev/null and b/source/images/blog/2019-05-nest-data-bye-bye/notice.png differ
diff --git a/source/images/blog/2019-05-release-93/automation-editor.png b/source/images/blog/2019-05-release-93/automation-editor.png
new file mode 100644
index 00000000000..b26584a58a6
Binary files /dev/null and b/source/images/blog/2019-05-release-93/automation-editor.png differ
diff --git a/source/images/blog/2019-05-release-93/components.png b/source/images/blog/2019-05-release-93/components.png
new file mode 100644
index 00000000000..62a476a4fe1
Binary files /dev/null and b/source/images/blog/2019-05-release-93/components.png differ
diff --git a/source/images/components/alexa/account_linking.png b/source/images/components/alexa/account_linking.png
new file mode 100644
index 00000000000..21de02ca2f3
Binary files /dev/null and b/source/images/components/alexa/account_linking.png differ
diff --git a/source/images/components/alexa/create_a_new_skill.png b/source/images/components/alexa/create_a_new_skill.png
new file mode 100644
index 00000000000..104a7317188
Binary files /dev/null and b/source/images/components/alexa/create_a_new_skill.png differ
diff --git a/source/images/components/alexa/create_iam_role_attach_permission.png b/source/images/components/alexa/create_iam_role_attach_permission.png
new file mode 100644
index 00000000000..f0db3c4b710
Binary files /dev/null and b/source/images/components/alexa/create_iam_role_attach_permission.png differ
diff --git a/source/images/components/alexa/lambda_function_env_var.png b/source/images/components/alexa/lambda_function_env_var.png
new file mode 100644
index 00000000000..edb8fbab2f1
Binary files /dev/null and b/source/images/components/alexa/lambda_function_env_var.png differ
diff --git a/source/images/supported_brands/ambiclimate.png b/source/images/supported_brands/ambiclimate.png
new file mode 100644
index 00000000000..ae941f22abd
Binary files /dev/null and b/source/images/supported_brands/ambiclimate.png differ
diff --git a/source/images/supported_brands/bizkaibus.png b/source/images/supported_brands/bizkaibus.png
new file mode 100755
index 00000000000..9904064200c
Binary files /dev/null and b/source/images/supported_brands/bizkaibus.png differ
diff --git a/source/images/supported_brands/essent.png b/source/images/supported_brands/essent.png
new file mode 100644
index 00000000000..b71cb038d3d
Binary files /dev/null and b/source/images/supported_brands/essent.png differ
diff --git a/source/images/supported_brands/incomfort.png b/source/images/supported_brands/incomfort.png
new file mode 100644
index 00000000000..41ee3f8375f
Binary files /dev/null and b/source/images/supported_brands/incomfort.png differ
diff --git a/source/images/supported_brands/iqvia.png b/source/images/supported_brands/iqvia.png
new file mode 100644
index 00000000000..6a89f0e37a1
Binary files /dev/null and b/source/images/supported_brands/iqvia.png differ
diff --git a/source/images/supported_brands/meteoalarm.png b/source/images/supported_brands/meteoalarm.png
new file mode 100644
index 00000000000..051e171170b
Binary files /dev/null and b/source/images/supported_brands/meteoalarm.png differ
diff --git a/source/images/supported_brands/pollen.jpg b/source/images/supported_brands/pollen.jpg
deleted file mode 100644
index 16311f0450a..00000000000
Binary files a/source/images/supported_brands/pollen.jpg and /dev/null differ
diff --git a/source/images/supported_brands/visual-studio.png b/source/images/supported_brands/visual-studio.png
new file mode 100644
index 00000000000..64af2161e6c
Binary files /dev/null and b/source/images/supported_brands/visual-studio.png differ
diff --git a/source/index.html b/source/index.html
index ddcff4f6af7..d91a0d43133 100644
--- a/source/index.html
+++ b/source/index.html
@@ -145,8 +145,6 @@ description: Open source home automation that puts local control and privacy fir
Home Assistant is sponsored by
-
-
