diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1b5db6f56d7..439b1e26c04 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,11 @@ **Description:** -**Pull request in [home-assistant](https://github.com/home-assistant/home-assistant) (if applicable):** home-assistant/home-assistant# +**Pull request in home-assistant (if applicable):** home-assistant/home-assistant# ## Checklist: -- [ ] Branch: `next` is for changes and new documentation that will go public with the next [home-assistant](https://github.com/home-assistant/home-assistant) release. Fixes, changes and adjustments for the current release should be created against `current`. +- [ ] Branch: `next` is for changes and new documentation that will go public with the next Home Assistant release. Fixes, changes and adjustments for the current release should be created against `current`. - [ ] The documentation follows the [standards][standards]. [standards]: https://developers.home-assistant.io/docs/documentation_standards.html diff --git a/Gemfile b/Gemfile index b09f53b62f0..1a06732930d 100644 --- a/Gemfile +++ b/Gemfile @@ -19,4 +19,4 @@ group :jekyll_plugins do end gem 'sinatra', '2.0.5' -gem 'nokogiri', '1.10.3' +gem 'nokogiri', '1.10.4' diff --git a/Gemfile.lock b/Gemfile.lock index f125a245016..222b24c147a 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -70,7 +70,7 @@ GEM mini_portile2 (2.4.0) multi_json (1.13.1) mustermann (1.0.3) - nokogiri (1.10.3) + nokogiri (1.10.4) mini_portile2 (~> 2.4.0) pathutil (0.16.2) forwardable-extended (~> 2.6) @@ -109,7 +109,7 @@ DEPENDENCIES jekyll-redirect-from (= 0.15.0) jekyll-sitemap (= 1.3.1) jekyll-time-to-read (= 0.1.2) - nokogiri (= 1.10.3) + nokogiri (= 1.10.4) rake (= 12.3.2) sass-globbing (= 1.1.5) sinatra (= 2.0.5) diff --git a/_config.yml b/_config.yml index b7388353e08..e2bb0812a7f 100644 --- a/_config.yml +++ b/_config.yml @@ -99,8 +99,8 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 97 -current_patch_version: 0 -date_released: 2019-08-07 +current_patch_version: 2 +date_released: 2019-08-12 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. diff --git a/source/_addons/samba.markdown b/source/_addons/samba.markdown index df767826ac6..488f0d75cf8 100644 --- a/source/_addons/samba.markdown +++ b/source/_addons/samba.markdown @@ -4,7 +4,7 @@ description: "Manage your Home Assistant and custom add-ons over Samba." featured: true --- -This add-on allows you to set up a [Samba](https://samba.org/) server to access Hass.io folders using Windows network shares. +This add-on allows you to set up a [Samba](https://www.samba.org) server to access Hass.io folders using Windows network shares.
diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown index 2097ba258c8..1791e897d33 100644 --- a/source/_components/alert.markdown +++ b/source/_components/alert.markdown @@ -153,7 +153,7 @@ binary_sensor: - platform: template sensors: motion_battery_low: - value_template: '{{ state_attr('sensor.motion', 'battery') < 15 }}' + value_template: "{{ state_attr('sensor.motion', 'battery') < 15 }}" friendly_name: 'Motion battery is low' alert: diff --git a/source/_components/alexa.smart_home.markdown b/source/_components/alexa.smart_home.markdown index f3618932853..b93b05bd19f 100644 --- a/source/_components/alexa.smart_home.markdown +++ b/source/_components/alexa.smart_home.markdown @@ -99,7 +99,7 @@ Next you need create a Lambda function. - 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: (modified code to support Alexa's proactive mode, see details below) - Scroll down a little bit, you will find `Environment variables`, you need add 4 environment variables: - * BASE_URL *(required)*: your Home Assistant instance's Internet accessible URL with port if need + * BASE_URL *(required)*: your Home Assistant instance's Internet accessible URL with port if needed. *Do not include the trailing `/`*. * NOT_VERIFY_SSL *(optional)*: you can set it to *True* to ignore the SSL issue, if you don't have a valid SSL certificate or you are using self-signed certificate. * DEBUG *(optional)*: set to *True* to log the debug message * LONG_LIVED_ACCESS_TOKEN *(optional, not recommend)*: you will connect your Alexa Smart Home skill with your Home Assistant user account in the later steps, so that you don't need to use long-lived access token here. However, the access token you got from login flow is only valid for 30 minutes. It will be hard for you to test lambda function with the access token in test data. So for your convinces, you can remove the access token from the test data, [generate a long-lived access token][generate-long-lived-access-token] put here, then the function will fall back to read token from environment variables. (tips: You did not enable the security storage for your environment variables, so your token saved here is not that safe. You should only use it for debugging and testing purpose. You should remove and delete the long-lived access token after you finish the debugging.) diff --git a/source/_components/androidtv.markdown b/source/_components/androidtv.markdown index 660860063a5..47e26e2e6a1 100644 --- a/source/_components/androidtv.markdown +++ b/source/_components/androidtv.markdown @@ -92,6 +92,11 @@ device_class: required: false default: auto type: string +state_detection_rules: + description: A dictionary whose keys are app IDs and whose values are lists of state detection rules; see the section [Custom State Detection](#custom-state-detection) for more info. + required: false + default: {} + type: map turn_on_command: description: An ADB shell command that will override the default `turn_on` command. required: false @@ -108,7 +113,8 @@ turn_off_command: # Example configuration.yaml entry media_player: # Use an ADB server to setup an Android TV device, provide - # an app name, and override the default turn on/off commands + # an app name, override the default turn on/off commands, + # and provide custom state detection rules - platform: androidtv name: Android TV device_class: androidtv @@ -118,6 +124,21 @@ media_player: com.amazon.tv.launcher: "Fire TV" turn_on_command: "input keyevent 3" turn_off_command: "input keyevent 223" + state_detection_rules: + 'com.amazon.tv.launcher': + - 'standby' + 'com.netflix.ninja': + - 'media_session_state' + 'com.ellation.vrv': + - 'audio_state' + 'com.plexapp.android': + - 'playing': + 'media_session_state': 3 # this indentation is important! + 'wake_lock_size': 3 # this indentation is important! + - 'paused': + 'media_session_state': 3 # this indentation is important! + 'wake_lock_size': 1 # this indentation is important! + - 'standby' # Use the Python ADB implementation with authentication # to setup a Fire TV device and don't get the running apps @@ -235,3 +256,18 @@ Available key commands include: The full list of key commands can be found [here](https://github.com/JeffLIrion/python-androidtv/blob/bf1058a2f746535921b3f5247801469c4567e51a/androidtv/constants.py#L143-L186). You can also use the command `GET_PROPERTIES` to retrieve the properties used by Home Assistant to update the device's state. These will be stored in the media player's `'adb_response'` attribute and logged at the INFO level, this information can be used to help improve state detection in the backend [androidtv](https://github.com/JeffLIrion/python-androidtv) package. + +## Custom State Detection + +The `state_detection_rules` configuration parameter allows you to provide your own rules for state detection. The keys are app IDs, and the values are lists of rules that are evaluated in order. Valid rules are: + +* `'standby'`, `'playing'`, `'paused'`, `'idle'`, `'stopped'`, or `'off'` + * If this is not a map, then this state will always be reported when this app is the current app + * If this is a map, then its entries are conditions that will be checked. If all of the conditions are true, then this state will be reported. Valid conditions pertain to 3 properties (see the example configuration above): + 1. ``'media_session_state'`` + 2. ``'audio_state'`` + 3. ``'wake_lock_size'`` +* `'media_session_state'` = try to use the `media_session_state` property to determine the state +* `'audio_state'` = try to use the `audio_state` property to determine the state + +To determine what these rules should be, you can use the `androidtv.adb_command` service with the command `GET_PROPERTIES`, as described in the [androidtv.adb_command](#androidtvadb_command) section. diff --git a/source/_components/apache_kafka.markdown b/source/_components/apache_kafka.markdown index 7169c51bd3e..9442b8613df 100644 --- a/source/_components/apache_kafka.markdown +++ b/source/_components/apache_kafka.markdown @@ -18,7 +18,7 @@ To use the `apache_kafka` integration in your installation, add the following to ```yaml apache_kafka: - ip_address: localhost + host: localhost port: 9092 topic: home_assistant_1 ``` diff --git a/source/_components/aquostv.markdown b/source/_components/aquostv.markdown index df895237204..5e87d5fd04a 100644 --- a/source/_components/aquostv.markdown +++ b/source/_components/aquostv.markdown @@ -74,5 +74,6 @@ Currently known supported models: - LC-60LE857U - LC-60EQ10U - LC-60SQ15U +- LC-50US40 (no volume control, not fully tested) If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.io/blob/current/source/_components/aquostv.markdown). diff --git a/source/_components/asuswrt.markdown b/source/_components/asuswrt.markdown index d4886aaac05..09e7cfa2edb 100644 --- a/source/_components/asuswrt.markdown +++ b/source/_components/asuswrt.markdown @@ -85,7 +85,7 @@ sensors:
-You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`. +You need to enable telnet on your router if you choose to use `protocol: telnet`.
diff --git a/source/_components/binary_sensor.knx.markdown b/source/_components/binary_sensor.knx.markdown index 34148af2a5a..2af616f8fd4 100644 --- a/source/_components/binary_sensor.knx.markdown +++ b/source/_components/binary_sensor.knx.markdown @@ -5,11 +5,19 @@ logo: knx.png ha_category: - Binary Sensor ha_release: 0.24 -ha_iot_class: Local Polling +ha_iot_class: Local Push --- +
+ +The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx). + +
+ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary sensors. +Binary sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/components/knx/#exposing-sensor-values-or-time-to-knx-bus). + ## Configuration The `knx` integration must be configured correctly, see [KNX Integration](/components/knx). @@ -18,11 +26,11 @@ The `knx` integration must be configured correctly, see [KNX Integration](/compo # Example configuration.yaml entry binary_sensor: - platform: knx - address: '6/0/2' + state_address: '6/0/2' ``` {% configuration %} -address: +state_address: description: KNX group address of the binary sensor. required: true type: string @@ -30,6 +38,11 @@ name: description: A name for this device used within Home Assistant. required: false type: string +sync_state: + description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. + required: false + type: boolean + default: True device_class: description: Sets the [class of the device](/components/binary_sensor/), changing the device state and icon that is displayed on the frontend. required: false @@ -54,7 +67,7 @@ You can also attach actions to binary sensors (e.g., to switch on a light when a binary_sensor: - platform: knx name: Livingroom.3Switch3 - address: '5/0/26' + state_address: '5/0/26' automation: - counter: 1 hook: 'on' diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index 3eff2ecfb53..e59acefa2a4 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -66,6 +66,15 @@ sensors: description: Defines a template for the entity picture of the sensor. required: false type: template + attribute_templates: + description: Defines templates for attributes of the sensor. + required: false + type: map + keys: + "attribute: template": + description: The attribute and corresponding template. + required: true + type: template delay_on: description: The amount of time the template state must be ***met*** before this sensor will switch to `on`. required: false @@ -210,6 +219,35 @@ binary_sensor: ``` {% endraw %} +### Device Tracker sensor with Latitude and Longitude Attributes + +This example shows how to combine an non-GPS (e.g. NMAP) and GPS device tracker while still including latitude and longitude attributes + +{% raw %} +```yaml +binary_sensor: + - platform: template + sensors: + my_device: + value_template: >- + {{ is_state('device_tracker.my_device_nmap','home') or is_state('device_tracker.my_device_gps','home') }} + device_class: 'presence' + attribute_templates: + latitude: >- + {% if is_state('device_tracker.my_device_nmap','home') %} + {{ state_attr('zone.home','latitude') }} + {% else %} + {{ state_attr('device_tracker.my_device_gps','latitude') }} + {% endif %} + longitude: >- + {% if is_state('device_tracker.my_device_nmap','home') %} + {{ state_attr('zone.home','longitude') }} + {% else %} + {{ state_attr('device_tracker.my_device_gps','longitude') }} + {% endif %} +``` +{% endraw %} + ### Change the icon when state changes This example demonstrates how to use `icon_template` to change the entity's diff --git a/source/_components/broadlink.markdown b/source/_components/broadlink.markdown index ff8b32e040e..c0bbc2c2b39 100644 --- a/source/_components/broadlink.markdown +++ b/source/_components/broadlink.markdown @@ -149,6 +149,11 @@ timeout: description: Timeout in seconds for the connection to the device. required: false type: integer +retry: + description: Retry times for fetch data if failed. + required: false + type: integer + default: 2 friendly_name: description: The name used to display the switch in the frontend. required: false @@ -216,6 +221,7 @@ switch: host: 192.168.1.2 mac: 'B4:43:0D:CC:0F:58' timeout: 15 + retry: 5 switches: # Will work on most Phillips TVs: tv_phillips: @@ -263,6 +269,7 @@ switch: host: IP_ADDRESS mac: 'MAC_ADDRESS' type: sp2 + retry: 5 friendly_name: 'Humidifier' ``` diff --git a/source/_components/buienradar.markdown b/source/_components/buienradar.markdown index 3eda01e9741..2a796080b5a 100644 --- a/source/_components/buienradar.markdown +++ b/source/_components/buienradar.markdown @@ -3,6 +3,7 @@ title: "Buienradar" description: "Instructions on how to integrate buienradar.nl weather within Home Assistant." logo: buienradar.png ha_category: + - Camera - Weather ha_release: 0.47 ha_iot_class: Cloud Polling @@ -14,6 +15,11 @@ The `buienradar` platform uses [buienradar.nl](http://buienradar.nl/) as a sourc The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the Buienradar weather/sensor component). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0). +Besides the weather platform, there is currently support for the following additional device types: + +- [Camera](#camera): Radar map +- [Sensor](/components/sensor.buienradar/): More customizable + ## Configuration To add the Buienradar weather to your installation, add the following to your `configuration.yaml` file: @@ -59,6 +65,7 @@ weather: forecast: true ``` +
This platform is an alternative to the [`buienradar`](/components/sensor.buienradar/) sensor. @@ -66,5 +73,47 @@ The weather platform is easier to configure but less customizable.
+## Camera + +The `buienradar` camera platform uses [buienradar.nl](http://buienradar.nl/) as a source for the last rain radar map. The overview image of the whole of the Netherlands is loaded and shown as a camera in Home Assistant. + +Internally this component uses the radar map image as [documented](https://www.buienradar.nl/overbuienradar/gratis-weerdata) on buienradar.nl. +The downloaded image is cached to prevent Home Assistant from making a new request to buienradar.nl multiple times a minute when Home Assistant checks for new stills from the camera. + +To add `buienradar` camera to Home Assistant, add the following section to your +`configuration.yaml` file: +```yaml +# Example configuration.yaml entry +camera: + - platform: buienradar +``` + +{% configuration %} +name: + description: You can (optionally) specify the name of the camera. The name + will be shown in the user interface below the radar image. + required: false + type: string +dimension: + description: Size of the image to be loaded from buienradar.nl + (120 to 700 pixels) + required: false + default: 512 + type: integer +delta: + description: Time interval in seconds between image updates + required: false + default: 600 + type: integer +{% endconfiguration %} + +### The `name` Variable + +If you specify a name, the camera will get this name as its label. A slugified +version of the name will be used as the name of the entity. + +With the default of "Buienradar loop" the entity name becomes +`camera.buienradar_loop`. + [Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata) > Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your use or to request permission. diff --git a/source/_components/calendar.google.markdown b/source/_components/calendar.google.markdown index 1c54c4fdc0a..fb2ade2bd60 100644 --- a/source/_components/calendar.google.markdown +++ b/source/_components/calendar.google.markdown @@ -65,7 +65,7 @@ track_new_calendar: The next steps will require you to have Home Assistant running. -After you have it running complete the Google authentication that pops up in notification (the little bell icon in the upper right corner). +After you have it running complete the Google authentication that pops up in notification (the little bell icon in the lower left corner). It will give you a URL and a code to enter. This will grant your Home Assistant service access to all the Google Calendars that the account you diff --git a/source/_components/camera.markdown b/source/_components/camera.markdown index 1ba029c33f7..03eb5bd36c7 100644 --- a/source/_components/camera.markdown +++ b/source/_components/camera.markdown @@ -26,7 +26,23 @@ This option will keep the stream alive, and preload the feed on Home Assistant s Once loaded, the `camera` platform will expose services that can be called to perform various actions. -Available services: `turn_on`, `turn_off`, `enable_motion_detection`, `disable_motion_detection`, `snapshot`, and `play_stream`. +Available services: `enable_motion_detection`, `disable_motion_detection`, `play_stream`, `record`, `snapshot`, `turn_off` and `turn_on`. + +#### Service `enable_motion_detection` + +Enable the motion detection in a camera. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.living_room_camera`. | + +#### Service `disable_motion_detection` + +Disable the motion detection in a camera. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.living_room_camera`. | #### Service `play_stream` @@ -48,61 +64,6 @@ action: media_player: media_player.chromecast ``` -#### Service `turn_on` - -Turn on camera. Not all camera models support this service, please consult individual camera page. - -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | Name(s) of entities to turn on, e.g., `camera.living_room_camera`. | - -#### Service `turn_off` - -Turn off camera. Not all camera models support this service, please consult individual camera page. - -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | Name(s) of entities to turn off, e.g., `camera.living_room_camera`. | - -#### Service `enable_motion_detection` - -Enable the motion detection in a camera. - -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.living_room_camera`. | - -#### Service `disable_motion_detection` - -Disable the motion detection in a camera. - -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.living_room_camera`. | - -#### Service `snapshot` - -Take a snapshot from a camera. - -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. | -| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}`{% endraw %}. | - -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 snapshot from "yourcamera" and save it to /tmp with a timestamped filename. - -{% raw %} -```yaml -action: - service: camera.snapshot - data: - entity_id: camera.yourcamera - filename: '/tmp/yourcamera_{{ now().strftime("%Y%m%d-%H%M%S") }}.jpg' -``` -{% endraw %} - #### Service `record` Make a `.mp4` recording from a camera stream. Requires `stream` integration to be set up. @@ -130,6 +91,45 @@ action: ``` {% endraw %} +#### Service `snapshot` + +Take a snapshot from a camera. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. | +| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}`{% endraw %}. | + +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 snapshot from "yourcamera" and save it to /tmp with a timestamped filename. + +{% raw %} +```yaml +action: + service: camera.snapshot + data: + entity_id: camera.yourcamera + filename: '/tmp/yourcamera_{{ now().strftime("%Y%m%d-%H%M%S") }}.jpg' +``` +{% endraw %} + +#### Service `turn_off` + +Turn off camera. Not all camera models support this service, please consult individual camera page. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | Name(s) of entities to turn off, e.g., `camera.living_room_camera`. | + +#### Service `turn_on` + +Turn on camera. Not all camera models support this service, please consult individual camera page. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | Name(s) of entities to turn on, e.g., `camera.living_room_camera`. | + ### Test if it works A simple way to test if you have set up your `camera` platform correctly, is to use service developer tool icon **Services** from the **Developer Tools**. Choose your service from the dropdown menu **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**. @@ -138,4 +138,4 @@ A simple way to test if you have set up your `camera` platform correctly, is to { "entity_id": "camera.living_room_camera" } -``` \ No newline at end of file +``` diff --git a/source/_components/climate.knx.markdown b/source/_components/climate.knx.markdown index 9abcffc5443..a0d63bac21b 100644 --- a/source/_components/climate.knx.markdown +++ b/source/_components/climate.knx.markdown @@ -5,12 +5,16 @@ logo: knx.png ha_category: - Climate ha_release: 0.25 -ha_iot_class: Local Polling +ha_iot_class: Local Push --- -The `knx` climate platform is used as in interface with KNX thermostats. +
+ +The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx). -The `knx` integration must be configured correctly, see [KNX Integration](/components/knx). +
+ +The `knx` climate platform is used as an interface to KNX thermostats and room controllers. To use your KNX thermostats in your installation, add the following lines to your `configuration.yaml` file: @@ -24,6 +28,7 @@ climate: setpoint_shift_state_address: '5/1/3' target_temperature_state_address: '5/1/4' operation_mode_address: '5/1/5' + operation_mode_state_address: '5/1/6' ``` Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode: @@ -40,10 +45,11 @@ climate: operation_mode_frost_protection_address: '5/1/5' operation_mode_night_address: '5/1/6' operation_mode_comfort_address: '5/1/7' + operation_mode_state_address: '5/1/8' ``` If your device doesn't support setpoint_shift calculations (i.e. if you don't provide a `setpoint_shift_address` value) please set the `min_temp` and `max_temp` -attributes of the climate device to avoid issues with increasing the temperature in the frontend. Please do also make sure to add the `target_temperature_address` +attributes of the climate device to avoid issues with exceeding valid temperature values in the frontend. Please do also make sure to add the `target_temperature_address` to the config in this case.: ```yaml @@ -57,11 +63,13 @@ climate: operation_mode_frost_protection_address: '5/1/5' operation_mode_night_address: '5/1/6' operation_mode_comfort_address: '5/1/7' + operation_mode_state_address: '5/1/8' min_temp: 7.0 max_temp: 32.0 ``` `operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` is specified. +If the actor doesn't support explicit state communication objects the *_state_address can be configured with the same group address as the writeable *_address. The Read-Flag for the *_state_address communication object has to be set in ETS to support initial reading eg. when starting home-assistant. The following values are valid for the `hvac_mode` attribute: @@ -86,27 +94,27 @@ name: default: KNX Climate type: string temperature_address: - description: KNX group address for reading current room temperature from KNX bus. + description: KNX group address for reading current room temperature from KNX bus. *DPT 9.001* required: true type: string target_temperature_address: - description: KNX group address for setting target temperature. + description: KNX group address for setting target temperature. *DPT 9.001* required: false type: string target_temperature_state_address: - description: KNX group address for reading current target temperature from KNX bus. + description: KNX group address for reading current target temperature from KNX bus. *DPT 9.001* required: true type: string setpoint_shift_address: - description: KNX address for setpoint_shift. + description: KNX address for setpoint_shift. *DPT 6.010* required: false type: string setpoint_shift_state_address: - description: Explicit KNX address for reading setpoint_shift. + description: KNX address for reading setpoint_shift. *DPT 6.010* required: false type: string setpoint_shift_step: - description: Defines for step size in Kelvin for each step of setpoint_shift. + description: Defines the step size in Kelvin for each step of setpoint_shift. required: false default: 0.5 type: float @@ -114,18 +122,18 @@ setpoint_shift_min: description: Minimum value of setpoint shift. required: false default: -6 - type: integer + type: float setpoint_shift_max: description: Maximum value of setpoint shift. required: false default: 6 - type: integer + type: float operation_mode_address: - description: KNX address for operation mode (Frost protection/night/comfort). + description: KNX address for setting operation mode (Frost protection/night/comfort). *DPT 20.102* required: false type: string operation_mode_state_address: - description: Explicit KNX address for reading operation mode. + description: KNX address for reading operation mode. *DPT 20.102* required: false type: string controller_status_address: @@ -133,15 +141,15 @@ controller_status_address: required: false type: string controller_status_state_address: - description: Explicit KNX address for reading HVAC controller status. + description: KNX address for reading HVAC controller status. required: false type: string controller_mode_address: - description: KNX address for handling controller modes. + description: KNX address for setting HVAC controller modes. *DPT 20.105* required: false type: string controller_mode_state_address: - description: Explicit KNX address for reading HVAC Control Mode. + description: KNX address for reading HVAC Control Mode. *DPT 20.105* required: false type: string operation_mode_frost_protection_address: diff --git a/source/_components/climate.markdown b/source/_components/climate.markdown index 07687206975..1b367c3e967 100644 --- a/source/_components/climate.markdown +++ b/source/_components/climate.markdown @@ -168,7 +168,7 @@ automation: ### Service `climate.set_swing_mode` -Set operation mode for climate device +Set swing operation mode for climate device | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | diff --git a/source/_components/cover.knx.markdown b/source/_components/cover.knx.markdown index e8f48ef6ca7..ff25c2eef65 100644 --- a/source/_components/cover.knx.markdown +++ b/source/_components/cover.knx.markdown @@ -5,13 +5,16 @@ logo: knx.png ha_category: - Cover ha_release: 0.48 -ha_iot_class: Local Polling +ha_iot_class: Local Push --- +
-The `knx` cover platform is used as in interface with KNX covers. +The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx). -The `knx` integration must be configured correctly, see [KNX Integration](/components/knx). +
+ +The `knx` cover platform is used as an interface to KNX covers. To use your KNX covers in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/cppm.markdown b/source/_components/cppm_tracker.markdown similarity index 97% rename from source/_components/cppm.markdown rename to source/_components/cppm_tracker.markdown index d30b472ec27..c8d86e219fc 100644 --- a/source/_components/cppm.markdown +++ b/source/_components/cppm_tracker.markdown @@ -6,6 +6,8 @@ ha_category: - Presence Detection ha_release: "0.90" ha_iot_class: Local Polling +redirect_from: + - /components/cppm/ --- This platform allows you to detect presence by looking at connected devices to [Aruba Clearpass](https://www.arubanetworks.com/products/security/network-access-control/). diff --git a/source/_components/darksky.markdown b/source/_components/darksky.markdown index c7ae5bca389..3c8f07eae5a 100644 --- a/source/_components/darksky.markdown +++ b/source/_components/darksky.markdown @@ -84,9 +84,9 @@ monitored_conditions: summary: description: A human-readable text summary. icon: - description: A machine-readable text summary, suitable for selecting an icon for display. See [Dark Sky API documentation][] for the list of possible values. + description: A machine-readable text summary, suitable for selecting an icon for display. See [Dark Sky API documentation](https://darksky.net/dev/docs) for the list of possible values. precip_type: - description: The type of precipitation occurring at the given time. If `precip_intensity` is zero, then this property will be `unknown`. See [Dark Sky API documentation][] for the list of possible values. + description: The type of precipitation occurring at the given time. If `precip_intensity` is zero, then this property will be `unknown`. See [Dark Sky API documentation](https://darksky.net/dev/docs) for the list of possible values. precip_intensity: description: The intensity of precipitation occurring at the given time. This value is conditional on probability (that is, assuming any precipitation occurs at all). precip_probability: @@ -238,7 +238,4 @@ All language options are described in this table that you can use for the dark s While the platform is called "darksky" the sensors will show up in Home Assistant as "dark_sky" (eg: sensor.dark_sky_summary).
-More details about the API are available in the [Dark Sky API documentation][]. - -[Dark Sky API documentation]: https://darksky.net/dev/docs - +More details about the API are available in the [Dark Sky API documentation](https://darksky.net/dev/docs). diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index b88395d9023..3b205c7491f 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -320,6 +320,8 @@ The `entity_id` name will be `binary_sensor.device_name`, where `device_name` is - Philips Hue Motion Sensor - Xiaomi Motion Sensor - Xiaomi Smart Home Aqara Human Body Sensor +- Water leakage detection + - Xiaomi Aqara water leak Sensor ## Climate @@ -340,7 +342,7 @@ The `entity_id` name will be `climate.device_name`, where `device_name` is defin Covers are devices like ventilation dampers or smart window covers. -Note that devices in the cover platform identify as lights, so there is a manually curated list that defines which "lights" are covers. +Note that devices in the cover platform identify as lights, so there is a manually curated list that defines which "lights" are covers. You therefore add a cover device as a light device in deCONZ (phoscon app). The `entity_id` name will be `cover.device_name`, where `device_name` is defined in deCONZ. diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown index 62f7868afb9..eebb94698b7 100644 --- a/source/_components/dialogflow.markdown +++ b/source/_components/dialogflow.markdown @@ -39,8 +39,6 @@ To get the webhook URL, go to the integrations page in the configuration screen - Click on "Create Agent" - Select name, language (if you are planning to use Google Actions check their [supported languages](https://support.google.com/assistant/answer/7108196?hl=en)) and time zone - Click "Save" -- Go to project settings (cog symbol in left menu) -- under "API VERSION" click on "V1 API" - Now go to "Fulfillment" (in the left menu) - Enable Webhook and set your Dialogflow webhook url as the endpoint, e.g., `https://myhome.duckdns.org/api/webhook/800b4cb4d27d078a8871656a90854a292651b20635685f8ea23ddb7a09e8b417` - Click "Save" @@ -53,6 +51,12 @@ To get the webhook URL, go to the integrations page in the configuration screen - On the top right, where is written "Try it now...", write, or say, the phrase you have previously defined and hit enter - Dialogflow has send a request to your Home Assistant server +
+ + The V1 api will be deprecated on October 23, 2019. If you are still using the V1 API, it is recommended to change your settings in Dialogflow to use the V2 API. No changes to your intents yaml configuration need to take place after upgrading to the V2 API. Change to the V2 API by clicking on the cog button [here](https://console.dialogflow.com/) and then select the V2 API. + +
+ Take a look to "Integrations", in the left menu, to configure third parties. ### Configuring Home Assistant diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index 004ac5f2633..2f02b20e83d 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -140,6 +140,17 @@ The _HVAC mode_ of the device is the currently active operational modes that the Ecobee thermostat provides: heat, auxHeatOnly, cool, auto, and off. +## Attributes + +The Ecobee climate entity has some extra attributes to represent the state of the thermostat. + +| Name | Description | +| ---- | ----------- | +| `fan` | If the fan is currently on or off: `on` / `off`. +| `climate_mode` | This is the climate mode that is active, or would be active if no override is active. +| `equipment_running` | This is a comma seperated list of equipment that is currently running. +| `fan_min_on_time` | The minimum amount of minutes that the fan will be on when it's turned on. + ## Services Besides the standard services provided by the Home Assistant [Climate](https://www.home-assistant.io/components/climate/) integration, the following extra service is provided by the Ecobee Thermostat: `resume_program`. diff --git a/source/_components/edp_redy.markdown b/source/_components/edp_redy.markdown deleted file mode 100644 index a1a8347af11..00000000000 --- a/source/_components/edp_redy.markdown +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "EDP re:dy" -description: "Instructions on how to integrate the EDP re:dy platform into Home Assistant." -logo: edp_redy.png -ha_category: - - Hub - - Sensor - - Switch -ha_release: 0.79 -ha_iot_class: Cloud Polling -redirect_from: - - /components/sensor.edp_redy/ - - /components/switch.edp_redy/ ---- - -[EDP re:dy](https://www.edp.pt/particulares/servicos/redy/) is a Home Automation platform from Portuguese energy provider EDP, that allows control of appliances and other devices, as well as monitoring power consumption. This integration allows integrating EDP re:dy into Home Assistant. - -## Configuration - -You will need your re:dy login information (username and password) to use this component. - -To set it up, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -edp_redy: - username: YOUR_USERNAME - password: YOUR_PASSWORD -``` - -{% configuration %} -username: - description: The username for accessing your re:dy account. - required: true - type: string -password: - description: The password for accessing your re:dy account. - required: true - type: string -{% endconfiguration %} - -After configuring the component, it will automatically add to Home Assistant: - -* A switch per toggleable device (switch, plug, etc). -* A sensor per each device that reports power consumption (SmartMeter, plug, meter) diff --git a/source/_components/environment_canada.markdown b/source/_components/environment_canada.markdown index 8b07398d502..8ec9178bbeb 100644 --- a/source/_components/environment_canada.markdown +++ b/source/_components/environment_canada.markdown @@ -129,7 +129,7 @@ longitude: required: inclusive type: float station: - description: The station code of a specific weather station to use. If provided, this station will be used and any latitude/longitude coordinates provided will be ignored. Station codes must be in the form of `AB/s0000123`, where `AB`is a provincial abbreviation and `s0000123` is a numeric station code. + description: The station code of a specific weather station to use. If provided, this station will be used and any latitude/longitude coordinates provided will be ignored. Station codes must be in the form of `AB/s0000123`, where `AB`is a provincial abbreviation and `s0000123` is a numeric station code. required: false type: string language: @@ -144,7 +144,7 @@ scan_interval: default: 600 {% endconfiguration %} -###Alert TTS Script +### Alert TTS Script If you would like to have alerts announced via a text-to-speech service, you can use a script similar to the following: @@ -177,7 +177,7 @@ camera: - If no name is given, the camera entity will be named `camera._radar`. - The platform automatically determines which radar station to use based on the system's latitude/longitude settings. For greater precision, it is also possible to specify either: - - A specific station ID from [this table](https://en.wikipedia.org/wiki/Canadian_weather_radar_network#List_of_radars) (remove the leading `C`, e.g. `XFT` or `ASBV`), or + - A specific station ID from [this table](https://en.wikipedia.org/wiki/Canadian_weather_radar_network#List_of_radars). The code must be in the form `XXX` or `CXXXX`, i.e., remove the leading `C` only if the result forms a three-letter code, otherwise, include it. Valid values include `XFT` for Ottawa or `CASBV` for Montreal. - A specific latitude/longitude {% configuration %} @@ -190,7 +190,7 @@ longitude: required: inclusive type: float station: - description: The station code of a specific radar station to use. If provided, this station will be used and any latitude/longitude coordinates provided will be ignored. + description: The station code of a specific radar station to use. If provided, this station will be used and any latitude/longitude coordinates provided will be ignored. Must be in the form `XXX` or `CXXXX`. required: false type: string name: diff --git a/source/_components/fedex.markdown b/source/_components/fedex.markdown index f76314d70bb..384656d9c82 100644 --- a/source/_components/fedex.markdown +++ b/source/_components/fedex.markdown @@ -10,6 +10,14 @@ redirect_from: - /components/sensor.fedex/ --- +
+ +This integration is deprecated and will be removed in Home Assistant 0.100.0. + +For more information see [Architecture Decision Record: 0004](https://github.com/home-assistant/architecture/blob/master/adr/0004-webscraping.md). + +
+ The `fedex` platform allows one to track deliveries by [FedEx](http://www.fedex.com/). To use this sensor, you need a [FedEx Delivery Manager](https://www.fedex.com/us/delivery/) account. ## Configuration diff --git a/source/_components/fortigate.markdown b/source/_components/fortigate.markdown index 3d063e675d4..a5e2b815d25 100644 --- a/source/_components/fortigate.markdown +++ b/source/_components/fortigate.markdown @@ -43,7 +43,7 @@ Add the following to your `configuration.yaml` file: # Example configuration.yaml entry fortigate: host: HOST_IP - username: YPUR_USERNAME + username: YOUR_USERNAME api_key: YOUR_API_KEY ``` diff --git a/source/_components/fortios.markdown b/source/_components/fortios.markdown index 404f369cc8e..4ec9a0de4c0 100644 --- a/source/_components/fortios.markdown +++ b/source/_components/fortios.markdown @@ -31,7 +31,7 @@ host: required: true type: string token: - description: "See [Fortinet Developer Network](https://fndn.fortinet.com) for how to create an API token. Remember this integration only needs read access to a FortiGate, so configure the API user to only to have limited and read-only access." + description: "See [Fortinet Developer Network](https://fndn.fortinet.net) for how to create an API token. Remember this integration only needs read access to a FortiGate, so configure the API user to only to have limited and read-only access." required: true type: string verify_ssl: diff --git a/source/_components/fronius.markdown b/source/_components/fronius.markdown index fb23ba7b51c..d317d18af1d 100644 --- a/source/_components/fronius.markdown +++ b/source/_components/fronius.markdown @@ -9,7 +9,7 @@ ha_iot_class: Local Polling ha_release: 0.96 --- -The `fronius` sensor will poll a [Fronius](http://www.fronius.com/) solar inverter, battery system or smart meter and present the values as sensors (or attributes of sensors) in Home Assistant. +The `fronius` sensor polls a [Fronius](http://www.fronius.com/) solar inverter, battery system or smart meter and present the values as sensors in Home Assistant. ## Configuration @@ -33,7 +33,7 @@ monitored_conditions: required: true type: list keys: - type: + sensor_type: description: "The kind of device, can be one of \"inverter\", \"storage\", \"meter\", or \"power_flow\"" required: true type: string @@ -48,6 +48,44 @@ monitored_conditions: default: "\"1\" for inverters and \"0\" for other devices such as storages in compliance with Fronius Specs" {% endconfiguration %} +## Monitored data + +Each sensor type chosen as monitored condition adds a set of sensors to Home Assistant. + +- `power_flow` + + Cumulative data such as the energy produced in the current day or year and overall produced energy. + Also, live values such as: + + - Power fed to the grid (if positive) or taken from the grid (if negative). + - Power load as a generator (if positive) or consumer (if negative). + - Battery charging power (if positive) or discharging power (if negative) and information about backup or standby mode. + - Photovoltaic production. + - Current relative self-consumption of produced energy. + - Current relative autonomy. + +- `inverter` + + Cumulative data such as the energy produced in the current day or year and overall produced energy. + Also, live values about AC/DC power, current, voltage and frequency. + The data is only shown when choosing device scope. + +- `meter` + + Detailed information about power, current and voltage, if supported split among the phases. + The data is only shown when choosing device scope. + +- `storage` + + Detailed information about current, voltage, state, cycle count, capacity and more about installed batteries. + +Note that some data (like photovoltaic production) is only provided by the Fronius device when non-zero. +The corresponding sensors are added to Home Assistant as entities as soon as they are available. +This means for example that when Home Assistant is started at night, +there might be no sensor providing photovoltaic related data. +This does not need to be problematic as the values will be added on sunrise, +when the Fronius devices begins providing the needed data. + ## Examples When including more of the components that one Fronius device offers, @@ -68,31 +106,3 @@ sensor: device: 0 - sensor_type: power_flow ``` - -## Sensors configuration - -To extract more detailed values from the state of each integrated sensor and to circumvent undefined values, -it is recommended to use template sensors as an interface: - -{% raw %} -```yaml -- platform: template - sensors: - electricity_inverter1_power_netto: - unit_of_measurement: 'W' - value_template: >- - {% if states.sensor.fronius_1921684247_inverter_1.attributes.power_ac is defined -%} - {{ states_attr('sensor.fronius_1921684247_inverter_1', 'power_ac') | float | round(2) }} - {%- else -%} - 0 - {%- endif %} - electricity_autonomy: - unit_of_measurement: '%' - value_template: >- - {% if states.sensor.fronius_1921684247_power_flow.attributes.relative_autonomy is defined -%} - {{ states_attr('sensor.fronius_1921684247_power_flow', 'relative_autonomy') | float | round(2) }} - {%- else -%} - 0 - {%- endif %} -``` -{% endraw %} diff --git a/source/_components/frontend.markdown b/source/_components/frontend.markdown index 6efe0efa3da..508ae23f407 100644 --- a/source/_components/frontend.markdown +++ b/source/_components/frontend.markdown @@ -17,7 +17,7 @@ frontend: {% configuration %} javascript_version: - description: "Version of the JavaScript to serve to clients. Options: `es5` - transpiled so old browsers understand it. `latest` - not transpiled, so will work on recent browsers only. `auto` - select a version according to the browser user-agent. The value in the config can be overiden by putting `es5` or `latest` in the URL. For example `http://localhost:8123/states?es5` " + description: "DEPRECATED, it is now done using feature detection in the browser. Version of the JavaScript to serve to clients. Options: `es5` - transpiled so old browsers understand it. `latest` - not transpiled, so will work on recent browsers only. `auto` - select a version according to the browser user-agent. The value in the config can be overiden by putting `es5` or `latest` in the URL. For example `http://localhost:8123/states?es5` " required: false type: string default: auto @@ -86,7 +86,6 @@ Set a theme at the startup of Home Assistant: ```yaml automation: - alias: 'Set theme at startup' - initial_state: 'on' trigger: - platform: homeassistant event: start @@ -101,7 +100,6 @@ To enable "night mode": ```yaml automation: - alias: 'Set dark theme for the night' - initial_state: true trigger: - platform: time at: '21:00:00' diff --git a/source/_components/garadget.markdown b/source/_components/garadget.markdown index 38f382effe0..2d5e969d857 100644 --- a/source/_components/garadget.markdown +++ b/source/_components/garadget.markdown @@ -89,13 +89,13 @@ sensor: sensors: garage_door_status: friendly_name: 'State of the door' - value_template: '{{ states('cover.garage_door') }}' + value_template: "{{ states('cover.garage_door') }}" garage_door_time_in_state: friendly_name: 'Since' - value_template: '{{ state_attr('cover.garage_door', 'time_in_state') }}' + value_template: "{{ state_attr('cover.garage_door', 'time_in_state') }}" garage_door_wifi_signal_strength: friendly_name: 'WiFi strength' - value_template: '{{ state_attr('cover.garage_door', 'wifi_signal_strength') }}' + value_template: "{{ state_attr('cover.garage_door', 'wifi_signal_strength') }}" unit_of_measurement: 'dB' group: diff --git a/source/_components/gc100.markdown b/source/_components/gc100.markdown index b073fba7e30..11765aaa454 100644 --- a/source/_components/gc100.markdown +++ b/source/_components/gc100.markdown @@ -17,7 +17,8 @@ hardware device which has an array of relays, RS232 serial ports, and flexible p There is currently support for the following device types within Home Assistant: -- [Binary Sensor](binary-sensor) +- [Configuration](#configuration) +- [Binary Sensor](#binary-sensor) - [Switch](#switch) Currently, only relays and ports configured to be digital inputs are supported in Home Assistant. For IR support, please use the [iTach remote platform](/components/remote.itach/), but note that it will likely not function concurrently on the same GC100 due to limitations in the TCP socket server implementation used by Global Caché. diff --git a/source/_components/generic_thermostat.markdown b/source/_components/generic_thermostat.markdown index ce18077f285..ded18e84a9b 100644 --- a/source/_components/generic_thermostat.markdown +++ b/source/_components/generic_thermostat.markdown @@ -77,7 +77,7 @@ initial_hvac_mode: required: false type: string away_temp: - description: Set the temperature used by "away_mode". If this is not specified, away_mode feature will not get activated. + description: "Set the temperature used by `preset_mode: away`. If this is not specified, the preset mode feature will not be available." required: false type: float precision: @@ -91,7 +91,7 @@ A full configuration example looks like the one below. `min_cycle_duration` and Currently the `generic_thermostat` climate platform supports 'heat', 'cool' and 'off' hvac modes. You can force your `generic_thermostat` to avoid starting by setting HVAC mode to 'off'. -Please note that changing Away Mode you will force a target temperature change as well that will get restored once the Away Mode is turned off. +Please note that when changing the preset mode to away, you will force a target temperature change as well that will get restored once the preset mode is set to none again. ```yaml # Full example configuration.yaml entry diff --git a/source/_components/geo_location.markdown b/source/_components/geo_location.markdown index a4ef666e619..cd95864cf06 100644 --- a/source/_components/geo_location.markdown +++ b/source/_components/geo_location.markdown @@ -16,6 +16,7 @@ The [Geolocation trigger](/docs/automation/trigger/#geolocation-trigger) can be | Platform | Source | |---------------------------------------------------|-------------------------------| | GeoJSON Events | `geo_json_events` | +| GeoNet New Zealand Quakes | `geonetnz_quakes` | | IGN Sismología | `ign_sismologia` | | NSW Rural Fire Service Incidents | `nsw_rural_fire_service_feed` | | Queensland Bushfire Alert | `qld_bushfire` | diff --git a/source/_components/geonetnz_quakes.markdown b/source/_components/geonetnz_quakes.markdown new file mode 100644 index 00000000000..56753cc44d9 --- /dev/null +++ b/source/_components/geonetnz_quakes.markdown @@ -0,0 +1,115 @@ +--- +title: "GeoNet NZ Quakes" +description: "Instructions on how to integrate the GeoNet New Zealand Quakes feed into Home Assistant." +logo: geonet-nz.png +ha_category: + - Geolocation +ha_iot_class: Cloud Polling +ha_release: 0.98 +--- + +The `geonetnz_quakes` integration lets you use a GeoJSON feed provided by +New Zealand's [GeoNet](https://www.geonet.org.nz/) with information +about quakes in the New Zealand region that happened within the last 7 days. +It retrieves incidents from a feed and +shows information of those incidents filtered by distance to Home Assistant's +location. + +Entities are generated, updated and removed automatically with each update +from the feed. Each entity defines latitude and longitude and will be shown +on the default map automatically, or on a map card by defining the source +`geonetnz_quakes`. The distance is available as the state of each entity, and +converted to the unit (kilometers or miles) configured in Home Assistant. + +

+ +

+ +The data is updated every 5 minutes. + +
+ +The material used by this integration is provided under the [Creative Commons Attribution 3.0 New Zealand (CC BY 3.0 NZ) license](http://creativecommons.org/licenses/by/3.0/nz/). +It has only been modified for the purpose of presenting the material in Home Assistant. +Please refer to the [creator's disclaimer notice](https://www.geonet.org.nz/disclaimer) and [data policy](https://www.geonet.org.nz/policy) for more information. + +We acknowledge the New Zealand GeoNet project and its sponsors EQC, GNS Science and LINZ, for providing data/images used in this integration. + +
+ + +## Configuration + +To integrate the GeoNet New Zealand Quakes feed use the "Integrations" feature +in the GUI, you find it under Configurations - Integrations, or add the +following line to your `configuration.yaml`. + +```yaml +# Example configuration.yaml entry +geonetnz_quakes: +``` + +{% configuration %} +mmi: + description: Request quakes that may have caused shaking greater than or equal to the [MMI](https://www.geonet.org.nz/earthquake/mmi) value. Allowable values are -1..8 inclusive. Value -1 is used for quakes that are too small to calculate a stable MMI value for. + required: false + type: integer + default: 2 +minimum_magnitude: + description: The minimum magnitude of an earthquake to be included. + required: false + type: float + default: 0.0 +radius: + description: The radius around your location to monitor; defaults to 50 km or mi (depending on the unit system defined in your `configuration.yaml`). + required: false + type: float + default: 50.0 +latitude: + description: Latitude of the coordinates around which quakes are considered. + required: false + type: float + default: Latitude defined in your configuration. +longitude: + description: Longitude of the coordinates around which quakes are considered. + required: false + type: float + default: Longitude defined in your configuration. +{% endconfiguration %} + + +## State Attributes + +The following state attributes are available for each entity in addition to +the standard ones: + +| Attribute | Description | +|-------------|-------------| +| latitude | Latitude of the quake. | +| longitude | Longitude of the quake. | +| source | `geonetnz_quakes` to be used in conjunction with `geo_location` automation trigger. | +| external_id | The external ID used in the feed to identify the quake in the feed. | +| title | Title of this entry. | +| mmi | The calculated MMI shaking at the closest locality in the New Zealand region. +| magnitude | The summary magnitude for the quake. | +| depth | The depth of the quake in km. | +| time | The origin date and time of the quake. | +| locality | Distance and direction to the nearest locality. | +| quality | The quality of this information: best, good, caution, deleted. | + +Please note that the reported MMI may be lower than the minimum requested MMI. +This integration is passing the requested MMI value to the feed source and +displays all entries retrieved without further filtering by MMI. + + +## Full Configuration + +```yaml +# Example configuration.yaml entry +geonetnz_quakes: + radius: 100 + mmi: 4 + minimum_magnitude: 4.5 + latitude: -41.2 + longitude: 174.7 +``` diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index 4dc35bc5a0b..45c030da0be 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -79,11 +79,12 @@ You need to create an API Key with the [Google Cloud API Console](https://consol 9. Testing instructions: Enter anything. It doesn't matter since you won't submit this app. Screenshot: Account linking - -3. Back on the overview page. Click `Simulator` under `TEST`. It will create a new draft version Test App. You don't have to actually test, but you need to generate this draft version Test App. -4. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#configuration) below. -5. Open the Google Home app and go into `Account > Settings > Assistant > Home Control`. -6. Click the `+` sign, and near the bottom, you should have `[test] your app name` listed under 'Add new.' Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms for your devices or nicknames for your devices. +3. Under `Build your Action` click `Add Action(s)`. + 1. Under `Fulfillment` fill in this URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant`. +4. Back on the overview page. Click `Simulator` under `TEST`. It will create a new draft version Test App. You don't have to actually test, but you need to generate this draft version Test App. +5. Add the `google_assistant` integration configuration to your `configuration.yaml` file and restart Home Assistant following the [configuration guide](#configuration) below. +6. Open the Google Home app and go into `Account > Settings > Assistant > Home Control`. +7. Click the `+` sign, and near the bottom, you should have `[test] your app name` listed under 'Add new.' Selecting that should lead you to a browser to login your Home Assistant instance, then redirect back to a screen where you can set rooms for your devices or nicknames for your devices.
diff --git a/source/_components/google_maps.markdown b/source/_components/google_maps.markdown index b6a7dc4d694..15ed3d36da1 100644 --- a/source/_components/google_maps.markdown +++ b/source/_components/google_maps.markdown @@ -42,10 +42,6 @@ username: description: The email address for the Google account that has access to your shared location. required: true type: string -password: - description: The password for your given username. - required: true - type: string max_gps_accuracy: description: Sometimes Google Maps can report GPS locations with a very low accuracy (few kilometers). That can trigger false zoning. Using this parameter, you can filter these false GPS reports. The number has to be in meters. For example, if you put 200 only GPS reports with an accuracy under 200 will be taken into account - Defaults to 100km if not specified. required: false diff --git a/source/_components/google_translate.markdown b/source/_components/google_translate.markdown index d0e7875433c..2f78f4c5f72 100644 --- a/source/_components/google_translate.markdown +++ b/source/_components/google_translate.markdown @@ -55,5 +55,5 @@ If you are using SSL certificate or Docker, you may need to add the `base_url` c ```yaml #Example configuration.yaml entry http: - base_url: example.duckdns.org + base_url: https://example.duckdns.org ``` diff --git a/source/_components/googlehome.markdown b/source/_components/googlehome.markdown deleted file mode 100644 index 0921c73dbe5..00000000000 --- a/source/_components/googlehome.markdown +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: "Google Home" -description: "Instructions on how to connect to your Google Home device." -logo: google_home.png -ha_release: 0.88 -ha_category: - - Hub - - Presence Detection - - Sensor -ha_iot_class: Local Polling -redirect_from: - - /components/device_tracker.googlehome/ ---- - -The `googlehome` integration allows you to connect to your Google Home device using an [unofficial Google Home API][googlehomeapi]. - -This integration will provide: -- [device_tracker](/components/device_tracker/) platform to track nearby bluetooth devices; -- [sensor](/components/sensor/) platform to track the alarms and the timers. - -## Configuration - -To integrate the `googlehome` integration in Home Assistant, add the following section to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -googlehome: - devices: - - host: IP_ADDRESS -``` - -{% configuration %} -devices: - description: A list of Google Home devices. - required: true - type: list - keys: - host: - description: The IP address of the Google Home device. - required: true - type: string - rssi_threshold: - description: The threshold for the RSSI signal of the device. - required: false - default: -70 - type: integer - device_types: - description: Device types that will be tracked [see device types](#device_types), by default all types are tracked. - required: false - type: list - track_alarms: - description: Setting to tell the integration to track the alarms of the device. - required: false - type: boolean - default: false - track_devices: - description: Setting to tell the integration to track nearby devices. - required: false - type: boolean - default: true -{% endconfiguration %} - -## Device types - -Device type | Description --- | -- -1 | Classic - BR/EDR devices -2 | Low Energy - LE-only -3 | Dual Mode - BR/EDR/LE - -## Notes - -Devices will appear in the format `device_tracker._`. Note that dots are removed from the IP and BT MAC addresses. - -[googlehomeapi]: https://rithvikvibhu.github.io/GHLocalApi/ -[devicetrackerconfig]: /components/device_tracker/#configuring-a-device_tracker-platform diff --git a/source/_components/haveibeenpwned.markdown b/source/_components/haveibeenpwned.markdown index 15de845e3d1..067c142799b 100644 --- a/source/_components/haveibeenpwned.markdown +++ b/source/_components/haveibeenpwned.markdown @@ -12,6 +12,12 @@ redirect_from: The `haveibeenpwned` sensor platform creates sensors that check for breached email accounts on [haveibeenpwned](https://haveibeenpwned.com). +
+ + The HaveIBeenPwned API now requires you to pay $3.50 a month in order to query the API. More info can be found [here](https://www.troyhunt.com/authentication-and-the-have-i-been-pwned-api/) + +
+ ## Configuration To enable this sensor, add the following lines to your `configuration.yaml`, it will list every specified email address as a sensor showing @@ -24,6 +30,7 @@ sensor: email: - your_email1@domain.com - your_email2@domain.com + api_key: API_KEY ``` {% configuration %} @@ -31,6 +38,10 @@ email: description: List of email addresses. required: true type: list +api_key: + description: HaveIBeenPwned API Key + required: true + type: string {% endconfiguration %} ## Breach meta data diff --git a/source/_components/history_stats.markdown b/source/_components/history_stats.markdown index fa23b01dd0f..68b05276c75 100644 --- a/source/_components/history_stats.markdown +++ b/source/_components/history_stats.markdown @@ -119,6 +119,12 @@ duration: minutes: 30 ``` +
+ + If the duration exceeds the number of days of history stored by the `recorder` component (`purge_keep_days`), the history statistics sensor will not have all the information it needs to look at the entire duration. For example, if `purge_keep_days` is set to 7, a history statistics sensor with a duration of 30 days will only report a value based on the last 7 days of history. + +
+ ### Examples Here are some examples of periods you could work with, and what to write in your `configuration.yaml`: diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown index 64ef560e215..5ad244ef746 100644 --- a/source/_components/homekit.markdown +++ b/source/_components/homekit.markdown @@ -248,7 +248,7 @@ In some cases it might be desirable to check that all entities are available bef ```yaml # Example checking specific entities to be available before start homekit: - auto_start: False + auto_start: false automation: - alias: 'Start HomeKit' diff --git a/source/_components/homekit_controller.markdown b/source/_components/homekit_controller.markdown index 2df614d999e..8d182278ccf 100644 --- a/source/_components/homekit_controller.markdown +++ b/source/_components/homekit_controller.markdown @@ -1,6 +1,6 @@ --- title: "HomeKit controller support" -description: "Instructions how to integrate your HomeKit devices within Home Assistant." +description: "Instructions for how to integrate your HomeKit devices within Home Assistant." logo: apple-homekit.png ha_category: - Hub @@ -24,7 +24,13 @@ redirect_from: - /components/sensor.homekit_controller/ --- -[HomeKit](https://developer.apple.com/homekit/) controller integration for Home Assistant allows you to connect HomeKit accessories to Home Assistant. This integration should not be confused with the [HomeKit](/components/homekit/) integration, which allows you to control Home Assistant devices via HomeKit. +The [HomeKit](https://developer.apple.com/homekit/) controller integration allows you to use accessories with the "Works with HomeKit" logo with Home Assistant. This integration should not be confused with the [HomeKit](/components/homekit/) integration, which allows you to control Home Assistant devices via HomeKit. + +The integration will automatically detect HomeKit compatible devices that are ready to pair if the [`zeroconf`](/components/zeroconf/) integration is enabled. This is enabled by default on new installations via the [`default_config`](/components/default_config/) component. + +To see which devices have been discovered see the "Integrations" page in your Home Assistant dashboard. When you click on "Configure" you can enter your HomeKit PIN and the device should be added to your Home Assistant instance. If your device is currently paired with an Apple device via HomeKit, you will need to reset it in order to pair it with Home Assistant. Once Home Assistant is configured to work with the device, you can export it back to Siri and Apple Home with the [`HomeKit`](/components/homekit/) integration. + +## Supported devices There is currently support for the following device types within Home Assistant: @@ -35,8 +41,55 @@ There is currently support for the following device types within Home Assistant: - Lock (HomeKit lock) - Switch (HomeKit switches) - Binary Sensor (HomeKit motion sensors and contact sensors) -- Sensor (HomeKit humidity, temperature, and light level sensors) +- Sensor (HomeKit humidity, temperature, co2 and light level sensors) -The integration will be automatically configured if the [`discovery`](/components/discovery/) integration is enabled. +HomeKit IP accessories for these device types may work with some caveats: -For each detected HomeKit accessory, a configuration prompt will appear in the web front end. Use this to provide the HomeKit PIN. Note that HomeKit accessories can only be paired to one device at once. If your device is currently paired with Siri, you will need to reset it in order to pair it with Home Assistant. Once Home Assistant is configured to work with the device, you can export it back to Siri with the [`HomeKit`](/components/homekit/) integration. +- If the device is WiFi based and has no physical controls or screen then you may need an Apple HomeKit device like an iPhone or iPad to get the accessory onto your WiFi network. For example, for a Koogeek LS1 you must add the accessory to HomeKit on your iOS device, then remove it from the iOS device. This leaves the LS1 in an unpaired state but still on your WiFi. Then Home Assistant can find it and pair with it. +- You need to know the HomeKit PIN. There is no way to recover this if you do not have it. You will need to contact the manufacturer to see what options you have. + +Home Assistant does not currently support HomeKit BLE. + +## Troubleshooting + +### I don't have a HomeKit PIN + +When you buy a certified HomeKit enabled device the PIN maybe with the instructions or on a sticker on the side or under the accessory. + +Devices with screens like thermostats may not have PIN codes in the packaging at all. Every time you click on "Configure" in the Home Assistant front end your accessory will generate a new pairing code and show it on the display. + +If your device doesn't have a display and got HomeKit support after it was released you may not have a pairing code. Dealing with this is manufacturer specific. Some manufacturers allow you to see the pairing code in their iOS app. Others force you to use their app to configure HomeKit and don't let you have the pairing pin - right now you won't be able to use HomeKit controller with those devices. + +If you have lost your PIN code then you may not be able to repair your accessory. You should contact the manufacturer to see if there is anything you can do. + +### My accessory isn't updating straight away + +This is normal - HomeKit controller is currently a local polling based integration. It polls your accessory for its latest state once a minute. + +### Home Assistant cannot discover my device + +For IP accessories, Home Assistant can only find devices that are already on the same network as your device. If an accessory is WiFi based and has no user interface for joining it to your Wifi network you will need an Apple HomeKit controller device (an iPhone or iPad). You should pair it with the controller and then remove the pairing in the UI (but do not reset the accessory itself). This will leave the accessory on your WiFi network but in an unpaired state, and then Home Assistant can find it. + +Home Assistant can only find accessories that aren't already paired. Even if you reset your Home Assistant configuration the accessory will still think it is paired and you won't be able to use it with Home Assistant. You should reset the accessory according to the manufacturer instructions. Some devices have a "Reset HomeKit" option, and some may require a full reset. + +### HomeKit controller is finding devices on my network even though I don't have any Apple device + +This is completely normal. Unlike many other commercial IoT offerings the HomeKit protocol is a local and offline protocol that does not rely on the Apple ecosystem to function. You do not need an Apple online account to use a "Works with HomeKit" device. Some WiFi devices may need an iOS briefly to get them onto your WiFi but other than that you do not need any Apple hardware on your network either. + +Many IoT devices are getting a post-launch HomeKit upgrade. This might mean your device starts showing in Home Assistant as a `homekit_controller` device even though when you bought it without HomeKit support. If maybe this is a better choice for you than a native integration. For example, a lot of climate devices have an online-only API and a HomeKit API. The HomeKit one might not expose all of the settings and controls you are used to but won't break if your internet connection goes down or the cloud service goes away. + +### I have a warning in my logs about HomeKit controller skipping updates + +You may say a log entry that looks like this: + +```log +HomeKit controller update skipped as previous poll still in flight +``` + +In these cases it's unlikely that HomeKit controller itself is directly responsible. This is a safety feature to avoid overloading your HomeAssistant instance. It means that Home Assistant tried to poll your accessory but the previous poll was still happening. This means it is taking over 1 minute to poll your accessory. This could be caused by a number of things: + +- You have too many blocking synchronous integrations for your Home Assistant instance. All synchronous integrations share a thread pool and if there are lots of tasks to run on it they will queued, causing delays. In the worst cases this queue can build up faster than it can be emptied. Faster hardware may help, but you may need to disable some integrations. +- Your network connection to an accessory is poor and HomeKit controller is unable to reach the accessory reliably. This will likely require a change to your network setup to improve WiFi coverage or replace damaged cabling etc. +- There is a problem with the actual accessory and this may be causing intermittent network issues. + +In these cases HomeKit controller will skip polling to avoid a build up of back pressure in your instance. diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index f83e5acabe7..8bd3b3ab4cd 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -70,6 +70,7 @@ local_ip: description: IP of device running Home Assistant. Override auto-detected value for exotic network setups. required: false type: string + default: 0.0.0.0 local_port: description: Port for connection with Home Assistant. By default it is randomly assigned. required: false diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown index 8d16d1f54b5..fffeeac7b95 100644 --- a/source/_components/homematicip_cloud.markdown +++ b/source/_components/homematicip_cloud.markdown @@ -87,6 +87,7 @@ authtoken: * homematicip_cloud.binary_sensor * Window and door contact (*HmIP-SWDO, -I*) * Contact Interface flush-mount – 1 channel (*HmIP-FCI1*) + * Contact Interface (*HmIP-SCI*) * Window Rotary Handle Sensor (*HmIP-SRH*) * Smoke sensor and alarm (*HmIP-SWSD*) * Motion Detector with Brightness Sensor - indoor (*HmIP-SMI*) diff --git a/source/_components/introduction.markdown b/source/_components/introduction.markdown deleted file mode 100644 index 265de216c48..00000000000 --- a/source/_components/introduction.markdown +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Introduction" -description: "Details about the introduction within Home Assistant." -logo: home-assistant.png -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 integration 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 integration is loaded by default on a new Home Assistant instance. - -```yaml -# Example configuration.yaml entry -introduction: -``` - -To disable this component, remove the `introduction:` entry from your `configuration.yaml` file. diff --git a/source/_components/joaoapps_join.markdown b/source/_components/joaoapps_join.markdown index 878bf842718..03e28627f66 100644 --- a/source/_components/joaoapps_join.markdown +++ b/source/_components/joaoapps_join.markdown @@ -14,7 +14,7 @@ The `joaoapps_join` integration 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. When in doubt, you can reference the [API documentation](https://joaoapps.com/join/api/) this this is based on. +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 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 diff --git a/source/_components/keba.markdown b/source/_components/keba.markdown new file mode 100644 index 00000000000..9ff867d9778 --- /dev/null +++ b/source/_components/keba.markdown @@ -0,0 +1,123 @@ +--- +title: "Keba Charging Station" +description: "Instructions on how to setup your Keba charging station with Home Assistant." +logo: keba.png +ha_category: + - Binary Sensor + - Lock + - Sensor +ha_release: 0.98 +--- + +The `keba` integrates your Keba charging station (wallbox) into your home assistant instance. It was tested with a BMW Wallbox but should also work with a Keba P20/P30 according to the developers [manual](https://www.keba.com/web/downloads/e-mobility/KeContact_P20_P30_UDP_ProgrGuide_en.pdf). The fetching interval to the charging station is set to 5 seconds, same as in the official mobile app. + +This component provides the following platforms: + +- Binary Sensors: Online state, plug state, Charging state and failsafe mode state. +- Lock: Authorization (like with the RFID card). +- Sensors: current set by the user, target energy set by the user, charging power, charged energy of the current session and total energy charged. +- Services: authorize, deauthorize, set energy target, set maximum allowed current and manually update the states. More details can be found [here](/components/keba/#services). + +## Configuration + +To enable this component in your installation, add at least the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +keba: + host: KEBA_HOST +``` + +{% configuration %} +keba: + description: configuration + required: true + type: map + keys: + host: + description: Keba host. + required: true + type: string + rfid: + description: RFID tag used for authorization. + required: false + type: string + default: "00845500" + failsafe: + description: Enable failsafe mode at home assistant startup. + required: false + type: boolean + default: false + failsafe_timeout: + description: Timeout of the failsafe mode in seconds. Allowed values are between 10 seconds and 600 seconds (this parameter is only used if failsafe mode is enabled). Make sure to call the `keba.set_curr` service regularly within this timeout period! + required: false + type: integer + default: 30 + failsafe_fallback: + description: Fallback current of the failsafe mode in A. Allowed values are between 6 Ampere and 63 Ampere. 0 Ampere disables the running charging process completely (this parameter is only used if failsafe mode is enabled). + required: false + type: integer + default: 6 + failsafe_persist: + description: Saving the failsafe configuration to internal EEPROM of the Keba charging station. 1 means save it, 0 means do only keep this configuration until the next restart of the charging station (this parameter is only used if failsafe mode is enabled). + required: false + type: integer + default: 0 + refresh_interval: + description: Refresh interval to fetch new data from the charging station. 5 seconds (same as in the official app) is recommended. + required: false + type: integer + default: 5 +{% endconfiguration %} + +## Services + +The `keba` component offers several services. Using these services will change the state of your charging station. So use these services with care! + +### Authorizing and Deauthorizing `keba.authorize` and `keba.deauthorize` + +The charging station can be authorized and deauthorized via service calls (`keba.authorize` and `keba.deauthorize`) or via the lock component that is created automatically for the charging station. In both cases the RFID tag from the configuration is used. + +### Start and Stop `keba.start` and `keba.stop` + +The service `keba.start` and `keba.stop` controls the charging process if the car is already authorized. Technically it sends `ena 1` or `ena 0` commands to the charging station. + +### Set Target Energy `keba.set_energy` + +The service `keba.set_energy` sets the target energy for the current session to the given energy attribute in kWh. Payload example: + +```json +{ + "energy": 10.0 +} +``` + +### Maximum Current `keba.set_curr` + +The service `keba.set_curr` sets the maximum current to the given current attribute in Ampere. Payload example: + +```json +{ + "current": 16.0 +} +``` + +### Request New Data `keba.request_data` + +The service `keba.request_data` sends data update requests to the charging station. + +### Request New Data `keba.set_failsafe` + +The service `keba.set_failsafe` sets the failsafe mode of the charging station. Payload example: + +```json +{ + "failsafe_timeout": 30, + "failsafe_fallback": 6, + "failsafe_persist": 0 +} +``` + +## Disclaimer + +This software is not affiliated with or endorsed by Keba. diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index 0cbabc45cfe..131ac8dcb8f 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -5,7 +5,7 @@ logo: knx.png ha_category: - Hub ha_release: 0.24 -ha_iot_class: Local Polling +ha_iot_class: Local Push --- The [KNX](https://www.knx.org) integration for Home Assistant allows you to connect to a KNX/IP devices. @@ -13,9 +13,7 @@ The [KNX](https://www.knx.org) integration for Home Assistant allows you to conn The integration requires a local KNX/IP interface like the [Weinzierl 730](https://www.weinzierl.de/index.php/en/all-knx/knx-devices-en/produktarchiv-en/knx-ip-interface-730-en). Through this, it will send and receive commands to and from other devices to the KNX bus.
- - Please note, the `knx` platform does not support Windows. - +Please note, the `knx` platform does not support Windows.
There is currently support for the following device types within Home Assistant: @@ -69,19 +67,21 @@ knx: host: description: Host of the KNX/IP tunneling device. type: string + required: true port: description: Port of the KNX/IP tunneling device. type: integer + required: false local_ip: description: IP of the local interface. type: string + required: false {% endconfiguration %} Explicit connection to a KNX/IP routing device: ```yaml knx: - config_file: '/path/to/xknx.yaml' routing: local_ip: '192.168.2.109' ``` @@ -90,6 +90,7 @@ knx: local_ip: description: The local IP address of interface (which should be used for multicasting). type: string + required: true {% endconfiguration %} ```yaml @@ -117,7 +118,7 @@ state_updater: ### Services -In order to directly interact with the KNX bus, you can now use the following service: +In order to directly interact with the KNX bus, you can use the following service: ``` Domain: knx @@ -145,6 +146,12 @@ knx: - type: 'temperature' entity_id: 'sensor.owm_temperature' address: '0/0/2' + - type: 'string' + address: '0/6/4' + entity_id: "sensor.owm_weather" + - type: 'binary' + entity_id: 'binary_sensor.kitchen_window' + address: '0/6/5' - type: 'time' address: '0/0/1' - type: 'datetime' @@ -153,12 +160,14 @@ knx: {% configuration %} type: - description: Type of the exposed value. Either time or datetime or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity"). + description: Type of the exposed value. Either 'binary', 'time', 'date', 'datetime' or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity"). type: string + required: true entity_id: - description: Entity id of the HASS integration to be exposed. Not necessary for types time and datetime. + description: Entity id to be exposed. Not needed for types time, date and datetime. type: string address: description: KNX group address. type: string + required: true {% endconfiguration %} diff --git a/source/_components/kodi.markdown b/source/_components/kodi.markdown index 57142d81195..8190ab09397 100644 --- a/source/_components/kodi.markdown +++ b/source/_components/kodi.markdown @@ -86,7 +86,7 @@ timeout: ### Services -#### Service `kodi_add_to_playlist` +#### Service `kodi.add_to_playlist` Add music to the default playlist (i.e. playlistid=0). @@ -98,14 +98,7 @@ Add music to the default playlist (i.e. playlistid=0). | `media_name` | no| Optional media name for filtering media. Can be 'ALL' when `media_type` is 'ALBUM' and `artist_name` is specified, to add all songs from one artist. | | `artist_name` | no | Optional artist name for filtering media. | -#### Service `media_player/kodi_set_shuffle` - -| Service data attribute | Optional | Description | -|------------------------|----------|-------------| -| `entity_id` | yes | Target a specific media player. It must be of type kodi. | -| `shuffle_on` | no | True/false for shuffle on/off. | - -#### Service `kodi_call_method` +#### Service `kodi.call_method` Call a [Kodi JSONRPC API](http://kodi.wiki/?title=JSON-RPC_API) method with optional parameters. Results of the Kodi API call will be redirected in a Home Assistant event: `kodi_call_method_result`. @@ -117,7 +110,7 @@ Call a [Kodi JSONRPC API](http://kodi.wiki/?title=JSON-RPC_API) method with opti ### Event triggering -When calling the `kodi_call_method` service, if the Kodi JSONRPC API returns data, when received by Home Assistant it will fire a `kodi_call_method_result` event on the event bus with the following `event_data`: +When calling the `kodi.call_method` service, if the Kodi JSONRPC API returns data, when received by Home Assistant it will fire a `kodi_call_method_result` event on the event bus with the following `event_data`: ```yaml entity_id: "" @@ -156,7 +149,7 @@ media_player: - platform: kodi host: 192.168.0.123 turn_off_action: - service: media_player.kodi_call_method + service: kodi.call_method data: entity_id: media_player.kodi method: Application.Quit @@ -169,7 +162,7 @@ media_player: - platform: kodi host: 192.168.0.123 turn_off_action: - service: media_player.kodi_call_method + service: kodi.call_method data: entity_id: media_player.kodi method: System.Hibernate @@ -182,7 +175,7 @@ media_player: - platform: kodi host: 192.168.0.123 turn_off_action: - service: media_player.kodi_call_method + service: kodi.call_method data: entity_id: media_player.kodi method: System.Suspend @@ -195,7 +188,7 @@ media_player: - platform: kodi host: 192.168.0.123 turn_off_action: - service: media_player.kodi_call_method + service: kodi.call_method data: entity_id: media_player.kodi method: System.Reboot @@ -208,7 +201,7 @@ media_player: - platform: kodi host: 192.168.0.123 turn_off_action: - service: media_player.kodi_call_method + service: kodi.call_method data: entity_id: media_player.kodi method: System.Shutdown @@ -223,7 +216,7 @@ media_player: - platform: kodi host: 192.168.0.123 turn_on_action: - service: media_player.kodi_call_method + service: kodi.call_method data: entity_id: media_player.kodi method: Addons.ExecuteAddon @@ -234,7 +227,7 @@ media_player: - service: media_player.media_stop data: entity_id: media_player.kodi - - service: media_player.kodi_call_method + - service: kodi.call_method data: entity_id: media_player.kodi method: Addons.ExecuteAddon @@ -293,7 +286,7 @@ script: alias: Update Kodi Library sequence: - alias: Call Kodi update - service: media_player.kodi_call_method + service: kodi.call_method data: entity_id: media_player.kodi method: VideoLibrary.Scan @@ -384,4 +377,4 @@ data: type: integer {% endconfiguration %} -To use notifications, please see the [getting started with automation page](/getting-started/automation/). \ No newline at end of file +To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/light.knx.markdown b/source/_components/light.knx.markdown index 04372579312..f97ee085522 100644 --- a/source/_components/light.knx.markdown +++ b/source/_components/light.knx.markdown @@ -5,9 +5,15 @@ logo: knx.png ha_category: - Light ha_release: 0.44 -ha_iot_class: Local Polling +ha_iot_class: Local Push --- +
+ +The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx). + +
+ The `knx light` integration is used as an interface to control knx actuators for lighting applications such as: - switching actuators @@ -15,8 +21,6 @@ The `knx light` integration is used as an interface to control knx actuators for - LED controllers - DALI gateways -The `knx` integration must be configured correctly to use this component, see [KNX Component](/components/knx). - ## Configuration To use your KNX light in your installation, add the following lines to your `configuration.yaml` file: @@ -57,6 +61,14 @@ color_state_address: description: KNX group address for retrieving the RGB color of the light. *DPT 232.600* required: false type: string +rgbw_address: + description: KNX group address for setting the RGBW color of the light. *DPT 251.600* + required: false + type: string +rgbw_state_address: + description: KNX group address for retrieving the RGBW color of the light. *DPT 251.600* + required: false + type: string color_temperature_address: description: KNX group address for setting the color temperature of the light. *DPT 5.001 or 7.600 based on color_temperature_mode* required: false diff --git a/source/_components/linksys_ap.markdown b/source/_components/linksys_ap.markdown index e0d1f34f93e..05285897853 100644 --- a/source/_components/linksys_ap.markdown +++ b/source/_components/linksys_ap.markdown @@ -9,6 +9,14 @@ redirect_from: - /components/device_tracker.linksys_ap/ --- +
+ +This integration is deprecated and will be removed in Home Assistant 0.100.0. + +For more information see [Architecture Decision Record: 0004](https://github.com/home-assistant/architecture/blob/master/adr/0004-webscraping.md). + +
+ The `linksys_ap` platform offers presence detection by looking at connected devices to a Linksys based access point. It was tested with a LAPAC1750 AC1750 Dual Band Access Point. diff --git a/source/_components/luci.markdown b/source/_components/luci.markdown index 531ef336064..4830ee51947 100644 --- a/source/_components/luci.markdown +++ b/source/_components/luci.markdown @@ -9,7 +9,7 @@ redirect_from: - /components/device_tracker.luci/ --- -_This is one of multiple ways we support OpenWRT. For an overview, see [openwrt](/components/device_tracker.openwrt/)._ +_This is one of multiple ways we support OpenWRT. For an overview, see [openwrt](/components/openwrt/)._ This is a presence detection scanner for OpenWRT using [luci](http://wiki.openwrt.org/doc/techref/luci). diff --git a/source/_components/lutron.markdown b/source/_components/lutron.markdown index f905a6c2b8e..c88bd94505d 100644 --- a/source/_components/lutron.markdown +++ b/source/_components/lutron.markdown @@ -75,3 +75,6 @@ The Lutron scene platform allows you to control scenes programmed into your SeeT After setup, scenes will appear in Home Assistant using the area, keypad and button name. +## Occupancy Sensors + +Any configured Powr Savr occuancy sensors will be added as occupancy binary sensors. Lutron reports occupancy for an area, rather than reporting individual sensors. Sensitivity and timeouts are controlled on the sensors themselves, not in software. diff --git a/source/_components/mcp23017.markdown b/source/_components/mcp23017.markdown index 0b2813a20dc..4991a3c7d67 100644 --- a/source/_components/mcp23017.markdown +++ b/source/_components/mcp23017.markdown @@ -98,12 +98,12 @@ i2c_address: required: false type: integer default: "`0x20`" -ports: +pins: description: Array of used pins. required: true type: list keys: - port: + pin: description: The pin numbers (from 0 to 15) and corresponding names. required: true type: [integer, string] diff --git a/source/_components/mercedesme.markdown b/source/_components/mercedesme.markdown deleted file mode 100644 index 43f57f29790..00000000000 --- a/source/_components/mercedesme.markdown +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Mercedes me" -description: "Instructions on how to integrate Mercedes car with Mercedes me into Home Assistant." -logo: mercedesme.png -ha_category: - - Car - - Binary Sensor - - Presence Detection - - Sensor -ha_release: 0.63 -ha_iot_class: Cloud Polling -redirect_from: - - /components/binary_sensor.mercedesme/ - - /components/device_tracker.mercedesme/ - - /components/sensor.mercedesme/ ---- - -The `mercedesme` integration offers integration with the [Mercedes me](https://www.mercedes-benz.com/de/mercedes-me/) cloud service and provides presence detection as well as sensors such as doors, tires, windows, and service interval. - -This integration provides the following platforms: - -- Binary Sensors: Windows, tires, doors and lock. -- Sensors:Fuel status, service interval, remaining km, etc. -- Device tracker: To track location of your car. - -Platforms will be automatically configured if Mercedes me integration is configured. - -
- The integration was removed. The vendor disabled the API endpoint and a new API is not available currently. -
diff --git a/source/_components/mikrotik.markdown b/source/_components/mikrotik.markdown index 1ab056dc995..fdb23f8e7c9 100644 --- a/source/_components/mikrotik.markdown +++ b/source/_components/mikrotik.markdown @@ -3,6 +3,7 @@ title: "MikroTik" description: "Instructions on how to integrate MikroTik/RouterOS based devices into Home Assistant." logo: mikrotik.png ha_category: + - Hub - Presence Detection ha_release: 0.44 redirect_from: @@ -11,7 +12,11 @@ redirect_from: The `mikrotik` platform offers presence detection by looking at connected devices to a [MikroTik RouterOS](http://mikrotik.com) based router. -## Configuring `mikrotik` device tracker +There is currently support for the following device types within Home Assistant: + +- Presence Detection + +## Configuring `mikrotik` hub You have to enable accessing the RouterOS API on your router to use this platform. @@ -33,9 +38,8 @@ To use a MikroTik router in your installation, add the following to your `config ```yaml # Example configuration.yaml entry -device_tracker: - - platform: mikrotik - host: IP_ADDRESS +mikrotik: + - host: IP_ADDRESS username: ROUTEROS_USERNAME password: ROUTEROS_PASSWORD ``` @@ -70,9 +74,14 @@ ssl: default: false type: boolean method: - description: Override autodetection of device scanning method. Can be `wireless` to use local wireless registration, `capsman` for capsman wireless registration, or `ip` for DHCP leases. + description: Override autodetection of device scanning method. Can be `wireless` to use local wireless registration, `capsman` for capsman wireless registration, or `dhcp` for DHCP leases. required: false type: string +arp_ping: + description: Use ARP ping with DHCP method for device scanning. + required: false + default: false + type: boolean {% endconfiguration %}
@@ -113,17 +122,25 @@ To use this device tracker you need restricted privileges only. To enhance the s /user set password="YOUR_PASSWORD" homeassistant ``` -## Using the additional configuration to the `mikrotik` device tracker entry in your `configuration.yaml` file: +## Using the additional configuration to the `mikrotik` entry in your `configuration.yaml` file: ```yaml -device_tracker: - - platform: mikrotik - host: 192.168.88.1 +mikrotik: + - host: 192.168.88.1 + username: homeassistant + password: YOUR_PASSWORD + ssl: true + arp_ping: true + method: dhcp + track_devices: true + + - host: 192.168.88.2 username: homeassistant password: YOUR_PASSWORD ssl: true port: 8729 method: capsman + track_devices: true ``` See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. diff --git a/source/_components/minio.markdown b/source/_components/minio.markdown new file mode 100644 index 00000000000..e4bba03e2ea --- /dev/null +++ b/source/_components/minio.markdown @@ -0,0 +1,153 @@ +--- +title: "Minio" +description: "Integration for interacting with Minio object storage." +logo: minio.png +ha_category: Utility +ha_iot_class: Cloud Push +ha_release: 0.98 +--- + +This integration adds interaction with [Minio](https://min.io). +Also enables to listen for bucket notifications: [watch docs](https://docs.min.io/docs/minio-client-complete-guide.html#watch) + +To download or upload files, folders must be added to [whitelist_external_dirs](/docs/configuration/basic/). + +## Configuration + +To enable the Minio integration in your installation, add the following to your `configuration.yaml` file: + +```yaml +minio: + host: localhost + port: 9000 + access_key: ACCESS_KEY + secret_key: SECRET_KEY + secure: false +``` + +{% configuration %} +host: + description: Minio server host + required: true + type: string +port: + description: Minio server port + required: true + type: integer +access_key: + description: Minio server access key + required: true + type: string +secret_key: + description: Minio server secret key + required: true + type: string +secure: + description: Whether to use http or https connection + required: true + type: boolean + default: false +listen: + description: List of configurations to listen for events to + required: false + default: [] + type: list + keys: + bucket: + description: Bucket to use + required: true + type: string + prefix: + description: What prefix to use to filter file events + required: false + type: string + default: "" + suffix: + description: What file suffix to use to filter file events + required: false + type: string + default: ".*" + events: + description: What file + required: false + type: string + default: "s3:ObjectCreated:*" +{% endconfiguration %} + +## Automations + +Automations can be triggered on new files created on the Minio server using the `data_template`. + +{% raw %} +```yaml +#Automatically upload new local files +automation: +- alias: Upload camera snapshot + trigger: + platform: event + event_type: folder_watcher + event_data: + event_type: created + action: + - delay: '00:00:01' + - service: minio.put + data_template: + file_path: "{{ trigger.event.data.path }}" + bucket: "camera-image-object-detection" + key: "input/{{ now().year }}/{{ (now().month | string).zfill(2) }}/{{ (now().day | string).zfill(2) }}/{{ trigger.event.data.file }}" + - delay: '00:00:01' + - service: shell_command.remove_file + data_template: + file: "{{ trigger.event.data.path }}" + +- alias: Download new Minio file + trigger: + - platform: event + event_type: minio + + condition: [] + action: + - service: minio.get + data_template: + bucket: "{{trigger.event.data.bucket}}" + key: "{{trigger.event.data.key}}" + file_path: "/tmp/{{ trigger.event.data.file_name }}" +``` +{% endraw %} + +## Platform Services + +These services are provided: + +- `get` +- `put` +- `remove` + +### Service `minio.get` + +Download file. + +| Service data attribute | Required | Description | +|---------------------------|----------|---------------------------------------------------| +| `bucket` | yes | Bucket to use | +| `key` | yes | Object key of the file | +| `file_path` | yes | File path on the local file system | + +### Service `minio.put` + +Upload file. + +| Service data attribute | Required | Description | +|---------------------------|----------|---------------------------------------------------| +| `bucket` | yes | Bucket to use | +| `key` | yes | Object key of the file | +| `file_path` | yes | File path on the local file system | + +### Service `minio.remove` + +Delete file. + +| Service data attribute | Required | Description | +|---------------------------|----------|---------------------------------------------------| +| `bucket` | yes | Bucket to use | +| `key` | yes | Object key of the file | diff --git a/source/_components/neato.markdown b/source/_components/neato.markdown index e7e5505f2bc..df88b15dcc9 100644 --- a/source/_components/neato.markdown +++ b/source/_components/neato.markdown @@ -64,7 +64,7 @@ Currently supported services are: - `stop` - `return_to_base` - `locate` -- `spot_clean` +- `clean_spot` And a specific Platform Service: diff --git a/source/_components/nest.markdown b/source/_components/nest.markdown index 7df45246460..e8186f0b3f2 100644 --- a/source/_components/nest.markdown +++ b/source/_components/nest.markdown @@ -28,6 +28,10 @@ There is currently support for the following device types within Home Assistant: ### Setting up developer account +

+ New users are not currently able to set up a Works With Nest Developer account due to the change announced by Google. 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. In the future we will add documentation on how to setup a Works With Google account and configure your Nest integration. +

+ 1. Visit [Nest Developers](https://developers.nest.com/), and sign in. Create an account if you don't have one already. 2. Fill in account details: * The "Company Information" can be anything. We recommend using your name. @@ -195,7 +199,7 @@ script: You must have the [Nest component](/components/nest/) configured to use the platforms below. -
+
## Binary Sensor @@ -313,7 +317,7 @@ The following conditions are available by device: - preset\_mode - temperature - target - - hvac\_mode: The currently active state of the HVAC system, `heat`, `cool` or `off` (previously `heating`, `cooling` or `off`). + - hvac\_state: The currently active state of the HVAC system, `heat`, `cool` or `off` (previously `heating`, `cooling` or `off`). - Nest Protect: - co\_status: `Ok`, `Warning` or `Emergency` - smoke\_status: `Ok`, `Warning` or `Emergency` diff --git a/source/_components/netgear_lte.markdown b/source/_components/netgear_lte.markdown index 5905d2950b8..e264c4dfbb2 100644 --- a/source/_components/netgear_lte.markdown +++ b/source/_components/netgear_lte.markdown @@ -148,6 +148,14 @@ This service asks the modem to establish its LTE connection, useful if the modem | ---------------------- | -------- | ----------- | | `host` | yes | The modem that should connect (optional when just one modem is configured). +### Service `netgear_lte.disconnect_lte` + +This service asks the modem to close its LTE connection. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `host` | yes | The modem that should disconnect (optional when just one modem is configured). + ### Service `netgear_lte.delete_sms` The integration makes a service available to delete messages from the modem inbox. This can be used to clean up after incoming SMS events. diff --git a/source/_components/notify.knx.markdown b/source/_components/notify.knx.markdown index 2f3572ba211..e01f5a874a5 100644 --- a/source/_components/notify.knx.markdown +++ b/source/_components/notify.knx.markdown @@ -8,9 +8,13 @@ ha_release: 0.53 ha_iot_class: Local Push --- -The `knx` notify platform allows you to send notifications to [KNX](http://www.knx.org) devices. +
+ +The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx). -The `knx` integration must be configured correctly, see [KNX Component](/components/knx). +
+ +The `knx` notify platform allows you to send notifications to [KNX](http://www.knx.org) devices. ## Configuration diff --git a/source/_components/opengarage.markdown b/source/_components/opengarage.markdown index 5f0da78a861..751c7a74e91 100644 --- a/source/_components/opengarage.markdown +++ b/source/_components/opengarage.markdown @@ -20,14 +20,14 @@ To enable OpenGarage Covers in your installation, add the following to your `con cover: platform: opengarage covers: - garage: - host: 192.168.1.12 - device_key: opendoor - name: Left Garage Door - garage2: - host: 192.168.1.13 - device_key: opendoor - name: Right Garage Door + garage: + host: 192.168.1.12 + device_key: opendoor + name: Left Garage Door + garage2: + host: 192.168.1.13 + device_key: opendoor + name: Right Garage Door ``` {% configuration %} diff --git a/source/_components/opentherm_gw.markdown b/source/_components/opentherm_gw.markdown index f410e61d6d9..39fb93c00ea 100644 --- a/source/_components/opentherm_gw.markdown +++ b/source/_components/opentherm_gw.markdown @@ -108,6 +108,19 @@ Please read [this information](http://otgw.tclcode.com/standalone.html) from the
+### Service `opentherm_gw.set_hot_water_ovrd` + +Set the domestic hot water enable option on the OpenTherm Gateway. +Control the domestic hot water enable option. If the boiler has +been configured to let the room unit control when to keep a +small amount of water preheated, this command can influence +that. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `gateway_id` | no | The `gateway_id` as specified in `configuration.yaml`. +| `dhw_override` | no | The domestic hot water override state. Value should be 0 or 1 to enable the override in off or on state, or "A" to disable the override. + ### Service `opentherm_gw.set_gpio_mode` Configure the GPIO behavior on the OpenTherm Gateway. diff --git a/source/_components/panasonic_viera.markdown b/source/_components/panasonic_viera.markdown index 01cfb0474eb..270159f227d 100644 --- a/source/_components/panasonic_viera.markdown +++ b/source/_components/panasonic_viera.markdown @@ -19,6 +19,7 @@ Currently known supported models: - TX-49DX650B - TX-50DX700B - TX-55CX700E +- TX-55CX680B - TX-55EXW584 - TX-65EXW784 - TX-L42ET50 diff --git a/source/_components/person.markdown b/source/_components/person.markdown index 8c523124714..515c3989d41 100644 --- a/source/_components/person.markdown +++ b/source/_components/person.markdown @@ -86,3 +86,15 @@ person: - device_tracker.stacey - device_tracker.beacon ``` + +### Customizing the picture for a person + +By following the instructions on the [customizing entities](/docs/configuration/customizing-devices#entity_picture) page, you can customize the picture used for a person entity in the `customize:` section of your configuration. For example: + +```yaml +customize: + person.ada6789: + entity_picture: "/local/ada.jpg" +``` + +See the documentation about [hosting files](/components/http/#hosting-files) for more information about the `www` folder. diff --git a/source/_components/plugwise.markdown b/source/_components/plugwise.markdown new file mode 100644 index 00000000000..efd96c7108e --- /dev/null +++ b/source/_components/plugwise.markdown @@ -0,0 +1,163 @@ +--- +title: "Plugwise" +description: "Plugwise Climate integration." +logo: plugwise.png +ha_category: Climate +ha_iot_class: Local Polling +ha_release: 0.98 +--- + +This enables [Plugwise](https://plugwise.com) [Anna](https://www.plugwise.com/en_US/products/anna) thermostats to be integrated. This integration talks locally to your **Smile** interface, and you will need its password and IP address. + +The password can be found on the bottom of your Smile, it should consist of 6 characters. To find your IP address use the Plugwise App: + + - Open the Plugwise App and choose the 'Settings'-icon (☰) and choose 'HTML-interface'. + - Go to the (lower) 'Settings'-icon (☰) and choose 'Preferences'. + - Choose 'System' then 'Networking' and your IP address will be shown. + +## Configuration + +You have to add the following to your configuration.yaml file: + +```yaml +# Minimal configuration.yaml entry +climate: + - platform: plugwise + password: YOUR_SHORT_IP + host: YOUR_SMILE_LOCAL_IP +``` + +{% configuration %} +password: + description: Your Smile ID (located on the bottom of the Smile, not the Anna). + required: true + type: string +host: + description: The IP address of your Smile. + required: true + type: string +name: + description: The name of your thermostat, i.e., "Anna". + required: false + type: string + default: "Plugwise Thermostat" +username: + description: Should you ever need to change this, you can. + required: false + type: string + default: smile +port: + description: When having a custom setup, you can change the port number. + required: false + type: integer + default: 80 +min_temp: + description: If you want to adjust the lower boundary, the integration will not allow temperatures below the set value. + required: false + type: integer + default: 4 +max_temp: + description: If you want to adjust the upper boundary, the integration will not allow temperatures above the set value. + required: false + type: integer + default: 30 +{% endconfiguration %} + +### Full configuration example + +```yaml +climate: + - platform: anna + name: YOUR_THERMOSTAT_NAME + password: YOUR_SHORT_ID + host: YOUR_SMILE_LOCAL_IP + port: YOUR_SMILE_PORT_NUMBER + min_temp: YOUR_MINIMAL_TARGET_TEMPERATURE + max_temp: YOUR_MAXIMAL_TARGET_TEMPERATURE +``` + +### Service + +#### Set HVAC mode (schedule) + +Service: `climate.set_hvac_mode` + +Available options include `auto` or `off`. The meaning of `auto` is that a schedule is active and the thermostat will change presets accordingly. The meaning of `off` is that there is no schedule active, i.e., the active preset or manually set temperature is to be used to control the climate of your house or rooms. +The last schedule that was active is determined the same way long-tapping the top of Anna works. + +Example: + +```yaml +# Example script change the temperature +script: + anna_reactive_last_schedule: + sequence: + - service: climate.set_hvac_mode + data: + hvac_mode: auto +``` + +Changing the active schedule can be done, though not easily: + +- Deactivate the schedule (press the power button on the UI-card). +- Look up the available schemas in the `states` view (attribute `available_schemas`). +- Change the attribute `active_schema` to the actual name of your schema as available from the above attribute or your Plugwise App. +- Activate the schedule (press the calendar button on the UI-card). + +#### Set temperature + +Service: `climate.set_temperature` + +Example: + +```yaml +# Example script change the temperature +script: + anna_set_predefined_temperature: + sequence: + - service: climate.set_temperature + data: + temperature: 19.5 +``` + +#### Set preset mode + +Service: `climate.set_preset_mode` + +Available options include: `home`, `vacation`, `no_frost`, `asleep` & `away`. + +Example: + +```yaml +# Example script changing the active (or currently set by schedule) preset +script: + anna_activate_preset_asleep: + sequence: + - service: climate.set_preset_mode + data: + preset_mode: asleep +``` + +### Troubleshooting + +Example of a working configuration excerpt (with debugging enabled): + +```txt +[homeassistant.loader] Loaded plugwise from custom_components.plugwise +[homeassistant.loader] You are using a custom integration for plugwise which has not been tested by Home Assistant. This component might cause stability problems, be sure to disable it if you do experience issues with Home Assistant. +[custom_components.plugwise.climate] Plugwise: custom component loading (Anna PlugWise climate) +[homeassistant.components.climate] Setting up climate.plugwise +[custom_components.plugwise.climate] Init called +[custom_components.plugwise.climate] Initializing API +[custom_components.plugwise.climate] platform ready +[custom_components.plugwise.climate] Update called +``` + +Example of something going wrong (IP address not set) excerpt is shown below. Correct your configuration and try again. If the errors persist, please share a larger excerpt of your logfile. + +```txt +1970-01-01 00:00:01 ERROR (MainThread) [homeassistant.components.climate] Error while setting up platform plugwise + File "/home/homeassistant/.homeassistant/custom_components/plugwise/climate.py", line 104, in setup_platform + File "/home/homeassistant/.homeassistant/custom_components/plugwise/climate.py", line 130, in __init__ + self._api = Haanna(self._username, self._password, self._host, self._port) +``` diff --git a/source/_components/prometheus.markdown b/source/_components/prometheus.markdown index 748bfbe51c2..95157c7c450 100644 --- a/source/_components/prometheus.markdown +++ b/source/_components/prometheus.markdown @@ -3,12 +3,14 @@ title: "Prometheus" description: "Record events in Prometheus." logo: prometheus.png ha_category: - - "History" + - History ha_release: 0.49 --- The `prometheus` integration exposes metrics in a format which [Prometheus](https://prometheus.io/) can read. +## Configuration + To use the `prometheus` integration in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -42,8 +44,67 @@ filter: description: The list of domains to be included from recordings. If set, all other entities will not be recorded. Values set by the **exclude_*** option will prevail. required: false type: list +default_metric: + type: string + description: Metric name to use when an entity doesn't have a unit. + required: false + default: uses the entity id of the entity +override_metric: + type: string + description: Metric name to use instead of unit or default metric. This will store all data points in a single metric. + required: false +component_config: + type: string + required: false + description: This attribute contains component-specific override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format. + keys: + override_metric: + type: string + description: Metric name to use instead of unit or default metric. This will store all data points in a single metric. + required: false +component_config_domain: + type: string + required: false + description: This attribute contains domain-specific component override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format. + keys: + override_metric: + type: string + description: Metric name to use instead of unit or default metric. This will store all data points in a single metric. + required: false +component_config_glob: + type: string + required: false + description: This attribute contains component-specific override values. See [Customizing devices and services](/getting-started/customizing-devices/) for format. + keys: + override_metric: + type: string + description: Metric name to use instead of unit or default metric. This will store all data points in a single metric. + required: false + {% endconfiguration %} +## Full Example + +Advanced configuration example: + +```yaml +# Advanced configuration.yaml entry +prometheus: + namespace: hass + component_config_glob: + sensor.*_hum: + override_metric: humidity_percent + sensor.*_temp: + override_metric: temperature_c + sensor.temperature*: + override_metric: temperature_c + sensor.*_bat: + override_metric: battery_percent + filter: + include_domains: + - sensor +``` + You can then configure Prometheus to fetch metrics from Home Assistant by adding to its `scrape_configs` configuration. ```yaml diff --git a/source/_components/qwikswitch.markdown b/source/_components/qwikswitch.markdown index 56b08c28e58..b54ba2605e7 100644 --- a/source/_components/qwikswitch.markdown +++ b/source/_components/qwikswitch.markdown @@ -22,12 +22,12 @@ There is currently support for the following device types within Home Assistant: - Binary Sensor - Light -- Sensor -- Switch +- [Sensor](#qwikswitch-sensors) +- [Switch](#switch) -The `qwikswitch` integration discovers all devices from QS Mobile. Currently, Relays and LED dimmers are discovered in Home Assistant. Relay devices are [lights](/components/light.qwikswitch/) by default, and can be configured as [switches](/components/switch.qwikswitch/). +The `qwikswitch` integration discovers all devices from QS Mobile. Currently, Relays and LED dimmers are discovered in Home Assistant. Relay devices are lights by default, and can be configured as [switches](#switch). -Configuration +## Configuration ```yaml # Example configuration.yaml entry diff --git a/source/_components/rainforest_eagle.markdown b/source/_components/rainforest_eagle.markdown index 99414c1e55b..d4b50ec4198 100644 --- a/source/_components/rainforest_eagle.markdown +++ b/source/_components/rainforest_eagle.markdown @@ -5,7 +5,7 @@ logo: rainforest_automation_logo.png ha_category: - Energy - Sensor -ha_release: 0.96 +ha_release: 0.97 ha_iot_class: Local Polling --- diff --git a/source/_components/recollect_waste.markdown b/source/_components/recollect_waste.markdown index 90b66fdd41d..d409d181630 100644 --- a/source/_components/recollect_waste.markdown +++ b/source/_components/recollect_waste.markdown @@ -10,7 +10,7 @@ redirect_from: - /components/sensor.recollect_waste/ --- -The `Recollect Waste` platform allows you to track the next scheduled waste pickup and what type of waste from [Recollect](https://recollect.net/solutions/waste/). To use this sensor your city's waste company must be Recollect and you will need to find your place_id and service_id. +The `recollect_waste` integration allows you to track the next scheduled waste pickup and what type of waste from [Recollect](https://recollect.net/private-waste-haulers/). To use this sensor your city's waste company must be Recollect and you will need to find your place_id and service_id. 1. In Chrome open developer tools and go to the network tab. 2. Go to your city's Recollect collection calendar. diff --git a/source/_components/ring.markdown b/source/_components/ring.markdown index 8f4a469f0e0..03d096030d8 100644 --- a/source/_components/ring.markdown +++ b/source/_components/ring.markdown @@ -7,6 +7,8 @@ ha_category: - Binary Sensor - Camera - Sensor + - Switch + - Light ha_release: 0.42 ha_iot_class: Cloud Polling redirect_from: @@ -20,8 +22,9 @@ The `ring` implementation allows you to integrate your [Ring.com](https://ring.c There is currently support for the following device types within Home Assistant: - [Binary Sensor](#binary-sensor) -- [Camera](#camera) - downloading and playing Ring video will require a Ring Protect plan. +- [Camera](#camera) - [Sensor](#sensor) +- [Switch](#switch) Currently only doorbells are supported by this sensor. @@ -49,11 +52,16 @@ password: description: The password for accessing your Ring account. required: true type: string +scan_interval: + description: How frequently to query for new video, or current sensor values in seconds + required: false + type: integer + default: 10 {% endconfiguration %} ## Binary Sensor -Once you have enabled the [Ring component](/components/ring), you can start using a binary sensor. Add the following to your `configuration.yaml` file: +Once you have enabled the [Ring integration](/components/ring), you can start using a binary sensor. Add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -81,7 +89,7 @@ Currently it supports doorbell, external chimes and stickup cameras. Please note that downloading and playing Ring video will require a Ring Protect plan.
-Once you have enabled the [Ring component](/components/ring), you can start using the camera platform. Add the following to your `configuration.yaml` file: +Once you have enabled the [Ring integration](/components/ring), you can start using the camera platform. Add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -94,11 +102,6 @@ ffmpeg_arguments: description: Extra options to pass to ffmpeg, e.g., image quality or video filter options. required: false type: string -scan_interval: - description: How frequently to query for new video in seconds. - required: false - type: integer - default: 90 {% endconfiguration %} **Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation. @@ -155,7 +158,7 @@ hass.services.call('downloader', 'download_file', data) ## Sensor -Once you have enabled the [Ring component](/components/ring), you can start using the sensor platform. Add the following to your `configuration.yaml` file: +Once you have enabled the [Ring integration](/components/ring), you can start using the sensor platform. Add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -186,3 +189,27 @@ monitored_conditions: {% endconfiguration %} Currently it supports doorbell, external chimes and stickup cameras. + +## Switch + +Once you have enabled the [Ring integration](/components/ring), you can start using the switch platform. Add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +switch: + - platform: ring +``` + +This will add a switch for every camera that supports a siren. Note the siren will only turn on for 30 seconds before automatically turning off. + +## Light + +Once you have enabled the [Ring integration](/components/ring), you can start using the light platform. Add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +light: + - platform: ring +``` + +This will add a light for every camera that supports a light (such as a flood light). diff --git a/source/_components/roku.markdown b/source/_components/roku.markdown index 69602f122db..2b48e436ea8 100644 --- a/source/_components/roku.markdown +++ b/source/_components/roku.markdown @@ -30,8 +30,8 @@ roku: {% configuration %} host: - description: Set the IP address of the Roku device. Use only if you don't want to autodiscover devices. - required: false + description: Set the IP address of the Roku device. + required: true type: string {% endconfiguration %} diff --git a/source/_components/ruter.markdown b/source/_components/ruter.markdown deleted file mode 100644 index aba13cb5772..00000000000 --- a/source/_components/ruter.markdown +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "Ruter Public Transport" -description: "Instructions on how to integrate departure times from Ruter within Home Assistant." -logo: ruter.png -ha_category: - - Transport -ha_iot_class: Cloud Polling -ha_release: 0.83 -redirect_from: - - /components/sensor.ruter/ ---- - -
- -The API used for this sensor is shutting down soon, you should consider starting to use the [`entur_public_transport`](/components/sensor.entur_public_transport/) sensor before that happen. -To read the deprecation warning visit [ruter.no/labs](https://ruter.no/labs/), - -
- -The `ruter` sensor will provide you departure information for the larger Oslo area in Norway from the [Ruter][ruter] public transportation service. - -This platform is using the [Ruter reisapi API][ruter-api] to gather the information. - -To find the `stop_id` you need to visit the [Ruter][ruter] site and search for your stop. -In the URL after you have searched, there will be an ID right after the `Stoppested/` in a format like this `(2190400)`, the numbers there is what you need to put in the `stop_id:` configuration option. - -Add the data to your `configuration.yaml` file as shown in the example: - -```yaml -# Example configuration.yaml entry -sensor: - - platform: ruter - stop_id: STOPID -``` - -{% configuration %} -stop_id: - description: The stop id for the stop you want to monitor. - required: true - type: string -destination: - description: A destination name to show only departures that has this as the final stop. - required: false - type: string -offset: - description: An offset for the next departure, 0 will give the first one. - required: false - type: integer - default: 0 -name: - description: Name of the sensor. - required: false - type: string - default: Ruter -{% endconfiguration %} - -[ruter]: https://ruter.no/reiseplanlegger/ -[ruter-api]: http://reisapi.ruter.no/Help diff --git a/source/_components/sabnzbd.markdown b/source/_components/sabnzbd.markdown index 389b11a4b3d..fcb9672c003 100644 --- a/source/_components/sabnzbd.markdown +++ b/source/_components/sabnzbd.markdown @@ -39,6 +39,10 @@ host: required: false default: localhost type: string +path: + description: Path to your SABnzbd instance corresponding to its `url_base` setting, e.g., `/sabnzbd`. + required: false + type: string name: description: The name of your SABnzbd instance (this will be the prefix for all created sensors). required: false @@ -81,6 +85,7 @@ Available sensors are: sabnzbd: api_key: YOUR_SABNZBD_API_KEY host: 192.168.1.32 + path: /sabnzbd name: sab port: 9090 ssl: true diff --git a/source/_components/samsungtv.markdown b/source/_components/samsungtv.markdown index cc32df32043..e62de8ebff5 100644 --- a/source/_components/samsungtv.markdown +++ b/source/_components/samsungtv.markdown @@ -33,7 +33,7 @@ host: required: true type: string port: - description: The port of the Samsung Smart TV. If set to 8001, the new websocket connection will be used (required for 2016+ TVs). + description: The port of the Samsung Smart TV. If set to 8001, the new websocket connection will be used (required for 2016+ TVs) - for installs other than Hass.io or Docker you may need to install a Python package, see below. required: false type: integer default: 55000 @@ -77,23 +77,23 @@ Currently known supported models: - K5579 (port must be set to 8001, On/Off, Forward/Backward, Volume control, but no Play button) - K5600AK (partially supported, turn on works but state is not updated) - K6500AF (port must be set to 8001) -- KS7005 (port must be set to 8001, and `pip3 install websocket-client` must be executed, MAC address must be provided, On/Off, Volume are OK, no channel change) -- KS7502 (port must be set to 8001, and `pip3 install websocket-client` must be executed, turn on doesn't work, turn off works fine) -- KS8000 (port must be set to 8001, and `pip3 install websocket-client` must be executed) -- KS8005 (port must be set to 8001, and `pip3 install websocket-client` must be executed) -- KS8500 (port must be set to 8001, and `pip3 install websocket-client` must be executed) -- KU6020 (port must be set to 8001, and `pip3 install websocket-client` must be executed) -- KU6100 (port must be set to 8001, and `pip3 install websocket-client` must be executed) +- KS7005 (port must be set to 8001, MAC address must be provided, On/Off, Volume are OK, no channel change) +- KS7502 (port must be set to 8001, turn on doesn't work, turn off works fine) +- KS8000 (port must be set to 8001) +- KS8005 (port must be set to 8001) +- KS8500 (port must be set to 8001) +- KU6020 (port must be set to 8001) +- KU6100 (port must be set to 8001) - KU6290 (port must be set to 8001) -- KU6400U (port must be set to 8001, and `pip3 install websocket-client` must be executed) +- KU6400U (port must be set to 8001) - KU7000 (port must be set to 8001) -- M5620 (port must be set to 8001, and `pip3 install websocket-client` must be executed) -- MU6170UXZG (port must be set to 8001, and `pip3 install websocket-client` must be executed) +- M5620 (port must be set to 8001) +- MU6170UXZG (port must be set to 8001) - NU7090 (port must be set to 8801, On/Off, MAC must be specified for Power On) -- NU7400 (port set to 8001 and `pip3 install websocket-client` executed) +- NU7400 (port set to 8001) - NU8000 - U6000 (port must be set to 8001) -- U6300 (port must be set to 8001, and `pip3 install websocket-client` must be executed) +- U6300 (port must be set to 8001) - UE6199UXZG (port must be set to 8001, On/Off, Forward/Backward, Volume control, but no Play button) - UE65KS8005 (port must be set to 8001, On/Off, Forward/Backward, Volume are OK, but no Play button) - UE49KU6470 (port must be set to 8001, On/Off, Forward/Backward, Volume are OK, but no Play button) @@ -112,7 +112,7 @@ Currently tested but not working models: - JU7000 - Unable to see state and unable to control (but port 8001 *is* open) - JU7500 - Unable to see state and unable to control - MU6125 - Unable to see state and unable to control (Tested on UE58MU6125 on port 8001 and 8801) -- MU6300 - Port set to 8001, `pip3 install websocket-client` must be executed, turning on works, status not working reliably, turning off is not permanent (it comes back on) +- MU6300 - Port set to 8001, turning on works, status not working reliably, turning off is not permanent (it comes back on) - Q7F - State is always "off" and unable to control via port 8001. None of the 2014 (H) and 2015 (J) model series (e.g., J5200) will work, since Samsung have used a different (encrypted) type of interface for these. @@ -134,3 +134,30 @@ with the following payload: ``` Currently the ability to select a source is not implemented. + +### Hass.io + +No additional actions are required + +### Docker + +No additional actions are required + +### Hassbian + +You will need to activate the venv and install the websocket library: + +```bash +$ sudo -u homeassistant -H -s +$ source /srv/homeassistant/bin/activate +$ pip3 install websocket-client +``` +### Other install methods + +You will need to install the `websocket-client` Python package in your Home Assistant install. This will probably be done with: + +```bash +$ pip3 install websocket-client +``` + +Remembering to activate your venv if you're using a venv install. diff --git a/source/_components/scene.knx.markdown b/source/_components/scene.knx.markdown index 0ee4c644c9b..6a05b862f57 100644 --- a/source/_components/scene.knx.markdown +++ b/source/_components/scene.knx.markdown @@ -7,9 +7,13 @@ ha_category: ha_release: 0.63 --- -The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes. +
+ +The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx). -The `knx` integration must be configured correctly, see [KNX Component](/components/knx). +
+ +The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes. ## Configuration @@ -26,11 +30,11 @@ scene: {% configuration %} address: - description: KNX group address of the binary sensor. + description: KNX group address for the scene. required: true type: string scene_number: - description: Zero-indexed KNX scene number to be activated. + description: KNX scene number to be activated. ( 1 ... 64 ) required: true type: integer name: diff --git a/source/_components/script.markdown b/source/_components/script.markdown index 499d234b114..09ba6536dcd 100644 --- a/source/_components/script.markdown +++ b/source/_components/script.markdown @@ -10,6 +10,8 @@ ha_release: 0.7 The `script` integration allows users to specify a sequence of actions to be executed by Home Assistant when turned on. The script integration will create an entity for each script and allow them to be controlled via services. +## Configuration + The sequence of actions is specified using the [Home Assistant Script Syntax](/getting-started/scripts/). ```yaml @@ -29,11 +31,49 @@ Script names (e.g., `message_temperature` in the example above) are not allowed +{% configuration %} +alias: + description: Friendly name for the script. + required: false + type: string +description: + description: A description of the script that will be displayed in the Services tab under Developer Tools. + required: false + default: '' + type: string +fields: + description: Information about the parameters that the script uses; see the [Passing variables to scripts](#passing-variables-to-scripts) section below. + required: false + default: {} + type: map + keys: + PARAMETER_NAME: + description: A parameter used by this script. + type: map + keys: + description: + description: A description of PARAMETER_NAME. + type: string + example: + description: An example value for PARAMETER_NAME. + type: string +sequence: + description: The sequence of actions to be performed in the script. + required: true + type: list +{% endconfiguration %} + +### Full Configuration + ```yaml script:  - # Turns on the bedroom lights and then the living room lights 1 minute later wakeup: alias: Wake Up + description: 'Turns on the bedroom lights and then the living room lights after a delay' + fields: + minutes: + description: 'The amount of time to wait before turning on the living room lights' + example: 1 sequence: # This is Home Assistant Script Syntax - event: LOGBOOK_ENTRY @@ -49,7 +89,7 @@ script:  brightness: 100 - delay: # supports seconds, milliseconds, minutes, hours - minutes: 1 + minutes: {{ minutes }} - alias: Living room lights on service: light.turn_on data: @@ -102,6 +142,14 @@ Using the variables in the script requires the use of `data_template`: # Example configuration.yaml entry script: notify_pushover: + description: 'Send a pushover notification' + fields: + title: + description: 'The title of the notification' + example: 'State change' + message: + description: 'The message content' + example: 'The light is on!' sequence: - condition: state entity_id: switch.pushover_notifications diff --git a/source/_components/sensor.knx.markdown b/source/_components/sensor.knx.markdown index dbd09b75cff..2432e35c78c 100644 --- a/source/_components/sensor.knx.markdown +++ b/source/_components/sensor.knx.markdown @@ -1,6 +1,6 @@ --- title: "KNX Sensor" -description: "Instructions on how to use the KNX Sensor with Home Assistant." +description: "Instructions on how to use a KNX Sensor with Home Assistant." logo: knx.png ha_category: - Sensor @@ -8,9 +8,16 @@ ha_release: 0.29 ha_iot_class: Local Push --- -The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensors. +
+ +The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx). + +
+ +The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensors. + +Sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/components/knx/#exposing-sensor-values-or-time-to-knx-bus). -The `knx` integration must be configured correctly, see [KNX Component](/components/knx). ## Configuration @@ -21,11 +28,11 @@ To use your KNX sensor in your installation, add the following lines to your `co sensor: - platform: knx name: Heating.Valve1 - address: '2/0/0' + state_address: '2/0/0' ``` {% configuration %} -address: +state_address: description: KNX group address of the sensor. required: true type: string @@ -33,44 +40,68 @@ name: description: A name for this device used within Home Assistant. required: false type: string -type: - description: A type from the following table can be defined. The DPT of the group address should match the expected KNX DPT to be parsed correctly. +sync_state: + description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. required: false + type: boolean + default: True +type: + description: A type from the following table must be defined. The DPT of the group address should match the expected KNX DPT to be parsed correctly. + required: true type: string {% endconfiguration %} -| type | unit | expected KNX DPT | -|--------------------|------|------------------| -| percent | % | 5.001 | -| pulse | | 5.010 | -| temperature | °C | 9.001 | -| humidity | % | 9.007 | -| illuminance | lx | 9.004 | -| brightness | lx | 7.013 | -| speed_ms | m/s | 9.005 | -| current | mA | 7.012 | -| voltage | mV | 9.020 | -| power | W | 14.056 | -| electric_current | A | 14.019 | -| electric_potential | V | 14.027 | -| energy | J | 14.031 | -| frequency | Hz | 14.033 | -| heatflowrate | W | 14.036 | -| phaseanglerad | rad | 14.054 | -| phaseangledeg | ° | 14.055 | -| powerfactor | | 14.057 | -| speed | m/s | 14.065 | -| enthalpy | H | 9.* | -| ppm | ppm | 9.008 | -| DPT-7 | | 7.* | -| 2byte_unsigned | | 7.* | -| DPT-9 | | 9.* | -| DPT-12 | | 12.* | -| 4byte_unsigned | | 12.* | -| DPT-13 | | 13.* | -| 4byte_signed | | 13.* | -| DPT-14 | | 14.* | -| 4byte_float | | 14.* | +| KNX DPT | type | size in byte | unit | +|--------:|--------------------|-------------:|----------------| +| 5.001 | percent | 1 | % | +| 5.003 | angle | 1 | ° | +| 5.004 | percentU8 | 1 | % | +| 5.010 | pulse | 1 | | +| 5.010 | DPT-5 | 1 | | +| 5.010 | 1byte_unsigned | 1 | | +| 6.001 | percentV8 | 1 | % | +| 6.010 | counter_pulses | 1 | counter pulses | +| 7.*** | DPT-7 | 2 | | +| 7.001 | 2byte_unsigned | 2 | pulses | +| 7.012 | current | 2 | mA | +| 7.013 | brightness | 2 | lx | +| 7.600 | color_temperature | 2 | K | +| 8.*** | DPT-8 | 2 | | +| 8.001 | 2byte_signed | 2 | pulses | +| 8.002 | delta_time_ms | 2 | ms | +| 8.005 | delta_time_sec | 2 | s | +| 8.006 | delta_time_min | 2 | min | +| 8.007 | delta_time_hrs | 2 | h | +| 8.010 | percentV16 | 2 | % | +| 8.011 | rotation_angle | 2 | ° | +| 9.* | enthalpy | 2 | H | +| 9.*** | DPT-9 | 2 | | +| 9.001 | temperature | 2 | °C | +| 9.004 | illuminance | 2 | lx | +| 9.005 | speed_ms | 2 | m/s | +| 9.007 | humidity | 2 | % | +| 9.008 | ppm | 2 | ppm | +| 9.020 | voltage | 2 | mV | +| 12.*** | DPT-12 | 4 | | +| 12.*** | 4byte_unsigned | 4 | | +| 13.*** | DPT-13 | 4 | | +| 13.*** | 4byte_signed | 4 | | +| 14.*** | DPT-14 | 4 | | +| 14.*** | 4byte_float | 4 | | +| 14.019 | electric_current | 4 | A | +| 14.027 | electric_potential | 4 | V | +| 14.031 | energy | 4 | J | +| 14.033 | frequency | 4 | Hz | +| 14.036 | heatflowrate | 4 | W | +| 14.042 | luminous_flux | 4 | lm | +| 14.054 | phaseanglerad | 4 | rad | +| 14.055 | phaseangledeg | 4 | ° | +| 14.056 | power | 4 | W | +| 14.057 | powerfactor | 4 | | +| 14.058 | pressure | 4 | Pa | +| 14.065 | speed | 4 | m/s | +| 16.000 | string | 14 | | +| 17.001 | scene_number | 1 | | ## Full example @@ -79,10 +110,11 @@ type: sensor: - platform: knx name: Heating.Valve1 - address: '2/0/0' + state_address: '2/0/0' type: 'percent' - platform: knx name: Kitchen.Temperature - address: '6/2/1' + state_address: '6/2/1' + sync_state: False type: 'temperature' ``` diff --git a/source/_components/sensor.modbus.markdown b/source/_components/sensor.modbus.markdown index 5b2ee02cc8f..13378090288 100644 --- a/source/_components/sensor.modbus.markdown +++ b/source/_components/sensor.modbus.markdown @@ -111,6 +111,12 @@ registers: It's possible to change the default 30 seconds scan interval for the sensor updates as shown in the [Platform options](/docs/configuration/platform_options/#scan-interval) documentation. +
+ +If you specify scale or offset as floating point values, double precision floating point arithmetic will be used to calculate final value. This can cause loss of precision for values that are larger than 2^53. + +
+ ### Full example Example a temperature sensor with a 10 seconds scan interval: diff --git a/source/_components/sma.markdown b/source/_components/sma.markdown index 4b440b9f8f4..af30b3b28f5 100644 --- a/source/_components/sma.markdown +++ b/source/_components/sma.markdown @@ -12,22 +12,36 @@ redirect_from: The `sma` sensor will poll a [SMA](http://www.sma-solar.com/) [(US)](http://www.sma-america.com/) solar inverter and present the values as sensors (or attributes of sensors) in Home Assistant. -This sensor uses the web interface and in order to use it you have to be able to connect to the solar inverter from your favorite web browser. +This sensor uses the web interface and to use it, you have to be able to connect to the solar inverter from your favorite web browser. ## Configuration To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yaml entry (http) sensor: - platform: sma host: IP_ADDRESS_OF_DEVICE password: YOUR_SMA_PASSWORD sensors: - current_consumption: [total_consumption] - pv_power: - total_yield: + - current_consumption + - total_consumption + - pv_power + - total_yield + +# Example configuration.yaml entry (https) +sensor: + - platform: sma + host: IP_ADDRESS_OF_DEVICE + ssl: true + verify_ssl: false + password: YOUR_SMA_PASSWORD + sensors: + - current_consumption + - total_consumption + - pv_power + - total_yield ``` {% configuration %} @@ -55,50 +69,10 @@ group: default: user type: string sensors: - description: A list of sensors that will be added. The value of the list can include a list of sensor names that will be used as attributes. + description: A list of sensors that will be added. Refer to the table in the Sensors section below. If not specified all the sensors in the library will be added. required: false default: All sensors type: list - keys: - pv_power: - description: Current power generated by the inverter (W). - pv_gen_meter: - description: Total kWh generated to date (kWh) - total_yield: - description: Total power yield from solar installation (kWh). - daily_yield: - description: The yield for today (Wh) - - current_consumption: - description: Power that you are currently drawing, depending on your installation it can be a combination of the inverter and the grid (W). - total_consumption: - description: Total power consumption (kWh). - - grid_power_supplied: - description: Power supplied (W) - grid_power_absorbed: - description: Power absorbed (W) - grid_total_yield: - description: Total power fom the grid (kWh) - grid_total_absorbed: - description: Total power supplied to the grid - - grid_power: - description: Power supplied by the grid (W) - frequency: - description: Grid frequency (W) - voltage_l1: - description: Voltage for phase 1 (V) - voltage_l2: - description: Voltage for phase 2 (V) - voltage_l2: - description: Voltage for phase 3 (V) - - status: - description: Status of the solar plant. - - your-custom-sensor: - description: Any sensor name defined in the `custom:` section custom: description: A dictionary of custom sensor key values and units. required: false @@ -117,16 +91,36 @@ custom: required: false default: 1 type: float + path: + description: A custom JMESpath to extract the sensor value (typically not required, advanced use only). + required: false + type: string {% endconfiguration %} -You can create composite sensors, where the sub-sensors will be attributes of the main sensor. E.g., +## Sensors -```yaml - sensors: - - current_power: [total_power, total_consumption] -``` +Sensors available in the library: -The SMA WebConnect module supports a wide variety of sensors, and not all these have been mapped to standard sensors. Custom sensors can be defined by using the `custom` section of the configuration. You will need: A sensor name (no spaces), the SMA sensor key and the unit +| name | Unit | Description | +|--------------|------|:-------------------------------------------| +| pv_power | W | Current power generated by the inverter. | +| pv_gen_meter | kWh | Total kWh generated to date. | +| total_yield | kWh | Total power yield from a solar installation. | +| daily_yield | Wh | The solar plant's yield for today. ! +| current_consumption | W | Power that you are currently drawing, depending on your installation it can be a combination of the inverter and the grid. | +| total_consumption | kWh | Total power consumption. | +| grid_power_supplied | W | Power supplied. | +| grid_power_absorbed | W | Power absorbed. | +| grid_total_yield | kWh | Total power from the grid. | +| grid_total_absorbed | Wh | Total power supplied to the grid +| grid_power | W | Power supplied by the grid. | +| frequency | Hz | Grid frequency. | +| voltage_l1 | V | Voltage for phase 1. | +| voltage_l2 | V | Voltage for phase 2. | +| voltage_l2 | V | Voltage for phase 3. | +| status | | Status of the solar plant. | + +The SMA WebConnect module supports a wide variety of sensors, and not all these have been mapped in the `pysma` library. Custom sensors can be defined by using the `custom` section of the configuration. You will need: A sensor name (no spaces), the SMA sensor key and the unit. Example: diff --git a/source/_components/snapcast.markdown b/source/_components/snapcast.markdown index a272fdd5ca8..ca8d6d88e54 100644 --- a/source/_components/snapcast.markdown +++ b/source/_components/snapcast.markdown @@ -37,7 +37,7 @@ port: The snapcast components provides a few services registered under the media_player component. -### Service `media_player.snapcast_snapshot` +### Service `snapcast.snapshot` Take a snapshot of what is currently playing on one or more speakers. This service, and the following one, are useful if you want to play a doorbell or notification sound and resume playback afterwards. @@ -45,7 +45,7 @@ Take a snapshot of what is currently playing on one or more speakers. This servi | ---------------------- | -------- | ----------- | | `entity_id` | no | The speakers to snapshot. -### Service `media_player.snapcast_restore` +### Service `snapcast.restore` Restore a previously taken snapshot of one or more speakers. @@ -53,7 +53,7 @@ Restore a previously taken snapshot of one or more speakers. | ---------------------- | -------- | ----------- | | `entity_id` | no | String or list of `entity_id`s that should have their snapshot restored. -### Service `media_player.snapcast_join` +### Service `snapcast.join` Group players together under a single group. @@ -62,7 +62,7 @@ Group players together under a single group. | `master` | no | Entity ID of the player to synchronize to. | `entity_id` | yes | String or list of `entity_id`s to join to the master. -### Service `media_player.snapcast_unjoin` +### Service `snapcast.unjoin` Remove one or more speakers from their group of speakers. diff --git a/source/_components/srp_energy.markdown b/source/_components/srp_energy.markdown index b166efaa6e1..c204277e9aa 100644 --- a/source/_components/srp_energy.markdown +++ b/source/_components/srp_energy.markdown @@ -9,6 +9,14 @@ redirect_from: - /components/sensor.srp_energy/ --- +
+ + This integration is deprecated and will be removed in Home Assistant 0.100.0. + + For more information see [Architecture Decision Record: 0004](https://github.com/home-assistant/architecture/blob/master/adr/0004-webscraping.md). + +
+ The `srp_energy` integration shows information from Srp hourly energy usage report for their customers. The srpenergy module fetches the data found on the website. You need a Username, Password, and AccountId which you can create at [Srp](https://www.srpnet.com). diff --git a/source/_components/switch.knx.markdown b/source/_components/switch.knx.markdown index 7765c7c7059..231340dfc2b 100644 --- a/source/_components/switch.knx.markdown +++ b/source/_components/switch.knx.markdown @@ -5,12 +5,16 @@ logo: knx.png ha_category: - Switch ha_release: 0.24 -ha_iot_class: Local Polling +ha_iot_class: Local Push --- -The `knx` switch integration is used as in interface to switching actuators. +
+ +The `knx` integration must be configured correctly to use this integration, see [KNX Integration](/components/knx). -The `knx` integration must be configured correctly, see [KNX Component](/components/knx). +
+ +The `knx` switch platform is used as an interface to switching actuators. ## Configuration diff --git a/source/_components/switch.pca.markdown b/source/_components/switch.pca.markdown index 53fabf8fa38..33de8832c39 100644 --- a/source/_components/switch.pca.markdown +++ b/source/_components/switch.pca.markdown @@ -15,9 +15,8 @@ To use your PCA 301 switch or socket in your installation, add the following to ```yaml # Example configuration.yaml entry -switch: - - platform: pca - device: SERIAL_PORT +elv: + device: SERIAL_PORT ``` This platform will add all PCA 301 switches which are in range. You can read the total used energy in KWh and the current power in Watt. diff --git a/source/_components/syncthru.markdown b/source/_components/syncthru.markdown index 1d8f4de2d31..04b26afa2a8 100644 --- a/source/_components/syncthru.markdown +++ b/source/_components/syncthru.markdown @@ -44,3 +44,7 @@ The following information is displayed in separate sensors, if it is available: - Black, cyan, magenta and yellow drum state - First to fifth paper input tray state - First to sixth paper output tray state + +
+Note that this component or parts thereof may not work if the language of your printer is not configured to be English. +
diff --git a/source/_components/sytadin.markdown b/source/_components/sytadin.markdown index 8333a70c646..164a64fec34 100644 --- a/source/_components/sytadin.markdown +++ b/source/_components/sytadin.markdown @@ -12,6 +12,14 @@ redirect_from: The `sytadin` sensor platform allows you to monitor traffic details from [Sytadin](http://www.sytadin.fr). +
+ +This integration is deprecated and will be removed in Home Assistant 0.100.0. + +For more information see [Architecture Decision Record: 0004](https://github.com/home-assistant/architecture/blob/master/adr/0004-webscraping.md). + +
+ ## Configuration To add Sytadin to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/tensorflow.markdown b/source/_components/tensorflow.markdown index 38066ccb35e..11253c3af22 100644 --- a/source/_components/tensorflow.markdown +++ b/source/_components/tensorflow.markdown @@ -160,3 +160,25 @@ image_processing: ## Optimising resources [Image processing components](/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. + +```yaml +# Example advanced configuration.yaml entry +image_processing: + - platform: tensorflow + scan_interval: 10000 + source: + - entity_id: camera.driveway + - entity_id: camera.backyard +``` + +```yaml +# Example advanced automations.yaml entry +- alias: Tensorflow scanning + trigger: + - platform: state + entity_id: + - binary_sensor.driveway + action: + - service: image_processing.scan + entity_id: camera.driveway +``` diff --git a/source/_components/tikteck.markdown b/source/_components/tikteck.markdown index 1cb6013bca9..e237c431538 100644 --- a/source/_components/tikteck.markdown +++ b/source/_components/tikteck.markdown @@ -41,7 +41,7 @@ devices: type: string {% endconfiguration %} -The password can be obtained from an Android device using an app like [aLogcat](https://play.google.com/store/apps/details?id=org.jtb.alogcat&hl=en) or the `adb logcat` command for phones in developer mode. Look for a line like: +The password can be obtained from an Android device using an app like [aLogcat](https://play.google.com/store/apps/details?id=rs.pedjaapps.alogcatroot.app&hl=en) or the `adb logcat` command for phones in developer mode. Look for a line like: ``` E LedoBleSDK: login =skName=======[Smart Light]=======skPw==[password] diff --git a/source/_components/todoist.markdown b/source/_components/todoist.markdown index 4d97b34a28f..f8fc8c8cc50 100644 --- a/source/_components/todoist.markdown +++ b/source/_components/todoist.markdown @@ -91,7 +91,7 @@ As you can see, there are 4 custom projects here: You can mix-and-match these attributes to create all sorts of custom projects. You can even use [IFTTT](https://ifttt.com/todoist) to create a task with a certain label, then have Home Assistant do some kind of automation when a task with that label comes due. -Home Assistant does its best to [determine what task in each project is "most" important](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/calendar/todoist.py#L432), and it's that task which has its state reported. You can access the other tasks you have due soon via the `all_tasks` array (see below). +Home Assistant does its best to [determine what task in each project is "most" important](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/todoist/calendar.py), and it's that task which has its state reported. You can access the other tasks you have due soon via the `all_tasks` array (see below). ### Sensor attributes diff --git a/source/_components/traccar.markdown b/source/_components/traccar.markdown index 1f0cfe181af..3f9706bb1e1 100644 --- a/source/_components/traccar.markdown +++ b/source/_components/traccar.markdown @@ -10,11 +10,15 @@ redirect_from: - /components/device_tracker.traccar/ --- -`Traccar` uses GPS for tracking and has support for over 1500 different types of devices. +`Traccar` uses GPS for tracking and has support for over 1500 different types of devices. One option is to track the [Traccar Client](https://www.traccar.org/client/) app on a smartphone via `webhook`. The other option is to connect to an existing [Traccar Server](https://www.traccar.org/server/) installation which is also available as Hass.io addon. -## Configuration +## Traccar Client -To integrate Traccar GPS tracker in Home Assistant, add the following section to your `configuration.yaml` file: +To configure Traccar Client, you must set it up via the integrations panel in the configuration screen. This will give you the webhook URL to use during mobile device configuration. This URL has to be set in the Traccar app. + +## Traccar Server + +To integrate Traccar Server in Home Assistant, add the following section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/twitter.markdown b/source/_components/twitter.markdown index e710baf500a..8b3296a21c6 100644 --- a/source/_components/twitter.markdown +++ b/source/_components/twitter.markdown @@ -14,7 +14,7 @@ The `twitter` notification platform uses [Twitter](https://twitter.com) to deliv ## Setup -Go to [Twitter Apps](https://apps.twitter.com/app/new) and create an application. Visit "Keys and Access Tokens" of the application to get the details (Consumer Key, Consumer Secret, Access Token and Access Token Secret which needs to be generated). +Make sure you have a developer account registered with Twitter, then go to [Twitter Apps](https://apps.twitter.com/app/new) and create an application. If you don't have a developer account you need to apply for one, it can take some time to get approved. Visit "Keys and Access Tokens" of the application to get the details (Consumer Key, Consumer Secret, Access Token and Access Token Secret which needs to be generated). ## Configuration diff --git a/source/_components/unifi.markdown b/source/_components/unifi.markdown index ec1c1a12d01..df7ccad1d65 100644 --- a/source/_components/unifi.markdown +++ b/source/_components/unifi.markdown @@ -39,7 +39,7 @@ unifi: site: My site ssid_filter: - 'HomeSSID' - 'IoTSSID' + - 'IoTSSID' ``` {% configuration %} @@ -63,6 +63,21 @@ detection_time: type: integer required: false default: 300 +dont_track_clients: + description: enable to not allow device tracker to track clients. + type: boolean + required: false + default: false +dont_track_devices: + description: enable to not allow device tracker to track devices. + type: boolean + required: false + default: false +dont_track_wired_clients: + description: enable to not allow device tracker to track wired clients. + type: boolean + required: false + default: false ssid_filter: description: Filter the SSIDs that tracking will occur on. type: list diff --git a/source/_components/updater.markdown b/source/_components/updater.markdown index 3b5f99d0709..052c01e9e5e 100644 --- a/source/_components/updater.markdown +++ b/source/_components/updater.markdown @@ -3,14 +3,14 @@ title: "Updater" description: "Detecting when Home Assistant updates are available." logo: home-assistant.png ha_category: - - Other + - binary_sensor ha_qa_scale: internal ha_release: 0.8 --- -The `updater` integration will check daily for new releases. It will show a badge in the frontend if a new version is found. As [Hass.io](/hassio/) has its own schedule for release it doesn't make sense to use this integration on Hass.io. +The `updater` binary sensor will check daily for new releases. The state will be "on" when an update is available. Otherwise, the state will be "off". The newer version, as well as the link to the release notes, are attributes of the updater. As [Hass.io](/hassio/) has its own schedule for release it doesn't make sense to use this binary sensor on Hass.io. -The updater integration will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91). +The updater integration will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater). ## Configuration @@ -59,12 +59,14 @@ For an added bonus, an automation integration can be created to send a message w ```yaml # Example configuration.yaml entry automation: - alias: 'Update Available Notifications' + alias: Update Available Notification trigger: - platform: state - entity_id: updater.updater + - platform: state + entity_id: binary_sensor.updater + from: 'off' + to: 'on' action: - service: notify.notify - data: - message: 'Update for Home Assistant is available.' + - service: notify.notify + data: + message: 'Update for Home Assistant is available.' ``` diff --git a/source/_components/ups.markdown b/source/_components/ups.markdown index 441b01f6c28..9a1c385bcd6 100644 --- a/source/_components/ups.markdown +++ b/source/_components/ups.markdown @@ -10,6 +10,14 @@ redirect_from: - /components/sensor.ups/ --- +
+ +This integration is deprecated and will be removed in Home Assistant 0.100.0. + +For more information see [Architecture Decision Record: 0004](https://github.com/home-assistant/architecture/blob/master/adr/0004-webscraping.md). + +
+ The `ups` platform allows one to track deliveries by the [UPS](https://www.ups.com/). To use this sensor, you need a [My UPS Account](https://www.ups.com/mychoice). ## Configuration diff --git a/source/_components/usps.markdown b/source/_components/usps.markdown index 92defd842fc..cb23482db1d 100644 --- a/source/_components/usps.markdown +++ b/source/_components/usps.markdown @@ -13,6 +13,14 @@ redirect_from: - /components/sensor.usps/ --- +
+ + This integration is deprecated and will be removed in Home Assistant 0.100.0. + + For more information see [Architecture Decision Record: 0004](https://github.com/home-assistant/architecture/blob/master/adr/0004-webscraping.md). + +
+ The `usps` platform allows one to track deliveries and inbound mail from the [US Postal Service (USPS)](https://www.usps.com/). In addition to having a USPS account, you will need to complete the "Opt-In" process for packages by clicking "Get Started Now" on [this page](https://my.usps.com/mobileWeb/pages/intro/start.action). You must also "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see inbound mail. diff --git a/source/_components/utility_meter.markdown b/source/_components/utility_meter.markdown index a79537d2ee2..59af11842ce 100644 --- a/source/_components/utility_meter.markdown +++ b/source/_components/utility_meter.markdown @@ -188,13 +188,11 @@ sensor: sensors: daily_power: friendly_name: Daily Power - icon: mdi:counter unit_of_measurement: kWh - value_template: {{ states('sensor.daily_power_offpeak')|float + states('sensor.daily_power_peak')|float }} + value_template: "{{ states('sensor.daily_power_offpeak')|float + states('sensor.daily_power_peak')|float }}" monthly_power: friendly_name: Monthly Power - icon: mdi:counter unit_of_measurement: kWh - value_template: {{ states('sensor.monthly_power_offpeak')|float + states('sensor.monthly_power_peak')|float }} + value_template: "{{ states('sensor.monthly_power_offpeak')|float + states('sensor.monthly_power_peak')|float }}" ``` {% endraw %} diff --git a/source/_components/vlc-telnet.markdown b/source/_components/vlc_telnet.markdown similarity index 98% rename from source/_components/vlc-telnet.markdown rename to source/_components/vlc_telnet.markdown index 7bef2182ebd..d15e8a4fb32 100644 --- a/source/_components/vlc-telnet.markdown +++ b/source/_components/vlc_telnet.markdown @@ -6,6 +6,8 @@ ha_category: - Media Player ha_release: 0.95 ha_iot_class: Local Polling +redirect_from: + - /components/vlc-telnet --- The `vlc_telnet` platform allows you to control a [VLC media player](http://www.videolan.org/vlc/index.html) using the built in telnet interface. diff --git a/source/_components/webhooks.markdown b/source/_components/webhooks.markdown index 2bf0a0ddb35..3e6f3c4acc2 100644 --- a/source/_components/webhooks.markdown +++ b/source/_components/webhooks.markdown @@ -63,7 +63,7 @@ trusted_networks: description: Telegram server access ACL as list. required: false type: string - default: 149.154.167.197-233 + default: 149.154.160.0/20, 91.108.4.0/22 {% endconfiguration %} To get your `chat_id` and `api_key` follow the instructions [here](/components/notify.telegram). As well as authorizing the chat, if you have added your bot to a group you will also need to authorize any user that will be interacting with the webhook. When an unauthorized user tries to interact with the webhook Home Assistant will raise an error ("Incoming message is not allowed"), you can easily obtain the users id by looking in the "from" section of this error message. @@ -81,12 +81,8 @@ telegram_bot: - platform: webhooks api_key: YOUR_API_KEY trusted_networks: - - 149.154.167.197/32 - - 149.154.167.198/31 - - 149.154.167.200/29 - - 149.154.167.208/28 - - 149.154.167.224/29 - - 149.154.167.232/31 + - 149.154.160.0/20 + - 91.108.4.0/22 allowed_chat_ids: - 12345 - 67890 diff --git a/source/_components/yeelight.markdown b/source/_components/yeelight.markdown index cfc496bf392..1ba375a4a5f 100644 --- a/source/_components/yeelight.markdown +++ b/source/_components/yeelight.markdown @@ -142,7 +142,7 @@ This integration is tested to work with the following models. If you have a diff | ?, may be `ceiling3` | YLXD04YL | Yeelight Ceiling Light (Jiaoyue 450) | | `ceiling3` | YLXD05YL | Yeelight Ceiling Light (Jiaoyue 480) | | `ceiling4` | YLXD02YL | Yeelight Ceiling Light (Jiaoyue 650) | - +| `mono` | YLTD03YL | Yeelight Serene Eye-Friendly Desk Lamp | ## Platform Services @@ -155,7 +155,6 @@ Set an operation mode. | `entity_id` | no | Only act on a specific lights. | | `mode` | no | Operation mode. Valid values are 'last', 'normal', 'rgb', 'hsv', 'color_flow', 'moonlight'. | - ### Service `yeelight.start_flow` Start flow with specified transitions diff --git a/source/_components/zha.markdown b/source/_components/zha.markdown index 13e66e8c7a4..9c8769a9c1f 100644 --- a/source/_components/zha.markdown +++ b/source/_components/zha.markdown @@ -56,11 +56,14 @@ The custom quirks implementations for zigpy implemented as ZHA Device Handlers f - [ConBee II (a.k.a. ConBee 2) USB adapter from Dresden-Elektronik](https://shop.dresden-elektronik.de/conbee-2.html) - [ConBee USB adapter from Dresden-Elektronik](https://www.dresden-elektronik.de/conbee/) - [RaspBee Raspberry Pi Shield from Dresden-Elektronik](https://www.dresden-elektronik.de/raspbee/) +- ZiGate based radios (via the [zigpy-zigate](https://github.com/doudz/zigpy-zigate) library for zigpy) + - ZiGate USB modules (require firmware 3.1a or later) ## Configuration -To configure the component, a `zha` section must be present in the `configuration.yaml`, -and the path to the serial device for the radio and path to the database which will persist your network data is required. +To configure the component, select ZHA on the Integrations page and provide the path to your Zigbee USB stick. + +Or, you can manually confiure `zha` section in `configuration.yaml`. The path to the database which will persist your network data is required. ```yaml # Example configuration.yaml entry @@ -71,7 +74,7 @@ zha: {% configuration %} radio_type: - description: One of `ezsp`, `xbee` or `deconz`. + description: One of `ezsp`, `xbee`, `deconz` or `zigate`. required: false type: string default: ezsp diff --git a/source/_components/zwave.markdown b/source/_components/zwave.markdown index 106a95d6c20..fd69e0c8045 100644 --- a/source/_components/zwave.markdown +++ b/source/_components/zwave.markdown @@ -83,10 +83,10 @@ automation: - platform: time at: "20:00:00" action: - - service: climate.set_operation_mode + - service: climate.set_hvac_mode data: entity_id: climate.remotec_zxt120_heating_1_id - operation_mode: Heat + hvac_mode: Heat - service: climate.set_temperature data: entity_id: climate.remotec_zxt120_heating_1_39 @@ -102,10 +102,10 @@ automation: - platform: time at: "21:00:00" action: - - service: climate.set_operation_mode + - service: climate.set_hvac_mode data: entity_id: climate.remotec_zxt120_heating_1_id - operation_mode: 'Off' + hvac_mode: 'Off' ``` **Note:** In the example above, the word `Off` is encased in single quotes to be valid YAML. @@ -117,7 +117,7 @@ A simple way to test if your Z-Wave climate device is working is to use **Server Control** and click on **Check Config** button in Configuration validation section to make sure there are no syntax errors before restarting Home Assistant. + +If your automation uses templates in any part, you can do the following to make sure it works as expected: + +1. Go to **Developer tools** -> **Template** tab. +2. Create all variables (sources) required for your template as described at the end of [this](https://www.home-assistant.io/docs/configuration/templating/#processing-incoming-data) paragraph. +3. Copy your template code and paste it in Template editor straight after your variables. +4. If necessary, change your sources' value and check if the template works as you want and does not generate any errors. diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown index 420cd090a76..d2724cd03bc 100644 --- a/source/_docs/configuration/customizing-devices.markdown +++ b/source/_docs/configuration/customizing-devices.markdown @@ -8,19 +8,25 @@ redirect_from: /getting-started/customizing-devices/ You can use the UI to change the `entity_id` and friendly name of supported entities. To do this: -1. Select the entity, either from or from the frontend, or by clicking next to the entity in the dev-states menu +1. Select the entity, either from the frontend or by clicking next to the entity in the dev-states menu 2. Click on the cog in the right corner of the entity's dialog 3. Enter the new name or the new entity ID (remember not to change the domain of the entity - the part before the `.`) 4. Select *Save* +If your entity is not supported, or you cannot customize what you need via this method, please see below for more options: + ## Customizing entities By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities. ### Customization using the UI -Under the *Configuration* menu you'll find the *Customization* menu. If this menu item is not visible, enable advanced mode on your [profile page](/docs/authentication/#your-account-profile) first. When you select an entity to customize, you'll see all the existing attributes listed and you can customize those, or select an additional supported attribute ([see below](/docs/configuration/customizing-devices/#possible-values)). +Under the *Configuration* menu you'll find the *Customization* menu. If this menu item is not visible, enable advanced mode on your [profile page](/docs/authentication/#your-account-profile) first. When you select an entity to customize, you'll see all the existing attributes listed and you can customize those or select an additional supported attribute ([see below](/docs/configuration/customizing-devices/#possible-values)). You may also need to add the following to your `configuration.yaml` file, depending when you started using Home Assistant: +```yaml +homeassistant: + customize: !include customize.yaml +``` #### Possible values {% configuration customize %} diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index 88646073fb2..08789841c4a 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -268,6 +268,10 @@ Some of these functions can also be used in a [filter](http://jinja.pocoo.org/do - `sin(value)` will return the sine of the input. Can be used as a filter. - `cos(value)` will return the cosine of the input. Can be used as a filter. - `tan(value)` will return the tangent of the input. Can be used as a filter. +- `asin(value)` will return the arcus sine of the input. Can be used as a filter. +- `acos(value)` will return the arcus cosine of the input. Can be used as a filter. +- `atan(value)` will return the arcus tangent of the input. Can be used as a filter. +- `atan2(y, x)` will return the four quadrant arcus tangent of y / x. Can be used as a filter. - `sqrt(value)` will return the square root of the input. Can be used as a filter. - `e` mathematical constant, approximately 2.71828. - `pi` mathematical constant, approximately 3.14159. diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index d2faea397b6..a3af594e399 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -20,7 +20,9 @@ If you have incorrect entries in your configuration files you can use the [`chec One of the most common problems with Home Assistant is an invalid `configuration.yaml` file. - - You can test your configuration using the command line with: `hass --script check_config`. On Hass.io you can use the [hassio command](/hassio/commandline/#home-assistant): `hassio homeassistant check`. + - You can test your configuration using the command line with: `hass --script check_config`. + - On Hass.io you can use the [hassio command](/hassio/commandline/#home-assistant): `hassio homeassistant check`. + - On Docker you can use `docker exec home-assistant python -m homeassistant --script check_config --config /config` - where `homeassistant` is the name of the container. - You can verify your configuration's yaml structure using [this online YAML parser](http://yaml-online-parser.appspot.com/) or [YAML Lint](http://www.yamllint.com/). - To learn more about the quirks of YAML, read [YAML IDIOSYNCRASIES](https://docs.saltstack.com/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html) by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well). diff --git a/source/_docs/ecosystem/appdaemon.markdown b/source/_docs/ecosystem/appdaemon.markdown index 58b20ea4642..f4c05863a79 100755 --- a/source/_docs/ecosystem/appdaemon.markdown +++ b/source/_docs/ecosystem/appdaemon.markdown @@ -101,4 +101,4 @@ Of course, if I wanted to make this App or its predecessor reusable, I would hav In addition, Apps can write to `AppDaemon`'s log files, and there is a system of constraints that allows you to control when and under what circumstances Apps and callbacks are active to keep the logic clean and simple. -For full installation instructions, see the [AppDaemon Project Documentation pages](http://appdaemon.readthedocs.io/en/stable/). If you're using Hassbian, then the [Hassbian scripts](https://github.com/home-assistant/hassbian-scripts/blob/dev/docs/appdaemon.md) make it easy to install. +For full installation instructions, see the [AppDaemon Project Documentation pages](http://appdaemon.readthedocs.io/en/stable/). If you're using Hassbian, then the [Hassbian scripts](https://github.com/home-assistant/hassbian-scripts/blob/dev/docs/suites/appdaemon.md) make it easy to install. diff --git a/source/_docs/installation.markdown b/source/_docs/installation.markdown index 1b66be349eb..14021f1d3b6 100644 --- a/source/_docs/installation.markdown +++ b/source/_docs/installation.markdown @@ -107,19 +107,13 @@ These guides are provided as-is. Some of these install methods are more limited
Synology
- -
- -
-
Vagrant
-
FreeNAS
 - +
diff --git a/source/_docs/installation/docker.markdown b/source/_docs/installation/docker.markdown index 392e5bf5523..72ae3082e0d 100644 --- a/source/_docs/installation/docker.markdown +++ b/source/_docs/installation/docker.markdown @@ -11,19 +11,19 @@ Installation with Docker is straightforward. Adjust the following command so tha ### Linux ```bash -$ docker run --init -d --name="home-assistant" -v /PATH_TO_YOUR_CONFIG:/config -v /etc/localtime:/etc/localtime:ro --net=host homeassistant/home-assistant +$ docker run --init -d --name="home-assistant" -e "TZ=America/New_York" -v /PATH_TO_YOUR_CONFIG:/config --net=host homeassistant/home-assistant ``` ### Raspberry Pi 3 (Raspbian) ```bash -$ docker run --init -d --name="home-assistant" -v /PATH_TO_YOUR_CONFIG:/config -v /etc/localtime:/etc/localtime:ro --net=host homeassistant/raspberrypi3-homeassistant +$ docker run --init -d --name="home-assistant" -e "TZ=America/New_York" -v /PATH_TO_YOUR_CONFIG:/config --net=host homeassistant/raspberrypi3-homeassistant ``` You need to replace `/PATH_TO_YOUR_CONFIG` with your path to the configuration, for example if you choose your configuration path to be `/home/pi/homeassistant`, then command would be: ```bash -$ docker run --init -d --name="home-assistant" -v /home/pi/homeassistant:/config -v /etc/localtime:/etc/localtime:ro --net=host homeassistant/raspberrypi3-homeassistant +$ docker run --init -d --name="home-assistant" -e "TZ=America/New_York" -v /home/pi/homeassistant:/config --net=host homeassistant/raspberrypi3-homeassistant ``` ### macOS @@ -33,7 +33,7 @@ When using `docker-ce` (or `boot2docker`) on macOS, you are unable to map the lo If you wish to browse directly to `http://localhost:8123` from your macOS host, meaning forward ports directly to the container, replace the `--net=host` switch with `-p 8123:8123`. More detail can be found in [the docker forums](https://forums.docker.com/t/should-docker-run-net-host-work/14215/10). ```bash -$ docker run --init -d --name="home-assistant" -v /PATH_TO_YOUR_CONFIG:/config -e "TZ=America/Los_Angeles" -p 8123:8123 homeassistant/home-assistant +$ docker run --init -d --name="home-assistant" -e "TZ=America/Los_Angeles" -v /PATH_TO_YOUR_CONFIG:/config -p 8123:8123 homeassistant/home-assistant ``` Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking docs](https://docs.docker.com/engine/userguide/networking/#default-networks). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates. @@ -41,7 +41,7 @@ Alternatively, `docker-compose` works with any recent release of `docker-ce` on ### Windows ```powershell -$ docker run --init -d --name="home-assistant" -v /PATH_TO_YOUR_CONFIG:/config -e "TZ=America/Los_Angeles" --net=host homeassistant/home-assistant +$ docker run --init -d --name="home-assistant" -e "TZ=America/Los_Angeles" -v /PATH_TO_YOUR_CONFIG:/config --net=host homeassistant/home-assistant ``` When running Home Assistant in Docker on Windows, you may have some difficulty getting ports to map for routing (since the `--net=host` switch actually applies to the hypervisor's network interface). To get around this, you will need to add port proxy ipv4 rules to your local Windows machine, like so (Replacing '192.168.1.10' with whatever your Windows IP is, and '10.0.50.2' with whatever your Docker container's IP is): @@ -197,7 +197,8 @@ As the docker command becomes more complex, switching to `docker-compose` can be image: homeassistant/home-assistant volumes: - /PATH_TO_YOUR_CONFIG:/config - - /etc/localtime:/etc/localtime:ro + environment: + - TZ=America/New_York restart: always network_mode: host ``` @@ -220,7 +221,7 @@ In order to use Z-Wave, Zigbee or other integrations that require access to devi ```bash $ docker run --init -d --name="home-assistant" -v /PATH_TO_YOUR_CONFIG:/config \ - -v /etc/localtime:/etc/localtime:ro --device /dev/ttyUSB0:/dev/ttyUSB0 \ + -e "TZ=Australia/Melbourne" --device /dev/ttyUSB0:/dev/ttyUSB0 \ --net=host homeassistant/home-assistant ``` @@ -234,11 +235,12 @@ or in a `docker-compose.yml` file: image: homeassistant/home-assistant volumes: - /PATH_TO_YOUR_CONFIG:/config - - /etc/localtime:/etc/localtime:ro devices: - /dev/ttyUSB0:/dev/ttyUSB0 - /dev/ttyUSB1:/dev/ttyUSB1 - /dev/ttyACM0:/dev/ttyACM0 + environment: + - TZ=America/New_York restart: always network_mode: host ``` diff --git a/source/_docs/installation/raspberry-pi.markdown b/source/_docs/installation/raspberry-pi.markdown index 631dc2fb877..1d662e30ffc 100644 --- a/source/_docs/installation/raspberry-pi.markdown +++ b/source/_docs/installation/raspberry-pi.markdown @@ -41,7 +41,7 @@ $ sudo apt-get upgrade -y Install the dependencies. ```bash -$ sudo apt-get install python3 python3-venv python3-pip libffi-dev libssl-dev autoconf +$ sudo apt-get install python3 python3-dev python3-venv python3-pip libffi-dev libssl-dev ``` Add an account for Home Assistant called `homeassistant`. diff --git a/source/_docs/installation/updating.markdown b/source/_docs/installation/updating.markdown index 737bc171273..70caea19b07 100644 --- a/source/_docs/installation/updating.markdown +++ b/source/_docs/installation/updating.markdown @@ -6,7 +6,7 @@ redirect_from: /getting-started/updating/
-The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install [Hass.io](/hassio/), [Hassbian](/docs/installation/hassbian/common-tasks/#update-home-assistant), [Vagrant](/docs/installation/vagrant/), or [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant). +The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install [Hass.io](/hassio/), [Hassbian](/docs/installation/hassbian/common-tasks/#update-home-assistant), or [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant).
@@ -14,7 +14,7 @@ Check what's new in the latest version and potentially impacts your system in [H
-To avoid permission errors, the upgrade must be run as the same user as the installation was completed, again review the documentation specific to your install [Hass.io](/hassio/), [Hassbian](/docs/hassbian/installation/), [Vagrant](/docs/installation/vagrant/), or [Virtualenv](/docs/installation/virtualenv). +To avoid permission errors, the upgrade must be run as the same user as the installation was completed, again review the documentation specific to your install [Hass.io](/hassio/), [Hassbian](/docs/hassbian/installation/), or [Virtualenv](/docs/installation/virtualenv).
@@ -75,6 +75,6 @@ Best practice for updating a Hass.io installation: 1. Backup your installation, using the snapshot functionality Hass.io offers. 2. Check the release notes for breaking changes on [Home Assistant release notes](https://github.com/home-assistant/home-assistant/releases). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f`) and search for **Breaking Changes**. -3. Check your configuration using the [Check Home Assistant configuration](/addons/check_config/) add-on. +3. Check your configuration using the [Check Home Assistant configuration](/addons/check_config/) add-on. 4. If the check passes, you can safely update. If not, update your configuration accordingly. 5. Update Home Assistant. diff --git a/source/_docs/installation/vagrant.markdown b/source/_docs/installation/vagrant.markdown deleted file mode 100644 index 3731173cd40..00000000000 --- a/source/_docs/installation/vagrant.markdown +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: "Installation on Vagrant" -description: "Instructions to run Home Assistant on a Vagrant VM." -redirect_from: /getting-started/installation-vagrant/ ---- - -A `Vagrantfile` is available into `virtualization/vagrant` folder for quickly spinning up a Linux virtual machine running Home Assistant. This can be beneficial for those who want to experiment with Home Assistant and/or developers willing to easily test local changes and run test suite against them. In the same `virtualization/vagrant` folder there's also a `provision.sh` shell script which provides an easy way to interact with the Home Assistant instance running within the Vagrant VM. For Windows, use the batch script `provision.bat`. - -
-Vagrant is intended for testing/development only. It is NOT recommended for permanent installations. -
- -## Install Vagrant - -You must have [Vagrant](https://www.vagrantup.com/downloads.html) and [Virtualbox](https://www.virtualbox.org/wiki/Downloads) installed on your workstation. Vagrant and Virtualbox support all the main platforms, including Windows, MacOS and Linux. - -Limited support is available for Hyper-V on Windows, see below. - -## Get Home Assistant source code - -Download the Home Assistant source code by either downloading the .zip file from [GitHub releases page](https://github.com/home-assistant/home-assistant/releases) or by using [Git](https://git-scm.com/) - -```bash -$ git clone https://github.com/home-assistant/home-assistant.git -$ cd home-assistant/virtualization/vagrant -``` - -
- -The following instructions will assume you changed your working directory to be `home-assistant/virtualization/vagrant`. This is mandatory because Vagrant will look for information about the running VM inside that folder and won't work otherwise - -
- -
- -When using Vagrant on Windows, change git's `auto.crlf` to input before cloning the Home Assistant repository. With input setting git won't automatically change line endings from Unix LF to Windows CRLF. Shell scripts executed during provision won't work with Windows line endings. - -
- -```bash -$ git config --global core.autocrlf input -``` - -## Create the Vagrant VM and start Home Assistant - -```bash -$ ./provision.sh setup -``` - -This will download and start a virtual machine using Virtualbox, which will internally setup the development environment necessary to start Home Assistant. The whole process might take up to 30 minutes to complete, depending on Internet connection speed and workstation resources. After the VM has started successfully, the Home Assistant frontend will be accessible locally from your browser at [http://localhost:8123](http://localhost:8123) - -## Stopping Vagrant - -To shutdown the Vagrant host: - -```bash -$ ./provision.sh stop -``` - -To start it again: - -```bash -$ ./provision.sh start -``` - -## Restarting Home Assistant process to test changes - -The root `home-assistant` directory on your workstation will be mirrored with `/home-assistant` inside the VM. In `virtualization/vagrant` there's also a `config` folder that you can use to drop configuration files (Check the [Configuration section](/docs/configuration/) in the docmentation for more information about how to configure Home Assistant). - -Any changes made to the local directory on your workstation will be available from the Vagrant host, so to apply your changes to the Home Assistant process, just restart it using the provided `provision.sh` wrapper script: - -```bash -$ ./provision.sh restart -``` - -
-This command will only restart the Home Assistant process inside the Vagrant VM, it will not reboot the virtual machine. If that's what you want, the right command is vagrant reload -
- -## Run test suite (Tox) - -To run tests against the local version of Home Assistant code: - -```bash -$ ./provision.sh tests -``` - -## Cleanup - -To completely remove the VM - -```bash -$ ./provision.sh destroy -``` - -To completely remove the VM **and** setup a fresh new environment: - -```bash -$ ./provision.sh recreate -``` - -## Windows - -On Windows, Vagrant is launched through an elevated `PowerShell`. Use the batch script `provision.bat` instead of the shell script `provision.sh`. - -## Hyper-V - -It is possible to use Hyper-V instead of Virtualbox on Windows, with some limitations. - -Samba is used for the virtual machine to access files, for which the Windows credentials are needed when the machine is created. -As Hyper-V does not allow for port forwarding, NAT is used by default for the network. Through creating an external network switch in Hyper-V it is possible to access the machine on the network. -The IP address is visible on creation, and through the Hyper-V manager. diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown index b82dddb5f69..b9fafaac92e 100644 --- a/source/_docs/z-wave/controllers.markdown +++ b/source/_docs/z-wave/controllers.markdown @@ -7,11 +7,11 @@ description: "Extended instructions how to setup Z-Wave." You need to have a compatible Z-Wave stick or module installed. This needs to be a *static controller*, which most Z-Wave sticks and modules will be. If yours is a *bridge* device then it won't work with [OpenZWave](http://openzwave.com/), which is what provides Home Assistant's Z-Wave capabilities. The following devices have been confirmed to work: -

- +

+ There have [been reports](https://www.raspberrypi.org/forums/viewtopic.php?f=28&t=245031#p1502030) of the Aeotec stick not working on the Raspberry Pi 4. -

+
* Aeotec Z-Stick Series 5 * Everspring USB stick - Gen 5 diff --git a/source/_docs/z-wave/device-specific.markdown b/source/_docs/z-wave/device-specific.markdown index 59b9ff49900..6ed30e45d2c 100644 --- a/source/_docs/z-wave/device-specific.markdown +++ b/source/_docs/z-wave/device-specific.markdown @@ -191,6 +191,161 @@ Triple tap on|2|4 5x tap off|1|6 5x tap on|2|6 +### Zooz Scene Capable On/Off and Dimmer Wall Switches (Zen26 & Zen27 - Firmware 2.0+) + +Many Zooz Zen26/27 switches that have been sold do not have firmware 2.0+. Contact Zooz to obtain the over the air firmware update instructions and new user manual for the switches. + +Once the firmware is updated, the the new configuration paramters will have to be added to the `zwcfg` file. Replace the existing `COMMAND_CLASS_CONFIGURATION` with the one of the following options (depending on your model of switch): + +Zen26 (On/Off Switch): +```xml + + + + Normal mode: Upper paddle turns the light on, lower paddle turns the light off. Reverse will reverse those functions. Any will toggle the light regardless of which button is pushed. + + + + + + LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on. + + + + + + + Enable or disable the auto turn-off timer function. + + + + + Time, in seconds, for auto-off timer delay. 60 (default). + + + Enable or disable the auto turn-on timer function. + + + + + Time, in minutes, for auto-on timer delay. 60 (default). + + + Status after power on after power failure. OFF will always turn light off. ON will always turn light on. Restore will remember the latest state and restore that state. + + + + + + Enable or disable scene control functionality for quick double tap triggers. + + + + + Enable or disable local on/off control. If enabled, you'll only be able to control the connected light via Z-Wave. + + + + +``` + +Zen27 (Dimmer): +```xml + + + + Normal mode: Upper paddle turns the light on, lower paddle turns the light off. Reverse will reverse those functions. Any will toggle the light regardless of which button is pushed. + + + + + + LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on. + + + + + + + + + + + Time, in minutes, for auto-off timer delay. + + + + + + + Time, in minutes, for auto-off timer delay. + + + Status after power on after power failure. OFF will always turn light off. ON will always turn light on. Restore will remember the latest state and restore that state. + + + + + + Adjust the ramp rate for your dimmer (fade-in / fade-out effect for on / off operation). Values correspond to the number of seconds it take for the dimmer to reach full brightness or turn off when operated manually. + + + Set the minimum brightness level for your dimmer. You won't be able to dim the light below the set value. + + + Set the maximum brightness level for your dimmer. You won't be able to add brightness to the light beyond the set value. Note: if Parameter 12 is set to value "Full", Parameter 11 is automatically disabled. + + + Double Tap action. When set to Full, turns light on to 100%. If set to Maximum Level, turns light on to % set in Parameter 11. + + + + + Enable or disable scene control functionality for quick double tap triggers. + + + + + Enable the double tap or disable the double tap function and assign brightness level to single tap. + + + + + + Enable or disable local on/off control. If enabled, light will only be able to be controlled via Z-Wave. + + + + +``` + +For Zooz switches, you'll need to update (or possibly add) the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following: +```xml + + + + + + +``` + +Go to the Z-Wave Network Management section in the Home Assistant Configuration, select the node which has just been updated and enable the scene support configuration paramter. + +Once this is complete, you should see the following `zwave.scene_activated` events: + +**Action**|**scene\_id**|**scene\_data** +:-----:|:-----:|:-----: +Single tap off|1|7680 +Single tap on|2|7680 +Double tap off|1|7860 +Double tap on|2|7860 +Triple tap off|1|7920 +Triple tap on|2|7920 +4x tap off|1|7980 +4x tap on|2|7980 +5x tap off|1|8040 +5x tap on|2|8040 + ### HomeSeer Switches For the HomeSeer devices specifically, you may need to update the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following: diff --git a/source/_docs/z-wave/services.markdown b/source/_docs/z-wave/services.markdown index 80290954c88..a6014382cb9 100644 --- a/source/_docs/z-wave/services.markdown +++ b/source/_docs/z-wave/services.markdown @@ -31,7 +31,6 @@ The `zwave` integration exposes multiple services to help maintain the network. | stop_network | Stops the Z-Wave network. | | test_network | Tells the controller to send no-op commands to each node and measure the time for a response. In theory, this can also bring back nodes which have been marked "presumed dead." | | test_node | Tells the controller to send no-op command(s) to a specific node. Requires `node_id` field. You can specify amount of test_messages to send by specifying it with `messages` field. In theory, this could bring back nodes marked as "presumed dead" -| update_config | Attempt to update OZW configuration files from git to support newer devices. After you run this, wait a few minutes then stop Home Assistant. You can now back up your `zwcfg_*.xml` file, then delete the relevant entries from your `zwcfg_*.xml` (between and including `` and ``), and finally start Home Assistant. | The `soft_reset` and `heal_network` commands can be used to help keep a Z-Wave network running reliably. This is a configuration option for the `zwave` component. The option defaults to `false` but can be enabled by setting `autoheal` to true. This, however, is bad practice since it introduces overhead that can be avoided since you only need to do a `heal_network` whenever one of the following actions are done: diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index e1c2af85c22..054b60fbf2a 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -61,6 +61,7 @@
  • {% active_link /docs/automation/condition/ Conditions %}
  • {% active_link /docs/automation/action/ Actions %}
  • {% active_link /docs/automation/templating/ Templates %}
    • +
  • {% active_link /docs/automation/troubleshooting/ Troubleshooting %}
  • diff --git a/source/_lovelace/markdown.markdown b/source/_lovelace/markdown.markdown index 63a8d298ca1..f8aafc15067 100644 --- a/source/_lovelace/markdown.markdown +++ b/source/_lovelace/markdown.markdown @@ -18,13 +18,23 @@ type: type: string content: required: true - description: "Content to render as [markdown](http://commonmark.org/help/)." + description: "Content to render as [markdown](http://commonmark.org/help/). May contain [templates](/configuration/templating/)." type: string title: required: false description: The card title. type: string default: none +card_size: + required: false + type: integer + default: none + description: The algorithm for placing cards aesthetically in lovelace may have problems with the markdown card if it contains templates. You can use this value to help it estimate the height of the card in units of 50 pixels (approximately 3 lines of text in default size). (e.g., `4`) +entity_id: + required: false + type: [string, list] + default: none + description: "A list of entity IDs so a template in `content:` only reacts to the state changes of these entities. This can be used if the automatic analysis fails to find all relevant entities." {% endconfiguration %} ## Example @@ -36,3 +46,27 @@ content: > Starting with Home Assistant 0.72, we're experimenting with a new way of defining your interface. We're calling it the **Lovelace UI**. ``` + +## Template variables + +A special template variable - `config` is set up for the `content` of the card. It contains the configuration of the card. + +E.g. +{% raw %} +```yaml +type: entity-filter +entities: + - light.bed_light + - light.ceiling_lights + - light.kitchen_lights +card: + type: markdown + content: | + The lights that are on are: + {% for l in config.entities %} + - {{ l.entity }} + {%- endfor %} + + And the door is {% if is_state('binary_sensor.door', 'on' %} open {% else %} closed {% endif %}. +``` +{% endraw %} diff --git a/source/_posts/2019-02-11-hass-cli-0-dot-5-area-entity-registry-and-event-cli.markdown b/source/_posts/2019-02-11-hass-cli-0-dot-5-area-entity-registry-and-event-cli.markdown index ddf0f0edbe1..3940cf811bb 100644 --- a/source/_posts/2019-02-11-hass-cli-0-dot-5-area-entity-registry-and-event-cli.markdown +++ b/source/_posts/2019-02-11-hass-cli-0-dot-5-area-entity-registry-and-event-cli.markdown @@ -144,7 +144,7 @@ Minor fixes: * fix bad typing [499b544](http://github.com/home-assistant/home-assistant-cli/commit/499b5449b0441b546ea48aff212754433457dbd5) @maxandersen * fix editor formatting [86d9bf8](http://github.com/home-assistant/home-assistant-cli/commit/86d9bf8bf6bfb5bec1a9f28177c105f84912a91b) @maxandersen * Fix version [3765a03](http://github.com/home-assistant/home-assistant-cli/commit/3765a03ccf11f0865baa7e70937279bcaa245352) @maxandersen -* Fix version marker [edbe4bf](http://github.com/homeassistant/homeassistant-cli/commit/edbe4bf42e7d0993d68a367ca04ad80217aac395) @maxandersen +* Fix version marker [edbe4bf](http://github.com/home-assistant/home-assistant-cli/commit/edbe4bf42e7d0993d68a367ca04ad80217aac395) @maxandersen Have fun! diff --git a/source/_posts/2019-04-24-release-92.markdown b/source/_posts/2019-04-24-release-92.markdown index 8ef8d80b108..58984611a7c 100644 --- a/source/_posts/2019-04-24-release-92.markdown +++ b/source/_posts/2019-04-24-release-92.markdown @@ -229,7 +229,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - Always set latest pin ([@balloob] - [#23328]) ([cloud docs]) (beta fix) - Add sensor and binary senseor to default expose ([@balloob] - [#23332]) ([google_assistant docs]) (beta fix) - Support unicode in configuration migration ([@awarecan] - [#23335]) (beta fix) -- Remove ghost folder ([@awarecan] - [#23350]) (aws_lambda docs) ([aws_sns docs]) ([aws_sqs docs]) (beta fix) +- Remove ghost folder ([@awarecan] - [#23350]) (aws_lambda docs) (aws_sns docs) (aws_sqs docs) (beta fix) ## All changes @@ -301,7 +301,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - Google Assistant: Add support for open/close binary sensors ([@balloob] - [#22674]) ([binary_sensor docs]) ([google_assistant docs]) - Update light/services.yaml ([@emontnemery] - [#22662]) - Fix connection loss issues for Harmony ([@ehendrix23] - [#22687]) ([harmony docs]) -- Remove aws_* notify platforms ([@awarecan] - [#22698]) (aws_lambda docs) ([aws_sns docs]) ([aws_sqs docs]) +- Remove aws_* notify platforms ([@awarecan] - [#22698]) (aws_lambda docs) (aws_sns docs) (aws_sqs docs) - Add manifests ([@balloob] - [#22699]) - Add a .codecov.yml to control coverage statuses and enable notifications ([@robbiet480] - [#22707]) - Raise ConfigEntryNotReady for MQTT connection exception ([@aav7fl] - [#22540]) @@ -542,7 +542,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - Always set latest pin ([@balloob] - [#23328]) ([cloud docs]) (beta fix) - Add sensor and binary senseor to default expose ([@balloob] - [#23332]) ([google_assistant docs]) (beta fix) - Support unicode in configuration migration ([@awarecan] - [#23335]) (beta fix) -- Remove ghost folder ([@awarecan] - [#23350]) (aws_lambda docs) ([aws_sns docs]) ([aws_sqs docs]) (beta fix) +- Remove ghost folder ([@awarecan] - [#23350]) (aws_lambda docs) (aws_sns docs) (aws_sqs docs) (beta fix) [#19590]: https://github.com/home-assistant/home-assistant/pull/19590 [#20256]: https://github.com/home-assistant/home-assistant/pull/20256 @@ -966,8 +966,6 @@ Experiencing issues introduced by this release? Please report them in our [issue [automation docs]: /components/automation/ [awair docs]: /components/awair/ [aws docs]: /components/aws/ -[aws_sns docs]: /components/aws_sns/ -[aws_sqs docs]: /components/aws_sqs/ [axis docs]: /components/axis/ [binary_sensor docs]: /components/binary_sensor/ [bloomsky docs]: /components/bloomsky/ diff --git a/source/_posts/2019-08-07-release-97.markdown b/source/_posts/2019-08-07-release-97.markdown index 9c19cf6b369..c1601dedffb 100644 --- a/source/_posts/2019-08-07-release-97.markdown +++ b/source/_posts/2019-08-07-release-97.markdown @@ -79,6 +79,60 @@ We wrote about how we use Azure DevOps to automate the development of Home Assis - Add De Lijn (Flemish Public Transport) component ([@bollewolle] - [#24265]) ([delijn docs]) (new-integration) (new-platform) - Add Support for VeSync Devices - Outlets and Switches ([@webdjoe] - [#24953]) ([vesync docs]) (new-platform) +## Release 0.97.1 - August 9 + +A new breaking change was introduced with 0.97.1 to accomodate for the HaveIBeenPwned shutting down v2 of their API on August 18. The integration has been migrated to using v3. + +- Update HIBP sensor to use API v3 and API Key ([@aetaric] - [#25699]) ([haveibeenpwned docs]) (breaking change) +- Update Cisco Mobility Express module version ([@fbradyirl] - [#25770]) ([cisco_mobility_express docs]) +- Don't track unstable attributes ([@jjlawren] - [#25787]) ([unifi docs]) (breaking change) +- Fix deconz allow_clip_sensor and allow_deconz_groups options ([@Anonym-tsk] - [#25811]) ([deconz docs]) + +[#25699]: https://github.com/home-assistant/home-assistant/pull/25699 +[#25770]: https://github.com/home-assistant/home-assistant/pull/25770 +[#25787]: https://github.com/home-assistant/home-assistant/pull/25787 +[#25811]: https://github.com/home-assistant/home-assistant/pull/25811 +[@Anonym-tsk]: https://github.com/Anonym-tsk +[@aetaric]: https://github.com/aetaric +[@fbradyirl]: https://github.com/fbradyirl +[@jjlawren]: https://github.com/jjlawren +[cisco_mobility_express docs]: /components/cisco_mobility_express/ +[deconz docs]: /components/deconz/ +[haveibeenpwned docs]: /components/haveibeenpwned/ +[unifi docs]: /components/unifi/ + +## Release 0.97.2 - August 11 + +- Fix eco preset for Wink Air Conditioner ([@cameronrmorris] - [#25763]) ([wink docs]) +- Update pyvera to 0.3.3 ([@brandond] - [#25820]) ([vera docs]) +- Fix Netatmo climate issue ([@cgtobi] - [#25830]) ([netatmo docs]) +- Fix KNX Climate mode change callback ([@tombbo] - [#25851]) ([knx docs]) +- Always populate hvac_modes in SmartThings climate platform ([@andrewsayre] - [#25859]) ([smartthings docs]) +- UniFi - Use state to know if device is online ([@Kane610] - [#25876]) ([unifi docs]) +- Fix issue with nuki new available state ([@pvizeli] - [#25881]) ([nuki docs]) + +[#25763]: https://github.com/home-assistant/home-assistant/pull/25763 +[#25820]: https://github.com/home-assistant/home-assistant/pull/25820 +[#25830]: https://github.com/home-assistant/home-assistant/pull/25830 +[#25851]: https://github.com/home-assistant/home-assistant/pull/25851 +[#25859]: https://github.com/home-assistant/home-assistant/pull/25859 +[#25876]: https://github.com/home-assistant/home-assistant/pull/25876 +[#25881]: https://github.com/home-assistant/home-assistant/pull/25881 +[@Kane610]: https://github.com/Kane610 +[@andrewsayre]: https://github.com/andrewsayre +[@brandond]: https://github.com/brandond +[@cameronrmorris]: https://github.com/cameronrmorris +[@cgtobi]: https://github.com/cgtobi +[@pvizeli]: https://github.com/pvizeli +[@tombbo]: https://github.com/tombbo +[knx docs]: /components/knx/ +[netatmo docs]: /components/netatmo/ +[nuki docs]: /components/nuki/ +[smartthings docs]: /components/smartthings/ +[unifi docs]: /components/unifi/ +[vera docs]: /components/vera/ +[wink docs]: /components/wink/ + ## If you need help... ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). @@ -146,6 +200,8 @@ Experiencing issues introduced by this release? Please report them in our [issue - Due in -> due_in - Due at -> due_at +- **haveibeenpwned** - the v2 API is now replaced with the v3 API, which requires an API key. v2 of the API will stop working on August 18. + ## Beta Fixes - Expose comfort presets as HA presets ([@balloob] - [#25491]) ([ecobee docs]) (breaking change) (beta fix) diff --git a/source/developers/credits.markdown b/source/developers/credits.markdown index 45b545902d3..4769d6ad038 100644 --- a/source/developers/credits.markdown +++ b/source/developers/credits.markdown @@ -4541,7 +4541,7 @@ This page contains a list of people who have contributed in one way or another t - [jaminh (@jaminh)](https://github.com/jaminh "1 total commits to the Home Assistant orga: 1 commit to open-zwave ") -- [JammyDodger231 (@JammyDodger231)](https://github.com/JammyDodger231 "6 total commits to the Home Assistant orga: +- [JamesMcClelland (@JamesMcClelland)](https://github.com/JamesMcClelland "6 total commits to the Home Assistant orga: 6 commits to home-assistant.io ") - [Jan Almeroth (@jalmeroth)](https://github.com/jalmeroth "8 total commits to the Home Assistant orga: @@ -7698,7 +7698,7 @@ This page contains a list of people who have contributed in one way or another t 12 commits to home-assistant 9 commits to home-assistant.io ") -- [Nick Zelei (@zelein)](https://github.com/zelein "1 total commits to the Home Assistant orga: +- [Nick Zelei (@nickzelei)](https://github.com/nickzelei "1 total commits to the Home Assistant orga: 1 commit to home-assistant.io ") - [Nicko van Someren (@nickovs)](https://github.com/nickovs "9 total commits to the Home Assistant orga: @@ -8350,7 +8350,7 @@ This page contains a list of people who have contributed in one way or another t - [Peter Tisovčík (@mienkofax)](https://github.com/mienkofax "1 total commits to the Home Assistant orga: 1 commit to open-zwave ") -- [Peter Weidenkaff (@hansgans)](https://github.com/hansgans "1 total commits to the Home Assistant orga: +- [Peter Weidenkaff (@weidenka)](https://github.com/weidenka "1 total commits to the Home Assistant orga: 1 commit to home-assistant.io ") - [Peter Zsak (@wroadd)](https://github.com/wroadd "1 total commits to the Home Assistant orga: diff --git a/source/hassio/commandline.markdown b/source/hassio/commandline.markdown index baf99c4bb62..8cd2c7bf925 100644 --- a/source/hassio/commandline.markdown +++ b/source/hassio/commandline.markdown @@ -57,33 +57,32 @@ Replace x.y.z with the desired version like `--version=0.74.2` You can get a better description of the CLI capabilities by typing `hassio help`: ```bash -NAME: - hassio - Commandline tool to allow interaction with hass.io +Usage: + hassio [command] -USAGE: - hassio [global options] command [command options] [arguments...] +Available Commands: + addons Install, update, remove and configure Hass.io add-ons + dns Get information, update or configure the Hass.io DNS server + hardware Provides hardware information about your system + hassos HassOS specific for updating, info and configuration imports + help Help about any command + homeassistant Provides control of Home Assistant running on Hass.io + host Control the host/system that Hass.io is running on + info Provides a general Hass.io information overview + snapshots Create, restore and remove snapshot backups + supervisor Monitor, control and configure the Hass.io Supervisor -VERSION: - 1.3.1 +Flags: + --api-token string Hass.io API token + --config string Optional config file (default is $HOME/.homeassistant.yaml) + --endpoint string Endpoint for Hass.io Supervisor ( default is 'hassio' ) + -h, --help help for hassio + --log-level string Log level (defaults to Warn) + --no-progress Disable the progress spinner + --raw-json Output raw JSON from the API -AUTHOR: - Home-Assistant +Use "hassio [command] --help" for more information about a command. -COMMANDS: - homeassistant, ha info, logs, check, restart, start, stop, update - supervisor, su info, logs, reload, update - host, ho reboot, shutdown, update - hardware, hw info, audio - network, ne info, options - snapshots, sn list, info, reload, new, restore, remove - addons, ad list, info, logo, changelog, logs, stats, - reload, start, stop, install, uninstall, update - help, h Shows a list of commands or help for one command - -GLOBAL OPTIONS: - --debug, -d Prints Debug information - --help, -h show help - --version, -v print the version ``` ## Console access diff --git a/source/images/frontpage/cast-frontpage.png b/source/images/frontpage/cast-frontpage.png new file mode 100644 index 00000000000..e94ce24913c Binary files /dev/null and b/source/images/frontpage/cast-frontpage.png differ diff --git a/source/images/screenshots/geonetnz-quakes-feed-map.png b/source/images/screenshots/geonetnz-quakes-feed-map.png new file mode 100644 index 00000000000..8f432e511a1 Binary files /dev/null and b/source/images/screenshots/geonetnz-quakes-feed-map.png differ diff --git a/source/images/supported_brands/edp_redy.png b/source/images/supported_brands/edp_redy.png deleted file mode 100644 index 0371f81f6a7..00000000000 Binary files a/source/images/supported_brands/edp_redy.png and /dev/null differ diff --git a/source/images/supported_brands/geonet-nz.png b/source/images/supported_brands/geonet-nz.png new file mode 100644 index 00000000000..69768c2902f Binary files /dev/null and b/source/images/supported_brands/geonet-nz.png differ diff --git a/source/images/supported_brands/google_home.png b/source/images/supported_brands/google_home.png deleted file mode 100644 index 645627d6a45..00000000000 Binary files a/source/images/supported_brands/google_home.png and /dev/null differ diff --git a/source/images/supported_brands/keba.png b/source/images/supported_brands/keba.png new file mode 100644 index 00000000000..ac182405dc4 Binary files /dev/null and b/source/images/supported_brands/keba.png differ diff --git a/source/images/supported_brands/mercedesme.png b/source/images/supported_brands/mercedesme.png deleted file mode 100644 index 008791b1a70..00000000000 Binary files a/source/images/supported_brands/mercedesme.png and /dev/null differ diff --git a/source/images/supported_brands/minio.png b/source/images/supported_brands/minio.png new file mode 100644 index 00000000000..38f6ff9f01d Binary files /dev/null and b/source/images/supported_brands/minio.png differ diff --git a/source/images/supported_brands/plugwise.png b/source/images/supported_brands/plugwise.png new file mode 100644 index 00000000000..f48480b7b13 Binary files /dev/null and b/source/images/supported_brands/plugwise.png differ diff --git a/source/images/supported_brands/ruter.png b/source/images/supported_brands/ruter.png deleted file mode 100644 index 18023120250..00000000000 Binary files a/source/images/supported_brands/ruter.png and /dev/null differ diff --git a/source/images/supported_brands/vagrant.png b/source/images/supported_brands/vagrant.png deleted file mode 100644 index b924569ea71..00000000000 Binary files a/source/images/supported_brands/vagrant.png and /dev/null differ diff --git a/source/index.html b/source/index.html index 4f6349ff5a8..a736d8601cb 100644 --- a/source/index.html +++ b/source/index.html @@ -48,6 +48,17 @@ description: Open source home automation that puts local control and privacy fir Read our founder's vision for the perfect home automation + + +
    +
    Take over all the screens
    +
    Home Assistant Cast makes each TV a display.
    +
    +