+ This is not required on HassOS based Hass.io installs and should not be installed +
+ Supported platforms: Raspberry Pi 3. diff --git a/source/_addons/google_assistant.markdown b/source/_addons/google_assistant.markdown index f48415638e4..40923fdb19d 100644 --- a/source/_addons/google_assistant.markdown +++ b/source/_addons/google_assistant.markdown @@ -10,6 +10,10 @@ footer: true featured: true --- ++ These instructions are outdated - the add-on has been updated and these are no longer accurate or complete +
+If you want to integrate your Google Home, or mobile phone running Google Assistant, with Home Assistant, then you want the [Google Assistant component](/components/google_assistant/).
diff --git a/source/_components/asterisk_mbox.markdown b/source/_components/asterisk_mbox.markdown index 2361dfe0c97..f040acd99bb 100644 --- a/source/_components/asterisk_mbox.markdown +++ b/source/_components/asterisk_mbox.markdown @@ -9,11 +9,11 @@ sharing: true footer: true logo: asterisk.png ha_category: Other -ha_version: 0.51 ha_iot_class: "Local Push" +ha_release: 0.51 --- -The `asterisk_mbox `Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The component includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine. +The `asterisk_mbox` Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The component includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine. To enable the component, a configuration is required in both Home Assistant as well as on the Asterisk server. @@ -31,13 +31,21 @@ asterisk_mbox: This will add a new 'Mailbox' side-panel, as well as a sensor to indicate # of messages available. -Configuration variables: - -- **password** (*Required*): The password that was set during Asterisk PBX configuration -- **host** (*Required*): The ip-address of the server that is running the Asterisk PBX -- **port** (*Required*): The port on the Asterisk PBX server that was configured during Asterisk PBX configuration +{% configuration %} +password: + description: The password that was set during Asterisk PBX configuration + required: true + type: string +host: + description: The ip-address of the server that is running the Asterisk PBX + required: true + type: string +port: + description: The port on the Asterisk PBX server that was configured during Asterisk PBX configuration + required: true + type: string +{% endconfiguration %}Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this component when communication is contained within a local area network.
- diff --git a/source/_components/auth.markdown b/source/_components/auth.markdown new file mode 100644 index 00000000000..96d0ab055a2 --- /dev/null +++ b/source/_components/auth.markdown @@ -0,0 +1,15 @@ +--- +layout: page +title: "Auth" +description: "This component is responsible for providing the authentication endpoints." +date: 2018-03-19 21:04 +sidebar: true +comments: false +sharing: true +footer: true +logo: home-assistant.png +ha_category: Other +ha_release: 0.73 +--- + +This component creates the endpoints for the authentication system that is built into Home Assistant. There are no configuration options for this component directly as it relies on the auth system in the core. diff --git a/source/_components/binary_sensor.insteon_plm.markdown b/source/_components/binary_sensor.insteon_plm.markdown index 9312a66cffd..0ee0aaf0375 100644 --- a/source/_components/binary_sensor.insteon_plm.markdown +++ b/source/_components/binary_sensor.insteon_plm.markdown @@ -10,12 +10,12 @@ footer: true logo: insteon.png ha_category: Binary Sensor ha_iot_class: "Local Push" -ha_version: 0.39 +ha_release: 0.39 --- -The `insteon_plm` binary sensor platform lets you control your sensors through +The `insteon_plm` binary sensor platform lets you control your sensors through an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a USB or serial port. To add support, set up the primary [insteon_plm] component. -[insteon_plm]: /components/insteon_plm/ \ No newline at end of file +[insteon_plm]: /components/insteon_plm/ diff --git a/source/_components/climate.oem.markdown b/source/_components/climate.oem.markdown index 2b7b4012295..1f07cf6bd58 100644 --- a/source/_components/climate.oem.markdown +++ b/source/_components/climate.oem.markdown @@ -13,7 +13,7 @@ ha_release: 0.39 ha_iot_class: "Local Polling" --- -This platform supports the ESP82666 based "WiFi MQTT Relay / Thermostat" sold by [OpenEnergyMonitor](https://shop.openenergymonitor.com/wifi-mqtt-relay-thermostat/). The underlying [library](http://oemthermostat.readthedocs.io/) only supports this single relay variant of the [original device](https://harizanov.com/2014/12/wifi-iot-3-channel-relay-board-with-mqtt-and-http-api-using-esp8266/). +This platform supports the ESP8266 based "WiFi MQTT Relay / Thermostat" sold by [OpenEnergyMonitor](https://shop.openenergymonitor.com/wifi-mqtt-relay-thermostat/). The underlying [library](http://oemthermostat.readthedocs.io/) only supports this single relay variant of the [original device](https://harizanov.com/2014/12/wifi-iot-3-channel-relay-board-with-mqtt-and-http-api-using-esp8266/). This platform controls the setpoint of the thermostat in its "manual" mode, therefore there is a configuration option the away setpoint. diff --git a/source/_components/device_tracker.bluetooth_tracker.markdown b/source/_components/device_tracker.bluetooth_tracker.markdown index 45bd09eae3d..fd79f3c3f04 100644 --- a/source/_components/device_tracker.bluetooth_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_tracker.markdown @@ -15,10 +15,6 @@ 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`. --[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: ```yaml diff --git a/source/_components/device_tracker.mqtt_json.markdown b/source/_components/device_tracker.mqtt_json.markdown index a6cbc50b876..cc0e4783ec3 100644 --- a/source/_components/device_tracker.mqtt_json.markdown +++ b/source/_components/device_tracker.mqtt_json.markdown @@ -9,11 +9,10 @@ sharing: true footer: true logo: mqtt.png ha_category: Presence Detection -ha_version: 0.44 ha_iot_class: depends +ha_release: 0.44 --- - The `mqtt_json` device tracker platform allows you to detect presence by monitoring an MQTT topic for new locations. To use this platform, you specify a unique topic for each device. To use this device tracker in your installation, add the following to your `configuration.yaml` file: @@ -27,10 +26,16 @@ device_tracker: annetherese_n4: location/annetherese ``` -Configuration variables: - -- **devices** (*Required*): List of devices with their topic. -- **qos** (*Optional*): The QoS level of the topic. +{% configuration %} +devices: + description: List of devices with their topic. + required: true + type: list +qos: + description: The QoS level of the topic. + required: false + type: string +{% endconfiguration %} This platform receives JSON formatted payloads containing GPS information, for example: diff --git a/source/_components/device_tracker.xiaomi_miio.markdown b/source/_components/device_tracker.xiaomi_miio.markdown index ae604043937..54f4cf9d5de 100644 --- a/source/_components/device_tracker.xiaomi_miio.markdown +++ b/source/_components/device_tracker.xiaomi_miio.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: xiaomi.png ha_category: Presence Detection -ha_version: 0.67 ha_iot_class: "Local Polling" +ha_release: 0.67 --- The `xiaomi_miio` device tracker platform is observing your Xiaomi Mi WiFi Repeater 2 and reporting all associated WiFi clients. diff --git a/source/_components/dominos.markdown b/source/_components/dominos.markdown index d6849d738fa..4f1d1618915 100644 --- a/source/_components/dominos.markdown +++ b/source/_components/dominos.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: dominos.png ha_category: Other -ha_version: 0.59 ha_iot_class: "Cloud Polling" +ha_release: 0.59 --- The `dominos` component allows you to order Dominos Pizza from within your Home Assistant scripts and automations. diff --git a/source/_components/fan.insteon_hub.markdown b/source/_components/fan.insteon_hub.markdown deleted file mode 100644 index 0436d4bddee..00000000000 --- a/source/_components/fan.insteon_hub.markdown +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: page -title: "Insteon Hub Fan" -description: "Instructions on how to setup the Insteon Hub Fans within Home Assistant." -date: 2017-08-26 08:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: insteon.png -ha_category: Fan -ha_release: "0.30" ---- - -The `insteon_hub` fan component lets you control your fans connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. - -To get your Insteon Hub fan working with Home Assistant, follow the instructions for the general [Insteon Hub component](/components/insteon_hub/). diff --git a/source/_components/fan.insteon_local.markdown b/source/_components/fan.insteon_local.markdown index d9738043c9a..69a2249ff9a 100644 --- a/source/_components/fan.insteon_local.markdown +++ b/source/_components/fan.insteon_local.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Insteon (Local) Fan" +title: "Insteon (local) Fan" description: "Instructions on how to setup the Insteon Hub Fans locally within Home Assistant." date: 2017-04-06 11:00 sidebar: true @@ -9,9 +9,10 @@ sharing: true footer: true logo: insteon.png ha_category: Fan -ha_version: 0.48 +ha_release: 0.48 +redirect_from: /components/fan.insteon_hub/ --- -The `insteon_local` fan component lets you control your fan connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. +The `insteon_local` fan component lets you control your fans connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. -To get your insteon fans working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The fans will be automatically disovered and added to Home Assistant. The device names will be the Insteon address of the fans. +To get your Insteon fans working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The fans will be automatically discovered and added to Home Assistant. The device names will be the Insteon address of the fans. diff --git a/source/_components/fan.insteon_plm.markdown b/source/_components/fan.insteon_plm.markdown index 3f2323e16eb..0c4478778e3 100644 --- a/source/_components/fan.insteon_plm.markdown +++ b/source/_components/fan.insteon_plm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon PLM Fan" -description: "Instructions on how to setup the Insteon PLM fan locally within Home Assistant." +description: "Instructions on how to setup the Insteon PLM Fans locally within Home Assistant." date: 2017-02-19 17:00 sidebar: true comments: false @@ -10,15 +10,7 @@ footer: true logo: insteon.png ha_category: Fan ha_iot_class: "Local Push" -ha_version: 0.65 +ha_release: 0.65 --- -The `insteon_plm` fan platform lets you control your [FanLinc] through -an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a -USB or serial port. To add support, set up the primary [insteon_plm] -component. - -[insteon_plm]: /components/insteon_plm/ -[FanLinc]: https://www.smarthome.com/fanlinc-insteon-2475f-ceiling-fan-and-light-controller-fixture-module-dual-band.html - - +The `insteon_plm` fan platform lets you control your [FanLinc](https://www.smarthome.com/fanlinc-insteon-2475f-ceiling-fan-and-light-controller-fixture-module-dual-band.html) through an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a USB or serial port. To add support, set up the primary [insteon_plm](/components/insteon_plm/) component. diff --git a/source/_components/fan.xiaomi_miio.markdown b/source/_components/fan.xiaomi_miio.markdown index e6e1408e27a..de4a07316da 100644 --- a/source/_components/fan.xiaomi_miio.markdown +++ b/source/_components/fan.xiaomi_miio.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: xiaomi.png ha_category: Fan -ha_version: 0.57 ha_iot_class: "Local Polling" +ha_release: 0.57 --- The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier and Xiaomi Air Humidifier. @@ -181,20 +181,20 @@ fan: {% configuration %} host: - description: The IP address of your fan. + description: The IP address of your miio fan. required: true type: string token: - description: The API token of your fan. + description: The API token of your miio fan. required: true type: string name: - description: The name of your fan. + description: The name of your miio fan. required: false type: string default: Xiaomi Air Purifier model: - description: The model of your device. + description: The model of your miio fan. Valid values are `zhimi.airpurifier.v6`, `zhimi.airpurifier.v3`, `zhimi.humidifier.v1` and `zhimi.humidifier.ca1`. This setting can be used to bypass the device model detection and is recommended if your device isn't always available. required: false type: string {% endconfiguration %} diff --git a/source/_components/goalfeed.markdown b/source/_components/goalfeed.markdown index 5632a8847d7..474e8a0351f 100644 --- a/source/_components/goalfeed.markdown +++ b/source/_components/goalfeed.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: goalfeed.png ha_category: Other -ha_version: 0.63 +ha_release: 0.63 --- The `goalfeed` component lets you use your Goalfeed account to trigger events in Home Assistant whenever a NHL or MLB team scores. diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 495dcf2283e..5f860b4d6d0 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -169,6 +169,18 @@ You can test whether your button works within Home Assistant if you look at the It may happen that "your_nice_name" is not resolved correctly; the according message (#2 in the above example) will be missing. This might be due to secure communication between your HM interface and the HM device. You can change the communication from "secure" to "standard" within your HM-interface to solve that issue (in "Einstellungen" - "Geräte" find your device and change "Übertragungsmodus" from secure to standard) - not recommended for devices that should have secure communication. +#### {% linkable_title `homematic.keypress` events for HomeMatic IP devices %} + +To get the `homematic.keypress` event for some HomeMatic IP devices like WRC2 / WRC6 (wall switch) or SPDR (passage sensor) you have to temporary create an empty program for each channel in the CCU: + +1. In the menu of your CCU's admin panel go to `Programs and connections` > `Programs & CCU connection` +2. Go to `New` in the footer menu +3. Click the plus icon below `Condition: If...` and press the button `Device selection` +4. Select one of the device's channels you need (1-2 / 1-6 for WRC2 / WRC6 and 2-3 for SPDR) +5. Save the program with the `OK` button +6. When your channel is working now, you can edit it to select the other channels one by one +7. At the end, you can delete this program from the CCU + ### {% linkable_title Services %} - *homematic.virtualkey*: Simulate a keypress (or other valid action) on CCU/Homegear with device or virtual keys. diff --git a/source/_components/image_processing.microsoft_face_identify.markdown b/source/_components/image_processing.microsoft_face_identify.markdown index eb6d0a110fd..7f0de67938f 100644 --- a/source/_components/image_processing.microsoft_face_identify.markdown +++ b/source/_components/image_processing.microsoft_face_identify.markdown @@ -24,10 +24,10 @@ For using the result inside an automation rule, take a look at the [component](/ ```yaml # Example configuration.yaml entry image_processing: - - platform: microsoft_face_identify - group: family - source: - - entity_id: camera.door + - platform: microsoft_face_identify + group: family + source: + - entity_id: camera.door ``` Configuration variables: diff --git a/source/_components/input_number.markdown b/source/_components/input_number.markdown index aadbd391509..9f7f65ed956 100644 --- a/source/_components/input_number.markdown +++ b/source/_components/input_number.markdown @@ -194,3 +194,38 @@ automation: payload: "{{ states('input_number.target_temp') | int }}" ``` {% endraw %} + +Here's an example of `input_number` being used as a delay in an automation. + +{% raw %} +```yaml +# Example configuration.yaml entry using 'input_number' as a delay in an automation +input_number: + minutes: + name: minutes + icon: mdi:clock-start + initial: 3 + min: 0 + max: 6 + step: 1 + + seconds: + name: seconds + icon: mdi:clock-start + initial: 30 + min: 0 + max: 60 + step: 10 + +automation: + - alias: turn something off after x time after turning it on + trigger: + platform: state + entity_id: switch.something + to: 'on' + action: + - delay: '00:{{ states.input_number.minutes.state | int }}:{{ states.input_number.seconds.state | int }}' + - service: switch.turn_off + entity_id: switch.something +``` +{% endraw %} diff --git a/source/_components/insteon_hub.markdown b/source/_components/insteon_hub.markdown deleted file mode 100644 index 5c9813bc5ca..00000000000 --- a/source/_components/insteon_hub.markdown +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: page -title: "Insteon Hub" -description: "Instructions on how to setup the Insteon Hub within Home Assistant." -date: 2016-01-27 08:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: insteon.png -ha_category: Hub -ha_iot_class: "Cloud Polling" ---- - --This component has been disabled due to a complaint by Insteon. It will be enabled again once this issue has been resolved. -
- -The `insteon` component lets you use your [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. - -You will need to obtain an Insteon REST API key from the [Insteon Developer program](http://www.insteon.com/become-an-insteon-developer) to use this component. - -To integrate your Insteon Hub with Home Assistant, add the following section to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -insteon_hub: - username: YOUR_USERNAME - password: YOUR_PASSWORD - api_key: YOUR_API_KEY -``` - -Configuration variables: - -- **username** (*Required*): The username used to access the Insteon interface (e.g., the [connect.insteon.com](http://connect.insteon.com/) site). -- **password** (*Required*): The password used to access the Insteon interface. -- **api_key** (*Required*): The Insteon REST API key emailed to you once you are approved in the Insteon Developer program. diff --git a/source/_components/insteon_local.markdown b/source/_components/insteon_local.markdown index 40ed93c1d56..b4b534aabd9 100644 --- a/source/_components/insteon_local.markdown +++ b/source/_components/insteon_local.markdown @@ -10,38 +10,53 @@ footer: true logo: insteon.png ha_category: Hub ha_iot_class: "Local Polling" -ha_version: 0.36 +ha_release: 0.36 +redirect_from: /components/insteon_hub/ --- The `insteon_local` component let you use your [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. -To integrate your Insteon local setup with Home Assistant, add the following section to your `configuration.yaml` file: +## {% linkable_title Configuration %} + +To integrate your Insteon Hub (local setup) with Home Assistant, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml platform entry insteon_local: - host: YOUR HUB IP - username: YOUR HUB USERNAME - password: YOUR HUB PASSWORD + host: YOUR_HUB_IP + username: YOUR_HUB_USERNAME + password: YOUR_HUB_PASSWORD ``` -Configuration variables: -*Note: The username and password here are for the hub and are different than the ones used to access the app. You can usually find these on the bottom of your hub (unless you've changed them through the settings in the app)* -- **host** (*Required*): The IP address of your hub. -- **username** (*Required*): The username used to access the Insteon interface (find in your Insteon app). -- **password** (*Required*): The password used to access the Insteon interface. -- **timeout** (*Optional*): Timeout to wait for connections. Defaults to 10 seconds. -- **port** (*Optional*): The port your hub is configured to listen to. Defaults to `25105`. +{% configuration %} +host: + description: The IP address of your hub. + required: true + type: string +username: + description: The username used to access the Insteon interface (find in your Insteon app). + required: true + type: string +password: + description: The password used to access the Insteon interface. + required: true + type: string +timeout: + description: Timeout to wait for connections. + required: false + type: time + default: 10 seconds +port: + description: The port your hub is configured to listen to. + required: false + type: string + default: 25105 +{% endconfiguration %} -### {% linkable_title Full configuration %} +*Note: The username and password here are for the hub and are different than the ones used to access the app. You can usually find these on the bottom of your hub (unless you've changed them through the settings in the app)* The `insteon_local` component currently supports lights (dimmers), switches and fans. -```yaml -insteon_local: - host: YOUR HUB IP - username: YOUR HUB USERNAME - password: YOUR HUB PASSWORD - timeout: 10 - port: 25105 -``` ++This component replaces the old `insteon_hub` component, which has been removed due to a complaint by Insteon. +
diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index 53ac5745983..52f7b93530c 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -10,22 +10,17 @@ footer: true logo: insteon.png ha_category: Hub ha_iot_class: "Local Push" -ha_version: 0.39 +ha_release: 0.39 --- -This component adds "local push" support for INSTEON PowerLinc Modems allowing -linked INSTEON devices to be used within Home Assistant as lights, switches, -and binary sensors. Device support is provided by the underlying [insteonplm] -package. It is known to work with the [2413U] USB and [2412S] RS242 flavors -of PLM and the [2448A7] USB stick. This component does not work with the -IP-based hub products. For that, you'll want the "Insteon (Local)" component -instead. +This component adds "local push" support for INSTEON PowerLinc Modems allowing linked INSTEON devices to be used within Home Assistant as lights, switches, and binary sensors. Device support is provided by the underlying [insteonplm] package. It is known to work with the [2413U] USB and [2412S] RS242 flavors of PLM and the [2448A7] USB stick. This component does not work with the IP-based hub products. For that, you'll want the [Insteon local component](/components/insteon_local/) instead. [insteonplm]: https://github.com/nugget/python-insteonplm [2413U]: https://www.insteon.com/powerlinc-modem-usb [2412S]: https://www.insteon.com/powerlinc-modem-serial [2448A7]: https://www.smarthome.com/insteon-2448a7-portable-usb-adapter.html +## {% linkable_title Configuration %} ```yaml # insteon_plm supported configuration variables @@ -46,78 +41,78 @@ insteon_plm: x10_all_lights_on: HOUSECODE x10_all_lights_off: HOUSECODE ``` -Configuration variables: -- **port** (*Required*): The port for your device, e.g., `/dev/ttyUSB0` -- **device_override** (*Optional*): Override the default device definition - - *ADDRESS* is found on the device itself in the form 1A.2B.3C or 1a2b3c - - *CATEGORY* is found in the back of the device's User Guide in the form of - 0x00 - 0xff - - *SUBCATEGORY* is found in the back of the device's User Guide in the form - of 0x00 - 0xff - - *FIRMWARE* and *PRODUCT_KEY* are more advanced options and will typically - not be used. -- **x10_devices** (*Optional*): Define X10 devices to control or respond to - - *HOUSECODE* is the X10 housecode values a - p - - *UNITCODE* is the X10 unit code values 1 - 16 - - *PLATFORM* is the Home Assistant Platform to associate the device with. - The following platforms are supported - - binary_sensor: Used for on/off devices or keypad buttons that are read only. - - light: Used for dimmable X10 devices - - switch: Used for On/Off X10 devices - - *STEPS* is the number of dim/bright steps the device supports. Used for - dimmable X10 devices only. Default value is 22. -- **x10_all_units_off** (*Optional*): Creates an binary_sensor that responds - to the X10 standard command for All Units Off. -- **x10_all_lights_on** (*Optional*): Creates an binary_sensor that responds - to the X10 standard command for All Lights On -- **x10_all_lights_off** (*Optional*): Creates an binary_sensor that responds - to the X10 standard command for All Lights Off + +{% configuration %} +port: + description: The port for your device, e.g., `/dev/ttyUSB0` + required: true + type: string +device_override: + description: Override the default device definition + required: false + type: list + keys: + ADDRESS: + description: is found on the device itself in the form 1A.2B.3C or 1a2b3c + CATEGORY: + description: is found in the back of the device's User Guide in the form of 0x00 - 0xff + SUBCATEGORY: + description: is found in the back of the device's User Guide in the form of 0x00 - 0xff + FIRMWARE: + description: is a more advanced option and will typically not be used. + PRODUCT_KEY: + description: is a more advanced option and will typically not be used. +x10_devices: + description: Define X10 devices to control or respond to + required: false + type: list + keys: + HOUSECODE: + description: is the X10 housecode values a - p + UNITCODE: + description: is the X10 unit code values 1 - 16 + PLATFORM: + description: is the Home Assistant Platform to associate the device with. Choose one of the following supported platforms. + type: string + keys: + binary_sensor: + description: Used for on/off devices or keypad buttons that are read only. + light: + description: Used for dimmable X10 devices + switch: + description: Used for On/Off X10 devices + STEPS: + description: is the number of dim/bright steps the device supports. Used for dimmable X10 devices only. + default: 22 +x10_all_units_off: + description: Creates an binary_sensor that responds to the X10 standard command for All Units Off. + required: false +x10_all_lights_on: + description: Creates an binary_sensor that responds to the X10 standard command for All Lights On + required: false +x10_all_lights_off: + description: Creates an binary_sensor that responds to the X10 standard command for All Lights Off + required: false +{% endconfiguration %} ### {% linkable_title Autodiscovery %} -The first time autodiscovery runs, the duration may require up to 20 seconds -per device. Subsequent startups will occur much quicker using cached device -information. If a device is not recognized during autodiscovery, you can add -the device to the **device_override** configuration. +The first time autodiscovery runs, the duration may require up to 20 seconds per device. Subsequent startups will occur much quicker using cached device information. If a device is not recognized during autodiscovery, you can add the device to the **device_override** configuration. -In order for a device to be discovered it must be linked to the PLM as either -a responder or a controller. +In order for a device to be discovered it must be linked to the PLM as either a responder or a controller. ### {% linkable_title Linking Devices to the PLM %} -In order for any two Insteon devices to talk with one another, they must be -linked. For an overview of device linking please read the Insteon page on -[understanding linking]. The Insteon PLM module supports All-Linking through -[Development Tools] service calls. The following services are available: +In order for any two Insteon devices to talk with one another, they must be linked. For an overview of device linking, please read the Insteon page on [understanding linking]. The Insteon PLM module supports All-Linking through [Development Tools] service calls. The following services are available: -In order for any two Insteon devices to talk with one another, they must be -linked. For an overview of device linking, please read the Insteon page on -[understanding linking]. The Insteon PLM module supports All-Linking through -[Development Tools] service calls. The following services are available: -- **insteon_plm.add_all_link**: Tells the Insteon Modem (IM) start All-Linking -mode. Once the IM is in All-Linking mode, press the link button on the device -to complete All-Linking. -- **insteon_plm.delete_all_link**: Tells the Insteon Modem (IM) to remove an -All-Link record from the All-Link Database of the IM and a device. Once the IM -is set to delete the link, press the link button on the corresponding device -to complete the process. -- **insteon_plm.load_all_link_database**: Load the All-Link Database for a -device. WARNING - Loading a device All-Link database is very time consuming -and inconsistent. This may take a LONG time and may need to be repeated to -obtain all records. -- **insteon_plm.print_all_link_database**: Print the All-Link Database for a -device. Requires that the All-Link Database is loaded into memory. -- **insteon_plm.print_im_all_link_database**: Print the All-Link Database for -the INSTEON Modem (IM). +- **insteon_plm.add_all_link**: Tells the Insteon Modem (IM) start All-Linking mode. Once the IM is in All-Linking mode, press the link button on the device to complete All-Linking. +- **insteon_plm.delete_all_link**: Tells the Insteon Modem (IM) to remove an All-Link record from the All-Link Database of the IM and a device. Once the IM is set to delete the link, press the link button on the corresponding device to complete the process. +- **insteon_plm.load_all_link_database**: Load the All-Link Database for a device. WARNING - Loading a device All-Link database is very time consuming and inconsistent. This may take a LONG time and may need to be repeated to obtain all records. +- **insteon_plm.print_all_link_database**: Print the All-Link Database for a device. Requires that the All-Link Database is loaded into memory. +- **insteon_plm.print_im_all_link_database**: Print the All-Link Database for the INSTEON Modem (IM). -If you are looking for more advanced options, you can use the -[insteonplm_interactive] command line tool that is distributed with the -[insteonplm] Python module. Please see the documentation on the [insteonplm] -GitHub site. Alternatively, you can download [HouseLinc] which runs on any -Windows PC, or you can use [Insteon Terminal] which is open source and runs -on most platforms. SmartHome no longer supports HouseLinc, but it still -works. Insteon Terminal is a very useful tool but please read the disclaimers -carefully, they are important. +If you are looking for more advanced options, you can use the [insteonplm_interactive] command line tool that is distributed with the +[insteonplm] Python module. Please see the documentation on the [insteonplm] GitHub site. Alternatively, you can download [HouseLinc] which runs on any Windows PC, or you can use [Insteon Terminal] which is open source and runs on most platforms. SmartHome no longer supports HouseLinc, but it still works. Insteon Terminal is a very useful tool but please read the disclaimers carefully, they are important. [understanding linking]: http://www.insteon.com/support-knowledgebase/2015/1/28/understanding-linking [Development Tools]: https://www.home-assistant.io/docs/tools/dev-tools/ @@ -127,31 +122,15 @@ carefully, they are important. ### {% linkable_title Customization %} -The only configuration item that is absolutely necessary is the port so that -Home Assistant can connect to the PLM. This will expose all the supported -INSTEON devices which exist in the modem’s ALL-Link database. However, devices -will only be shown by their INSTEON hex address (e.g., “1A.2B.3C”) which can -be a bit unwieldy. As you link and unlink devices using the ‘Set’ buttons, -they’ll be added and removed from Home Assistant automatically. +The only configuration item that is absolutely necessary is the port so that Home Assistant can connect to the PLM. This will expose all the supported INSTEON devices which exist in the modem’s ALL-Link database. However, devices will only be shown by their INSTEON hex address (e.g., “1A.2B.3C”) which can be a bit unwieldy. As you link and unlink devices using the ‘Set’ buttons, they’ll be added and removed from Home Assistant automatically. -You can use the normal Home Assistant [device customization] section of your -configuration to assign friendly names and special icons to your devices. This -is especially useful for setting device_class on your binary_sensor INSTEON -devices. - -[device customization]: /getting-started/customizing-devices/ +You can use the normal Home Assistant [device customization](/getting-started/customizing-devices/) section of your configuration to assign friendly names and special icons to your devices. This is especially useful for setting device_class on your binary_sensor INSTEON devices. ### {% linkable_title Device Overrides %} -INSTEON devices are added to Home Assistant using the platform(s) that make the -most sense given the model and features of the hardware. The features of the -INSTEON device are built into the Home Assistant platform. Changing the -platform is not recommended. There are two primary uses for the -**device_override** feature. -- Devices that do not respond during autodiscovery. This is common for battery - operated devices. -- Devices that have not been fully developed. This allows an unknown device to - be mapped to a device that operates similarly to another device. +INSTEON devices are added to Home Assistant using the platform(s) that make the most sense given the model and features of the hardware. The features of the INSTEON device are built into the Home Assistant platform. Changing the platform is not recommended. There are two primary uses for the **device_override** feature. +- Devices that do not respond during autodiscovery. This is common for battery operated devices. +- Devices that have not been fully developed. This allows an unknown device to be mapped to a device that operates similarly to another device. ### {% linkable_title Example Configuration with Options%} @@ -176,10 +155,7 @@ insteon_plm: ### {% linkable_title What NOT to do %} -Insteon PLM is a top level component and device discovery will identify -the Home Assistant platform the device belongs in. As such, do not -declare Insteon devices in other platforms. For example, this configuration -will NOT work: +Insteon PLM is a top level component and device discovery will identify the Home Assistant platform the device belongs in. As such, do not declare Insteon devices in other platforms. For example, this configuration will NOT work: ```yaml light: diff --git a/source/_components/light.insteon_hub.markdown b/source/_components/light.insteon_hub.markdown deleted file mode 100644 index f581706b92c..00000000000 --- a/source/_components/light.insteon_hub.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: "Insteon Hub Light" -description: "Instructions on how to setup the Insteon Hub Lights within Home Assistant." -date: 2016-09-10 08:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: insteon.png -ha_category: Light -ha_release: 0.21 -ha_iot_class: "Local Push" ---- - -The `insteon_hub` light component lets you control your lights connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. - -To get your Insteon Hub fan working with Home Assistant, follow the instructions for the general [Insteon Hub component](/components/insteon_hub/). diff --git a/source/_components/light.insteon_local.markdown b/source/_components/light.insteon_local.markdown index b9aacb3250f..818e450eb90 100644 --- a/source/_components/light.insteon_local.markdown +++ b/source/_components/light.insteon_local.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Insteon (Local) Light" +title: "Insteon (local) Light" description: "Instructions on how to setup the Insteon Hub Lights locally within Home Assistant." date: 2016-12-18 08:00 sidebar: true @@ -9,10 +9,11 @@ sharing: true footer: true logo: insteon.png ha_category: Light -ha_version: 0.36 ha_iot_class: "Local Push" +ha_release: 0.36 +redirect_from: /components/light.insteon_hub/ --- The `insteon_local` light component lets you control your lights connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. -To get your insteon lights working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The lights will be automatically disovered and added to Home Assistant. The device names will be the Insteon address of the lights. +To get your Insteon lights working with Home Assistant, follow the instructions for the general [Insteon local component] (/components/insteon_local/). The lights will be automatically discovered and added to Home Assistant. The device names will be the Insteon address of the lights. diff --git a/source/_components/light.insteon_plm.markdown b/source/_components/light.insteon_plm.markdown index 65026cf5761..40561bdd914 100644 --- a/source/_components/light.insteon_plm.markdown +++ b/source/_components/light.insteon_plm.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Insteon PLM Light" -description: "Instructions on how to setup Insteon PLM lights locally within Home Assistant." +description: "Instructions on how to setup the Insteon PLM Lights locally within Home Assistant." date: 2017-02-19 17:00 sidebar: true comments: false @@ -10,8 +10,7 @@ footer: true logo: insteon.png ha_category: Light ha_iot_class: "Local Push" -ha_version: 0.39 +ha_release: 0.39 --- The `insteon_plm` light platform lets you control your dimmable light switches through an INSTEON PowerLinc Modem (PLM) device connected directly to your system on an USB or serial port. To add support, set up the primary [insteon_plm](/components/insteon_plm/) component. - diff --git a/source/_components/light.sensehat.markdown b/source/_components/light.sensehat.markdown index 55e09b12194..7c7a4d0b378 100644 --- a/source/_components/light.sensehat.markdown +++ b/source/_components/light.sensehat.markdown @@ -8,9 +8,9 @@ comments: false sharing: true footer: true logo: sense-hat.png -ha_version: 0.44 ha_category: Light ha_iot_class: "Assumed State" +ha_release: 0.44 --- The `sensehat` light platform lets you control the [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) board's 8x8 RGB LED matrix on your Raspberry Pi from within Home Assistant. diff --git a/source/_components/light.xiaomi_miio.markdown b/source/_components/light.xiaomi_miio.markdown index 991ff8c97fa..4597bc7f8fa 100644 --- a/source/_components/light.xiaomi_miio.markdown +++ b/source/_components/light.xiaomi_miio.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: philips.png ha_category: Light -ha_version: 0.53 ha_iot_class: "Local Polling" +ha_release: 0.53 --- The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philips LED Ball Lamp, Xiaomi Philips Zhirui LED Bulb E14 Candle Lamp, Xiaomi Philips LED Ceiling Lamp and Xiaomi Philips Eyecare Lamp 2. @@ -76,28 +76,22 @@ light: model: philips.light.bulb ``` -Configuration variables: -- **host** (*Required*): The IP of your light. -- **token** (*Required*): The API token of your light. -- **name** (*Optional*): The name of your light. -- **model** (*Optional*): The model of your light. Valid values are `philips.light.bulb`, `philips.light.candle2`, `philips.light.sread1`, `philips.light.ceiling` and `philips.light.zyceiling`. This setting can be used to bypass the device model detection and is recommended if your device isn't always available. - {% configuration %} host: - description: The IP address of your device. + description: The IP address of your miio light. required: true type: string token: - description: The API token of your device. + description: The API token of your miio light. required: true type: string name: - description: The name of your device. + description: The name of your miio light. required: false type: string default: Xiaomi Philips Light model: - description: The model of your device. + description: The model of your miio light. Valid values are `philips.light.bulb`, `philips.light.candle2`, `philips.light.sread1`, `philips.light.ceiling` and `philips.light.zyceiling`. This setting can be used to bypass the device model detection and is recommended if your device isn't always available. required: false type: string {% endconfiguration %} diff --git a/source/_components/lirc.markdown b/source/_components/lirc.markdown index 1c6dc56be31..ad96e2316b2 100644 --- a/source/_components/lirc.markdown +++ b/source/_components/lirc.markdown @@ -41,7 +41,7 @@ For more information have a look at `/usr/share/doc/lirc/README.Debian.gz` where Now teach LIRC about your particular remote control by preparing a lircd configuration file (`/etc/lirc/lircd.conf`). Search the [LIRC remote database](http://lirc.sourceforge.net/remotes/) for your model. If you can't find it, then you can always use the `irrecord` program to learn your remote. This will create a valid configuration file. Add as many remotes as you want by pasting them into the file. If `irrecord` doesn't work (e.g., for some air conditioner remotes), then the `mode2` program is capable of reading the codes in raw mode, followed by `irrecord -a` to extract hex codes. -Next, you have to make a `~/.lircrc` file that maps keypresses to system actions. [The configuration](http://www.lirc.org/html/configure.html) is a bit tedious but it must be done. Use the `prog = home-assistant` for all keys you want to be recognized by Home Assistant. The values you set for `button` must be the same as in the `lircd.conf` file and the values you put for `config` entry will be the sensor value in Home Assistant when you press the button. An example may look like this: +Next, you have to make a `~/.lircrc` file that maps keypresses to system actions. The file has to be in the home dir of the user running Home Assistant, e.g. in `/home/homeassistant/.lircrc` if you're running in a virtual env. [The configuration](http://www.lirc.org/html/configure.html) is a bit tedious but it must be done. Use the `prog = home-assistant` for all keys you want to be recognized by Home Assistant. The values you set for `button` must be the same as in the `lircd.conf` file and the values you put for `config` entry will be the sensor value in Home Assistant when you press the button. An example may look like this: ```bash begin diff --git a/source/_components/mailbox.asterisk_mbox.markdown b/source/_components/mailbox.asterisk_mbox.markdown index 15d5ec455f7..07e50d287c1 100644 --- a/source/_components/mailbox.asterisk_mbox.markdown +++ b/source/_components/mailbox.asterisk_mbox.markdown @@ -9,8 +9,7 @@ sharing: true footer: true logo: asterisk.png ha_category: Mailbox -ha_version: 0.51 +ha_release: 0.51 --- The Asterisk Voicemail Mailbox provides visual and audio access to voicemail on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail component](/components/asterisk_mbox/) configuration. - diff --git a/source/_components/mailbox.markdown b/source/_components/mailbox.markdown index 16bfa603b8d..c6d270fdad9 100644 --- a/source/_components/mailbox.markdown +++ b/source/_components/mailbox.markdown @@ -6,13 +6,12 @@ date: 2017-06-30 18:30 sidebar: true comments: false sharing: true -ha_version: 0.51 footer: true +ha_release: 0.51 --- -Mailboxes provide a list of messages with short information about each. Mailbox messages appear on a separate panel in the frontend. +Mailboxes provide a list of messages with short information about each. Mailbox messages appear on a separate panel in the frontend. Home Assistant currently supports only the [Asterisk Voicemail](/component/mailbox.asterisk_mbox) mailbox. Each mailbox also provides an entity to indicate the number of messages available on the main page. - diff --git a/source/_components/matrix.markdown b/source/_components/matrix.markdown index b6e9e9814b9..75bd6da0e6a 100644 --- a/source/_components/matrix.markdown +++ b/source/_components/matrix.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: matrix.png ha_category: Hub -ha_version: 0.69 +ha_release: 0.69 --- This component allows you to send messages to matrix rooms, as well as to react to messages in matrix rooms. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index 49bda958e0a..1525cd8ec5d 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -57,6 +57,7 @@ Currently known supported models: - U6300 (port must be set to 8001, and `pip3 install websocket-client` must be executed) - K5579 (port must be set to 8001, On/Off, Forward/Backward, Volume control, but no Play button) - 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) - 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) - KU6020 (port must be set to 8001, and `pip3 install websocket-client` must be executed) @@ -65,6 +66,7 @@ Currently known supported models: - MU6170UXZG (port must be set to 8001, and `pip3 install websocket-client` must be executed) - KS7502 (port must be set to 8001, and `pip3 install websocket-client` must be executed, turn on doesn't work, turn off works fine) - K5600AK (partially supported, turn on works but state is not updated) +- M5620 (port must be set to 8001, and `pip3 install websocket-client` must be executed) - UE65KS8005 (port must be set to 8001, On/Off, Forward/Backward, Volume are OK, but no Play button) - UE6199UXZG (port must be set to 8001, On/Off, Forward/Backward, Volume control, but no Play button) diff --git a/source/_components/media_player.webostv.markdown b/source/_components/media_player.webostv.markdown index 8a18623775c..b045ccc518a 100644 --- a/source/_components/media_player.webostv.markdown +++ b/source/_components/media_player.webostv.markdown @@ -40,7 +40,7 @@ Configuration variables: - **turn_on_action** (*Optional*): Defines an [action](/docs/automation/action/) to turn the TV on. - **name** (*Optional*): The name you would like to give to the LG webOS Smart TV. - **timeout** (*Optional*): The timeout for connections to the TV in seconds. -- **filename** (*Optional*): The filename where the pairing key with the TV should be stored. This path is relative to Home Assistant's config directory. It defaults to `webostv.conf`. +- **filename** (*Optional*): The filename where the pairing key with the TV should be stored. This path is relative to Home Assistant's config directory. It defaults to `webostv.conf`. **NOTE**: When using multiple TVs each TV will need its own unique file. - **customize** array (*Optional*): List of options to customize. - **sources** array (*Optional*): List of hardware and webOS App inputs. diff --git a/source/_components/neato.markdown b/source/_components/neato.markdown index 611bc77c00d..43aca42701f 100644 --- a/source/_components/neato.markdown +++ b/source/_components/neato.markdown @@ -12,7 +12,7 @@ ha_category: Hub ha_release: 0.33 --- -The `neato` component allows you to control your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). +The `neato` component allows you to control your [Neato Botvac Connected Robots](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). To enable `neato` in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/notify.telegram.markdown b/source/_components/notify.telegram.markdown index 534924105de..077288efab2 100644 --- a/source/_components/notify.telegram.markdown +++ b/source/_components/notify.telegram.markdown @@ -99,7 +99,7 @@ action: service: notify.NOTIFIER_NAME data: title: '*Send a message*' - message: 'That's an example that _sends_ a *formatted* message with a custom inline keyboard.' + message: "That's an example that _sends_ a *formatted* message with a custom inline keyboard." data: inline_keyboard: - 'Task 1:/command1, Task 2:/command2' @@ -121,7 +121,7 @@ action: service: notify.NOTIFIER_NAME data: title: Send an images - message: That's an example that sends an image. + message: "That's an example that sends an image." data: photo: - url: http://192.168.1.28/camera.jpg @@ -164,7 +164,7 @@ action: service: notify.NOTIFIER_NAME data: title: Send a video - message: That's an example that sends a video. + message: "That's an example that sends a video." data: video: - url: http://192.168.1.28/camera.mp4 @@ -194,7 +194,7 @@ action: service: notify.NOTIFIER_NAME data: title: Send a document - message: That's an example that sends a document and a custom keyboard. + message: "That's an example that sends a document and a custom keyboard." data: document: file: /tmp/whatever.odf diff --git a/source/_components/prometheus.markdown b/source/_components/prometheus.markdown index d7bdeeb3aa2..42eddb45996 100644 --- a/source/_components/prometheus.markdown +++ b/source/_components/prometheus.markdown @@ -23,7 +23,7 @@ prometheus: Configuration variables: -- **namespace** (*Optional*): The "namespace" that will be assigned to all the Prometheus metrics. This is the prefix of the metric name. E.g., having `myhass` as the namespace will cause the device tracker metrics to be `myhass_device_tracker_state`, the switch metrics to be `myhass_switch_state` and so on. The default is to not add any prefix to the metrics name. +- **namespace** (*Optional*): The "namespace" that will be assigned to all the Prometheus metrics. This is the prefix of the metric name. E.g., having `myhass` as the namespace will cause the device tracker metrics to be `myhass_device_tracker_state`, the switch metrics to be `myhass_switch_state` and so on. The default is to not add any prefix to the metrics name. (available in version 0.73.0 and later) - **filter** (*Optional*): Filtering directives for the components which should be included or excluded from recording. - **exclude** (*Optional*): Excluded from recording. - **entities** (*Optional*): The list of entity ids to be excluded from recording. diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown index ab75ddbdacb..8c8b5a4cbc0 100644 --- a/source/_components/recorder.markdown +++ b/source/_components/recorder.markdown @@ -119,7 +119,7 @@ recorder: - sensor.date ``` -If you only want to hide events from e.g., your history, take a look at the [`history` component](/components/history/). Same goes for logbook. But if you have privacy concerns about certain events or neither want them in history or logbook, you should use the `exclude`/`include` options of the `recorder` component, that they aren't even in your database. That way you can save storage and keep the database small by excluding certain often-logged events (like `sensor.last_boot`). +If you only want to hide events from e.g., your history, take a look at the [`history` component](/components/history/). Same goes for logbook. But if you have privacy concerns about certain events or neither want them in history or logbook, you should use the `exclude`/`include` options of the `recorder` component, that way they aren't even in your database. That way you can save storage and keep the database small by excluding certain often-logged events (like `sensor.last_boot`). ### {% linkable_title Service `purge` %} diff --git a/source/_components/rest_command.markdown b/source/_components/rest_command.markdown index 962d92e3c43..4e4ef8fb6f5 100644 --- a/source/_components/rest_command.markdown +++ b/source/_components/rest_command.markdown @@ -39,5 +39,48 @@ Configuration variables: - **timeout** (*Optional*): Timeout for requests. Defaults to 10 seconds. - **content_type** (*Optional*): Content type for the request. -The commands can be dynamic, using templates to insert values of other entities. -Service call support variables for template stuff. +## {% linkable_title Examples %} + +The commands can be dynamic, using templates to insert values of other entities. Service call support variables for doing things with templates. + +{% raw %} +```yaml +# Example configuration.yaml entry +rest_command: + my_request: + url: https://slack.com/api/users.profile.set + method: POST + headers: + authorization: !secret rest_headers_secret + accept: 'application/json, text/html' + payload: '{"profile":{"status_text": "{{ status }}","status_emoji": "{{ emoji }}"}}' + content_type: 'application/json; charset=utf-8' +``` +{% endraw %} + +In this example entry, you can see some simple [templates](/docs/configuration/templating/) in use for dynamic parameters. + +Call the new service from [developer tools](/docs/tools/dev-tools/) in the sidebar with some `data` like: + +```json +{ + "status":"My Status Goes Here", + "emoji":":plex:" +} +``` +Or in an example `automation` + +```yaml +automation: +- alias: 'Arrive at Work' + trigger: + platform: zone + entity_id: device_tracker.my_device + zone: zone.work + event: enter + action: + - service: rest_command.my_request + data: + status: "At Work" + emoji: ":calendar:" +``` diff --git a/source/_components/sensor.duke_energy.markdown b/source/_components/sensor.duke_energy.markdown index 35a14abd964..1d1bb410d5e 100644 --- a/source/_components/sensor.duke_energy.markdown +++ b/source/_components/sensor.duke_energy.markdown @@ -9,7 +9,7 @@ sharing: true footer: true logo: duke_energy.png ha_category: Sensor -ha_release: "0.73" +ha_release: "0.74" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.fixer.markdown b/source/_components/sensor.fixer.markdown index f02af8ef6b5..6bb80331e0a 100644 --- a/source/_components/sensor.fixer.markdown +++ b/source/_components/sensor.fixer.markdown @@ -16,7 +16,7 @@ ha_release: 0.23 The `fixer` sensor will show you the current exchange rate from [Fixer.io](http://fixer.io/) which is using data from the [European Central Bank (ECB)](https://www.ecb.europa.eu). -To get an overview about the available [currencies](http://api.fixer.io/latest). +To get an overview about the available [currencies](https://fixer.io/symbols). ## {% linkable_title Setup %} diff --git a/source/_components/sensor.fritzbox_callmonitor.markdown b/source/_components/sensor.fritzbox_callmonitor.markdown index dd57677a9ca..6e50df044b1 100644 --- a/source/_components/sensor.fritzbox_callmonitor.markdown +++ b/source/_components/sensor.fritzbox_callmonitor.markdown @@ -17,10 +17,22 @@ ha_iot_class: "Local Polling" The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes. It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes. -## {% linkable_title Configuration %} +## {% linkable_title Prerequisites %} + +To build the package you have to install some dependencies first. + +```bash +$ sudo apt-get update +$ sudo apt-get install libxml2-dev libxslt-dev \ + python3-setuptools zlib1g-dev build-essential +``` + +## {% linkable_title Setup%} To activate the call monitor on your Fritz!Box, dial #96\*5\* from any phone connected to it. +## {% linkable_title Configuration %} + To use the Fritz!Box call monitor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.geo_rss_events.markdown b/source/_components/sensor.geo_rss_events.markdown index 6679f455323..9d73fe5f7b9 100644 --- a/source/_components/sensor.geo_rss_events.markdown +++ b/source/_components/sensor.geo_rss_events.markdown @@ -9,36 +9,27 @@ sharing: true footer: true logo: rss.png ha_category: Sensor -ha_version: 0.55 ha_iot_class: "Cloud Polling" +ha_release: 0.55 --- -The `geo_rss_events` sensor retrieves events from a GeoRSS feed and -shows information of those events filtered by distance to Home Assistant's -location and grouped by category. +The `geo_rss_events` sensor retrieves events from a GeoRSS feed and shows information of those events filtered by distance to Home Assistant's location and grouped by category. -This sensor is particularly useful if events occur unexpectedly in the -vicinity of the home while the GeoRSS feed also contains many events -representing distant unrelated entries. Typical examples are bush fires -alerts or earthquakes. +This sensor is particularly useful if events occur unexpectedly in the vicinity of the home while the GeoRSS feed also contains many events representing distant unrelated entries. Typical examples are bush fires alerts or earthquakes.
If you are tracking temperature it is recommended to set `bed` and/or `number_of_tools` in your octoprint configuration. This will allow the octoprint sensors to load if the printer is offline during Home Assistant startup. diff --git a/source/_components/sensor.postnl.markdown b/source/_components/sensor.postnl.markdown index 29a193a3416..3fa41230239 100644 --- a/source/_components/sensor.postnl.markdown +++ b/source/_components/sensor.postnl.markdown @@ -45,5 +45,5 @@ password: {% endconfiguration %}
-This component is not affiliated with PostNL and retrieves date from the endpoints of the mobile application. Use at your own risk. +This component is not affiliated with PostNL and retrieves data from the endpoints of the mobile application. Use at your own risk.
diff --git a/source/_components/sensor.waqi.markdown b/source/_components/sensor.waqi.markdown index a3fd05aab8d..163ce64ee68 100644 --- a/source/_components/sensor.waqi.markdown +++ b/source/_components/sensor.waqi.markdown @@ -27,7 +27,7 @@ sensor: locations: - beijing stations: - - Beijing US Embassy + - Beijing US Embassy, Beijing ``` Configuration variables: diff --git a/source/_components/sensor.xiaomi_miio.markdown b/source/_components/sensor.xiaomi_miio.markdown index d67aa622baf..26e1a4293b9 100644 --- a/source/_components/sensor.xiaomi_miio.markdown +++ b/source/_components/sensor.xiaomi_miio.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: xiaomi.png ha_category: Sensor -ha_version: 0.66 ha_iot_class: "Local Polling" +ha_release: 0.66 --- The `xiaomi_miio` sensor platform is observing your Xiaomi Mi Air Quality Monitor (PM2.5) and reporting the air quality index. diff --git a/source/_components/snips.markdown b/source/_components/snips.markdown index fd125970615..825dbf19d53 100644 --- a/source/_components/snips.markdown +++ b/source/_components/snips.markdown @@ -77,7 +77,7 @@ Note: if you already have an assistant installed and wish to replace it, start b ### {% linkable_title Running Snips %} -Make sure that a microphone is plugged to the Raspberry Pi. If you are having trouble setting up audio, we have written a guide on [Raspberry Pi Audio Configuration](https://github.com/snipsco/snips-platform-documentation/wiki/1.-Setup-the-Snips-Voice-Platform-on-your-Raspberry-Pi#configuring-the-audio). +Make sure that a microphone is plugged to the Raspberry Pi. If you are having trouble setting up audio, we have written a guide on [Raspberry Pi Audio Configuration](https://snips.gitbook.io/documentation/installing-snips/on-a-raspberry-pi#2-configuration). Start the Snips Voice Platform by starting the `snips-*` services: @@ -97,7 +97,7 @@ As the Snips Platform parses this query into an intent, it will be published on #### {% linkable_title Optional: specifying an external MQTT broker %} -By default, Snips runs its own MQTT broker. But we can also tell Snips to use an external broker by specifying this when launching Snips. In this case, we need to specify this in the `/etc/snips.toml` configuration file. For more information on configuring this, see the [Using an external MQTT broker](https://github.com/snipsco/snips-platform-documentation/wiki/6.--Miscellaneous#using-external-mqtt-broker) article. +By default, Snips runs its own MQTT broker. But we can also tell Snips to use an external broker by specifying this when launching Snips. In this case, we need to specify this in the `/etc/snips.toml` configuration file. For more information on configuring this, see the [Using an external MQTT broker](https://snips.gitbook.io/documentation/advanced-configuration/platform-configuration) article. ## {% linkable_title Home Assistant configuration %} diff --git a/source/_components/switch.insteon_local.markdown b/source/_components/switch.insteon_local.markdown index 8a3c3f93603..d465cae2fe5 100644 --- a/source/_components/switch.insteon_local.markdown +++ b/source/_components/switch.insteon_local.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Insteon (Local) Switch" +title: "Insteon (local) Switch" description: "Instructions on how to setup the Insteon Hub switches locally within Home Assistant." date: 2016-12-18 08:00 sidebar: true @@ -9,9 +9,9 @@ sharing: true footer: true logo: insteon.png ha_category: Switch -ha_version: 0.36 +ha_release: 0.36 --- The `insteon_local` switch component lets you control your switches connected to an [Insteon Hub](http://www.insteon.com/insteon-hub/) with Home Assistant. -To get your insteon switches working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The switches will be automatically disovered and added to Home Assistant. The device names will be the Insteon address of the switch. +To get your Insteon switches working with Home Assistant, follow the instructions for the general [Insteon local component](/components/insteon_local/). The switches will be automatically discovered and added to Home Assistant. The device names will be the Insteon address of the switch. diff --git a/source/_components/switch.insteon_plm.markdown b/source/_components/switch.insteon_plm.markdown index 8843679bb01..39f7d1235dc 100644 --- a/source/_components/switch.insteon_plm.markdown +++ b/source/_components/switch.insteon_plm.markdown @@ -10,13 +10,7 @@ footer: true logo: insteon.png ha_category: Switch ha_iot_class: "Local Push" -ha_version: 0.39 +ha_release: 0.39 --- -The `insteon_plm` switch platform lets you control your on/off switches through -an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a -USB or serial port. To add support, set up the primary [insteon_plm] -component. - -[insteon_plm]: /components/insteon_plm/ - +The `insteon_plm` switch platform lets you control your on/off switches through an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a USB or serial port. To add support, set up the primary [insteon_plm](/components/insteon_plm/) component. diff --git a/source/_components/switch.xiaomi_miio.markdown b/source/_components/switch.xiaomi_miio.markdown index 61244372095..11596d6c241 100644 --- a/source/_components/switch.xiaomi_miio.markdown +++ b/source/_components/switch.xiaomi_miio.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: xiaomi.png ha_category: Switch -ha_version: 0.56 ha_iot_class: "Local Polling" +ha_release: 0.56 --- The `xiaomi_miio` switch platform allows you to control the state of your Xiaomi Smart WiFi Socket aka Plug, Xiaomi Smart Power Strip and Xiaomi Chuangmi Plug V1. @@ -57,28 +57,22 @@ switch: model: chuangmi.plug.m1 ``` -Configuration variables: -- **host** (*Required*): The IP of your miio device. -- **token** (*Required*): The API token of your miio device. -- **name** (*Optional*): The name of your miio device. -- **model** (*Optional*): The model of your miio device. Valid values are `chuangmi.plug.v1`, `qmi.powerstrip.v1`, `zimi.powerstrip.v2`, `chuangmi.plug.m1` and `chuangmi.plug.v2`. This setting can be used to bypass the device model detection and is recommended if your device isn't always available. - {% configuration %} host: - description: The IP address of your device. + description: The IP address of your miio device. required: true type: string token: - description: The API token of your device. + description: The API token of your miio device. required: true type: string name: - description: The name of your device. + description: The name of your miio device. required: false type: string default: Xiaomi Miio Switch model: - description: The model of your device. + description: The model of your miio device. Valid values are `chuangmi.plug.v1`, `qmi.powerstrip.v1`, `zimi.powerstrip.v2`, `chuangmi.plug.m1` and `chuangmi.plug.v2`. This setting can be used to bypass the device model detection and is recommended if your device isn't always available. required: false type: string {% endconfiguration %} diff --git a/source/_components/tahoma.markdown b/source/_components/tahoma.markdown index f41f3936cce..03734815e39 100644 --- a/source/_components/tahoma.markdown +++ b/source/_components/tahoma.markdown @@ -40,3 +40,5 @@ exclude: required: false type: list {% endconfiguration %} + +This also works with the Somfy Connexoon. Check [here](https://somfyhouse.freshdesk.com/nl/support/solutions/articles/14000058145-wat-is-het-verschil-tussen-de-tahoma-en-de-connexoon-) for the differences between the bridges. diff --git a/source/_components/vacuum.neato.markdown b/source/_components/vacuum.neato.markdown index b670457369b..d1d334bc3de 100644 --- a/source/_components/vacuum.neato.markdown +++ b/source/_components/vacuum.neato.markdown @@ -14,11 +14,15 @@ ha_iot_class: "Cloud Polling" redirect_from: /components/sensor.neato/ --- --Starting with 0.57 the `neato` sensor was migrated to a vacuum platform. -
- -The `neato` vacuum platform allows you to control your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). +The `neato` vacuum platform allows you to control your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). The status will contain attributes on the robots last clean session. -To add `neato` sensors to your installation, follow instructions in [Neato component](/components/neato/). +To add `neato` vacuum to your installation, please follow instructions in [Neato component](/components/neato/). + +Currently supported features are: + +- `turn_on` +- `pause` +- `stop` +- `return_to_home` +- `turn_off` (stop all activity and return to dock) diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 6cdc2c33f30..be3f1ed0bbf 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -125,7 +125,9 @@ The following table shows the units of measurement for each attribute: ## {% linkable_title Retrieving the Access Token %}-As per [python-miio issue 185](https://github.com/rytilahti/python-miio/issues/185) the Mi-Home app no longer stores the token within the database (it's retrieved from Xiaomi servers from version 5.0.31+). Currently the only known fix is to uninstall, then install a downgraded version of the apk. Apkmirror is a trusted source for older versions of the app. [Mi-Home version 5.0.0](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-0-release/) is confirmed as working for the following Android methods. +As per [python-miio issue 185](https://github.com/rytilahti/python-miio/issues/185) the Android Mi-Home app no longer stores the token within the database (it's retrieved from Xiaomi servers from version 5.0.31+). Currently the only known fix is to uninstall, then install a downgraded version of the apk. Apkmirror is a trusted source for older versions of the app. [Mi-Home version 5.0.0](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-0-release/) is confirmed as working for the following Android methods. + +The iPhone app still stores the token in the sqlite db as of v4.7.18 (July 17, 2018). This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum, Mi Robot 2 (Roborock) Vacuum, Xiaomi Philips Lights and Xiaomi IR Remote. 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 or using the `miio` command line tool. diff --git a/source/_cookbook/google_maps_card.markdown b/source/_cookbook/google_maps_card.markdown index 1f3c9c1f01c..9055e4c6726 100644 --- a/source/_cookbook/google_maps_card.markdown +++ b/source/_cookbook/google_maps_card.markdown @@ -12,6 +12,8 @@ ha_category: User Interface Using the [generic camera platform] you can present any image on the internet as a camera. Starting release 0.27 these urls can also be based on a template. This example uses this functionality to point a generic camera at the Google Maps static image API and pass in the location of a device. +As of June 2018, Google has changed the API limits for static maps. You now need to have a Google Maps API key. Instructions for registering a key can be found [here](https://github.com/googlemaps/google-maps-services-python#api-keys). Replace `YOUR_API_KEY` with the key you registered. + It also leverages the `limit_refetch_to_url_change` option to ensure that we do not make a lot of requests to the Google Maps API. ```yaml @@ -20,7 +22,7 @@ It also leverages the `limit_refetch_to_url_change` option to ensure that we do camera: name: Paulus platform: generic - still_image_url: {% raw %}https://maps.googleapis.com/maps/api/staticmap?center={{ states.device_tracker.demo_paulus.attributes.latitude }},{{ states.device_tracker.demo_paulus.attributes.longitude }}&zoom=13&size=500x500&maptype=roadmap&markers=color:blue%7Clabel:P%7C{{ states.device_tracker.demo_paulus.attributes.latitude }},{{ states.device_tracker.demo_paulus.attributes.longitude }}{% endraw %} + still_image_url: {% raw %}https://maps.googleapis.com/maps/api/staticmap?center={{ states.device_tracker.demo_paulus.attributes.latitude }},{{ states.device_tracker.demo_paulus.attributes.longitude }}&zoom=13&size=500x500&maptype=roadmap&markers=color:blue%7Clabel:P%7C{{ states.device_tracker.demo_paulus.attributes.latitude }},{{ states.device_tracker.demo_paulus.attributes.longitude }}{% endraw %}&key=YOUR_API_KEY limit_refetch_to_url_change: true ``` diff --git a/source/_docs/ecosystem/nginx.markdown b/source/_docs/ecosystem/nginx.markdown index 46ae6152d1c..0d44113b3e4 100644 --- a/source/_docs/ecosystem/nginx.markdown +++ b/source/_docs/ecosystem/nginx.markdown @@ -85,7 +85,7 @@ Forward ports 443 and 80 to your server on your router. Do not forward port 8123 ### {% linkable_title NGINX Config %} -```text +```nginx map $http_upgrade $connection_upgrade { default upgrade; '' close; diff --git a/source/_docs/ecosystem/nginx_subdomain.markdown b/source/_docs/ecosystem/nginx_subdomain.markdown index 714be21f489..64831bd8194 100644 --- a/source/_docs/ecosystem/nginx_subdomain.markdown +++ b/source/_docs/ecosystem/nginx_subdomain.markdown @@ -34,7 +34,7 @@ server { ssl_prefer_server_ciphers on; location / { - proxy_pass http://localhost:8123/; + proxy_pass http://localhost:8123; proxy_set_header Host $host; proxy_http_version 1.1; @@ -78,7 +78,7 @@ Start Home Assistant: Now, you have another instance running on http://localhost To access this instance by using https://countryside.example.org create the file `/etc/nginx/sites-enabled/countryside.example.org` (or symlink via `/etc/nginx/sites-available`) and add the following: -```bash +```nginx server { listen 443 ssl; server_name countryside.example.org; @@ -89,7 +89,7 @@ server { ssl_prefer_server_ciphers on; location / { - proxy_pass http://localhost:8124/; + proxy_pass http://localhost:8124; proxy_set_header Host $host; } @@ -109,7 +109,7 @@ server { Add to your `/etc/nginx/sites-enabled/default` -```bash +```nginx server { listen 80 default_server; server_name example.tld; diff --git a/source/_docs/installation/docker.markdown b/source/_docs/installation/docker.markdown index 4245f1069c1..8b3583fd494 100644 --- a/source/_docs/installation/docker.markdown +++ b/source/_docs/installation/docker.markdown @@ -56,14 +56,14 @@ As Synology within DSM now supports Docker (with a neat UI), you can simply inst The steps would be: * Install "Docker" package on your Synology NAS * Launch Docker-app and move to "Registry"-section -* Find "homeassistant/home-assistant" with registry and click on "Download" +* Find "homeassistant/home-assistant" within registry and click on "Download". Choose the "latest" tag, this will make verison updates easier later on. * Wait for some time until your NAS has pulled the image * Move to the "Image"-section of the Docker-app * Click on "Launch" * Choose a container-name you want (e.g., "homeassistant") * Click on "Advanced Settings" * Set "Enable auto-restart" if you like -* Within "Volume" click on "Add Folder" and choose either an existing folder or add a new folder. The "mount point" has to be "/config", so that Home Assistant will use it for the configs and logs. +* Within "Volume" click on "Add Folder" and choose either an existing folder or add a new folder. The "mount path" has to be "/config", so that Home Assistant will use it for the configs and logs. * Within "Network" select "Use same network as Docker Host" * To ensure that Home Assistant displays the correct timezone go to the "Environment" tab and click the plus sign then add `variable` = `TZ` & `value` = `Europe/London` choosing [your correct timezone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) * Confirm the "Advanced Settings" @@ -71,9 +71,9 @@ The steps would be: * Your Home Assistant within Docker should now run and will serve the web interface from port 8123 on your Docker host (this will be your Synology NAS IP address - for example `http://192.168.1.10:8123`) Remark: to update your Home Assistant on your Docker within Synology NAS, you just have to do the following: -* Go to the Docker-app and move to "Image"-section -* Download the "homeassistant/home-assistant" image - don't care, that it is already there -* wait until the system-message/-notification comes up, that the download is finished (there is no progress bar) +* Go to the Docker-app and move to "Registry"-section +* Find "homeassistant/home-assistant" within registry and click on "Download". Choose the "latest" tag, this will overwrite your current image to the latest version. +* Wait until the system-message/-notification comes up, that the download is finished (there is no progress bar) * Move to "Container"-section * Stop your container if it's running * Right-click on it and select "Action"->"Clear". You won't lose any data, as all files are stored in your config-directory @@ -180,6 +180,12 @@ Then start the container with: $ docker-compose up -d ``` +To restart Home Assistant when you have changed configuration: + +```bash +$ docker-compose restart +``` + ### {% linkable_title Exposing Devices %} In order to use Z-Wave, ZigBbee or other components that require access to devices, you need to map the appropriate device into the container. Ensure the user that is running the container has the correct privileges to access the `/dev/tty*` file, then add the device mapping to your docker command: diff --git a/source/_docs/installation/hassbian/installation.markdown b/source/_docs/installation/hassbian/installation.markdown index be9a4e500a9..9c0f5934586 100644 --- a/source/_docs/installation/hassbian/installation.markdown +++ b/source/_docs/installation/hassbian/installation.markdown @@ -13,7 +13,7 @@ redirect_from: /docs/hassbian/installation/ One of the easiest ways to install Home Assistant on your Raspberry Pi Zero, 2, 3 and 3B+ is by using Hassbian: a Raspberry Pi image with Home Assistant built-in. The image will install the latest version of Home Assistant on initial boot (~10 minutes). 1. [Download the Hassbian image][image-download] - 2. Use [Etcher][etcher] to flash the image to your SD card + 2. Use [Etcher][etcher] to flash the image to your SD card. We recommend at least a 32 GB SD card to avoid running out of space. 3. Ensure your Raspberry Pi has wired access to the internet for the entire process or configure your [wireless network settings](#wireless-network) **before proceeding to step 4**. 4. Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 10 minutes. diff --git a/source/_docs/mqtt/broker.markdown b/source/_docs/mqtt/broker.markdown index 87406a58736..47a19df934f 100644 --- a/source/_docs/mqtt/broker.markdown +++ b/source/_docs/mqtt/broker.markdown @@ -31,6 +31,13 @@ Home Assistant contains an embedded MQTT broker. If no broker configuration is g mqtt: ``` +
+There is an issue with the HBMQTT broker that can cause a memory leak (slowly increasing used memory). This causes an unstable system after the memory is full. You could measure/monitor this with a system monitor. The issue is from 2016 and could already be resolved with newer versions. Use another broker when you experience this issue, for example, Mosquitto.
+
+Issue with the HBMQTT broker: https://github.com/beerfactory/hbmqtt/issues/62
+System monitor: https://www.home-assistant.io/components/sensor.systemmonitor/
+
-Home Assistant is an open-source home automation platform running on Python 3. Track and control all devices at home and automate control. Perfect to run on a Raspberry Pi. +Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server.
diff --git a/source/_lovelace/entities.markdown b/source/_lovelace/entities.markdown
index d32e39a94c4..6cc85912674 100644
--- a/source/_lovelace/entities.markdown
+++ b/source/_lovelace/entities.markdown
@@ -161,4 +161,4 @@ Special rows:
name: Home Assistant
url: https://www.home-assistant.io/
icon: mdi:home-assistant
-```
\ No newline at end of file
+```
diff --git a/source/_lovelace/picture-elements.markdown b/source/_lovelace/picture-elements.markdown
index a12ce456df4..e9da937b142 100644
--- a/source/_lovelace/picture-elements.markdown
+++ b/source/_lovelace/picture-elements.markdown
@@ -55,6 +55,7 @@ style:
required: true
description: Position and style the element using CSS.
type: object
+ default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
### {% linkable_title Icon representing an entity state %}
@@ -89,6 +90,7 @@ style:
required: true
description: Position and style the element using CSS.
type: object
+ default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
### {% linkable_title Label with state text %}
@@ -131,6 +133,7 @@ style:
required: true
description: Position and style the element using CSS.
type: object
+ default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
### {% linkable_title Service Call Button %}
@@ -156,6 +159,7 @@ style:
required: true
description: Position and style the element using CSS.
type: object
+ default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
### {% linkable_title Icon Element %}
@@ -198,6 +202,7 @@ style:
required: true
description: Position and style the element using CSS.
type: object
+ default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
### {% linkable_title Image Element %}
@@ -209,7 +214,7 @@ type:
type: string
entity:
required: false
- description: Entity to use for state_image and state_filter and also target for actions.
+ description: Entity to use for state_image and state_filter and also target for actions.
type: string
tap_action:
required: false
@@ -240,7 +245,7 @@ state_image:
required: false
description: '[State-based images](#how-to-use-state_image)'
type: object
-filter:
+filter:
required: false
description: Default CSS filter
type: string
@@ -252,8 +257,27 @@ style:
required: true
description: Position and style the element using CSS.
type: object
+ default: "position: absolute, transform: translate(-50%, -50%)"
{% endconfiguration %}
+### {% linkable_title Custom Elements %}
+
+{% configuration %}
+type:
+ required: true
+ description: 'Card name with `custom:` prefix (e.g. `custom:my-custom-card`)'
+ type: string
+style:
+ required: true
+ description: Position and style the element using CSS.
+ type: object
+ default: "position: absolute, transform: translate(-50%, -50%)"
+{% endconfiguration %}
+
+The process for creating and referencing custom elements is the same as for custom cards.
+Please see the [developer docs on creating custom cards](https://developers.home-assistant.io/docs/en/lovelace_custom_card.html)
+for more information.
+
## {% linkable_title How to use the style object %}
Position and style your elements using [CSS](https://en.wikipedia.org/wiki/Cascading_Style_Sheets). More/other keys are also possible.
@@ -282,9 +306,9 @@ state_image:
Specify different [CSS filters](https://developer.mozilla.org/en-US/docs/Web/CSS/filter)
```yaml
-state_filter:
- 'on': brightness(110%) saturate(1.2)
- 'off': brightness(50%) hue-rotate(45deg)
+state_filter:
+ "on": brightness(110%) saturate(1.2)
+ "off": brightness(50%) hue-rotate(45deg)
```
## {% linkable_title Example %}
@@ -315,7 +339,7 @@ state_filter:
style:
top: 95%
left: 60%
- service: light.turn_off
+ service: homeassistant.turn_off
service_data:
entity_id: group.all_lights
- type: icon
@@ -325,8 +349,6 @@ state_filter:
style:
top: 10%
left: 10%
-
-
```
## {% linkable_title Images Example %}
@@ -340,20 +362,20 @@ state_filter:
entity: light.living_room
tap_action: toggle
image: /local/living_room.png
- state_image:
- 'off': /local/living_room_off.png
+ state_image:
+ "off": /local/living_room_off.png
filter: saturate(.8)
state_filter:
- 'on': brightness(120%) saturate(1.2)
- style:
- top: 25%
- left: 75%
- width: 15%
+ "on": brightness(120%) saturate(1.2)
+ style:
+ top: 25%
+ left: 75%
+ width: 15%
# Camera, red border, rounded-rectangle - show more-info on click
- type: image
entity: camera.driveway_camera
camera_image: camera.driveway_camera
- style:
+ style:
top: 5%
left: 10%
width: 10%
diff --git a/source/_posts/2018-07-16-release-73-2.markdown b/source/_posts/2018-07-16-release-73-2.markdown
new file mode 100644
index 00000000000..fdaaae717ba
--- /dev/null
+++ b/source/_posts/2018-07-16-release-73-2.markdown
@@ -0,0 +1,106 @@
+---
+layout: post
+title: "0.73.2 - Security Incident"
+description: "We have discovered a security issue and have issued a hot fix."
+date: 2018-07-16 00:01:00
+date_formatted: "July 16, 2018"
+author: Paulus Schoutsen
+author_twitter: balloob
+comments: true
+categories: Release-Notes
+---
+
+Today we are releasing 0.73.2 to fix a security incident. We've discovered that 9 months ago, with the release of Home Assistant 0.56, we misconfigured the SSL context that aiohttp used ([PR](https://github.com/home-assistant/home-assistant/pull/9958)). By trying to do the right thing (use an up to date cert store instead of relying on the system certs), we ended up doing the complete opposite: SSL verification was disabled for **outgoing** requests that were done using the shared aiohttp session. This is our fault, and not aiohttp's faults. The impact of this is that certain integrations in Home Assistant have been susceptible to [man in the middle attacks](https://en.wikipedia.org/wiki/Man-in-the-middle_attack).
+
+A man in the middle attack is when an attacker is able to inject itself between you and the server you're communicating with, allowing it to read and alter the communication. The odds of this happening at home is very rare, yet we wanted to be transparent about this incident.
+
+After research, the following integrations have been impacted. Although the odds are extremely small, we still suggest that if you use any of these integrations, to create new API keys or change your password.
+
+- [alarm_control_panel.alarmdotcom](https://www.home-assistant.io/components/alarm_control_panel.alarmdotcom/)
+- [climate.sensibo](https://www.home-assistant.io/components/climate.sensibo/)
+- [cloud](https://www.home-assistant.io/components/cloud/) (only short lived tokens impacted)
+- [device_tracker.automatic](https://www.home-assistant.io/components/device_tracker.automatic/)
+- [duckdns](https://www.home-assistant.io/components/duckdns/)
+- [freedns](https://www.home-assistant.io/components/freedns/)
+- [google_assistant](https://www.home-assistant.io/components/google_assistant/) (manual setup)
+- [google_domains](https://www.home-assistant.io/components/google_domains/)
+- [homematicip_cloud](https://www.home-assistant.io/components/homematicip_cloud/)
+- [image_processing.openalpr_cloud](https://www.home-assistant.io/components/image_processing.openalpr_cloud/)
+- [microsoft_face](https://www.home-assistant.io/components/microsoft_face/)
+- [namecheapdns](https://www.home-assistant.io/components/namecheapdns/)
+- [no_ip](https://www.home-assistant.io/components/no_ip/)
+- [notify.flock](https://www.home-assistant.io/components/notify.flock/)
+- [notify.prowl](https://www.home-assistant.io/components/notify.prowl/)
+- [rest_command](https://www.home-assistant.io/components/rest_command/)
+- [scene.lifx_cloud](https://www.home-assistant.io/components/scene.lifx_cloud/)
+- [switch.hook](https://www.home-assistant.io/components/switch.hook/)
+- [switch.rest](https://www.home-assistant.io/components/switch.rest/)
+- [telegram_bot.polling](https://www.home-assistant.io/components/telegram_bot.polling/)
+- [tts.voicerss](https://www.home-assistant.io/components/tts.voicerss/)
+
+Also impacted, but integrations are read only:
+
+- [sensor.airvisual](https://www.home-assistant.io/components/sensor.airvisual/)
+- [sensor.ebox](https://www.home-assistant.io/components/sensor.ebox/)
+- [sensor.fido](https://www.home-assistant.io/components/sensor.fido/)
+- [sensor.foobot](https://www.home-assistant.io/components/sensor.foobot/)
+- [sensor.hydroquebec](https://www.home-assistant.io/components/sensor.hydroquebec/)
+- [sensor.startca](https://www.home-assistant.io/components/sensor.startca/)
+- [sensor.teksavvy](https://www.home-assistant.io/components/sensor.teksavvy/)
+- [sensor.thethingsnetwork](https://www.home-assistant.io/components/sensor.thethingsnetwork/)
+- [sensor.tibber](https://www.home-assistant.io/components/sensor.tibber/)
+- [sensor.waqi](https://www.home-assistant.io/components/sensor.waqi/)
+
+If you are running Home Assistant on a system with Python 3.4, we've created a new release 0.64.4b0 with the patch applied. We have made it available as a beta. To install the pre-release run `python3 -m pip install homeassistant==0.64.4b0`.
+
+
+
+For complete transparency, the following two sets of integrations also used aiohttp to send or retrieve data. However, they either did not transmit authentication or only communicated with local devices and services.
+
+Affected, but not transmitting authentication:
+
+- [sensor.buienradar](https://www.home-assistant.io/components/sensor.buienradar/)
+- [sensor.citybikes](https://www.home-assistant.io/components/sensor.citybikes/)
+- [sensor.comed_hourly_pricing](https://www.home-assistant.io/components/sensor.comed_hourly_pricing/)
+- [sensor.luftdaten](https://www.home-assistant.io/components/sensor.luftdaten/)
+- [sensor.pollen](https://www.home-assistant.io/components/sensor.pollen/)
+- [sensor.sochain](https://www.home-assistant.io/components/sensor.sochain/)
+- [sensor.swiss_public_transport](https://www.home-assistant.io/components/sensor.swiss_public_transport/)
+- [sensor.viaggiatreno](https://www.home-assistant.io/components/sensor.viaggiatreno/)
+- [sensor.wunderground](https://www.home-assistant.io/components/sensor.wunderground/)
+- [sensor.yr](https://www.home-assistant.io/components/sensor.yr/)
+- [weather.ipma](https://www.home-assistant.io/components/weather.ipma/)
+- [tts.google](https://www.home-assistant.io/components/tts.google/)
+- [tts.yandextts](https://www.home-assistant.io/components/tts.yandextts/)
+- [updater](https://www.home-assistant.io/components/updater/)
+
+Local, so cannot be impacted:
+
+- [android_ip_webcam](https://www.home-assistant.io/components/android_ip_webcam/)
+- [apple_tv](https://www.home-assistant.io/components/apple_tv/)
+- [camera.amcrest](https://www.home-assistant.io/components/camera.amcrest/)
+- [camera.doorbird](https://www.home-assistant.io/components/camera.doorbird/)
+- [camera.familyhub](https://www.home-assistant.io/components/camera.familyhub/)
+- [camera.generic](https://www.home-assistant.io/components/camera.generic/)
+- [camera.mjpeg](https://www.home-assistant.io/components/camera.mjpeg/)
+- [camera.proxy](https://www.home-assistant.io/components/camera.proxy/)
+- [camera.synology](https://www.home-assistant.io/components/camera.synology/)
+- [deconz](https://www.home-assistant.io/components/deconz/)
+- [device_tracker.upc_connect](https://www.home-assistant.io/components/device_tracker.upc_connect/)
+- [hassio](https://www.home-assistant.io/components/hassio/)
+- [hue](https://www.home-assistant.io/components/hue/)
+- [media_player.bluesound](https://www.home-assistant.io/components/media_player.bluesound/)
+- [media_player.epson](https://www.home-assistant.io/components/media_player.epson/)
+- [media_player.kodi](https://www.home-assistant.io/components/media_player.kodi/)
+- [media_player.squeezebox](https://www.home-assistant.io/components/media_player.squeezebox/)
+- [media_player.volumio](https://www.home-assistant.io/components/media_player.volumio/)
+- [notify.kodi](https://www.home-assistant.io/components/notify.kodi/)
+- [qwikswitch](https://www.home-assistant.io/components/qwikswitch/)
+- [rainmachine](https://www.home-assistant.io/components/rainmachine/)
+- [scene.hunterdouglas_powerview](https://www.home-assistant.io/components/scene.hunterdouglas_powerview/)
+- [sensor.netdata](https://www.home-assistant.io/components/sensor.netdata/)
+- [sensor.pi_hole](https://www.home-assistant.io/components/sensor.pi_hole/)
+- [sensor.sma](https://www.home-assistant.io/components/sensor.sma/)
+- [sensor.worxlandroid](https://www.home-assistant.io/components/sensor.worxlandroid/)
+- [spc](https://www.home-assistant.io/components/spc/)
+- [tts.marytts](https://www.home-assistant.io/components/tts.marytts/)
diff --git a/source/_posts/2018-07-21-release-74.markdown b/source/_posts/2018-07-21-release-74.markdown
new file mode 100644
index 00000000000..1de4c7f4bd2
--- /dev/null
+++ b/source/_posts/2018-07-21-release-74.markdown
@@ -0,0 +1,423 @@
+---
+layout: post
+title: "0.74: Tuya, Cloudflare DNS, Push Camera and Users UI"
+description: "This release builds on top of the previous release, as that is how releases work."
+date: 2018-07-20 00:01:00
+date_formatted: "July 20, 2018"
+author: Paulus Schoutsen
+author_twitter: balloob
+comments: true
+categories: Release-Notes
+og_image: /images/blog/2018-07-0.74/paulus_guido.jpg
+---
+
+
+
+It's time for Home Assistant 0.74! 🎉
+
+This week we heard that Guido van Rossum, the founder of Python, is taking a permanent vacation as the leader of Python after being at the helm for almost 30 years. Guido has not been directly involved with Home Assistant. However he created Python and was part of the team that built asyncio, technologies that power the foundation of Home Assistant and what makes us so fast and robust. Under Guido's guidance, the Python community has grown out to be very friendly and open. A great inspiration for us and other tech communities out there. Thanks for all you have done Guido!
+
+
+
+Paulus & Guido at PyCon US 2018
+
Templates are rendered using the Jinja2 template engine with some Home Assistant specific extensions.
[[processed]]
Templates are rendered using the Jinja2 template engine with some Home Assistant specific extensions.
[[processed]]