diff --git a/_config.yml b/_config.yml index df6d10b5780..220f016d3fe 100644 --- a/_config.yml +++ b/_config.yml @@ -140,11 +140,11 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 53 -current_patch_version: 0 -date_released: 2017-09-9 +current_patch_version: 1 +date_released: 2017-09-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. # Major release: -patch_version_notes: "#" +patch_version_notes: "#release-0531---september-11" # Minor release (Example #release-0431---april-25): diff --git a/source/_components/alert.markdown b/source/_components/alert.markdown index 2f3f58d5184..8967a134e5f 100644 --- a/source/_components/alert.markdown +++ b/source/_components/alert.markdown @@ -75,7 +75,7 @@ freshwater_temp_alert: ### {% linkable_title Complex Alert Criteria %} -By design, the `alert` component only handles very simple criteria for firing. That is, is only checks if a single entity's state is equal to a value. At some point, it may be desireable to have an alert with a more complex criteria. Possibly, when a battery percentage falls below a threshold. Maybe you want to disable the alert on certain days. Maybe the alert firing should depend on more than one input. For all of these situations, it is best to use the alert in conjunction with a `Template Binary Sensor`. The following example does that. +By design, the `alert` component only handles very simple criteria for firing. That is, it only checks if a single entity's state is equal to a value. At some point, it may be desireable to have an alert with a more complex criteria. Possibly, when a battery percentage falls below a threshold. Maybe you want to disable the alert on certain days. Maybe the alert firing should depend on more than one input. For all of these situations, it is best to use the alert in conjunction with a `Template Binary Sensor`. The following example does that. ```yaml binary_sensor: diff --git a/source/_components/binary_sensor.bayesian.markdown b/source/_components/binary_sensor.bayesian.markdown index 588798a355a..af58bf0d2fe 100644 --- a/source/_components/binary_sensor.bayesian.markdown +++ b/source/_components/binary_sensor.bayesian.markdown @@ -14,12 +14,9 @@ ha_release: 0.53 --- -The `bayesian` binary sensor platform observes the state from multiple sensors and uses Bayes' rule to estimate the probability that an event has occurred -given the state of the observed sensors. If the estimated posterior probability is above the `probabiliy_threshold`, the value of the sensor is `on`. -Otherwise, the sensor is `off`. +The `bayesian` binary sensor platform observes the state from multiple sensors and uses Bayes' rule to estimate the probability that an event has occurred given the state of the observed sensors. If the estimated posterior probability is above the `probability_threshold`, the sensor is `on` otherwise it is `off`. -This allows for the detection of complex events that may not be readily observable, i.e., cooking, showering, in bed, the start of a morning routine, etc. It -can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, i.e., presence. +This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, e.g., presence. To enable the Bayesian sensor, add the following lines to your `configuration.yaml`: @@ -39,7 +36,7 @@ binary_sensor: Configuration variables: - **prior** (*Required*): The prior probability of the event. At any point in time (ignoring all external influences) how likely is this event to occur? -- **observations** array (*Required*): The observations which should influence the likelihood that the given event has occurred. +- **observations** array (*Required*): The observations which should influence the likelihood that the given event has occurred. - **entity_id** (*Required*): Name of the entity to monitor. - **prob_given_true** (*Required*): The probability of the observation occurring, given the event is `true`. - **prob_given_false** (*Optional*): The probability of the observation occurring, given the event is `false` can be set as well. If `prob_given_false` is not set, it will default to `1 - prob_given_true`. @@ -77,4 +74,3 @@ binary_sensor: platform: 'state' to_state: 'below_horizon' ``` - diff --git a/source/_components/binary_sensor.template.markdown b/source/_components/binary_sensor.template.markdown index 1a983ecc89d..c7743f3ba64 100644 --- a/source/_components/binary_sensor.template.markdown +++ b/source/_components/binary_sensor.template.markdown @@ -108,7 +108,7 @@ This example creates a washing machine "load running" sensor by monitoring an en binary_sensor: - platform: template name: Washing Machine - value_template: {% raw %}'{{ sensor.washing_machine_power > 0 }}'{% endraw %} + value_template: {% raw %}'{{ states.sensor.washing_machine_power.state > 0 }}'{% endraw %} off_delay: minutes: 5 ``` @@ -117,7 +117,7 @@ binary_sensor: This example is determining if anyone is home based on the combination of device tracking and motion sensors. It's extremely useful if you -have kids / baby sitter / grand parrents who might still be in your +have kids/baby sitter/ grand parents who might still be in your house that aren't represented by a trackable device in home assistant. This is providing a composite of wifi based device tracking and z-wave multisensor presence sensors. diff --git a/source/_components/camera.arlo.markdown b/source/_components/camera.arlo.markdown index 0a659827ea6..1d66a90bbf0 100644 --- a/source/_components/camera.arlo.markdown +++ b/source/_components/camera.arlo.markdown @@ -28,6 +28,6 @@ camera: Configuration variables: -- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g. image quality or video filter options. +- **ffmpeg_arguments**: (*Optional*): Extra options to pass to ffmpeg, e.g., image quality or video filter options. **Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](https://home-assistant.io/components/ffmpeg/) documentation. diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown index 7df1c2e6cf5..96ea3d9cb8e 100644 --- a/source/_components/counter.markdown +++ b/source/_components/counter.markdown @@ -26,10 +26,10 @@ counter: Configuration variables: -- **[alias]** (*Required*): Alias for the slider input. Multiple entries are allowed. - - **name** (*Optional*): Friendly name of the slider input. +- **[alias]** (*Required*): Alias for the counter. Multiple entries are allowed. + - **name** (*Optional*): Friendly name of the counter. - **initial** (*Optional*): Initial value when Home Assistant starts. Defaults to 0. - - **step** (*Optional*): Step value for the slider. Defaults to 1. + - **step** (*Optional*): Incremental/step value for the counter. Defaults to 1 (increments by 1). - **icon** (*Optional*): Icon for entry. Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`. diff --git a/source/_components/device_tracker.bluetooth_tracker.markdown b/source/_components/device_tracker.bluetooth_tracker.markdown index 20d2b5617c7..f926d934042 100644 --- a/source/_components/device_tracker.bluetooth_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_tracker.markdown @@ -13,10 +13,10 @@ ha_iot_class: "Local Polling" ha_release: 0.18 --- -This tracker discovers new devices on boot and tracks bluetooth devices periodically based on interval_seconds value. It is not required to pair the devices with each other! Devices discovered are stored with 'bt_' as the prefix for device mac addresses in `known_devices.yaml`. +This tracker discovers new devices on boot and tracks Bluetooth devices periodically based on `interval_seconds` value. It is not required to pair the devices with each other! Devices discovered are stored with 'bt_' as the prefix for device MAC addresses in `known_devices.yaml`.

-If you are using [Hass.io](/hassio/) you will need to enable the Bluetooth BCM43xx (/addons/bluetooth_bcm43xx/) addon. +[Hass.io](/hassio/) only supports bluetooth on Raspberry Pi 3 via the Bluetooth BCM43xx (/addons/bluetooth_bcm43xx/) addon. [Hass.io](/hassio/) doesn't support external Bluetooth dongles.

To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file: @@ -27,6 +27,6 @@ device_tracker: - platform: bluetooth_tracker ``` -In some cases it can be that your device is not discovered. In that case let your phone scan for BT devices while you restart Home Assistant. Just hit `Scan` on your phone all the time until Home Assistant is fully restarted and the device should appear in `known_devices.yaml`. +In some cases it can be that your device is not discovered. In that case let your phone scan for Bluetooth devices while you restart Home Assistant. Just hit `Scan` on your phone all the time until Home Assistant is fully restarted and the device should appear in `known_devices.yaml`. For additional configuration variables check the [Device tracker page](/components/device_tracker/). diff --git a/source/_components/discovery.markdown b/source/_components/discovery.markdown index 41c7e2392d1..c133e9a7125 100644 --- a/source/_components/discovery.markdown +++ b/source/_components/discovery.markdown @@ -55,11 +55,14 @@ Valid values for ignore are: * `apple_tv`: Apple TV * `axis`: Axis Communications security devices + * `bluesound` * `bose_soundtouch`: Bose Soundtouch speakers * `denonavr`: Denon Network Receivers * `directv`: DirecTV * `flux_led`: Flux Led/MagicLight + * `frontier_silicon` * `google_cast`: Google Chromecast + * `harmony`: Harmony Hub * `ikea_tradfri`: IKEA Trådfri * `logitech_mediaserver`: Logitech media server - Squeezebox player * `openhome`: Linn/Openhome @@ -67,11 +70,12 @@ Valid values for ignore are: * `philips_hue`: Philips Hue * `plex_mediaserver`: Plex media server * `roku`: Roku media player + * `sabnzbd` * `samsung_tv`: Samsung TV * `sonos`: Sonos Speakers * `yamaha`: Yamaha media player * `yeelight`: Yeelight Sunflower Bulb - +

Home Assistant must be on the same network as the devices for uPnP discovery to work. If running Home Assistant in a [Docker container](/docs/installation/docker/) use switch `--net=host` to put it on the host's network. diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 02de009442a..2f6a245d90e 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -37,7 +37,6 @@ Configuration variables (global): - **hosts** (*Required*): Configuration for each host to integrate into Home Assistant. - **local_ip** (*Optional*): IP of device running Home Assistant. Override autodetected value for exotic network setups. - **local_port** (*Optional*): Port for connection with Home Assistant. By default it is randomly assigned. -- **delay** (*Optional*): [Float] Delay fetching of current state per device on startup. Used to prevent overloading of the CCU. Defaults to 0.5. Configuration variables (host): @@ -55,7 +54,6 @@ Configuration variables (host): ```yaml homematic: - delay: 1.0 hosts: rf: ip: 127.0.0.1 diff --git a/source/_components/http.markdown b/source/_components/http.markdown index be058d6a342..749c9fa0e15 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -62,6 +62,8 @@ http: The [Set up encryption using Let's Encrypt](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) blog post gives you details about the encryption of your traffic using free certificates from [Let's Encrypt](https://letsencrypt.org/). +Or use a self signed certificate following the instructions here [Self-signed certificate for SSL/TLS](/docs/ecosystem/certificates/tls_self_signed_certificate/) + On top of the `http` component is a [REST API](/developers/rest_api/) and a [Python API](/developers/python_api/) available. There is also support for [Server-sent events](/developers/server_sent_events/). The `http` platforms are not real platforms within the meaning of the terminology used around Home Assistant. Home Assistant's [REST API](/developers/rest_api/) sends and receives messages over HTTP. diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown index 8aa8aa16b57..fc330b5f799 100644 --- a/source/_components/ifttt.markdown +++ b/source/_components/ifttt.markdown @@ -13,15 +13,15 @@ featured: true ha_iot_class: "Cloud Push" --- -[IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so called "Applets". With the IFTTT component you can trigger applets through the **"Maker"** channel. See the [announcement blog post](/blog/2015/09/13/home-assistant-meets-ifttt/) for examples how to use it. +[IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so called "Applets". With the IFTTT component you can trigger applets through the **"Webhooks"** service (which was previously the **"Maker"** channel). See the [announcement blog post](/blog/2015/09/13/home-assistant-meets-ifttt/) for examples how to use it. ```yaml # Example configuration.yaml entry ifttt: - key: xxxxx-x-xxxxxxxxxxxxx + key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ``` -`key` is your API key which can be obtained by viewing the **Settings** of the [Maker Channel](https://ifttt.com/services/maker_webhooks/settings). It's the last part of the URL (e.g. https://maker.ifttt.com/use/MYAPIKEY) you will find under **Settings** > **Account Info**. +`key` is your API key which can be obtained by viewing the **Settings** of the [Webhooks applet](https://ifttt.com/services/maker_webhooks/settings). It's the last part of the URL (e.g. https://maker.ifttt.com/use/MYAPIKEY) you will find under **My Applets** > **Webhooks** > **Settings**.

@@ -37,7 +37,7 @@ After restarting the server, be sure to watch the console for any logging errors ### {% linkable_title Testing your trigger %} -You can use the **Developer tools** to test your [Maker Channel](https://ifttt.com/maker) trigger. To do this, open the Home Assistant frontend, open the sidebar, click on the first icon in the developer tools. This should get you to the **Call Service** screen. Fill in the following values: +You can use the **Developer tools** to test your [Webhooks](https://ifttt.com/maker_webhooks) trigger. To do this, open the Home Assistant frontend, open the sidebar, click on the first icon in the developer tools. This should get you to the **Call Service** screen. Fill in the following values: Field | Value ----- | ----- @@ -52,11 +52,11 @@ When your screen looks like this, click the 'call service' button. ### {% linkable_title Setting up a recipe %} -Press the *New applet* button and search for *Maker* . +Press the *New applet* button and search for *Webhooks*.

-Choose "Maker" as service. +Choose "Webhooks" as service.

diff --git a/source/_components/light.xiaomi_philipslight.markdown b/source/_components/light.xiaomi_philipslight.markdown index ec4d351e25f..de6d95cf6f3 100644 --- a/source/_components/light.xiaomi_philipslight.markdown +++ b/source/_components/light.xiaomi_philipslight.markdown @@ -17,7 +17,7 @@ The `xiaomi_philipslight` platform allows you to control the state of your Xiaom Currently, the supported features are `on`, `off`, `set_cct` (colortemp) , `set_bright` (brightness). -Please follow the instructions on [Retrieving the Access Token](/xiaomi/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. +Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. To add a Xiaomi Philips Light to your installation, add the following to your configuration.yaml file: diff --git a/source/_components/lock.wink.markdown b/source/_components/lock.wink.markdown index cc13cda757b..e8689f58263 100644 --- a/source/_components/lock.wink.markdown +++ b/source/_components/lock.wink.markdown @@ -23,6 +23,7 @@ The requirement is that you have setup [Wink](/components/wink/). - Kwikset - Schlage +- August (No Wink hub required) (August Connect required) - Generic Z-wave

diff --git a/source/_components/media_extractor.markdown b/source/_components/media_extractor.markdown index 482f40cb682..3deb105407e 100644 --- a/source/_components/media_extractor.markdown +++ b/source/_components/media_extractor.markdown @@ -13,7 +13,7 @@ ha_release: 0.49 --- -The `media_extractor` component gets an stream URL and send it to a media player entity. This component can extract entity specific streams if configured accordingly. +The `media_extractor` component gets a stream URL and sends it to a media player entity. This component can extract entity specific streams if configured accordingly.

Media extractor doesn't transcode streams, it just tries to find stream that match requested query. diff --git a/source/_components/media_player.markdown b/source/_components/media_player.markdown index daa7b072c55..90fe9a22423 100644 --- a/source/_components/media_player.markdown +++ b/source/_components/media_player.markdown @@ -14,7 +14,7 @@ Interacts with media players on your network. Please check the sidebar for a ful ## {% linkable_title Services %} ### {% linkable_title Media control services %} -Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `media_play_pause`, `media_play`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist` +Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `media_play_pause`, `play_media`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist` | Service data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------------ | diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index 23121583a87..27e275554b9 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -38,6 +38,7 @@ Configuration variables: Currently known supported models: - C7700 +- D6500 - D7000 - D8000 - ES5500 diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index 7c8c16d2bd5..ddf835cff50 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -27,7 +27,7 @@ recorder: Configuration variables: -- **purge_days** (*Optional*): Delete events and states older than x days. +- **purge_days** (*Optional*): Delete events and states older than x days. The purge task runs every 2 days, starting from when Home Assistant is started if you restart your instance more frequently than the purge will never take place. - **exclude** (*Optional*): Configure which components should be excluded from recordings. - **entities** (*Optional*): The list of entity ids to be excluded from recordings. - **domains** (*Optional*): The list of domains to be excluded from recordings. diff --git a/source/_components/sensor.mold_indicator.markdown b/source/_components/sensor.mold_indicator.markdown index eda7abafbbf..4cc9c84833a 100644 --- a/source/_components/sensor.mold_indicator.markdown +++ b/source/_components/sensor.mold_indicator.markdown @@ -29,9 +29,9 @@ sensor: Configuration variables: -- **indoor_temp_sensor** (*Required*): The enditiy ID of the indoor temperature sensor. -- **indoor_humidity_sensor** (*Required*): The enditiy ID of the indoor humidity sensor. -- **outdoor_temp_sensor** (*Required*): The enditiy ID of the outdoor temperature sensor. +- **indoor_temp_sensor** (*Required*): The entitiy ID of the indoor temperature sensor. +- **indoor_humidity_sensor** (*Required*): The entitiy ID of the indoor humidity sensor. +- **outdoor_temp_sensor** (*Required*): The entitiy ID of the outdoor temperature sensor. - **calibration_factor** (*Required*): Needs to be calibrated to the critical point in the room. In this case, the weather forecast temperature sensor is used for the outside temperature. diff --git a/source/_components/sensor.season.markdown b/source/_components/sensor.season.markdown index a2d21e35235..da386ca5015 100644 --- a/source/_components/sensor.season.markdown +++ b/source/_components/sensor.season.markdown @@ -25,5 +25,9 @@ All information about how the seasons work was taken from Wikipedia: # Example configuration.yaml entry sensor: - platform: season - type: astronomical (optional, will default to astronomical) + type: astronomical ``` + +Configuration variables: + +- **type** (*Optional*): Type of season definition. Options are `meteorological` or `astronomical`. Default is `astronomical`. diff --git a/source/_components/sensor.speedtest.markdown b/source/_components/sensor.speedtest.markdown index 7fd0ec202a7..d9c25821a8a 100644 --- a/source/_components/sensor.speedtest.markdown +++ b/source/_components/sensor.speedtest.markdown @@ -90,6 +90,25 @@ sensor: - upload ``` +### {% linkable_title Using as a trigger in an automation %} + +```yaml +# Example configuration.yaml entry +automation: + - alias: 'Internet Speed Glow Connect Great' + trigger: + platform: template + value_template: '{% raw %}{{ states.sensor.speedtest_download.state|float > 10}}{% endraw %}' + action: + service: shell_command.green + - alias: 'Internet Speed Glow Connect Poor' + trigger: + platform: template + value_template: '{% raw %}{{ states.sensor.speedtest_download.state| float < 10 }}{% endraw %}' + action: + service: shell_command.red +``` + ## {% linkable_title Notes %} - When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter. diff --git a/source/_components/sensor.template.markdown b/source/_components/sensor.template.markdown index 096b6e75527..bc2cade44c1 100644 --- a/source/_components/sensor.template.markdown +++ b/source/_components/sensor.template.markdown @@ -37,7 +37,7 @@ Configuration variables: - **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any. - **value_template** (*Required*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the event bus. - **icon_template** (*Optional*): Defines a [template](/topics/templating/) for the icon of the sensor. - - **entity_id** (*Optional*): Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update it's state. + - **entity_id** (*Optional*): Add a list of entity IDs so the sensor only reacts to state changes of these entities. This will reduce the number of times the sensor will try to update its state. ## {% linkable_title Examples %} diff --git a/source/_components/sensor.wink.markdown b/source/_components/sensor.wink.markdown index 402a92dba70..a67e3c2df42 100644 --- a/source/_components/sensor.wink.markdown +++ b/source/_components/sensor.wink.markdown @@ -27,7 +27,7 @@ The requirement is that you have setup [Wink](/components/wink/). - Wink eggminder (No Wink hub required) - Nest protect Smoke and CO severity (No confirmation that this is actually reported) (No Wink hub required) - Motion sensor temperature -- Quirky refuel propane tank monitor +- Quirky refuel propane tank monitor (No Wink hub required)

The above devices are confimed to work, but others may work as well. diff --git a/source/_components/telegram_bot.webhooks.markdown b/source/_components/telegram_bot.webhooks.markdown index 3b4675eca7b..0cf3a4db249 100644 --- a/source/_components/telegram_bot.webhooks.markdown +++ b/source/_components/telegram_bot.webhooks.markdown @@ -42,7 +42,7 @@ Configuration variables: - **parse_mode** (*Optional*): Default parser for messages if not explicit in message data: 'html' or 'markdown'. Default is 'markdown'. - **proxy_url** (*Optional*): Proxy url if working behind one (`socks5://proxy_ip:proxy_port`) - **proxy_params** (*Optional*): Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.) -- **url** (*Optional*): Allow to overwrite the `base_url` from http component for diferent configs. +- **url** (*Optional*): Allow to overwrite the `base_url` from the [`http`](/components/http/) component for different configurations (`https://:`). To get your `chat_id` and `api_key` follow the instructions [here](/components/notify.telegram). As well as authorising the chat, if you have added your bot to a group you will also need to authorise any user that will be interacting with the webhook. When an unauthorised user tries to interact with the webhook Home Assistant will raise an error ("Incoming message is not allowed"), you can easily obtain the the users id by looking in the "from" section of this error message. diff --git a/source/_components/vacuum.xiaomi.markdown b/source/_components/vacuum.xiaomi.markdown index 586baa0bccb..4968bf53796 100644 --- a/source/_components/vacuum.xiaomi.markdown +++ b/source/_components/vacuum.xiaomi.markdown @@ -17,7 +17,7 @@ The `xiaomi` vacuum platform allows you to control the state of your [Xiaomi Mi Current supported features are `turn_on`, `pause`, `stop`, `return_to_home`, `turn_off` (stops goes to dock), `locate`, `clean_spot`, `set_fanspeed` and even remote control your robot. -Please follow the instructions on [Retrieving the Access Token](/components/xiaomi/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. +Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. To add a vacuum to your installation, add the following to your `configuration.yaml` file: @@ -79,3 +79,63 @@ Use this call to enter the remote control mode, make one move, and stop and exit | `velocity` | no | Speed, between -0.29 and 0.29. | | `rotation` | no | Rotation, between -179 degrees and 179 degrees. | | `duration` | no | Parameter affecting the duration of the movement. | + +### {% linkable_title Retrieving the Access Token %} + +

+This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum and Xiaomi Philips Light. The Xiaomi Gateway uses another security method and requires a `key` (16 alphanumeric chars) which can be obtained easily via a hidden menu item at the Mi-Home app. +

+ +Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from a SQLite file inside your phone. + +Before you begin you need to install `libffi-dev` and `libssl-dev` by running the command below. This is needed for `python-mirobo` to be installed correctly. + +```bash +$ sudo apt-get install libffi-dev libssl-dev +``` + +If your Home Assistant installation is running in a [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below. + +```bash +$ sudo su -s /bin/bash homeassistant +$ source /srv/homeassistant/bin/activate +``` + +To fetch the token follow these instructions depending on your mobile phone platform. + +#### {% linkable_title Windows and Android %} + +1. Configure the robot with the Mi-Home app. +2. Enable developer mode and USB debugging on the Android phone and plug it into the computer. +3. Get and install the [ADB tool for Windows](https://developer.android.com/studio/releases/platform-tools.html). +4. Create a backup of the application `com.xiaomi.smarthome`: +```bash +$ adb backup -noapk com.xiaomi.smarthome -f backup.ab +``` +5. If you have this message: "More than one device or emulator", use this command to list all devices: +```bash +$ adb devices +``` +and execute this command: +```bash +$ adb -s DEVICEID backup -noapk com.xiaomi.smarthome -f backup.ab # (with DEVICEID the device id from the previous command) +``` +6. On the phone, you must confirm the backup. DO NOT enter any password and press button to make the backup. +7. Get and install [ADB Backup Extractor](https://sourceforge.net/projects/adbextractor/). +8. Extract All files from the backup: +```bash +$ java.exe -jar ../android-backup-extractor/abe.jar unpack backup.ab backup.tar "" +``` +9. Unzip the ".tar" file. +10. Open the SQLite database `miio2.db` with a tool like SQLite Manager extension for FireFox. +11. Get the token from "devicerecord" table. + +#### {% linkable_title Linux and Android (rooted!) %} + +1. Configure the light with the Mi-Home app. +2. Enable developer mode, USB debugging and root permission only for ADB on the Android phone and plug it into the computer. +3. Get ADB f.e. `apt-get install android-tools-adb` +4. `adb devices` should list your device +5. `adb root` (does work for development builds only: ones with `ro.debuggable=1`) +6. `adb shell` +7. `echo "select name,localIP,token from devicerecord;" | sqlite3 /data/data/com.xiaomi.smarthome/databases/miio2.db` returns a list of all registered devices including IP address and token. diff --git a/source/_components/xiaomi.markdown b/source/_components/xiaomi.markdown index c162283ed2d..432af9e1da6 100644 --- a/source/_components/xiaomi.markdown +++ b/source/_components/xiaomi.markdown @@ -46,8 +46,6 @@ What's not available? Follow the setup process using your phone and Mi-Home app. From here you will be able to retrieve the key from within the app following [this tutorial](https://community.home-assistant.io/t/beta-xiaomi-gateway-integration/8213/1832) -Please check the instructions in this [section](/xiaomi/#retrieving-the-access-token) to get the API token to use with your platforms. - To enable Xiaomi gateway in your installation, add the following to your `configuration.yaml` file: ### {% linkable_title One Gateway %} @@ -140,72 +138,8 @@ Automation example That means that Home Assistant is not getting any response from your Xiaomi gateway. Might be a local network problem or your firewall. - Make sure you have enabled LAN access: https://community.home-assistant.io/t/beta-xiaomi-gateway-integration/8213/1832 -- Turn off the firewall on the system where Home Assistant is running +- Turn off the firewall on the system where Home Assistant is running. - Try to leave the MAC address `mac:` blank. -- Try to set `discovery_retry: 10` -- Try to disable and then enable LAN access - -### {% linkable_title Retrieving the Access Token %} - -Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from a SQLite file inside your phone. This token is needed for using various `xiaomi_*` platforms. - -Before you begin you need to install `libffi-dev` by running the command below. This is needed for `python-mirobi` to be installed correctly. - -```bash -$ sudo apt-get install libffi-dev -``` - -If your Home Assistant installation is running in a [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below. - -```bash -$ sudo su -s /bin/bash homeassistant -$ source /srv/homeassistant/bin/activate -``` - -To fetch the token follow these instructions depending on your mobile phone platform. - -#### {% linkable_title Windows and Android %} - -1. Configure the robot with the Mi-Home app. -2. Enable developer mode and USB debugging on the Android phone and plug it into the computer. -3. Get and install the [ADB tool for Windows](https://developer.android.com/studio/releases/platform-tools.html). -4. Create a backup of the application `com.xiaomi.smarthome`: -```bash -$ adb backup -noapk com.xiaomi.smarthome -f backup.ab -``` -5. If you have this message: "More than one device or emulator", use this command to list all devices: -```bash -$ adb devices -``` -and execute this command: -```bash -$ adb -s DEVICEID backup -noapk com.xiaomi.smarthome -f backup.ab # (with DEVICEID the device id from the previous command) -``` -6. On the phone, you must confirm the backup. DO NOT enter any password and press button to make the backup. -7. Get and install [ADB Backup Extractor](https://sourceforge.net/projects/adbextractor/). -8. Extract All files from the backup: -```bash -$ java.exe -jar ../android-backup-extractor/abe.jar unpack backup.ab backup.tar "" -``` -9. Unzip the ".tar" file. -10. Open the SQLite database `miio2.db` with a tool like SQLite Manager extension for FireFox. -11. Get the token from "devicerecord" table. - -#### {% linkable_title Linux and Android (rooted!) %} - -1. Configure the light with the Mi-Home app. -2. Enable developer mode, USB debugging and root permission only for ADB on the Android phone and plug it into the computer. -3. Get ADB f.e. `apt-get install android-tools-adb` -4. `adb devices` should list your device -5. `adb root` (does work for development builds only: ones with `ro.debuggable=1`) -6. `adb shell` -7. `echo "select name,localIP,token from devicerecord;" | sqlite3 /data/data/com.xiaomi.smarthome/databases/miio2.db` returns a list of all registered devices including IP address and token. - -#### {% linkable_title macOS and iOS %} - -1. Setup iOS device with the Mi-Home app. -2. Create an unencrypted backup of the device using iTunes. -3. Install [iBackup Viewer](http://www.imactools.com/iphonebackupviewer/). -4. Extract this file: **`/raw data/com.xiami.mihome/1234567_mihome.sqlite`** to your computer, where `_1234567_` is any string of numbers. -5. Open the SQLite database with a tool like SQLite Manager extension for FireFox or DB Browser. You will then see the list of all the devices in your account with their token. The token you need is in the column **`ZToken`** and looks like **`123a1234567b12345c1d123456789e12`**. -(Location of SQLite files directly on iOS devices **/private/var/mobile/Containers/Data/Application/A80CE9E4-AD2E-4649-8C28-801C96B16BD7/Documents/**) +- Try to set `discovery_retry: 10`. +- Try to disable and then enable LAN access. +- Hard reset the gateway: Press the button of the gateway 30 seconds and start again from scratch. diff --git a/source/_cookbook/python_component_mqtt_basic.markdown b/source/_cookbook/python_component_mqtt_basic.markdown index 3deb82bd4b8..f038f21969e 100644 --- a/source/_cookbook/python_component_mqtt_basic.markdown +++ b/source/_cookbook/python_component_mqtt_basic.markdown @@ -46,7 +46,7 @@ def setup(hass, config): # Subscribe our listener to a topic. mqtt.subscribe(hass, topic, message_received) - # Set the intial state + # Set the initial state. hass.states.set(entity_id, 'No messages') # Service to publish a message on MQTT. diff --git a/source/_docs/ecosystem/backup/backup_github.markdown b/source/_docs/ecosystem/backup/backup_github.markdown index b917fe32b97..0a0bf9e5ffc 100644 --- a/source/_docs/ecosystem/backup/backup_github.markdown +++ b/source/_docs/ecosystem/backup/backup_github.markdown @@ -50,37 +50,17 @@ Before creating and pushing your Home Assistant configuration to GitHub, please Creating a `.gitignore` file in your repository will tell git which files NOT to push to the GitHub server. This should be used to prevent publishing sensitive files to the public. It should contain a list of filenames and pattern matches. This list should include at least your `secrets.yaml` file, device configuration files, and the Home Assistant database/directory structure. The `.gitignore` file should be placed in your Home Assistant directory. -Here is a sane example, but yours should be based on the files in your structure: +Here is an example that will include your `.gitignore` file, a `scenes` directory, and all .yaml files except for `secrets.yaml` and `known_devices.yaml`. All other files will be excluded. `.gitignore` ```bash -*.pid -*.xml -*.csr -*.crt -*.key -www -OZW_Log.txt -home-assistant.log -home-assistant_v2.db -*.db-journal -lib -deps -tts +* +!*.yaml +!scenes +!.gitignore secrets.yaml known_devices.yaml -*.conf -plex.conf -phue.conf -harmony_media_room.conf -pyozw.sqlite -.* -!/.gitignore -!/.travis.yml -html5_push_registrations.conf -ip_bans.yaml -/icloud/* ``` More information on the layout of the file can be found in the [.gitignore manual](https://git-scm.com/docs/gitignore). diff --git a/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown b/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown index 9eb1035eab6..53736e06937 100644 --- a/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown +++ b/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown @@ -10,25 +10,39 @@ footer: true redirect_from: /cookbook/tls_self_signed_certificate/ --- -If your Home Assistant instance is only accessible from your local network you can still protect the communication between your browsers and the frontend with SSL/TLS. [Let's encrypt]({{site_root}}/blog/2015/12/13/setup-encryption-using-lets-encrypt/) will only work if you have a DNS entry and remote access is allowed. The solution is to use a self-signed certificate. As you most likely don't have a certification authority (CA) your browser will conplain about the security. If you have a CA then this will not be an issue. +If your Home Assistant instance is only accessible from your local network you can still protect the communication between your browsers and the frontend with SSL/TLS. +[Let's encrypt]({{site_root}}/blog/2015/12/13/setup-encryption-using-lets-encrypt/) will only work if you have a DNS entry and remote access is allowed. +The solution is to use a self-signed certificate. As you most likely don't have a certification authority (CA) your browser will conplain about the security. If you have a CA then this will not be an issue. -To create locally a certificate you need the [OpenSSL](https://www.openssl.org/) command-line tool. +To create a certificate locally, you need the [OpenSSL](https://www.openssl.org/) command-line tool. -Change to your Home Assistant [configuration directory](/getting-started/configuration/) like `~/.homeassistant`. This will make it easier to backup your certificate and the key. Run the command shown below. +Change to your Home Assistant [configuration directory](/getting-started/configuration/) like `~/.homeassistant`. This will make it easier to backup your certificate and the key. Run the command shown below. + +The certificate **must** be `.pem` extension. + +If you are going to use this certificate with the iOS app, you need to ensure you complete **all** fields during the cetificate creation process, then: + +* Send **only** the `certificate.pem` file to the iOS device, using airdrop or other transfer method. +* Open the `.pem` file on the iOS device, follow the prompts to trust and install it. +* If you are using iOS 10.3 or newer then [additional steps](https://support.apple.com/en-us/HT204477) are needed. ```bash -$ openssl req -new -x509 -sha256 -newkey rsa:4096 -nodes -keyout privkey.pem -days 730 -out fullchain.pem +$ openssl req -sha256 -newkey rsa:4096 -nodes -keyout privkey.pem -x509 -days 730 -out certificate.pem ``` -For details about the parameters, please check the OpenSSL documentation. Provide the requested information during the generation process. At the end you will have two files called `privkey.pem` and `fullchain.pem`. The key and the certificate. +For details about the parameters, please check the OpenSSL documentation. Provide the requested information during the generation process. + +At the end you will have two files called `privkey.pem` and `certificate.pem`. The key and the certificate. Update the `http:` entry in your `configuration.yaml` file and let it point to your created files. ```yaml http: api_password: YOUR_SECRET_PASSWORD - ssl_certificate: /home/fab/.homeassistant/fullchain.pem - ssl_key: /home/fab/.homeassistant/privkey.pem + ssl_certificate: /home/your_user/.homeassistant/certificate.pem + ssl_key: /home/your_user/.homeassistant/privkey.pem ``` +A restart of Home Assistant is required for the changes to take effect. + A tutorial "[Working with SSL Certificates, Private Keys and CSRs](https://www.digitalocean.com/community/tutorials/openssl-essentials-working-with-ssl-certificates-private-keys-and-csrs)" could give you some insight about special cases. diff --git a/source/_docs/installation/raspberry-pi.markdown b/source/_docs/installation/raspberry-pi.markdown index bb899d6c377..713cde495cc 100644 --- a/source/_docs/installation/raspberry-pi.markdown +++ b/source/_docs/installation/raspberry-pi.markdown @@ -67,7 +67,7 @@ Once you have activated the virtual environment you will notice the prompt chang (homeassistant) homeassistant@raspberrypi:/srv/homeassistant $ pip3 install homeassistant ``` -Start Home Assistant for the first time. This will complete the installation, create the `.homeasssistant` configuration directory in the `/home/homeassistant` directory and install any basic dependencies. +Start Home Assistant for the first time. This will complete the installation, create the `.homeassistant` configuration directory in the `/home/homeassistant` directory and install any basic dependencies. ```bash (homeassistant) $ hass diff --git a/source/_docs/installation/updating.markdown b/source/_docs/installation/updating.markdown index 6e4cf49c365..f5df3a9361b 100644 --- a/source/_docs/installation/updating.markdown +++ b/source/_docs/installation/updating.markdown @@ -11,7 +11,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 [HASSbian](/docs/hassbian/common-tasks/#update-home-assistant), [Raspberry Pi All-In-One Installer](/docs/installation/raspberry-pi-all-in-one/#upgrading), [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/hassbian/common-tasks/#update-home-assistant), [Raspberry Pi All-In-One Installer](/docs/installation/raspberry-pi-all-in-one/#upgrading), [Vagrant](/docs/installation/vagrant/), or [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant).

The default way to update Home Assistant to the latest release, when available, is: @@ -23,7 +23,7 @@ $ pip3 install --upgrade homeassistant After updating, you must restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/docs/autostart/) daemon (if applicable). Startup can take considerable amount of time (i.e. minutes) depending on your device. This is because all requirements are updated as well.

-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 [HASSbian](/docs/hassbian/installation/), [Raspberry Pi All-In-One Installer](/docs/installation/raspberry-pi-all-in-one/), [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 [HASSIO](/hassio/), [HASSbian](/docs/hassbian/installation/), [Raspberry Pi All-In-One Installer](/docs/installation/raspberry-pi-all-in-one/), [Vagrant](/docs/installation/vagrant/), or [Virtualenv](/docs/installation/virtualenv).

[BRUH automation](http://www.bruhautomation.com) has created [a tutorial video](https://www.youtube.com/watch?v=tuG2rs1Cl2Y) explaining how to upgrade Home Assistant. diff --git a/source/_docs/z-wave.markdown b/source/_docs/z-wave.markdown index a97a8200d0b..a171d8c7abc 100644 --- a/source/_docs/z-wave.markdown +++ b/source/_docs/z-wave.markdown @@ -14,6 +14,8 @@ redirect_from: /getting-started/z-wave/ There is currently support for climate, covers, lights, locks, sensors, switches, and thermostats. All will be picked up automatically after configuring this platform. +Before configuring the Z-Wave setup, please take a moment and read [this article](https://drzwave.blog/2017/01/20/seven-habits-of-highly-effective-z-wave-networks-for-consumers/) to understand the most common pitfalls of Z-Wave networks. + ### {% linkable_title Installation %} As of version 0.45, Home Assistant automatically installs python-openzwave from PyPI as needed. diff --git a/source/_docs/z-wave/device-specific.markdown b/source/_docs/z-wave/device-specific.markdown index 19c968c0732..0b6ef4ee261 100644 --- a/source/_docs/z-wave/device-specific.markdown +++ b/source/_docs/z-wave/device-specific.markdown @@ -51,69 +51,77 @@ Make sure you copy the newly saved `zwcfg_[home_id].xml`into your Home Assistant Here's a handy configuration for the Aeon Labs Minimote that defines all possible button presses. Put it into `automation.yaml`. ```yaml - - alias: Minimote Button 1 Pressed - trigger: - platform: event - event_type: zwave.scene_activated - event_data: - entity_id: zwave.aeon_labs_minimote_1 - scene_id: 1 + - id: mini_1_pressed + alias: 'Minimote Button 1 Pressed' + trigger: + - platform: event + event_type: zwave.scene_activated + event_data: + entity_id: zwave.aeon_labs_minimote_1 + scene_id: 1 - - alias: Minimote Button 1 Held - trigger: - platform: event - event_type: zwave.scene_activated - event_data: - entity_id: zwave.aeon_labs_minimote_1 - scene_id: 2 + - id: mini_1_held + alias: 'Minimote Button 1 Held' + trigger: + - platform: event + event_type: zwave.scene_activated + event_data: + entity_id: zwave.aeon_labs_minimote_1 + scene_id: 2 - - alias: Minimote Button 2 Pressed - trigger: - platform: event - event_type: zwave.scene_activated - event_data: - entity_id: zwave.aeon_labs_minimote_1 - scene_id: 3 + - id: mini_2_pressed + alias: 'Minimote Button 2 Pressed' + trigger: + - platform: event + event_type: zwave.scene_activated + event_data: + entity_id: zwave.aeon_labs_minimote_1 + scene_id: 3 - - alias: Minimote Button 2 Held - trigger: - platform: event - event_type: zwave.scene_activated - event_data: - entity_id: zwave.aeon_labs_minimote_1 - scene_id: 4 + - id: mini_2_held + alias: 'Minimote Button 2 Held' + trigger: + - platform: event + event_type: zwave.scene_activated + event_data: + entity_id: zwave.aeon_labs_minimote_1 + scene_id: 4 - - alias: Minimote Button 3 Pressed - trigger: - platform: event - event_type: zwave.scene_activated - event_data: - entity_id: zwave.aeon_labs_minimote_1 - scene_id: 5 + - id: mini_3_pressed + alias: 'Minimote Button 3 Pressed' + trigger: + - platform: event + event_type: zwave.scene_activated + event_data: + entity_id: zwave.aeon_labs_minimote_1 + scene_id: 5 - - alias: Minimote Button 3 Held - trigger: - platform: event - event_type: zwave.scene_activated - event_data: - entity_id: zwave.aeon_labs_minimote_1 - scene_id: 6 + - id: mini_3_held + alias: 'Minimote Button 3 Held' + trigger: + - platform: event + event_type: zwave.scene_activated + event_data: + entity_id: zwave.aeon_labs_minimote_1 + scene_id: 6 - - alias: Minimote Button 4 Pressed - trigger: - platform: event - event_type: zwave.scene_activated - entity_data: - entity_id: zwave.aeon_labs_minimote_1 - scene_id: 7 + - id: mini_4_pressed + alias: 'Minimote Button 4 Pressed' + trigger: + - platform: event + event_type: zwave.scene_activated + event_data: + entity_id: zwave.aeon_labs_minimote_1 + scene_id: 7 - - alias: Minimote Button 4 Held - trigger: - platform: event - event_type: zwave.scene_activated - event_data: - entity_id: zwave.aeon_labs_minimote_1 - scene_id: 8 + - id: mini_4_held + alias: 'Minimote Button 4 Held' + trigger: + - platform: event + event_type: zwave.scene_activated + event_data: + entity_id: zwave.aeon_labs_minimote_1 + scene_id: 8 ``` diff --git a/source/_posts/2017-09-09-release-53.markdown b/source/_posts/2017-09-09-release-53.markdown index f056fc6ead6..924af92d24f 100644 --- a/source/_posts/2017-09-09-release-53.markdown +++ b/source/_posts/2017-09-09-release-53.markdown @@ -17,7 +17,7 @@ The Home Assistant community has been super busy in the last two weeks to bring 9 days away from our 4th birthday, we've just accomplished a couple of great milestones that I would love to share with you. We've hit over 8000 stars 🌟 on GitHub and starting this release we now ship over 800 platforms and components! -## Customize editor +## {% linkable_title Customize editor %} Another step in making Home Assistant configurable via the frontend has been contributed by @andrey-git: a customization editor! You are now able to inspect all (possible) customizations of an entity and update them with just a few taps. Want to change the name or icon of an entity? All possible in mere seconds. @@ -38,15 +38,15 @@ homeassistant: config: ``` -## Tesla +## {% linkable_title Tesla %} Thanks to the contribution by @zabuldon, you will now be able to control your Tesla car from Home Assistant. You're able to check the temperature inside and outside your car, control your AC and unlock the car. -## Input text +## {% linkable_title Input text %} This release introduces a new input component: `input_text` contributed by @BioSehnsucht. With this component you will be able to set free form from the UI and then let that be used by your automations or templates. -## KNX +## {% linkable_title KNX %} This release ships a new KNX implementation thanks to @Julius2342. It will instantly show all changed states of KNX devices within Home Assistant. Additionally it brings support for HVAC devices and notification services. It also adds a service for direct communication with the KNX bus. You can connect to KNX/IP routing and tunnelling devices. In the background it uses asyncio communication. Check the climate integration in action [here](https://www.youtube.com/watch?v=JI0VJzlGpx4) and see the lights in action below: @@ -54,7 +54,7 @@ This release ships a new KNX implementation thanks to @Julius2342. It will insta -## New Platforms +## {% linkable_title New Platforms %} - Xiaomi Philips Lights integration ([@syssi] - [#9087]) ([light.xiaomi_philipslight docs]) (new-platform) - Mycroft notify/component ([@btotharye] - [#9173]) ([mycroft docs]) ([notify.mycroft docs]) (new-platform) @@ -66,12 +66,19 @@ This release ships a new KNX implementation thanks to @Julius2342. It will insta - Tesla platform ([@zabuldon] - [#9211]) ([tesla docs]) ([binary_sensor.tesla docs]) ([climate.tesla docs]) ([device_tracker.tesla docs]) ([lock.tesla docs]) ([sensor.tesla docs]) (new-platform) - mopar sensor ([@happyleavesaoc] - [#9136]) ([sensor.mopar docs]) (new-platform) - Add Geofency device tracker ([@gunnarhelgason] - [#9106]) ([device_tracker.geofency docs]) (new-platform) -- Added DWD WarnApp Sensor ([@runningman84] - [#8657]) ([sensor.dwd_warnapp docs]) (new-platform) +- Added DWD WarnApp Sensor ([@runningman84] - [#8657]) ([sensor.dwdwarnapp docs]) (new-platform) - Add input_text component ([@BioSehnsucht] - [#9112]) ([input_text docs]) (new-platform) - Introducing a media_player component for Yamaha Multicast devices ([@jalmeroth] - [#9258]) ([media_player.yamaha_musiccast docs]) (new-platform) - Stable and asynchronous KNX library. ([@Julius2342] - [#8725]) ([knx docs]) ([binary_sensor.knx docs]) ([climate.knx docs]) ([cover.knx docs]) ([light.knx docs]) ([sensor.knx docs]) ([switch.knx docs]) (new-platform) - Adds the AirVisual air quality sensor platform ([@bachya] - [#9320]) ([sensor.airvisual docs]) (new-platform) +## {% linkable_title Release 0.53.1 - September 12 %} + +- Fix Twitter notifications with certain media such as small images ([@MikeChristianson] - [#9354]) ([notify.twitter docs]) +- Added additional string check in Wunderground sensor ([@arsaboo] - [#9380]) ([sensor.wunderground docs]) +- Fixing foscam library dependency/requirements ([@viswa-swami] - [#9387]) ([camera.foscam docs]) +- Fixes for customize editor ([@andrey-git]) + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums][forum] or join us for a little [chat][discord]. The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. @@ -80,7 +87,7 @@ Experiencing issues introduced by this release? Please report them in our [issue -## Breaking Changes +## {% linkable_title Breaking Changes %} - The new customize editor is using the file `customize.yaml` in your config folder. If you are using this file today for other config, make sure to rename it before using the new customize UI editor. ([@andrey-git] - [#9134]) ([config docs]) (breaking change) (new-platform) - The frontend component now supports loading custom html files when Home Assistant front end starts ([@andrey-git] - [#9150]) (breaking change). It could be Javascript, CSS or custom Web Components. Along there was a breaking change in the way Custom UI is used: @@ -97,7 +104,7 @@ frontend: - The Homematic `delay` option has been dropped because it is no longer necessary ([@pvizeli] - [#9058]) ([homematic docs]) ([binary_sensor.homematic docs]) ([climate.homematic docs]) ([cover.homematic docs]) ([light.homematic docs]) ([sensor.homematic docs]) ([switch.homematic docs]) (breaking change) - Switch - Dlink: Remove spaces and capital letters from attribute names for consistency ([@emlt] - [#9277]) ([switch.dlink docs]) (breaking change) -## All changes +## {% linkable_title All changes %} - Xiaomi Philips Lights integration ([@syssi] - [#9087]) ([light.xiaomi_philipslight docs]) (new-platform) - Backend changes for customize config panel. ([@andrey-git] - [#9134]) ([config docs]) (breaking change) @@ -176,7 +183,7 @@ frontend: - Update jinja to 2.9.6 ([@pvizeli] - [#9306]) - Ensure display-name does not exceed 12 characters for CecAdapter. ([@gollo] - [#9268]) ([hdmi_cec docs]) - Expose hue group 0 ([@filcole] - [#8663]) ([light.hue docs]) -- Added DWD WarnApp Sensor ([@runningman84] - [#8657]) ([sensor.dwd_warnapp docs]) (new-platform) +- Added DWD WarnApp Sensor ([@runningman84] - [#8657]) ([sensor.dwdwarnapp docs]) (new-platform) - Add input_text component ([@BioSehnsucht] - [#9112]) ([input_text docs]) (new-platform) - Introducing a media_player component for Yamaha Multicast devices ([@jalmeroth] - [#9258]) ([media_player.yamaha_musiccast docs]) (new-platform) - Handle the case where no registration number is available (instead display VIN (vehicle identification number)). ([@molobrakos] - [#9073]) ([volvooncall docs]) ([device_tracker.volvooncall docs]) @@ -381,7 +388,6 @@ frontend: [image_processing.dlib_face_detect docs]: https://home-assistant.io/components/image_processing.dlib_face_detect/ [image_processing.dlib_face_identify docs]: https://home-assistant.io/components/image_processing.dlib_face_identify/ [input_text docs]: https://home-assistant.io/components/input_text/ -[input_text docs]: https://home-assistant.io/components/input_text/ [insteon_plm docs]: https://home-assistant.io/components/insteon_plm/ [light.homematic docs]: https://home-assistant.io/components/light.homematic/ [light.hue docs]: https://home-assistant.io/components/light.hue/ @@ -390,7 +396,6 @@ frontend: [light.xiaomi_philipslight docs]: https://home-assistant.io/components/light.xiaomi_philipslight/ [light.rfxtrx docs]: https://home-assistant.io/components/light.rfxtrx/ [light.tradfri docs]: https://home-assistant.io/components/light.tradfri/ -[light.xiaomi_philipslight docs]: https://home-assistant.io/components/light.xiaomi_philipslight/ [light.knx docs]: https://home-assistant.io/components/light.knx/ [light.zha docs]: https://home-assistant.io/components/light.zha/ [lock.abode docs]: https://home-assistant.io/components/lock.abode/ @@ -415,7 +420,7 @@ frontend: [sensor.airvisual docs]: https://home-assistant.io/components/sensor.airvisual/ [sensor.buienradar docs]: https://home-assistant.io/components/sensor.buienradar/ [sensor.dht docs]: https://home-assistant.io/components/sensor.dht/ -[sensor.dwd_warnapp docs]: https://home-assistant.io/components/sensor.dwd_warnapp/ +[sensor.dwdwarnapp docs]: https://home-assistant.io/components/sensor.dwdwarnapp/ [sensor.fitbit docs]: https://home-assistant.io/components/sensor.fitbit/ [sensor.homematic docs]: https://home-assistant.io/components/sensor.homematic/ [sensor.mopar docs]: https://home-assistant.io/components/sensor.mopar/ @@ -449,3 +454,9 @@ frontend: [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues [discord]: https://discord.gg/c5DvZ4e +[#9354]: https://github.com/home-assistant/home-assistant/pull/9354 +[#9380]: https://github.com/home-assistant/home-assistant/pull/9380 +[#9387]: https://github.com/home-assistant/home-assistant/pull/9387 +[@viswa-swami]: https://github.com/viswa-swami +[camera.foscam docs]: https://home-assistant.io/components/camera.foscam/ +[sensor.wunderground docs]: https://home-assistant.io/components/sensor.wunderground/ diff --git a/source/_posts/2019-09-16-hassbian-1.3-a-bit-of-a-stretch.markdown b/source/_posts/2019-09-16-hassbian-1.3-a-bit-of-a-stretch.markdown new file mode 100644 index 00000000000..8d1c4732c8a --- /dev/null +++ b/source/_posts/2019-09-16-hassbian-1.3-a-bit-of-a-stretch.markdown @@ -0,0 +1,36 @@ +--- +layout: post +title: "Hassbian 1.3 - A bit of a stretch" +description: "Raspbian Stretch release of the HASSbian Raspberry Pi Image for Home Assistant" +date: 2017-09-16 16:00:00 +0100 +date_formatted: "September 16, 2017" +author: Fredrik Lindqvist +comments: true +categories: Technology +--- + +This new release finally brings us the release of Hassbian based on the release of Raspbian Stretch. The most significant change with this is that we now run Home Assistant on Python 3.5. +Other than that the changes are mostly to our tool `hassbian-config`. + +### {% linkable_title Hassbian-config %} + +To allow you to customize your installation further, we have made a few additions to our tool called `hassbian-config`. Majority of these changes where contributed by [@Ludeeus][ludeeus]. + +#### {% linkable_title Upgrade scripts %} + +[@Ludeeus][ludeeus] contributed the possibility to run upgrade scripts to the `hassbian-config` tool. + + - Upgrade Hassbian: Upgrades packages of the base operating system. Contributed by [@Landrash][landrash]. + - Upgrade Hassbian-script: Downloads and upgrades the latest release of Hassbian-scripts. Contributed by [@Ludeeus][ludeeus]. + - Upgrade Home-assistant: Upgrades the Home Assistant installation to the latest release. Contributed by [@Ludeeus][ludeeus]. + +To follow discussions about the development of the HASSbian image or to contribute join our [Discord chat server][discord-hassbian]. + +To get started with the new image, check out the installation instructions on the [installing Hassbian page][install]. + +[landrash]: http://github.com/landrash +[ludeeus]: http://github.com/ludeeus +[hassbian-repo]: https://github.com/home-assistant/hassbian-scripts/ +[hassbian-config-release]: https://github.com/home-assistant/hassbian-scripts/releases/latest +[install]: https://home-assistant.io/docs/installation/hassbian/installation/ +[discord-hassbian]: https://discord.gg/RkajcgS diff --git a/source/developers/component_generic_discovery.markdown b/source/developers/component_generic_discovery.markdown index 1791b756a00..8eacc22ff4a 100644 --- a/source/developers/component_generic_discovery.markdown +++ b/source/developers/component_generic_discovery.markdown @@ -67,7 +67,7 @@ def setup_platform(hass, config, add_devices, discovery_info=None): ``` -The `load_platform` method allows the platforms to be loaded with the need for any additional platform entries in your `configuration.yaml` file, which normally would have been: +The `load_platform` method allows the platforms to be loaded without the need for any additional platform entries in your `configuration.yaml` file, which normally would have been: ```yaml #light: diff --git a/source/developers/development_catching_up.markdown b/source/developers/development_catching_up.markdown index 7bfc8064805..88f4b73e078 100644 --- a/source/developers/development_catching_up.markdown +++ b/source/developers/development_catching_up.markdown @@ -24,6 +24,13 @@ If rebase detects conflicts, repeat this process until all changes have been res 4. Continue rebase: `git rebase --continue` 5. Repeat until you've resolved all conflicts +After rebasing your branch, you will have rewritten history relative to your GitHub fork's branch. When you go to push you will see an error that your history has diverged from the original branch. In order to get your GitHub fork up-to-date with your local branch, you will need to force push, using the following command: + +```bash +# Run this from your feature branch +$ git push origin --force +``` + Other workflows are covered in detail in the [Github documentation](https://help.github.com/articles/fork-a-repo/). Add an additional `remote` after you clone your fork. ```bash diff --git a/source/developers/hassio/addon_config.markdown b/source/developers/hassio/addon_config.markdown index 639f579350e..ad4d7e4c3ae 100644 --- a/source/developers/hassio/addon_config.markdown +++ b/source/developers/hassio/addon_config.markdown @@ -155,8 +155,9 @@ The `schema` looks like `options` but describes how we should validate the user We support: - str - bool -- int -- float +- int / int(min,) / int(,max) / int(min,max) +- float / float(min,) / float(,max) / float(min,max) - email - url - port +- match(REGEX) diff --git a/source/developers/hassio/debugging.markdown b/source/developers/hassio/debugging.markdown index d5dee3b6905..b10426728ed 100644 --- a/source/developers/hassio/debugging.markdown +++ b/source/developers/hassio/debugging.markdown @@ -20,7 +20,7 @@ The following debug tips and tricks are for people who are running the Hass.io i ## {% linkable_title SSH access to the host %} -Create an `authorized_keys` file in the root of your SD card with your public key. Once the device is booted, you can access your device as root over SSH on port 22222. +Create an `authorized_keys` file containing your public key, and place it in the root of the boot partition of your SD card. Once the device is booted, you can access your device as root over SSH on port 22222. Windows instructions how to generate and use private/public keys with Putty are [here][windows-keys]. Instead of the droplet instructions, add the public key as per above instructions. diff --git a/source/hassio/index.markdown b/source/hassio/index.markdown index c6f15c61fcd..4d5ae8d5558 100644 --- a/source/hassio/index.markdown +++ b/source/hassio/index.markdown @@ -28,11 +28,17 @@ The advantages of using Hass.io: +### {% linkable_title Upgrading %} + +Hass.io users can update Home Assistant via the 'Hass.io' page in the UI. However please note that Home Assistant updates take time to roll into the Hass.io builds. Therefore there is often a slight delay between the availability of a Home Assistant update and an update being available in Hass.io, be patient. When a Hass.io update is available it will be shown as available on the ‘Hass.io' page in your UI. +

Hass.io dashboard

+If you would prefer not to be notified of the general updates in the UI you can disable the [updater](components/updater/) component in your configuration. + [Google Assistant]: /addons/google_assistant/ [Snips.ai]: /addons/snips/ [Let's Encrypt]: /addons/lets_encrypt/ diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index eb93eb47334..83a8dee27ec 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -37,10 +37,10 @@ For advanced users, it is also possible to try Hass.io on your Linux server or i [Etcher]: https://etcher.io/ [resinos-network]: https://docs.resin.io/deployment/network/2.0.0/ -[pi1]: https://github.com/home-assistant/hassio-build/releases/download/1.0/resinos-hassio-1.0-raspberrypi.img.bz2 -[pi2]: https://github.com/home-assistant/hassio-build/releases/download/1.0/resinos-hassio-1.0-raspberrypi2.img.bz2 -[pi3]: https://github.com/home-assistant/hassio-build/releases/download/1.0/resinos-hassio-1.0-raspberrypi3.img.bz2 -[nuc]: https://github.com/home-assistant/hassio-build/releases/download/1.0/resinos-hassio-1.0-intel-nuc.img.bz2 +[pi1]: https://github.com/home-assistant/hassio-build/releases/download/1.1/resinos-hassio-1.1-raspberrypi.img.bz2 +[pi2]: https://github.com/home-assistant/hassio-build/releases/download/1.1/resinos-hassio-1.1-raspberrypi2.img.bz2 +[pi3]: https://github.com/home-assistant/hassio-build/releases/download/1.1/resinos-hassio-1.1-raspberrypi3.img.bz2 +[nuc]: https://github.com/home-assistant/hassio-build/releases/download/1.1/resinos-hassio-1.1-intel-nuc.img.bz2 [linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio [local]: http://hassio.local:8123 [samba]: /addons/samba/ diff --git a/source/hassio/zwave.markdown b/source/hassio/zwave.markdown index c450e019626..6d14fabcabc 100644 --- a/source/hassio/zwave.markdown +++ b/source/hassio/zwave.markdown @@ -24,7 +24,7 @@ dtoverlay=pi3-miniuart-bt For some exceptional devices, the `/dev/ttyAMA0` will not be detected by udev and are therefor not mapped with docker. So you need explicit set this device for mapping to Home-Assistant. Execute this command on ssh add-on: ```bash -$ curl -d '{"devices": ["ttyAMA0"]}' http://172.17.0.2/homeassistant/options +$ curl -d '{"devices": ["ttyAMA0"]}' http://hassio/homeassistant/options ``` After that, you need change `usb_path` to `/dev/ttyAMA0`. diff --git a/source/help/index.markdown b/source/help/index.markdown index a2750554c69..a4fd646e4f3 100644 --- a/source/help/index.markdown +++ b/source/help/index.markdown @@ -29,8 +29,9 @@ Have you found an issue in your Home Assistant installation? Please report it. R ### {% linkable_title Videos, talks, workshops and alike %} -- [Why we can't have the Internet of Nice Things: A home automation primer](https://www.openwest.org/custom/description.php?id=92) at [OpenWest 2017](https://www.openwest.org)- July 2017 -- [Home Automation with Home Assistant](https://github.com/jjmontesl/talk-hass-pydaygalicia2017) at [PyDay Galicia 2017](https://pyday2017.python-vigo.es/gl/)- June 2017 +- [Open Source Heimautomation mit Home Assistant](https://github.com/home-assistant/home-assistant-assets/tree/master/german/2017-maker-faire-zurich) at [Mini Maker Faire Zurich 2017](https://www.makerfairezurich.ch/en/) - September 2017 +- [Why we can't have the Internet of Nice Things: A home automation primer](https://www.openwest.org/custom/description.php?id=92) at [OpenWest 2017](https://www.openwest.org) - July 2017 +- [Home Automation with Home Assistant](https://github.com/jjmontesl/talk-hass-pydaygalicia2017) at [PyDay Galicia 2017](https://pyday2017.python-vigo.es/gl/) - June 2017 - [Home Automation with Python](https://www.youtube.com/watch?v=KNFZSSCPUyM) at [GLT 2017](https://glt17.linuxtage.at) - April 2017 - [Home Assistant workshop](https://github.com/home-assistant/home-assistant-assets/tree/master/german/2017-clt-workshop) at [CLT 2017](https://chemnitzer.linux-tage.de/2017/de/) - March 2017 - [Home Assistant - Erweiterungen (Platforms/Components)](https://github.com/home-assistant/home-assistant-assets/tree/master/german/2016-puzzle) at [Puzzle ITC](https://www.puzzle.ch/de/) - December 2016 @@ -69,10 +70,6 @@ Don't miss the regular [Home Assistant podcasts](https://hasspodcast.io/). - [5 open source home automation tools](https://opensource.com/life/16/3/5-open-source-home-automation-tools) by [opensource.com](https://opensource.com) - March 2016 - [Home Assistant – Open Source Python Home Automation Platform](http://www.automatedhome.co.uk/new-products/home-assistant-open-source-python-home-automation-platform.html) - January 2015 -### {% linkable_title Site Search %} - -There is not currently a site search for Home-Assistant.io but it's in the works. For now, you can use this [Google link](https://cse.google.com/cse/publicurl?cx=005053695590750500199:dtrfi8yigbi) which will narrow your search to this specific site. - ### {% linkable_title Roadmap %} There is no explicit roadmap available but the public [tracker](https://www.pivotaltracker.com/n/projects/1250084) can give you some insight into what is going on. diff --git a/source/images/components/ifttt/setup_service.png b/source/images/components/ifttt/setup_service.png index ab9685921b9..c4fc848b182 100644 Binary files a/source/images/components/ifttt/setup_service.png and b/source/images/components/ifttt/setup_service.png differ