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/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/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.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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/updater.markdown b/source/_components/updater.markdown index ab4f81cc2d5..052c01e9e5e 100644 --- a/source/_components/updater.markdown +++ b/source/_components/updater.markdown @@ -10,7 +10,7 @@ ha_release: 0.8 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 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 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 6ccb9a356f4..9c8769a9c1f 100644 --- a/source/_components/zha.markdown +++ b/source/_components/zha.markdown @@ -61,8 +61,9 @@ The custom quirks implementations for zigpy implemented as ZHA Device Handlers f ## 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 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/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/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/_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/_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 110ab89d05c..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). @@ -95,7 +149,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - **Z-Wave** - Improve handling of Z-Wave config entry vs yaml config. If a Z-Wave `network_key` is specified in configuration.yaml it will override a `network_key` specified in the Z-Wave config entry. ([@cgarwood] - [#25112]) ([zwave docs]) - **Unifi** - Unifi Device tracker is now part of config entry. After initial import the unifi device tracker configuration is no longer needed. If configuring SSID filter or detection time you will need to use the new configuration from UniFi. See UniFi component documentation for details. ([@Kane610] - [#24367]) ([unifi docs]) - **Ecobee** - Ecobee presets now represent the different Ecobee comfort settings. Selectable by name instead of unknown ID. ([@balloob] - PR link todo) -- **Calendar** - Rewrite calendar component - The calendar integration has been rewritten to follow our current standards and is mostly non breaking. The reset (clean up) of state attributes upon an event time passing has been removed, though. Attributes are no longer set to an arbitrary default value, and will now keep the attributes representing the last event. With this change, automations that rely on state attributes getting reset will need to be updated. All platforms have been converted. - ([@MartinHjelmare] - [#24950]) ([caldav docs]) ([calendar docs]) ([demo docs]) ([google docs]) ([todoist docs]) +- **Calendar** - Rewrite calendar component - The calendar integration has been rewritten to follow our current standards and is mostly non breaking. The reset (clean up) of state attributes upon an event time passing has been removed, though. Attributes are no longer set to an arbitrary default value, and will now keep the attributes representing the last event. With this change, automations that rely on state attributes getting reset will need to be updated. All platforms have been converted. - ([@MartinHjelmare] - [#24950]) ([caldav docs]) ([calendar docs]) ([demo docs]) ([google cal docs]) ([todoist docs]) - **SyncThru** - The monitored_conditions configuration option has been removed. All available monitored conditions will be used by default. Users that have been using the monitored_conditions option need to remove it from the syncthru section in configuration.yaml. ([@nielstron] - [#25052]) ([syncthru docs]) - **KNX** - Updates the knx component to use xknx 0.11.1 . This introduces several new features and bugfixes. For a complete list see: https://github.com/XKNX/xknx/releases/tag/0.11.0 ([@farmio] - [#24738]) ([knx docs]) - `scene:` `scene_number` is now 1 indexed according to KNX standards. Previously it was 0 based. Please add 1 to your already configured scene numbers (`scene_number: 5` becomes `scene_number: 6`). @@ -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) @@ -695,7 +751,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [fortigate docs]: /components/fortigate/ [fortios docs]: /components/fortios/ [geniushub docs]: /components/geniushub/ -[google docs]: /components/google/ +[google cal docs]: /components/calendar.google/ [google_assistant docs]: /components/google_assistant/ [google_maps docs]: /components/google_maps/ [google_travel_time docs]: /components/google_travel_time/ 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/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/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.
    +
    +