diff --git a/source/_addons/check_config.markdown b/source/_addons/check_config.markdown index a11232b5ea3..9ae856d22a3 100644 --- a/source/_addons/check_config.markdown +++ b/source/_addons/check_config.markdown @@ -11,6 +11,16 @@ footer: true You can use this add-on to check whether your configuration files are valid against the new version of Home Assistant before you actually update your Home Assistant installation. This add-on will help you avoid errors due to breaking changes, resulting in a smooth update. +### {% linkable_title How to use this add-on %} + +1. Just start the add-on. +2. Wait (On a Raspberry Pi it can take several minutes). +3. If you see the following output then you are good to go to update Home Assistant: `[Info] Configuration check finished - no error found! :)`. + +If you get errors, then you should look for **Breaking Changes** against the version you specified for this add-on and change your configuration accordingly. + +### {% linkable_title Add-on configuration %} + ```json { "version": "latest" diff --git a/source/_addons/mosquitto.markdown b/source/_addons/mosquitto.markdown index 2f8a4d15fe4..26d93276cc3 100644 --- a/source/_addons/mosquitto.markdown +++ b/source/_addons/mosquitto.markdown @@ -55,6 +55,24 @@ This add-on is attached to the Home Assistant user system, so mqtt clients can m To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the integration page and install the configuration with one click. If you have old MQTT settings available, remove this old integration and restart Home Assistant to see the new one. +#### {% linkable_title Using Mosquitto with Hass.io %} + +1. Install the [Mosquitto add-on](https://www.home-assistant.io/addons/mosquitto/) with the default configuration via 'Hass.io > ADD-ON STORE'. (Don't forget to start the add-on & verify that 'Start on boot' is enabled.) + +2. Create a new user for MQTT via the `Configuration > Users (manage users)`. (Note: This name cannot be "homeassistant" or "addon") + +3. Once back on-line, return to `Configuration > Integrations` and select configure next to `MQTT`. + +``` + Broker: YOUR_HASSIO_IP_ADDRESS + Port: 1883 + Username: MQTT_USERNAME + Password: MQTT_PASSWORD +``` + +Note: .yaml modifications are not required. +See [testing your setup](https://www.home-assistant.io/docs/mqtt/testing/) to verify the steps above. + ### {% linkable_title Disable listening on insecure (1883) ports %} Remove the ports from the add-on page network card (set them as blank) to disable them. diff --git a/source/_components/binary_sensor.mqtt.markdown b/source/_components/binary_sensor.mqtt.markdown index 64dd7f1daa2..198dc2c17b6 100644 --- a/source/_components/binary_sensor.mqtt.markdown +++ b/source/_components/binary_sensor.mqtt.markdown @@ -197,3 +197,7 @@ binary_sensor: payload_on: "1" payload_off: "0" ``` +<<<<<<< HEAD +======= + +>>>>>>> current diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index a69deb7940a..5fe812ac1e4 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -115,7 +115,7 @@ determine if the furnace is running by checking that it is over some threshold: {% raw %} ```yaml -sensor: +binary_sensor: - platform: template sensors: furnace_on: diff --git a/source/_components/doorbird.markdown b/source/_components/doorbird.markdown index db6cbd8444b..b8b3050ae9e 100644 --- a/source/_components/doorbird.markdown +++ b/source/_components/doorbird.markdown @@ -35,11 +35,11 @@ doorbird: {% configuration %} token: - description: Token to be used to authenticate Doorbird calls to Home Assistant. + description: Token to be used to authenticate Doorbird calls to Home Assistant. This can be obtained from your "Digital Passport" document provided with your Doorbird. required: true type: string devices: - description: List of doorbird devices. + description: List of Doorbird devices. required: true type: list keys: @@ -48,7 +48,7 @@ devices: required: true type: string username: - description: The username of a non-administrator user account on the device. This user needs the "API-Operator" permission enabled on doorbird. + description: The username of a non-administrator user account on the device. This user needs the "API-Operator" permission enabled on Doorbird. It is recommended to set up a new account on your Doorbird for use with Home Assistant. This can be added via the Doorbird App by choosing Administration -> (User) Add. When the new account is created, you will need to enable the permission "API-Operator" in the "permissions" option. required: true type: string password: @@ -69,7 +69,7 @@ devices: type: string keys: doorbell: - description: Monitor doorbell events + description: Monitor doorbell events. motion: description: Monitor motion events (Motion monitoring must be enabled on the doorstation via DoorBird app). {% endconfiguration %} @@ -114,7 +114,8 @@ Please note that clearing device registrations will prevent the device from send

#### {% linkable_title Event Data %} -Each event includes live image and live video URLs for the Doorbird device that triggered the event. These URLs can be found on the event data and can be useful in automation actions. For example, you could use `html5_viewer_url` on a notification to be linked directly to the live view of the device that triggered the automation. + +Each event includes live image and video URLs for the Doorbird device that triggered the event. These URLs can be found on the event data and can be useful in automation actions. For example, you could use `html5_viewer_url` on a notification to be linked directly to the live view of the device that triggered the automation.

The URLs on the event will be based on the configuration used to connect to your Doorbird device. Ability to connect from outside your network will depend on your configuration. diff --git a/source/_components/fibaro.markdown b/source/_components/fibaro.markdown index e56514e6b7d..1e503e324d9 100644 --- a/source/_components/fibaro.markdown +++ b/source/_components/fibaro.markdown @@ -17,7 +17,7 @@ redirect_from: The [Fibaro](http://fibaro.com) hub is a controller mainly connecting to Z-Wave devices. -Binary sensors, switches, lights (including Dimmers), locks, sensors, binary sensors and covers are supported and will be automatically added when Home Assistant connects to your Fibaro controller. +Binary sensors, switches, lights (including Dimmers), locks, sensors and covers are supported and will be automatically added when Home Assistant connects to your Fibaro controller. ## {% linkable_title Configuration %} diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index dc61e9904f1..af8e8dd730d 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -53,6 +53,8 @@ Since release 0.80, the `Authorization Code` type of `OAuth` account linking is

If you've added Home Assistant to the home screen, you have to first remove it from home screen, otherwise, this HTML5 app will show up instead of a browser. Using it would prevent Home Assistant to redirect back to the `Google Assistant` app. + +If you're still having trouble, make sure that you're not connected to the same network Home Assistant is running on, e.g., use 4G/LTE instead.

## {% linkable_title First time setup %} @@ -62,7 +64,7 @@ You need to create an API Key with the [Google Cloud API Console](https://consol 1. Create a new project in the [Actions on Google console](https://console.actions.google.com/). 1. Add/Import a project and give it a name. 2. Click on the `Home Control` card, select the `Smart home` recommendation. - 3. Create an Action, under the build section. Add your Home Assistant URL: `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant`, replace the `[YOUR HOME ASSISTANT URL:PORT]` with the domain / IP address and the port under which your Home Assistant is reachable. + 3. Click `Build your Action`, select `Add Action(s)`, and click `Add your first action`. Add your Home Assistant URL: `https://[YOUR HOME ASSISTANT URL:PORT]/api/google_assistant`, replace the `[YOUR HOME ASSISTANT URL:PORT]` with the domain / IP address and the port under which your Home Assistant is reachable. 4. Click `Done`. Then click on `Overview`, which will lead you back to the app details screen. 2. `Account linking` is required for your app to interact with Home Assistant. Set this up under the `Quick Setup` section. 1. Leave it at the default `No, I only want to allow account creation on my website` and select Next. @@ -71,7 +73,7 @@ You need to create an API Key with the [Google Cloud API Console](https://consol 4. Client Secret: Anything you like, Home Assistant doesn't need this field. 5. Authorization URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL:PORT]/auth/authorize`. 6. Token URL (replace with your actual URL): `https://[YOUR HOME ASSISTANT URL:PORT]/auth/token`. - 7. Configure your client. Add scopes for `email` and `name`. + 7. Configure your client: Type `email` and click `Add scope`, then type `name` and click `Add scope` again. 8. Do **NOT** check `Google to transmit clientID and secret via HTTP basic auth header`. 9. Testing instructions: Enter anything. It doesn't matter since you won't submit this app. @@ -186,7 +188,7 @@ Currently, the following domains are available to be used with Google Assistant, - lock (lock/unlock (to allow assistant to unlock, set the `allow_unlock` key in configuration)) - cover (on/off/set position (via set brightness)) - media_player (on/off/set volume (via set brightness)/source (via set input source)) -- climate (temperature setting) +- climate (temperature setting, operation_mode) - vacuum (dock/start/stop/pause) ### {% linkable_title Media Player Sources %} @@ -196,8 +198,22 @@ There is currently a limitation with this feature that requires a hard-coded set https://developers.google.com/actions/reference/smarthome/traits/modes #### Example Command: + "Hey Google, change input source to TV on Living Room Receiver" +### {% linkable_title Climate Operation Modes %} + +There is not an exact 1-1 match between Home Assistant and Google Assistant for the available operation modes. +Here are the modes that are currently available: + +- off +- heat +- cool +- heatcool (auto) +- fan-only +- dry +- eco + ### {% linkable_title Troubleshooting the request_sync service %} The request_sync service requires that the initial sync from Google includes the agent_user_id. If not, the service will log an error that reads something like "Request contains an invalid argument". If this happens, then [unlink the account](https://support.google.com/googlehome/answer/7506443) from Home Control and relink. diff --git a/source/_components/light.yeelight.markdown b/source/_components/light.yeelight.markdown index 609bd18e1c3..ae047f196d1 100644 --- a/source/_components/light.yeelight.markdown +++ b/source/_components/light.yeelight.markdown @@ -59,7 +59,7 @@ devices: type: boolean default: False model: - description: "Yeelight model. Possible values are `mono1`, `color1`, `strip1`, `bslamp1`, `ceiling1`, `ceiling2`, `ceiling3`, `ceiling4`. The setting is used to enable model specific features f.e. a particular color temperature range." + description: "Yeelight model. Possible values are `mono1`, `color1`, `color2`, `strip1`, `bslamp1`, `ceiling1`, `ceiling2`, `ceiling3`, `ceiling4`. The setting is used to enable model specific features f.e. a particular color temperature range." required: false type: string {% endconfiguration %} diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index 48d9cba191f..2568eef1730 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -102,6 +102,7 @@ Currently tested but not working models: - J5200 - Unable to see state and unable to control - J5500 - State is always "on" and unable to control (but port 8001 *is* open) +- J6200 - State is always "on" and unable to control (but port 8001 *is* open) - J6300 - State is always "on" and unable to control (but port 8001 *is* open) - JS8005 - State tracking working but unable to control (but port 8001 *is* open) - JS9000 - State is always "on" and unable to control (but port 8001 *is* open) diff --git a/source/_components/tts.google.markdown b/source/_components/tts.google.markdown index c3bdf2d0cca..927d672a7c4 100644 --- a/source/_components/tts.google.markdown +++ b/source/_components/tts.google.markdown @@ -12,7 +12,7 @@ ha_category: Text-to-speech ha_release: 0.35 --- -The `google` text-to-speech platform uses [Google Text-to-Speech engine](https://console.developers.google.com/apis/api/speech.googleapis.com/overview) Text-to-Speech engine to read a text with natural sounding voices. +The `google` text-to-speech platform uses [Google Text-to-Speech engine](https://console.developers.google.com/apis/library/texttospeech.googleapis.com) Text-to-Speech engine to read a text with natural sounding voices. ## {% linkable_title Configuration %} diff --git a/source/_components/water_heater.markdown b/source/_components/water_heater.markdown index 56917dcc57b..245b6eb67c8 100644 --- a/source/_components/water_heater.markdown +++ b/source/_components/water_heater.markdown @@ -77,13 +77,14 @@ automation: operation_mode: eco ``` -### {% linkable_title Service `water_heater.turn_away_mode_on` %} +### {% linkable_title Service `water_heater.set_away_mode` %} -Turn away mode on for water heater device +Turn away mode on or off for water heater device | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all. +| `away_mode` | no | New value of away mode. 'on'/'off' or True/False #### {% linkable_title Automation example %} @@ -93,28 +94,8 @@ automation: platform: time at: "07:15:00" action: - - service: water_heater.turn_away_mode_on + - service: water_heater.set_away_mode data: entity_id: water_heater.demo + away_mode: True ``` - -### {% linkable_title Service `water_heater.turn_away_mode_off` %} - -Trun away mode off for water heater device - -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all. - -#### {% linkable_title Automation example %} - -```yaml -automation: - trigger: - platform: time - at: "07:15:00" - action: - - service: water_heater.turn_away_mode_off - data: - entity_id: water_heater.demo -``` \ No newline at end of file diff --git a/source/_docs/ecosystem/ios.markdown b/source/_docs/ecosystem/ios.markdown index d6554f1ace7..2fc5de550b1 100644 --- a/source/_docs/ecosystem/ios.markdown +++ b/source/_docs/ecosystem/ios.markdown @@ -31,6 +31,8 @@ The `ios` component is the companion component for the Home Assistant iOS app. W Loading the `ios` component will also load the [`device_tracker`](/components/device_tracker), [`zeroconf`](/components/zeroconf) and [`notify`](/components/notify) platforms. +In order to save credentials and adjust settings within the iOS Home Assistant app, the Optional (`api_password`)[https://www.home-assistant.io/components/http/#api_password] must be set. + ## {% linkable_title Setup %} ### {% linkable_title Automated Setup %} diff --git a/source/_docs/installation/updating.markdown b/source/_docs/installation/updating.markdown index 4bc5d375eb1..b82e53d1488 100644 --- a/source/_docs/installation/updating.markdown +++ b/source/_docs/installation/updating.markdown @@ -63,3 +63,13 @@ If you want to stay on the bleeding-edge Home Assistant development branch, you ```bash $ pip3 install --upgrade git+git://github.com/home-assistant/home-assistant.git@dev ``` + +### {% linkable_title Update Hass.io installation %} + +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. +4. If the check passes, you can safely update. If not, update your configuration accordingly. +5. Update Home Assistant. diff --git a/source/_lovelace/history-graph.markdown b/source/_lovelace/history-graph.markdown index a27641069a1..0ff77517850 100644 --- a/source/_lovelace/history-graph.markdown +++ b/source/_lovelace/history-graph.markdown @@ -13,8 +13,13 @@ footer: true History graph is a basic card, allowing you to display a graph for each of the entities in the list specified as config.

-Screenshot of the history graph card -Screenshot of the history graph card. +Screenshot of the history graph card for entities without a unit_of_measurement +Screenshot of the history graph card, when no `unit_of_measurement` is defined. +

+ +

+Screenshot of the history graph card for entities with a unit_of_measurement +Screenshot of the history graph card, when a `unit_of_measurement` is defined.

{% configuration %} diff --git a/source/_posts/2018-12-12-release-84.markdown b/source/_posts/2018-12-12-release-84.markdown index 086039fb2de..59584e8b24f 100644 --- a/source/_posts/2018-12-12-release-84.markdown +++ b/source/_posts/2018-12-12-release-84.markdown @@ -33,6 +33,8 @@ We have a new more reliable way of state restoration introduced by [@armills]. I This comes with a downside: we will be unable to restore states the first time you start 0.84. +This means that on upgrade to 0.84 any automation that doesn't have an `initial_state` defined **will be disabled**. + ## {% linkable_title Improved service calling %} We have improved how we call services with better validation checks. This means that if you have an automation or a script that sends invalid data, we will now stop the execution and be better able to point out where your incorrect calls are coming from. diff --git a/source/images/lovelace/lovelace_history_graph_lines.png b/source/images/lovelace/lovelace_history_graph_lines.png new file mode 100644 index 00000000000..b72c5c70566 Binary files /dev/null and b/source/images/lovelace/lovelace_history_graph_lines.png differ diff --git a/source/images/supported_brands/netdata.png b/source/images/supported_brands/netdata.png index 73f99217039..cc0367be5e4 100644 Binary files a/source/images/supported_brands/netdata.png and b/source/images/supported_brands/netdata.png differ