You must have the [USPS component](/components/usps/) configured to use this camera. The camera will be setup if the `usps` component is configured and the required configuration is set.
+## {% linkable_title Configuration %} + To customize the interval that mail images are rotated in the mail camera you can edit your `configuration.yaml` file with the following settings: ```yaml # Example configuration.yaml entry diff --git a/source/_components/camera.uvc.markdown b/source/_components/camera.uvc.markdown index d83f1457e87..cd86a1214cf 100644 --- a/source/_components/camera.uvc.markdown +++ b/source/_components/camera.uvc.markdown @@ -56,4 +56,3 @@ password: type: string default: ubnt {% endconfiguration %} - diff --git a/source/_components/camera.verisure.markdown b/source/_components/camera.verisure.markdown index 35b4c25e4e7..e3980f71748 100644 --- a/source/_components/camera.verisure.markdown +++ b/source/_components/camera.verisure.markdown @@ -13,8 +13,6 @@ ha_release: 0.31 ha_iot_class: "Local Polling" --- - The `verisure` camera platform allows you to control your [Verisure](https://www.verisure.com/) cameras. The requirement is that you have setup your [Verisure hub](/components/verisure/). - diff --git a/source/_components/camera.xeoma.markdown b/source/_components/camera.xeoma.markdown index e54e24f3b37..afb89f1877d 100644 --- a/source/_components/camera.xeoma.markdown +++ b/source/_components/camera.xeoma.markdown @@ -15,6 +15,8 @@ ha_release: 0.62 The `Xeoma` camera platform allows you to view the video feeds from a [Xeoma](http://felenasoft.com/xeoma) video surveillance server. +## {% linkable_title Configuration %} + To enable Xeoma camera feeds, add the following lines to your `configuration.yaml`: ```yaml @@ -40,8 +42,8 @@ password: new_version: description: Set to false if the Xeoma server version is 17.5 or earlier. required: false - default: true type: boolean + default: true cameras: description: List of customizations for individual Xeoma cameras. required: false @@ -54,16 +56,16 @@ cameras: name: description: The name to display in the frontend for this camera. required: false - default: The `image_name` for this camera. type: string + default: The `image_name` for this camera. hide: description: Don't show this camera in Home Assistant. required: false - default: false type: boolean + default: false {% endconfiguration %} -## {% linkable_title Full examples %} +## {% linkable_title Full example %} ```yaml # Example configuration.yaml entry diff --git a/source/_components/camera.xiaomi.markdown b/source/_components/camera.xiaomi.markdown index 05e213825de..0dc5777f35a 100644 --- a/source/_components/camera.xiaomi.markdown +++ b/source/_components/camera.xiaomi.markdown @@ -76,16 +76,15 @@ password: path: description: The path to the raw MP4 files. required: false - default: /media/mmcblk0p1/record type: string + default: /media/mmcblk0p1/record username: description: The user that can access the FTP server. required: false - default: root type: string + default: root ffmpeg_arguments: - description: > - Extra options to pass to `ffmpeg` + description: Extra options to pass to `ffmpeg`. required: false type: string {% endconfiguration %} diff --git a/source/_components/camera.yi.markdown b/source/_components/camera.yi.markdown index dada5b76b48..0fce50e8b96 100644 --- a/source/_components/camera.yi.markdown +++ b/source/_components/camera.yi.markdown @@ -81,13 +81,13 @@ password: path: description: The path to the raw MP4 files. required: false - default: /media/mmcblk0p1/record type: string + default: /media/mmcblk0p1/record username: description: The user that can access the FTP server. required: false - default: root type: string + default: root ffmpeg_arguments: description: Extra options to pass to `ffmpeg` (e.g., image quality or video filter options). required: false diff --git a/source/_components/camera.zoneminder.markdown b/source/_components/camera.zoneminder.markdown index d1fc230ecc4..51a00ef3d17 100644 --- a/source/_components/camera.zoneminder.markdown +++ b/source/_components/camera.zoneminder.markdown @@ -13,13 +13,14 @@ ha_release: 0.39 ha_iot_class: "Local Polling" --- - The `zoneminder` camera platform lets you monitor the current stream of your [ZoneMinder](https://www.zoneminder.com) cameras.You must have the [ZoneMinder component](/components/zoneminder/) configured to view the camera stream.
+## {% linkable_title Configuration %} + To set it up, add the following information to your `configuration.yaml` file: ```yaml diff --git a/source/_components/canary.markdown b/source/_components/canary.markdown index d9805b5edff..8f43c61d53b 100644 --- a/source/_components/canary.markdown +++ b/source/_components/canary.markdown @@ -29,19 +29,19 @@ canary: ``` {% configuration %} - username: - description: The username for accessing your Canary account. - required: true - type: string - password: - description: The password for accessing your Canary account. - required: true - type: string - timeout: - description: Timeout to wait for connections. - required: false - type: integer - default: 10 +username: + description: The username for accessing your Canary account. + required: true + type: string +password: + description: The password for accessing your Canary account. + required: true + type: string +timeout: + description: Timeout to wait for connections. + required: false + type: integer + default: 10 {% endconfiguration %} Once loaded, your front end will have the following components: diff --git a/source/_components/climate.dyson.markdown b/source/_components/climate.dyson.markdown new file mode 100644 index 00000000000..969c20594cf --- /dev/null +++ b/source/_components/climate.dyson.markdown @@ -0,0 +1,27 @@ +--- +layout: page +title: "Dyson Climate Control" +description: "Instructions on how to integrate your Dyson Climate device within Home Assistant." +date: 2018-05-23 22:30 +sidebar: true +comments: false +sharing: true +footer: true +logo: dyson.png +ha_category: Climate +ha_iot_class: "Cloud Polling" +ha_release: 0.81 +--- + +The `dyson` climate platform allows you to control your Dyson Pure Hot+Cool Fan thermal control. For controlling the fan functionality, see the [Dyson fan](/components/fan.dyson/) platform. + +You have first to set up the [Dyson component](/components/dyson/). + +### {% linkable_title Component services %} + +This component supports the following services (see [Climate](/components/climate/)): +* [`turn_on`](/components/climate/#service-climateturn_on) +* [`turn_off`](/components/climate/#service-climateturn_off) +* [`set_temperature`](/components/climate/#service-climateset_temperature) +* [`set_fan_mode`](/components/climate/#service-climateset_fan_mode) +* [`set_operation_mode`](/components/climate/#service-climateset_operation_mode) diff --git a/source/_components/climate.elkm1.markdown b/source/_components/climate.elkm1.markdown new file mode 100644 index 00000000000..b93f06baf87 --- /dev/null +++ b/source/_components/climate.elkm1.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: "Elk-M1 Thermostat" +description: "Instructions how to integrate Elk-M1 thermostats." +date: 2018-10-20 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: elkproducts.png +ha_release: 0.81 +ha_category: Climate +ha_iot_class: "Local Push" +--- + +The `elkm1` platform allows you to control your [Elk-M1](https://www.elkproducts.com/m1_controls.html). + +An Elk-M1 thermostat is represented as a `climate` entity. + ++Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page. +
diff --git a/source/_components/climate.ephember.markdown b/source/_components/climate.ephember.markdown index d2fba985e2c..ebcdb1fccbe 100644 --- a/source/_components/climate.ephember.markdown +++ b/source/_components/climate.ephember.markdown @@ -27,10 +27,16 @@ climate: A single interface can handle up to 32 connected devices. -Configuration variables: - -- **username** (*Required*): The email address you used to sign up to the EMBER app -- **password** (*Required*): The password you used to sign up to the EMBER app +{% configuration %} +username: + description: The email address you used to sign up to the EMBER app. + required: true + type: string +password: + description: The password you used to sign up to the EMBER app. + required: true + type: string +{% endconfiguration %} The supported operation modes map to the ON/OFF period selection of your timeswitch / EMBER app. These include: diff --git a/source/_components/climate.flexit.markdown b/source/_components/climate.flexit.markdown index 0281b507565..36cda1ecf58 100644 --- a/source/_components/climate.flexit.markdown +++ b/source/_components/climate.flexit.markdown @@ -26,10 +26,16 @@ climate: slave: 21 ``` -Configuration variables: - -- **slave** (*Required*): The slave ID of the modbus adapter, set using DIP-switches. -- **name** (*Optional*): Displayed name of the A/C unit +{% configuration %} +slave: + description: The slave ID of the modbus adapter, set using DIP-switches. + required: true + type: integer +name: + description: Displayed name of the A/C unit. + required: false + type: string +{% endconfiguration %}This component requires the [Modbus](/components/modbus/) component to be set up to work diff --git a/source/_components/climate.generic_thermostat.markdown b/source/_components/climate.generic_thermostat.markdown index 89d09a5981e..ee522ae27ed 100644 --- a/source/_components/climate.generic_thermostat.markdown +++ b/source/_components/climate.generic_thermostat.markdown @@ -7,14 +7,13 @@ sidebar: true comments: false sharing: true footer: true -logo: heat-control.png +logo: home-assistant.png ha_category: Climate ha_release: pre 0.7 ha_iot_class: "Local Polling" --- - -The `generic_thermostat` climate platform is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater or air conditioning under the hood. When in heater mode, if the measured temperature is cooler then the target temperature, the heater will be turned on and turned off when the required temperature is reached. When in air conditioning mode, if the measured temperature is hotter then the target temperature, the air conditioning will be turned on and turned off when required temperature is reached. One Generic Thermostat entity can only control one switch. If you need to activate two switches, one for a heater and one for an air conditioner, you will need two Generic Thermostat entities. +The `generic_thermostat` climate platform is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater or air conditioning under the hood. When in heater mode, if the measured temperature is cooler then the target temperature, the heater will be turned on and turned off when the required temperature is reached. When in air conditioning mode, if the measured temperature is hotter then the target temperature, the air conditioning will be turned on and turned off when required temperature is reached. One Generic Thermostat entity can only control one switch. If you need to activate two switches, one for a heater and one for an air conditioner, you will need two Generic Thermostat entities. ```yaml # Example configuration.yaml entry @@ -25,27 +24,71 @@ climate: target_sensor: sensor.study_temperature ``` -Configuration variables: - -- **name** (*Required*): Name of thermostat -- **heater** (*Required*): `entity_id` for heater switch, must be a toggle device. Becomes air conditioning switch when `ac_mode` is set to `True` -- **target_sensor** (*Required*): `entity_id` for a temperature sensor, target_sensor.state must be temperature. -- **min_temp** (*Optional*): Set minimum set point available (default: 7) -- **max_temp** (*Optional*): Set maximum set point available (default: 35) -- **target_temp** (*Optional*): Set initial target temperature. Failure to set this variable will result in target temperature being set to null on startup. As of version 0.59, it will retain the target temperature set before restart if available. -- **ac_mode** (*Optional*): Set the switch specified in the *heater* option to be treated as a cooling device instead of a heating device. -- **min_cycle_duration** (*Optional*): Set a minimum amount of time that the switch specified in the *heater* option must be in its current state prior to being switched either off or on. -- **cold_tolerance** (*Optional*): Set a minimum amount of difference between the temperature read by the sensor specified in the *target_sensor* option and the target temperature that must change prior to being switched on. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will start when the sensor equals or goes below 24.5. -- **hot_tolerance** (*Optional*): Set a minimum amount of difference between the temperature read by the sensor specified in the *target_sensor* option and the target temperature that must change prior to being switched off. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will stop when the sensor equals or goes above 25.5. -- **keep_alive** (*Optional*): Set a keep-alive interval. If set, the switch specified in the *heater* option will be triggered every time the interval elapses. Use with heaters and A/C units that shut off if they don't receive a signal from their remote for a while. Use also with switches that might lose state. The keep-alive call is done with the current valid climate component state (either on or off). -- **initial_operation_mode** (*Optional*): Set the initial operation mode. Valid values are `off` or `auto`. Value has to be double quoted. If this parameter is not set, it is preferable to set a *keep_alive* value. This is helpful to align any discrepancies between *generic_thermostat* and *heater* state. -- **away_temp** (*Optional*): Set the temperature used by "away_mode". If this is not specified, away_mode feature will not get activated. +{% configuration %} +name: + description: Name of thermostat. + required: true + default: Generic Thermostat + type: string +heater: + description: "`entity_id` for heater switch, must be a toggle device. Becomes air conditioning switch when `ac_mode` is set to `true`." + required: true + type: string +target_sensor: + description: "`entity_id` for a temperature sensor, target_sensor.state must be temperature." + required: true + type: string +min_temp: + description: Set minimum set point available. + required: false + default: 7 + type: float +max_temp: + description: Set maximum set point available. + required: false + default: 35 + type: float +target_temp: + description: Set initial target temperature. Failure to set this variable will result in target temperature being set to null on startup. As of version 0.59, it will retain the target temperature set before restart if available. + required: false + type: float +ac_mode: + description: Set the switch specified in the *heater* option to be treated as a cooling device instead of a heating device. + required: false + type: boolean +min_cycle_duration: + description: Set a minimum amount of time that the switch specified in the *heater* option must be in its current state prior to being switched either off or on. + required: false + type: [time, integer] +cold_tolerance: + description: Set a minimum amount of difference between the temperature read by the sensor specified in the *target_sensor* option and the target temperature that must change prior to being switched on. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will start when the sensor equals or goes below 24.5. + required: false + default: 0.3 + type: float +hot_tolerance: + description: Set a minimum amount of difference between the temperature read by the sensor specified in the *target_sensor* option and the target temperature that must change prior to being switched off. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will stop when the sensor equals or goes above 25.5. + required: false + default: 0.3 + type: float +keep_alive: + description: Set a keep-alive interval. If set, the switch specified in the *heater* option will be triggered every time the interval elapses. Use with heaters and A/C units that shut off if they don't receive a signal from their remote for a while. Use also with switches that might lose state. The keep-alive call is done with the current valid climate component state (either on or off). + required: false + type: [time, integer] +initial_operation_mode: + description: Set the initial operation mode. Valid values are `off` or `auto`. Value has to be double quoted. If this parameter is not set, it is preferable to set a *keep_alive* value. This is helpful to align any discrepancies between *generic_thermostat* and *heater* state. + required: false + type: string +away_temp: + description: Set the temperature used by "away_mode". If this is not specified, away_mode feature will not get activated. + required: false + type: float +{% endconfiguration %} A full configuration example looks like the one below. `min_cycle_duration` and `keep_alive` must contain at least one of the following entries: `days:`, `hours:`, `minutes:`, `seconds:` or `milliseconds:`. -Currently the `generic_thermostat` climate platform supports 'heat', 'cool' and 'off' operation modes. You can force your `generic_thermostat` to avoid starting by setting Operation to 'off'. +Currently the `generic_thermostat` climate platform supports 'heat', 'cool' and 'off' operation modes. You can force your `generic_thermostat` to avoid starting by setting Operation to 'off'. -Please note that changing Away Mode you will force a target temperature change as well that will get restored once the Away Mode is turned off. +Please note that changing Away Mode you will force a target temperature change as well that will get restored once the Away Mode is turned off. ```yaml # Full example configuration.yaml entry diff --git a/source/_components/climate.heatmiser.markdown b/source/_components/climate.heatmiser.markdown index b1478034e9f..d55c605019f 100644 --- a/source/_components/climate.heatmiser.markdown +++ b/source/_components/climate.heatmiser.markdown @@ -13,7 +13,6 @@ ha_release: "0.10" ha_iot_class: "Local Polling" --- - The `heatmiser` climate platform let you control [Heatmiser DT/DT-E/PRT/PRT-E](http://www.heatmisershop.co.uk/heatmiser-slimline-programmable-room-thermostat/) thermostats from Heatmiser. The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP. Further work would be required to get this setup to connect over Wifi, but the HeatmiserV3 python module being used is a full implementation of the V3 protocol. @@ -23,7 +22,7 @@ To set it up, add the following information to your `configuration.yaml` file: ```yaml climate: - platform: heatmiser - ipaddress: YOUR_IPADDRESS + ipaddress: YOUR_IP_ADDRESS port: YOUR_PORT tstats: - 1: @@ -33,10 +32,26 @@ climate: A single interface can handle up to 32 connected devices. -Configuration variables: - -- **ipaddress** (*Required*): The ip address of your interface. -- **port** (*Required*): The port that the interface is listening on. -- **tstats** (*Required*): A list of thermostats activated on the gateway. -- **id** (*Required*): The id of the thermostat as configured on the device itself -- **name** (*Required*): A friendly name for the thermostat +{% configuration %} +ipaddress: + description: The IP address of your interface. + required: true + type: string +port: + description: The port that the interface is listening on. + required: true + type: integer +tstats: + description: A list of thermostats activated on the gateway. + required: true + type: list + keys: + id: + description: The ID of the thermostat as configured on the device itself. + required: true + type: string + name: + description: A friendly name for the thermostat. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/climate.honeywell.markdown b/source/_components/climate.honeywell.markdown index 64270441aac..bb174d8f5c8 100644 --- a/source/_components/climate.honeywell.markdown +++ b/source/_components/climate.honeywell.markdown @@ -33,12 +33,38 @@ climate: Scan interval is expressed in seconds. Omitting scan_interval may result in too-frequent polling and cause you to rate-limited by Honeywell.
-Configuration variables: - -- **username** (*Required*): The username of an user with access. -- **password** (*Required*): The password for your given admin account. -- **region** (*Optional*): Region identifier (either 'eu' or 'us'). Defaults to 'eu' if not provided. -- **scan_interval**(*Optional*): Scan interval is expressed in seconds. Recommended value of 600 seconds. Default value is 120 seconds. Omitting scan_interval may result in too-frequent polling and cause you to rate-limited by Honeywell. -- **away_temperature** (*Optional*) (*only for eu region*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C. -- **away_cool_temperature** (*Optional*) (*only for us region*): Cooling setpoint when away mode is on. If omitted it defaults to 30.0 deg C. -- **away_heat_temperature** (*Optional*) (*only for us region*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C. +{% configuration %} +username: + description: The username of an user with access. + required: true + type: string +password: + description: The password for your given admin account. + required: true + type: string +region: + description: Region identifier (either 'eu' or 'us'). + required: false + default: eu + type: string +scan_interval: + description: Scan interval is expressed in seconds. Recommended value of 600 seconds. Omitting scan_interval may result in too-frequent polling and cause you to rate-limited by Honeywell. + required: false + default: 120 + type: integer +away_temperature: + description: "(*only for eu region*) Heating setpoint when away mode is on, in deg C." + required: false + default: 16.0 + type: float +away_cool_temperature: + description: "(*only for us region*) Cooling setpoint when away mode is on, in deg C." + required: false + default: 30.0 + type: float +away_heat_temperature: + description: "(*only for us region*) Heating setpoint when away mode is on, in deg C." + required: false + default: 16.0 + type: float +{% endconfiguration %} diff --git a/source/_components/climate.knx.markdown b/source/_components/climate.knx.markdown index b5b59a01e36..839be524398 100644 --- a/source/_components/climate.knx.markdown +++ b/source/_components/climate.knx.markdown @@ -13,7 +13,6 @@ ha_release: 0.25 ha_iot_class: "Local Polling" --- - The `knx` climate platform is used as in interface with KNX thermostats. The `knx` component must be configured correctly, see [KNX Component](/components/knx). @@ -48,29 +47,71 @@ climate: operation_mode_comfort_address: '5/1/7' ``` -Configuration variables: +{% configuration %} +name: + description: A name for this device used within Home Assistant. + required: false + default: KNX Climate + type: string +temperature_address: + description: KNX group address for reading current room temperature from KNX bus. + required: true + type: string +target_temperature_address: + description: KNX group address for reading current target temperature from KNX bus. + required: true + type: string +setpoint_shift_address: + description: KNX address for setpoint_shift. + required: false + type: string +setpoint_shift_state_address: + description: Explicit KNX address for reading setpoint_shift. + required: false + type: string +setpoint_shift_step: + description: Defines for step size in Kelvin for each step of setpoint_shift. + required: false + default: 0.5 + type: float +setpoint_shift_min: + description: Minimum value of setpoint shift. + required: false + default: -6 + type: integer +setpoint_shift_max: + description: Maximum value of setpoint shift. + required: false + default: 6 + type: integer +operation_mode_address: + description: KNX address for operation mode (Frost protection/night/comfort). + required: false + type: string +operation_mode_state_address: + description: Explicit KNX address for reading operation mode. + required: false + type: string +controller_status_address: + description: KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3). + required: false + type: string +controller_status_state_address: + description: Explicit KNX address for reading HVAC controller status. + required: false + type: string +operation_mode_frost_protection_address: + description: KNX address for switching on/off frost/heat protection mode. + required: false + type: string +operation_mode_night_address: + description: KNX address for switching on/off night mode. + required: false + type: string +operation_mode_comfort_address: + description: KNX address for switching on/off comfort mode. + required: false + type: string +{% endconfiguration %} -- **name** (*Optional*): A name for this device used within Home Assistant. -- **temperature_address**: KNX group address for reading current room temperature from KNX bus. -- **target_temperature_address**: KNX group address for reading current target temperature from KNX bus. - -The `knx` component sets the desired target temperature by modifying the setpoint_shift. The module provides the following configuration options: - -* **setpoint_shift_address**: (*Optional*) KNX address for setpoint_shift -* **setpoint_shift_state_address**: (*Optional*) Explicit KNX address for reading setpoint_shift. -* **setpoint_shift_step**: (*Optional*) Defines for step size in Kelvin for each step of setpoint_shift. Default is 0.5 K. -* **setpoint_shift_min**: (*Optional*) Minimum value of setpoint shift. Default is "-6". -* **setpoint_shift_max**: (*Optional*) Maximum value of setpoint shift. Default is "6". - -The operation modes may be controlled with the following directives: - -- **operation_mode_address** (*Optional*): KNX address for operation mode (Frost protection/night/comfort). -- **operation_mode_state_address** (*Optional*): Explicit KNX address for reading operation mode -- **controller_status_address** (*Optional*): KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3) -- **controller_status_state_address** (*Optional*): Explicit KNX address for reading HVAC controller status - -- **operation_mode_frost_protection_address** (*Optional*): KNX address for switching on/off frost/heat protection mode. -- **operation_mode_night_address** (*Optional*): KNX address for switching on/off night mode. -- **operation_mode_comfort_address** (*Optional*): KNX address for switching on/off comfort mode. - -`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` was specified. +`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` are not necessary if `operation_mode_address` is specified. diff --git a/source/_components/climate.mill.markdown b/source/_components/climate.mill.markdown new file mode 100644 index 00000000000..aa13ac75be1 --- /dev/null +++ b/source/_components/climate.mill.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Mill heater" +description: "Instructions on how to integrate Mill heater into Home Assistant." +date: 2018-10-10 15:00 +0200 +sidebar: true +comments: false +sharing: true +footer: true +logo: mill.png +ha_category: Climate +ha_release: 0.81 +ha_iot_class: "Cloud Polling" +--- + +Integrates Mill heater into Home Assistant. + +The component requires that the heater is set as an [independent device](https://millheat.zendesk.com/hc/en-us/articles/115001123491-What-is-an-Independent-device-) in the Mill app. + + +To enable this platform, add the following lines to your `configuration.yaml` file: + +```yaml +climate: + - platform: mill + username: email@gmail.com + password: pswd +``` + +{% configuration %} +username: + description: Your registered Mill email. + required: true + type: string +password: + description: Your Mill password. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/climate.mqtt.markdown b/source/_components/climate.mqtt.markdown index 96f98766b54..66cd9a2ccdd 100644 --- a/source/_components/climate.mqtt.markdown +++ b/source/_components/climate.mqtt.markdown @@ -24,8 +24,8 @@ It uses a sensor under the hood to obtain the current temperature. climate: - platform: mqtt name: Study - current_temperature_topic: /sensors/hvac_study/current_temp - temperature_command_topic: /sensors/hvac_study/target_temp + current_temperature_topic: sensors/hvac_study/current_temp + temperature_command_topic: sensors/hvac_study/target_temp ``` {% configuration %} @@ -58,12 +58,12 @@ payload_on: description: The payload that represents enabled state. required: false type: string - default: ON + default: "ON" payload_off: description: The payload that represents disabled state. required: false type: string - default: OFF + default: "OFF" availability_topic: description: The MQTT topic subscribed to receive availability (online/offline) updates. required: false @@ -201,6 +201,11 @@ max_temp: description: Maximum set point available type: number required: false +temp_step: + description: Step size for temperature set point + type: number + required: false + default: 1 {% endconfiguration %} #### {% linkable_title Optimistic mode %} @@ -219,9 +224,9 @@ climate: - platform: mqtt name: Study modes: - - off - - on - - auto + - "off" + - "on" + - "auto" mode_command_topic: "study/ac/mode/set" mode_state_topic: "study/ac/mode/state" mode_state_template: "{{ value_json }}" @@ -241,16 +246,16 @@ climate: - platform: mqtt name: Study modes: - - off - - cool - - fan_only + - "off" + - "cool" + - "fan_only" swing_modes: - - on - - off + - "on" + - "off" fan_modes: - - high - - medium - - low + - "high" + - "medium" + - "low" power_command_topic: "study/ac/power/set" mode_command_topic: "study/ac/mode/set" temperature_command_topic: "study/ac/temperature/set" diff --git a/source/_components/climate.oem.markdown b/source/_components/climate.oem.markdown index 1f07cf6bd58..98e9933cffc 100644 --- a/source/_components/climate.oem.markdown +++ b/source/_components/climate.oem.markdown @@ -26,12 +26,32 @@ climate oem: host: 192.168.0.100 ``` -Configuration variables: - -- **host** (*Required*): The IP address or hostname of the thermostat. -- **port** (*Optional*): The port for the web interface. Defaults to 80. -- **name** (*Optional*): The name to use for the frontend. -- **username** (*Optional*): Username for the web interface if set. -- **password** (*Optional*): Password for the web interface if set. -- **away_temp** (*Optional*): Setpoint for the thermostat in away mode. Defaults to 14 C. - +{% configuration %} +host: + description: The IP address or hostname of the thermostat. + required: true + type: string +port: + description: The port for the web interface. + required: false + default: 80 + type: integer +name: + description: The name to use for the frontend. + required: false + default: Thermostat + type: string +username: + description: Username for the web interface if set. + required: inclusive + type: string +password: + description: Password for the web interface if set. + required: inclusive + type: string +away_temp: + description: Setpoint for the thermostat in away mode. + required: false + default: 14.0 + type: float +{% endconfiguration %} diff --git a/source/_components/climate.opentherm_gw.markdown b/source/_components/climate.opentherm_gw.markdown index 41444ff8ae2..1248a657816 100644 --- a/source/_components/climate.opentherm_gw.markdown +++ b/source/_components/climate.opentherm_gw.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "OpenTherm Gateway" +title: "OpenTherm Gateway Climate" description: "Control your OpenTherm Gateway from Home Assistant." date: 2018-08-29 16:23 sidebar: true @@ -18,48 +18,8 @@ The `opentherm_gw` climate platform is used to control the [OpenTherm Gateway](h # {% linkable_title Configuration %} -```yaml -# Example configuration.yaml entry -climate: - - platform: opentherm_gw - device: /dev/ttyUSB0 -``` - -{% configuration %} -device: - description: "Path to OpenTherm Gateway device as supported by [PySerial](https://pythonhosted.org/pyserial/url_handlers.html)." - required: true - type: string -name: - description: The name for the device within Home Assistant. - required: false - type: string - default: OpenTherm Gateway -precision: - description: "The desired precision for this device. Can be used to match your actual thermostat's precision. Supported values are `0.1`, `0.5` and `1.0`." - required: false - type: float - default: "`0.5` for Celsius and `1.0` for Fahrenheit." -floor_temperature: - description: Some thermostats round all temperatures down to the lower value according to their precision. Default behaviour for Home Assistant is to round temperatures to the nearest value. Set this to `true` to override Home Assistant and round to the lower value according to the configured `precision`. - required: false - type: boolean -{% endconfiguration %} +Configuration of this platform is achieved through the [OpenTherm Gateway Hub](/components/opentherm_gw/) configuration.The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.
- -# {% linkable_title Example %} - -A full configuration example with the OpenTherm Gateway connected to a remote host running `ser2net` looks like the one below. - -```yaml -# Full example configuration.yaml entry -climate: - - platform: opentherm_gw - device: socket://otgw.example.org:2345 - name: Thermostat - precision: 0.5 - floor_temperature: true -``` diff --git a/source/_components/climate.proliphix.markdown b/source/_components/climate.proliphix.markdown index b089ef586d5..28748d520ca 100644 --- a/source/_components/climate.proliphix.markdown +++ b/source/_components/climate.proliphix.markdown @@ -30,12 +30,20 @@ climate: password: YOUR_PASSWORD ``` -Configuration variables: - -- **host** (*Required*): Address of your thermostat, eg. 192.168.1.32. -- **username** (*Required*): Username for the thermostat. -- **password** (*Required*): Password for the thermostat. +{% configuration %} +host: + description: Address of your thermostat, e.g., 192.168.1.32. + required: true + type: string +username: + description: Username for the thermostat. + required: true + type: string +password: + description: Password for the thermostat. + required: true + type: string +{% endconfiguration %} The Proliphix NT Thermostat series are Ethernet connected thermostats. They have a local HTTP interface that is based on get/set of OID values. A complete collection of the API is available in this [API documentation](https://github.com/sdague/thermostat.rb/blob/master/docs/PDP_API_R1_11.pdf). - diff --git a/source/_components/climate.radiotherm.markdown b/source/_components/climate.radiotherm.markdown index f4d08db1072..311fe0b3f42 100644 --- a/source/_components/climate.radiotherm.markdown +++ b/source/_components/climate.radiotherm.markdown @@ -30,12 +30,27 @@ climate: - platform: radiotherm ``` -Configuration variables: - -- **host** (*Optional*): List of your Radiotherm thermostats. If not provided the thermostats will be auto-detected. -- **away_temperature_heat** (*Optional*): Target heating temperature in Fahrenheit for away mode. This is separate from away mode in the app. Defaults to '60'. -- **away_temperature_cool** (*Optional*): Target cooling temperature in Fahrenheit for away mode. This is separate from away mode in the app. Defaults to '85'. -- **hold_temp** (*Optional*): Boolean to control if Home Assistant temperature adjustments hold (`True`) or are temporary (`False`). Defaults to `False`. +{% configuration %} +host: + description: List of your Radiotherm thermostats. If not provided the thermostats will be auto-detected. + required: false + type: list +away_temperature_heat: + description: Target heating temperature in Fahrenheit for away mode. This is separate from away mode in the app. + required: false + default: 60 + type: float +away_temperature_cool: + description: Target cooling temperature in Fahrenheit for away mode. This is separate from away mode in the app. + required: false + default: 85 + type: float +hold_temp: + description: Boolean to control if Home Assistant temperature adjustments hold (`true`) or are temporary (`false`). + required: false + default: false + type: boolean +{% endconfiguration %} Set `hold_temp: True` if you want temperature settings from Home Assistant to override a thermostat schedule on the thermostat itself. Otherwise Home Assistant will perform temporary temperature changes. diff --git a/source/_components/climate.sensibo.markdown b/source/_components/climate.sensibo.markdown index 85577dcdf81..f45c818e80a 100644 --- a/source/_components/climate.sensibo.markdown +++ b/source/_components/climate.sensibo.markdown @@ -21,7 +21,7 @@ To enable this platform, add the following lines to your `configuration.yaml` fi # Example configuration.yaml entry climate: - platform: sensibo - api_key:
The above devices are confirmed to work, but others may work as well.
diff --git a/source/_components/cloudflare.markdown b/source/_components/cloudflare.markdown
index b2f5ad956cd..de36ccbe86f 100644
--- a/source/_components/cloudflare.markdown
+++ b/source/_components/cloudflare.markdown
@@ -28,9 +28,9 @@ To use the component in your installation, add the following to your `configurat
```yaml
# Example configuration.yaml entry
cloudflare:
- email: user@example.com
- api_key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41
- zone: example.com
+ email: YOUR_EMAIL_ADDRESS
+ api_key: YOUR_GLOBAL_API_KEY
+ zone: EXAMPLE.COM
records:
- bin
- www
diff --git a/source/_components/coinbase.markdown b/source/_components/coinbase.markdown
index bbe82837d40..f45ffa69888 100644
--- a/source/_components/coinbase.markdown
+++ b/source/_components/coinbase.markdown
@@ -25,8 +25,8 @@ To set it up, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
coinbase:
- api_key: asdfghjklqwertyuiopzxcvbnm
- api_secret: nkjnewncfghjklqwertyuiopzxcvbnm
+ api_key: YOUR_API_KEY
+ api_secret: YOUR_API_SECRET
exchange_rate_currencies:
- BTC
- ETH
diff --git a/source/_components/comfoconnect.markdown b/source/_components/comfoconnect.markdown
index 7394042b84d..6494ed5c8a6 100644
--- a/source/_components/comfoconnect.markdown
+++ b/source/_components/comfoconnect.markdown
@@ -28,13 +28,32 @@ comfoconnect:
host: 192.168.1.213
```
-Configuration variables:
-
-- **host** (*Required*): The ip or hostname of the ComfoConnect LAN C bridge.
-- **name** (*Optional*): The name of this device as you want to see it in Home Assistant.
-- **token** (*Optional*): The token you want to use when registering with the device. This is a random 32 char hexadecimal string. The default value is `00000000000000000000000000000001`.
-- **user_agent** (*Optional*): The name you want to supply when registering with the device. The default value is `Home Assistant`.
-- **pin** (*Optional*): The pin code to use when registering. This is `0000` by default. You only need to change this if you have changed the factory default pin.
+{% configuration %}
+host:
+ description: The IP or hostname of the ComfoConnect LAN C bridge.
+ required: true
+ type: string
+name:
+ description: The name of this device as you want to see it in Home Assistant.
+ required: false
+ default: ComfoAirQ
+ type: string
+token:
+ description: The token you want to use when registering with the device. This is a random 32 char hexadecimal string.
+ required: false
+ default: "`00000000000000000000000000000001`"
+ type: string
+user_agent:
+ description: The name you want to supply when registering with the device.
+ required: false
+ default: "`Home Assistant`"
+ type: string
+pin:
+ description: The pin code to use when registering. You only need to change this if you have changed the factory default pin.
+ required: false
+ default: "`0000`"
+ type: integer
+{% endconfiguration %}
To register the sensors, add the following to your `configuration.yaml` file:
diff --git a/source/_components/cover.deconz.markdown b/source/_components/cover.deconz.markdown
index 1b721a581c1..5f2e3999fc5 100644
--- a/source/_components/cover.deconz.markdown
+++ b/source/_components/cover.deconz.markdown
@@ -15,7 +15,7 @@ ha_iot_class: "Local Push"
See the [deCONZ main component](/components/deconz/) for configuration instructions.
-Covers are devices like ventilation dampers.
+Covers are devices like ventilation dampers or smart window covers.
Note that devices in the cover platform identify as lights, so there is a manually curated list that defines which "lights" are covers.
@@ -24,3 +24,4 @@ The `entity_id` name will be `cover.device_name`, where `device_name` is defined
#### {% linkable_title Verified supported covers %}
- Keen vents
+- Xiaomi Aqara Curtain controller
diff --git a/source/_components/cover.garadget.markdown b/source/_components/cover.garadget.markdown
index 0a3b5de358e..e232a615089 100644
--- a/source/_components/cover.garadget.markdown
+++ b/source/_components/cover.garadget.markdown
@@ -25,24 +25,42 @@ To enable Garadget Covers in your installation, add the following to your `confi
cover:
- platform: garadget
covers:
- 190028001947343412342341:
- username: YOUR_USERNAME
- password: YOUR_PASSWORD
+ 190028001947343412342341:
+ username: YOUR_USERNAME
+ password: YOUR_PASSWORD
4c003f001151353432134214:
access_token: df4cc785ff818f2b01396c44142342fccdef
```
-Configuration variables:
-
-- **covers** array (*Required*): List of your doors.
- - **device** (*Required*): This is the device id from your Garadget portal.
- - Either:
- - **username** (*Required*): Your Garadget account username.
- - **password** (*Required*): Your Garadget account password.
- - Or:
- - **access_token** (*Required*): A generated `access_token` from your Garadget account.
- - **name** (*Optional*): Name to use in the frontend, will use name configured in Garadget otherwise.
-
+{% configuration %}
+covers:
+ description: List of your doors.
+ required: true
+ type: list
+ keys:
+ device:
+ description: This is the device id from your Garadget portal.
+ required: true
+ type: string
+ keys:
+ username:
+ description: Your Garadget account username.
+ required: true
+ type: string
+ password:
+ description: Your Garadget account password.
+ required: true
+ type: string
+ access_token:
+ description: A generated `access_token` from your Garadget account.
+ required: true
+ type: string
+ name:
+ description: me to use in the frontend, will use name configured in Garadget otherwise.
+ required: false
+ default: Garadget
+ type: string
+{% endconfiguration %}
If provided, the **access_token** will be used, otherwise the **username** and **password** will be used to automatically generate an access token at start time.
diff --git a/source/_components/cover.markdown b/source/_components/cover.markdown
index f276c9b398a..d954ee83f0e 100644
--- a/source/_components/cover.markdown
+++ b/source/_components/cover.markdown
@@ -15,12 +15,22 @@ The display style of each entity can be modified in the [customize section](/get
| Attribute | Default | Description |
| --------- | ------- | ----------- |
-| `device_class` | | `none` Generic cover device
`damper` Ventilation damper controller
`garage` Garage door controller
`window` Window controller
+| `device_class` | | see below
| `assumed_state` | `false` | If set to `true`, cover buttons will always be enabled
+### {% linkable_title Device Class %}
+
+The way these sensors are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for covers:
+
+- **None**: Generic cover. This is the default and doesn't need to be set.
+- **damper**: Ventilation damper controller.
+- **garage**: Garage door controller.
+- **window**: Window controller.
+
## {% linkable_title Services %}
### {% linkable_title Cover control services %}
+
Available services: `cover.open_cover`, `cover.close_cover`, `cover.stop_cover`, `cover.open_cover_tilt`, `cover.close_cover_tilt`, `cover.stop_cover_tilt`
| Service data attribute | Optional | Description |
diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown
index b3f15bfeccd..26bb333b6b3 100644
--- a/source/_components/cover.mqtt.markdown
+++ b/source/_components/cover.mqtt.markdown
@@ -159,6 +159,35 @@ unique_id:
description: An ID that uniquely identifies this cover. If two covers have the same unique ID, Home Assistant will raise an exception.
required: false
type: string
+device:
+ description: 'Information about the device this cover is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.'
+ required: false
+ type: map
+ keys:
+ identifiers:
+ description: 'A list of IDs that uniquely identify the device. For example a serial number.'
+ required: false
+ type: list, string
+ connections:
+ description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
+ required: false
+ type: list
+ manufacturer:
+ description: 'The manufacturer of the device.'
+ required: false
+ type: string
+ model:
+ description: 'The model of the device.'
+ required: false
+ type: string
+ name:
+ description: 'The name of the device.'
+ required: false
+ type: string
+ sw_version:
+ description: 'The firmware version of the device.'
+ required: false
+ type: string
{% endconfiguration %}
## {% linkable_title Examples %}
diff --git a/source/_components/cover.rflink.markdown b/source/_components/cover.rflink.markdown
index bc4d18538db..768d1e20455 100644
--- a/source/_components/cover.rflink.markdown
+++ b/source/_components/cover.rflink.markdown
@@ -25,17 +25,18 @@ You have to add the Somfy RTS manually with the supplied RFlinkLoader (Windows o
Press the Learn button on the original Somfy remote enter the following code within 3 seconds. Your blinds will go up and down shortly:
-````
+```text
10;RTS;02FFFF;0412;3;PAIR;
-````
+```
Your blinds will go up and down again. This means your Rflink is now paired with your RTS motor.
To check this enter the following code again and see if there is a record.
-````
+```text
10;RTSSHOW;
-````
-````
+```
+
+```text
RTS Record: 0 Address: FFFFFF RC: FFFF
RTS Record: 1 Address: FFFFFF RC: FFFF
RTS Record: 2 Address: FFFFFF RC: FFFF
@@ -52,7 +53,7 @@ RTS Record: 12 Address: FFFFFF RC: FFFF
RTS Record: 13 Address: FFFFFF RC: FFFF
RTS Record: 14 Address: FFFFFF RC: FFFF
RTS Record: 15 Address: FFFFFF RC: FFFF
-````
+```
After configuring the RFLink Somfy RTS you have to add the cover to the `configuration.yaml` file like any other RFlink device.
@@ -73,28 +74,59 @@ cover:
name: Sovrumsgardin
```
-Configuration variables:
-
-- **automatic_add** (*Optional*): Automatically add new/unconfigured devices to Home Assistant if detected (default: True).
-- **devices** (*Optional*): A list of devices with their name to use in the frontend.
-- **device_defaults**: (*Optional*)
- - **fire_event** (*Optional*): Set default `fire_event` for Rflink switch devices (see below).
- - **signal_repetitions** (*Optional*): Set default `signal_repetitions` for Rflink switch devices (see below).
-
-Device configuration variables:
-
-- **name** (*Optional*): Name for the device, defaults to Rflink ID.
-- **aliases** (*Optional*): Alternative Rflink ID's this device is known by.
-- **fire_event** (*Optional*): Fire a `button_pressed` event if this device is turned on or off (default: False).
-- **signal_repetitions** (*Optional*): Repeat every Rflink command this number of times (default: 1).
-- **fire_event_** (*Optional*): Set default `fire_event` for RFLink switch devices (see below).
-- **signal_repetitions** (*Optional*): Set default `signal_repetitions` for RFLink switch devices (see below).
-- **group** (*Optional*): Allow light to respond to group commands (ALLON/ALLOFF). (default: yes)
-- **group_aliases** (*Optional*): `aliases` which only respond to group commands.
-- **no_group_aliases** (*Optional*): `aliases` which do not respond to group commands.
-
+{% configuration %}
+devices:
+ description: A list of devices with their name to use in the frontend.
+ required: false
+ type: list
+ keys:
+ name:
+ description: The name for the device. Defaults to value for Rflink ID.
+ required: false
+ type: string
+ aliases:
+ description: The alternative Rflink ID's this device is known by.
+ required: false
+ type: list
+ fire_event:
+ description: Fire a `button_pressed` event if this device is turned on or off.
+ required: false
+ default: False
+ type: boolean
+ signal_repetitions:
+ description: The number of times every Rflink command should repeat.
+ required: false
+ type: integer
+ group:
+ description: Allow light to respond to group commands (ALLON/ALLOFF).
+ required: false
+ default: True
+ type: boolean
+ group_aliases:
+ description: The `aliases` which only respond to group commands.
+ required: false
+ type: list
+ no_group_aliases:
+ description: The `aliases` which do not respond to group commands.
+ required: false
+ type: list
+device_defaults:
+ description: The default values for a device.
+ required: false
+ type: list
+ keys:
+ fire_event:
+ description: The default `fire_event` for Rflink cover devices.
+ required: false
+ default: False
+ type: boolean
+ signal_repetitions:
+ description: The default `signal_repetitions` for Rflink cover devices.
+ required: false
+ default: 1
+ type: integer
+{% endconfiguration %}
### {% linkable_title Device support %}
-See [device support](/components/rflink/#device-support)
-
+See [device support](/components/rflink/#device-support).
diff --git a/source/_components/cover.rfxtrx.markdown b/source/_components/cover.rfxtrx.markdown
index 342677cb5ae..801d0644b6b 100644
--- a/source/_components/cover.rfxtrx.markdown
+++ b/source/_components/cover.rfxtrx.markdown
@@ -61,12 +61,31 @@ cover:
name: Bathroom Shutter
```
-Configuration variables:
-
-- **devices** (*Required*): A list of devices with their name to use in the frontend.
-- **automatic_add** (*Optional*): To enable the automatic addition of new covers (Siemens/LightwaveRF only).
-- **signal_repetitions** (*Optional*): Because the rxftrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the roller shutter to try to send each signal repeatedly.
-- **fire_event** (*Optional*): Fires an event even if the state is the same as before. Can be used for automations.
+{% configuration %}
+devices:
+ description: A list of devices.
+ required: false
+ type: list
+ keys:
+ name:
+ description: Override the name to use in the frontend.
+ required: true
+ type: string
+ fire_event:
+ description: Fires an event even if the state is the same as before. Can be used for automations.
+ required: false
+ default: false
+ type: boolean
+automatic_add:
+ description: To enable the automatic addition of new covers (Siemens/LightwaveRF only).
+ required: false
+ default: false
+ type: boolean
+signal_repetitions:
+ description: Because the rxftrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the roller shutter to try to send each signal repeatedly.
+ required: false
+ type: integer
+{% endconfiguration %}
If a device ID consists of only numbers, please make sure to surround it with quotes. diff --git a/source/_components/cover.rpi_gpio.markdown b/source/_components/cover.rpi_gpio.markdown index 37427a321d8..2026b7bc3b6 100644 --- a/source/_components/cover.rpi_gpio.markdown +++ b/source/_components/cover.rpi_gpio.markdown @@ -35,18 +35,47 @@ cover: state_pin: 11 ``` -Configuration variables: +{% configuration %} +relay_time: + description: The time that the relay will be on for in seconds. + required: false + default: 0.2 + type: float +invert_relay: + description: Invert the relay pin output so that it is active-high (True). + required: false + default: False + type: boolean +state_pull_mode: + description: The direction the State pin is pulling. It can be UP or DOWN. + required: false + default: UP + type: string +invert_state: + description: Invert the value of the State pin so that 0 means closed. + required: false + default: False + type: boolean +covers: + description: List of your doors. + required: true + type: list + keys: + relay_pin: + description: The pin of your Raspberry Pi where the relay is connected. + required: true + type: integer + state_pin: + description: The pin of your Raspberry Pi to retrieve the state. + required: true + type: integer + name: + description: The name to use in the frontend. + required: false + type: string +{% endconfiguration %} -- **relay_time** (*Optional*): The time that the relay will be on for in seconds. Default is 0.2 seconds. -- **invert_relay** (*Optional*): Invert the relay pin output so that it is active-high. Default is False (active-low). -- **state_pull_mode** (*Optional*): The direction the State pin is pulling. It can be UP or DOWN. Default is UP. -- **invert_state** (*Optional*): Invert the value of the State pin so that 0 means closed. Default is False. -- **covers** array (*Required*): List of your doors. - - **relay_pin** (*Required*): The pin of your Raspberry Pi where the relay is connected. - - **state_pin** (*Required*): The pin of your Raspberry Pi to retrieve the state. - - **name** (*Optional*): Name to use in the frontend. - -Full example: +## {% linkable_title Full example %} ```yaml # Example configuration.yaml entry diff --git a/source/_components/cover.ryobi_gdo.markdown b/source/_components/cover.ryobi_gdo.markdown deleted file mode 100644 index eac9454463d..00000000000 --- a/source/_components/cover.ryobi_gdo.markdown +++ /dev/null @@ -1,59 +0,0 @@ ---- -layout: page -title: "Ryobi GDO Cover" -description: "Instructions on how to integrate Ryobi Garage Door Opener (RyobiGDO) within Home Assistant." -date: 2018-04-22 09:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: ryobi.png -ha_category: Cover -ha_release: 0.71 -ha_iot_class: "Cloud Polling" ---- - - -The `ryobi_gdo` cover platform lets you control [Ryobi](https://www.ryobitools.com/gdo/) garage door opener through Home Assistant. - -## {% linkable_title Setup %} - -In order to be able to use your Ryobi garage door opener, you will have to get the DEVICE_ID_OF_YOUR_COVER (one for each garage door). - -The DEVICE_ID_OF_YOUR_COVER can be retrieved using `curl`, simply use your username and password using the following example. Your `DEVICE_ID_OF_YOUR_COVER` will be `varName`: - -```bash -$ curl -H "Content-Type: application/json" -X GET \ - -d '{"username":"RYOBIGDO_USERNAME","password":"RYOBIGDO_PASSWORD"}' \ - https://tti.tiwiconnect.com/api/devices -``` - -## {% linkable_title Configuration %} - -To enable Ryobi covers in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -cover: - - platform: ryobi_gdo - username: RYOBIGDO_USERNAME - password: RYOBIGDO_PASSWORD - device_id: - - DEVICE_ID_OF_YOUR_COVER#1 - - DEVICE_ID_OF_YOUR_COVER#2 -``` - -{% configuration %} -username: - description: Your RyobiGDO account username. - required: true - type: string -password: - description: Your RyobiGDO account password. - required: true - type: string -device_id: - description: List of your doors. - required: true - type: list -{% endconfiguration %} diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown index d4b25765958..c060f41b3f8 100644 --- a/source/_components/daikin.markdown +++ b/source/_components/daikin.markdown @@ -43,7 +43,7 @@ hosts: description: List of IP addresses or hostnames. required: false default: All discovered hosts - type: array + type: list monitored_conditions: description: List of items you want to monitor for each device. required: false diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index 0340ef07126..db8927e9a4e 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -88,7 +88,7 @@ Typical values for switches, the event codes are 4 numbers where the first and l Where for example on a Philips Hue Dimmer, 2001 would be holding the dim up button. -For the IKEA Tradfri remote, 1 is the middle button, 2 is up, 3 is down, 4 is left, and 5 is right. +For the IKEA Tradfri remote the first digit equals, 1 for the middle button, 2 for up, 3 for down, 4 for left, and 5 for right (e.g., "event: 1002" for middle button short release). ## {% linkable_title Examples %} diff --git a/source/_components/demo.markdown b/source/_components/demo.markdown index 7fc7ba7025a..1ea674c92c6 100644 --- a/source/_components/demo.markdown +++ b/source/_components/demo.markdown @@ -45,6 +45,9 @@ To integrate a demo platform in Home Assistant, add the following section to you - platform: demo ``` -Configuration variables: - -- **[component]** (*Required*): The name of the component as stated in the listing above the configuration example. +{% configuration %} +"[component]": + description: The name of the component as stated in the listing above the configuration example. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/device_sun_light_trigger.markdown b/source/_components/device_sun_light_trigger.markdown index 2be37360ace..ffb052445ea 100644 --- a/source/_components/device_sun_light_trigger.markdown +++ b/source/_components/device_sun_light_trigger.markdown @@ -27,12 +27,26 @@ To enable this component, add the following lines to your `configuration.yaml` f device_sun_light_trigger: ``` -Configuration variables: - -- **light_group** (*Optional*): Specify a specific light/group of lights that has to be turned on. -- **light_profile** (*Optional*): Specify which light profile to use when turning lights on. -- **device_group** (*Optional*): Specify which group of devices to track. -- **disable_turn_off** (*Optional*): Disable lights being turned off when everybody leaves the house. +{% configuration %} +light_group: + description: Specify a specific light/group of lights that has to be turned on. + required: false + type: string +light_profile: + description: Specify which light profile to use when turning lights on. + required: false + default: relax + type: string +device_group: + description: Specify which group of devices to track. + required: false + type: string +disable_turn_off: + description: Disable lights being turned off when everybody leaves the house. + required: false + default: false + type: boolean +{% endconfiguration %} A full configuration example could look like this: diff --git a/source/_components/device_tracker.bluetooth_le_tracker.markdown b/source/_components/device_tracker.bluetooth_le_tracker.markdown index 421a6e0708b..3cef5e1b2d2 100644 --- a/source/_components/device_tracker.bluetooth_le_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_le_tracker.markdown @@ -54,11 +54,12 @@ Some BTLE devices (e.g., fitness trackers) are only visible to the devices that ## {% linkable_title Rootless Setup %} -Normally accessing the Bluetooth stack is reserved for root, but running programs that are networked as root is a bad security wise. To allow non-root access to the Bluetooth stack we can give Python 3 the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information). +Normally accessing the Bluetooth stack is reserved for root, but running programs that are networked as root is a bad security wise. To allow non-root access to the Bluetooth stack we can give Python 3 and hcitool the missing capabilities to access the Bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information). ```bash $ sudo apt-get install libcap2-bin $ sudo setcap 'cap_net_raw,cap_net_admin+eip' `readlink -f \`which python3\`` +$ sudo setcap 'cap_net_raw+ep' `readlink -f \`which hcitool\`` ``` A restart of Home Assistant is required. diff --git a/source/_components/device_tracker.ddwrt.markdown b/source/_components/device_tracker.ddwrt.markdown index 01e1c68ce5e..d4bb1a028b6 100644 --- a/source/_components/device_tracker.ddwrt.markdown +++ b/source/_components/device_tracker.ddwrt.markdown @@ -38,6 +38,16 @@ password: description: The password for your given admin account. required: true type: string +ssl: + description: Whether to connect via HTTPS. + required: false + type: boolean + default: false +verify_ssl: + description: If SSL/TLS verification for HTTPS resources needs to be turned off (for self-signed certs, etc.) + required: false + type: boolean + default: true {% endconfiguration %} By default Home Assistant pulls information about connected devices from DD-WRT every 5 seconds. diff --git a/source/_components/device_tracker.fritz.markdown b/source/_components/device_tracker.fritz.markdown index 07d2eee540f..f478fdea748 100644 --- a/source/_components/device_tracker.fritz.markdown +++ b/source/_components/device_tracker.fritz.markdown @@ -19,7 +19,7 @@ The `fritz` platform offers presence detection by looking at connected devices t
It might be necessary to install additional packages: $ sudo apt-get install python3-lxml
-If you installed Home Assistant in a virtualenv, run the following commands inside it: $ sudo apt-get install libxslt-dev libxml2-dev zlib1g-dev; pip install lxml; be patient this will take a while.
$ sudo apt-get install libxslt-dev libxml2-dev zlib1g-dev; pip3 install lxml; be patient this will take a while.
## {% linkable_title Configuration %}
diff --git a/source/_components/device_tracker.gpslogger.markdown b/source/_components/device_tracker.gpslogger.markdown
index 6d1b2d5446a..bf98c0b62ed 100644
--- a/source/_components/device_tracker.gpslogger.markdown
+++ b/source/_components/device_tracker.gpslogger.markdown
@@ -13,6 +13,18 @@ ha_release: 0.34
The `gpslogger` device tracker platform allows you to detect presence using [GPSLogger](http://code.mendhak.com/gpslogger/). GPSLogger is an open source app for [Android](https://play.google.com/store/apps/details?id=com.mendhak.gpslogger) that allows users to set up a `GET` request to update GPS coordinates. This can be configured with Home Assistant to update your location.
+## {% linkable_title Auth change release 0.77 and above %}
+
+Since release 0.77, we now have long-lived access tokens. These are setup under your profile and configured in the GPSLogger application on your smartphone as explained below.
+
+```yaml
+# Example configuration.yaml entry
+device_tracker:
+ - platform: gpslogger
+```
+
+## {% linkable_title Before release 0.77 %}
+
To integrate GPSLogger in Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
@@ -68,10 +80,11 @@ Add the above URL after you modified it with your settings into the **URL** fiel
- Use the domain that Home Assistant is available on the internet (or the public IP address if you have a static IP address). This can be a local IP address if you are using an always on VPN from your mobile device to your home network.
- Only remove `PORT` if your Home Assistant instance is using port 443. Otherwise set it to the port you're using.
- For Home Assistant only the above URL, as written, will work - do not add, remove, or change the order of any of the parameters.
-- Make sure to include your [API password](/components/http/) if you have configured a password. Add `&api_password=YOUR_PASSWORD` to the end of the URL.
+- **0.77+** If you are using Long-Lived access tokens, then add `Authorization: Bearer LLAT` to the HTTP Headers setting (replace `LLAT` with your Long Lived Access Token).
+- **<0.77** Make sure to include your [API password](/components/http/) if you have configured a password. Add `&api_password=YOUR_PASSWORD` to the end of the URL.
- You can change the name of your device name by replacing `&device=%SER` with `&device=DEVICE_NAME`.
-If your battery drains fast then you can tune the performance of GPSLogger under **Performance** -> **Location providers**
+If your battery drains fast then you can tune the performance of GPSLogger under **Performance** -> **Location providers**
diff --git a/source/_components/device_tracker.huawei_router.markdown b/source/_components/device_tracker.huawei_router.markdown
index 92ee5c62d47..5fa66cdd696 100644
--- a/source/_components/device_tracker.huawei_router.markdown
+++ b/source/_components/device_tracker.huawei_router.markdown
@@ -12,7 +12,7 @@ ha_category: Presence Detection
ha_release: 0.51
---
-The `huawei` device trakcer platform offers presence detection by looking at connected devices to a [Huawei router](http://m.huawei.com/enmobile/enterprise/products/network/access/pon-one/hw-371813.htm).
+The `huawei` device tracker platform offers presence detection by looking at connected devices to a [Huawei router](http://m.huawei.com/enmobile/enterprise/products/network/access/pon-one/hw-371813.htm).
Currently, this was only tested with the Huawei HG8247H and HG8247Q Smart Router (used by Vodafone Portugal).
diff --git a/source/_components/device_tracker.nmap_tracker.markdown b/source/_components/device_tracker.nmap_tracker.markdown
index aa268fe6fcf..27cbb88d448 100644
--- a/source/_components/device_tracker.nmap_tracker.markdown
+++ b/source/_components/device_tracker.nmap_tracker.markdown
@@ -46,7 +46,7 @@ home_interval:
required: false
type: integer
exclude:
- description: Hosts not to include in Nmap scanning. Scanning the host where Home Assistant is running can cause problems (websocket error), so excluding that host is a good idea.
+ description: Hosts not to include in Nmap scanning. Scanning the host where Home Assistant is running can cause problems (websocket error and authentication failures), so excluding that host is a good idea.
required: false
type: list
scan_options:
diff --git a/source/_components/device_tracker.owntracks.markdown b/source/_components/device_tracker.owntracks.markdown
index 66838f654e4..9a2e98158de 100644
--- a/source/_components/device_tracker.owntracks.markdown
+++ b/source/_components/device_tracker.owntracks.markdown
@@ -101,7 +101,11 @@ Home Assistant will use the enter and leave messages to set your zone location.
When you exit a zone, Home Assistant will start using location updates to track you again. To make sure that Home Assistant correctly exits a zone (which it calculates based on your GPS coordinates), you may want to set your Zone radius in HA to be slightly smaller that the Owntracks region radius.
-### {% linkable_title Using Owntracks regions - forcing Owntracks to update using %}iBeacons
+### {% linkable_title Using Owntracks regions - forcing Owntracks to update using iBeacons %}
+
+
+Owntracks v2.0.0 removes support for iBecons on Android. +
When run in the usual *significant changes mode* (which is kind to your phone battery), Owntracks sometimes doesn't update your location as quickly as you'd like when you arrive at a zone. This can be annoying if you want to trigger an automation when you get home. You can improve the situation using iBeacons. diff --git a/source/_components/device_tracker.ping.markdown b/source/_components/device_tracker.ping.markdown index 84c41802c23..06305cec6d2 100644 --- a/source/_components/device_tracker.ping.markdown +++ b/source/_components/device_tracker.ping.markdown @@ -36,7 +36,7 @@ device_tracker: hosts: description: List of device names and their corresponding IP address or hostname. required: true - type: array + type: list count: description: Number of packet used for each device (avoid false detection). required: false diff --git a/source/_components/device_tracker.quantum_gateway.markdown b/source/_components/device_tracker.quantum_gateway.markdown new file mode 100644 index 00000000000..05ff8524740 --- /dev/null +++ b/source/_components/device_tracker.quantum_gateway.markdown @@ -0,0 +1,43 @@ +--- +layout: page +title: "Quantum Gateway" +description: "Instructions on how to integrate Quantum Gateways into Home Assistant." +date: 2018-09-30 01:40 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Presence Detection +logo: fios.svg +ha_release: 0.81 +--- + +The `quantum_gateway` device tracker platform offers presence detection by looking at connected devices to a Verizon Fios gateway. + +It was tested with a Verizon Fios-G1100 Quantum Gateway. + +## {% linkable_title Configuration %} + +To use a Verizon Fios Quantum Gateway in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +device_tracker: + - platform: quantum_gateway + host: 192.168.1.1 + password: YOUR_PASSWORD +``` + +{% configuration %} +host: + description: The IP address of your router, e.g., `192.168.1.1`. + required: false + type: string + default: myfiosgateway.com +password: + description: The password for the `admin` user. The default password may be printed on the gateway itself. + required: true + type: string +{% endconfiguration %} + +See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_components/device_tracker.snmp.markdown b/source/_components/device_tracker.snmp.markdown index a7fe4236902..05a5b2fb867 100644 --- a/source/_components/device_tracker.snmp.markdown +++ b/source/_components/device_tracker.snmp.markdown @@ -25,7 +25,7 @@ The following OID examples pull the current MAC Address table from a router. Thi |---|---|---|---| | Mikrotik | unknown RouterOS version/model | `1.3.6.1.4.1.14988.1.1.1.2.1.1` | | Mikrotik | RouterOS 6.x on RB2011 | `1.3.6.1.2.1.4.22.1.2` | -| Aruba | (untested) | `1.3.6.1.4.1.14823.2.3.3.1.2.4.1.1` | +| Aruba | IAP325 on AOS 6.5.4.8 | `1.3.6.1.4.1.14823.2.3.3.1.2.4.1.1` | | pfSense | 2.2.4 | `1.3.6.1.2.1.4.22.1.2` | | BiPAC | 7800DXL Firmware 2.32e | `1.3.6.1.2.1.17.7.1.2.2.1.1` | | OpenWrt | Chaos Calmer 15.05 | `1.3.6.1.2.1.4.22.1.2` | diff --git a/source/_components/device_tracker.unifi.markdown b/source/_components/device_tracker.unifi.markdown index 2bb4372c4b3..60d6448dd5b 100644 --- a/source/_components/device_tracker.unifi.markdown +++ b/source/_components/device_tracker.unifi.markdown @@ -88,6 +88,21 @@ The Unifi controller can either be a dedicated hardware device (Unifi's cloud ke It is recommended that you run the Unifi controller in a dedicated virtual machine to avoid that situation. +### {% linkable_title Correctly specifying the Site ID %} + +For environments where there are multiple sites setup on the controller, or the default site is not being used you can use the `site_id` parameter to specify which site you would like to target. + +Please note that the value that is to be specificed here is not the name of the site as you would see it in controller interface, but a site ID value assigned from the software itself. + +To obtain this value for your configuration file, you can take it from the URL of your browser when on the controller webpage. + +For example, this is what would be seen in the URL bar when inside the dashboard page of a site: + +* https://127.0.0.1:8443/manage/s/ceb1m27d/dashboard + +And your `site_id` value would be ceb1m27d. + + ### {% linkable_title Troubleshooting and Time Synchronization %} Presence detection depends on accurate time configuration between Home Assistant and the Unifi controller. diff --git a/source/_components/device_tracker.xiaomi.markdown b/source/_components/device_tracker.xiaomi.markdown index 640f240efc2..7f9494c2af5 100644 --- a/source/_components/device_tracker.xiaomi.markdown +++ b/source/_components/device_tracker.xiaomi.markdown @@ -14,6 +14,8 @@ ha_release: 0.36 The `xiaomi` platform offers presence detection by looking at connected devices to a [Xiaomi](http://miwifi.com) router. +## {% linkable_title Setup %} + To use an Xiaomi router in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -41,3 +43,8 @@ password: {% endconfiguration %} See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. + +### {% linkable_title Compatibility test %} + +To ensure that your router is compatible, navigate to `http://YOUR_ROUTER_IP/api/misystem/devicelist`. +You should see a listing of the device currently connected to your router. diff --git a/source/_components/device_tracker.xiaomi_miio.markdown b/source/_components/device_tracker.xiaomi_miio.markdown index 54f4cf9d5de..850e2fee69d 100644 --- a/source/_components/device_tracker.xiaomi_miio.markdown +++ b/source/_components/device_tracker.xiaomi_miio.markdown @@ -17,7 +17,7 @@ The `xiaomi_miio` device tracker platform is observing your Xiaomi Mi WiFi Repea Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token. -To add a Xiaomi Mi Air Quality Monitor to your installation, add the following to your `configuration.yaml` file: +To add a Xiaomi Mi WiFi Repeater device tracker to your installation, add the following to your `configuration.yaml` file: ```yaml device_tracker: diff --git a/source/_components/downloader.markdown b/source/_components/downloader.markdown index f41c2fd1168..0e77a6bb719 100644 --- a/source/_components/downloader.markdown +++ b/source/_components/downloader.markdown @@ -23,9 +23,12 @@ downloader: download_dir: downloads ``` -Configuration variables: - -- **download_dir** (*Required*): If the path is not absolute, it's assumed to be relative to the Home Assistant configuration directory (eg. `.homeassistant/downloads`). +{% configuration %} +download_dir: + description: "If the path is not absolute, it's assumed to be relative to the Home Assistant configuration directory (eg. `.homeassistant/downloads`)." + required: true + type: string +{% endconfiguration %} ### {% linkable_title Use the service %} diff --git a/source/_components/duckdns.markdown b/source/_components/duckdns.markdown index 7b67ed702e3..9548049cf6d 100644 --- a/source/_components/duckdns.markdown +++ b/source/_components/duckdns.markdown @@ -23,7 +23,7 @@ To use the component in your installation, add the following to your `configurat # Example configuration.yaml entry duckdns: domain: YOUR_SUBDOMAIN - access_token: YOUR_ACCSS_TOKEN + access_token: YOUR_ACCESS_TOKEN ``` {% configuration duckdns %} diff --git a/source/_components/dyson.markdown b/source/_components/dyson.markdown index b02d948f7ee..6bccfa636a2 100644 --- a/source/_components/dyson.markdown +++ b/source/_components/dyson.markdown @@ -13,7 +13,7 @@ ha_iot_class: "Cloud Polling" ha_release: 0.47 --- -The `dyson` component is the main component to integrate all [Dyson](https://dyson.com) related platforms: [Fans](/components/fan.dyson/) and [Robot vacuum](/components/vacuum.dyson/). +The `dyson` component is the main component to integrate all [Dyson](https://dyson.com) related platforms: [Fans](/components/fan.dyson/) and [Robot vacuum cleaners](/components/vacuum.dyson/). ## {% linkable_title Configuration %} @@ -24,7 +24,7 @@ To enable this component, add the following lines to your `configuration.yaml`: dyson: username: YOUR_DYSON_USERNAME password: YOUR_DYSON_PASSWORD - language: YOUR_DYSON_ACCOUNT_LANGUGAGE + language: YOUR_DYSON_ACCOUNT_LANGUAGE devices: - device_id: DEVICE_ID_1 # eg. Serial number: XXX-XX-XXXXXXXX device_ip: DEVICE_IP_1 diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index 217922806b2..9edb7356213 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -48,13 +48,20 @@ To set it up, add the following information to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry ecobee: - api_key: asdfghjklqwertyuiopzxcvbnm + api_key: YOUR_API_KEY ``` -Configuration variables: - -- **api_key** (*Required*): Your ecobee API key. This is only needed for the initial setup of the component. Once registered it can be removed. If you revoke the key in the ecobee portal you will need to update this again and remove the ecobee.conf file in the `.homeassistant` configuration path. -- **hold_temp** (*Optional*): True/False whether or not to hold changes indefinitely (True) or until the next scheduled event. Defaults to `False`. +{% configuration %} +api_key: + description: Your ecobee API key. This is only needed for the initial setup of the component. Once registered it can be removed. If you revoke the key in the ecobee portal you will need to update this again and remove the ecobee.conf file in the `.homeassistant` configuration path. + required: true + type: string +hold_temp: + description: True/False whether or not to hold changes indefinitely (True) or until the next scheduled event. + required: false + default: "`false`" + type: boolean +{% endconfiguration %}
diff --git a/source/_components/envisalink.markdown b/source/_components/envisalink.markdown
index 57deb9f53fb..15c3283d38a 100644
--- a/source/_components/envisalink.markdown
+++ b/source/_components/envisalink.markdown
@@ -54,20 +54,76 @@ envisalink:
name: 'Home Alarm'
```
-Configuration variables:
-
-- **host** (*Required*): The IP address of the Envisalink device on your home network.
-- **panel_type** (*Required*): `HONEYWELL` or `DSC`, depending upon which alarm system you have.
-- **user_name** (*Required*): Which username to authenticate with when connecting to the device. On a Honeywell alarm panel, the username/password are the same.
-- **password** (*Required*): Which password to authenticate with when connecting to the device. EVL3 only works with max. 6 characters.
-- **code** (*Required*): Your alarm panel's code, for authenticating user input during arm/disarm.
-- **port** (*Optional*): Which network port to connect with. Default: `4025`
-- **evl_version** (*Optional*): 3 for evl3, or 4 for evl4. Default: `3`
-- **keepalive_interval** (*Optional*): This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems. Defaults to `60` seconds.
-- **zonedump_interval** (*Optional*): This is an interval (measured in seconds) where the evl will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this. Default: `30`
-- **panic_type** (*Optional*): Both DSC and Honeywell boards support a "panic" alarm. This is used when the alarm_trigger service is called in Home Assistant. This determines which type of panic alarm to raise. Default = Police. Valid values are: Police, Fire, Ambulance
-- **zones** (*Optional*): Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.envisalink/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*
-- **partitions** (*Optional*): Again, Envisalink boards do not tell us what is in use and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded.
+{% configuration %}
+host:
+ description: The IP address of the Envisalink device on your home network.
+ required: true
+ type: string
+panel_type:
+ description: "`HONEYWELL` or `DSC`, depending upon which alarm system you have."
+ required: true
+ type: string
+user_name:
+ description: Which username to authenticate with when connecting to the device. On a Honeywell alarm panel, the username/password are the same.
+ required: true
+ type: string
+password:
+ description: Which password to authenticate with when connecting to the device. EVL3 only works with max. 6 characters.
+ required: true
+ type: string
+code:
+ description: Your alarm panel's code, for authenticating user input during arm/disarm.
+ required: true
+ type: string
+port:
+ description: Which network port to connect with.
+ required: false
+ default: 4025
+ type: integer
+evl_version:
+ description: 3 for evl3, or 4 for evl4.
+ required: false
+ default: 3
+ type: integer
+keepalive_interval:
+ description: This is a periodic heartbeat signal (measured in seconds) sent to your Envisalink board to keep it from restarting. This is required for DSC and Honeywell systems.
+ required: false
+ default: 60
+ type: integer
+zonedump_interval:
+ description: This is an interval (measured in seconds) where Envisalink will dump out all zone statuses. This is required for Honeywell systems, which do not properly send zone closure events. DSC boards do not technically need this.
+ required: false
+ default: 30
+ type: integer
+panic_type:
+ description: "Both DSC and Honeywell boards support a panic alarm. This is used when the alarm_trigger service is called in Home Assistant. This determines which type of panic alarm to raise. Valid values are: Police, Fire, Ambulance."
+ required: false
+ default: Police
+ type: string
+zones:
+ description: "Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.envisalink/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*"
+ required: false
+ type: integer
+ keys:
+ name:
+ description: Zone name
+ required: true
+ type: string
+ type:
+ description: Zone type
+ required: false
+ default: opening
+ type: string
+partitions:
+ description: Again, Envisalink boards do not tell us what is in use and what is not, so each partition must be configured with a partition name. If no partition parameter is specified, then no alarm_panel or sensor components are loaded.
+ required: false
+ type: integer
+ keys:
+ name:
+ description: Partition name
+ required: true
+ type: string
+{% endconfiguration %}
Supported services:
diff --git a/source/_components/evohome.markdown b/source/_components/evohome.markdown
index 6a69e5b7413..eaa1706bb5a 100644
--- a/source/_components/evohome.markdown
+++ b/source/_components/evohome.markdown
@@ -29,9 +29,9 @@ To use this component in your installation, add the following to your `configura
```yaml
# Example configuration.yaml entry
evohome:
- - username: YOUR_USERNAME
- password: YOUR_PASSWORD
- location_idx: 0
+ username: YOUR_USERNAME
+ password: YOUR_PASSWORD
+ location_idx: 0
```
This is a IoT cloud-polling device, and the `scan_interval` is currently fixed at 3 minutes. Testing has indicated that this is a safe interval that - by itself - shouldn't cause you to be rate-limited by Honeywell.
diff --git a/source/_components/fan.dyson.markdown b/source/_components/fan.dyson.markdown
index c3480135efb..22240bbdb92 100644
--- a/source/_components/fan.dyson.markdown
+++ b/source/_components/fan.dyson.markdown
@@ -16,16 +16,16 @@ ha_release: 0.47
The `dyson` fan platform allows you to control your Dyson Purifier fans.
-You have first to setup the [Dyson component](/components/dyson/)
+You first have to setup the [Dyson component](/components/dyson/)
### {% linkable_title Supported fan devices %}
- Pure Cool link (desk and tower)
-- Pure Hot+cool link (but heating is not yet supported)
+- Pure Hot+cool link (see [climate](/components/climate.dyson/) for thermal control)
### {% linkable_title Attributes %}
-The are several attributes that can be useful for automations and templates.
+There are several attributes which can be used for automations and templates.
| Attribute | Description |
| --------- | ----------- |
diff --git a/source/_components/fan.mqtt.markdown b/source/_components/fan.mqtt.markdown
index f48971fde9c..2a726f19e46 100644
--- a/source/_components/fan.mqtt.markdown
+++ b/source/_components/fan.mqtt.markdown
@@ -50,12 +50,12 @@ payload_on:
description: The payload that represents the running state.
required: false
type: string
- default: ON
+ default: "ON"
payload_off:
description: The payload that represents the stop state.
required: false
type: string
- default: OFF
+ default: "OFF"
state_value_template:
description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the state."
required: false
@@ -146,6 +146,35 @@ unique_id:
description: An ID that uniquely identifies this fan. If two fans have the same unique ID, Home Assistant will raise an exception.
required: false
type: string
+device:
+ description: 'Information about the device this fan is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.'
+ required: false
+ type: map
+ keys:
+ identifiers:
+ description: 'A list of IDs that uniquely identify the device. For example a serial number.'
+ required: false
+ type: list, string
+ connections:
+ description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.'
+ required: false
+ type: list, tuple
+ manufacturer:
+ description: 'The manufacturer of the device.'
+ required: false
+ type: string
+ model:
+ description: 'The model of the device.'
+ required: false
+ type: string
+ name:
+ description: 'The name of the device.'
+ required: false
+ type: string
+ sw_version:
+ description: 'The firmware version of the device.'
+ required: false
+ type: string
{% endconfiguration %}
diff --git a/source/_components/fan.zha.markdown b/source/_components/fan.zha.markdown index 536d9c78bd1..60d316e5926 100644 --- a/source/_components/fan.zha.markdown +++ b/source/_components/fan.zha.markdown @@ -1,7 +1,7 @@ --- layout: page -title: "ZigBee Home Automation Fan" -description: "Instructions how to setup ZigBee Home Automation fans within Home Assistant." +title: "Zigbee Home Automation Fan" +description: "Instructions how to setup Zigbee Home Automation fans within Home Assistant." date: 2018-02-10 00:00 sidebar: true comments: false @@ -13,4 +13,4 @@ ha_iot_class: "Local Polling" ha_release: 0.66 --- -To get your ZigBee fans working with Home Assistant, follow the instructions for the general [ZigBee Home Automation component](/components/zha/). +To get your Zigbee fans working with Home Assistant, follow the instructions for the general [Zigbee Home Automation component](/components/zha/). diff --git a/source/_components/gc100.markdown b/source/_components/gc100.markdown index 43d74d72b7c..1899560f492 100644 --- a/source/_components/gc100.markdown +++ b/source/_components/gc100.markdown @@ -25,7 +25,14 @@ gc100: port: 4998 ``` -Configuration variables: - -- **host** (*Required*): The hostname/IP address of your GC100 device. -- **port** (*Optional*): The port on which the GC100 is listening. +{% configuration %} +host: + description: The hostname or IP address of your GC100 device. + required: true + type: string +port: + description: The port on which the GC100 is listening. + required: false + default: 4998 + type: integer +{% endconfiguration %} diff --git a/source/_components/geo_location.nsw_rural_fire_service_feed.markdown b/source/_components/geo_location.nsw_rural_fire_service_feed.markdown new file mode 100644 index 00000000000..4bae0d66a2a --- /dev/null +++ b/source/_components/geo_location.nsw_rural_fire_service_feed.markdown @@ -0,0 +1,88 @@ +--- +layout: page +title: "NSW Rural Fire Service Incidents" +description: "Instructions on how to integrate the NSW Rural Fire Service Incidents feed into Home Assistant." +date: 2018-09-23 08:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: nsw-rural-fire-service.png +ha_category: Geo Location +ha_iot_class: "Cloud Polling" +ha_release: "0.81" +--- + +The `nsw_rural_fire_service_feed` platform lets you integrate a GeoJSON feed provided by the [NSW Rural Fire Service](https://www.rfs.nsw.gov.au/fire-information/fires-near-me) with information about bush fires, grass fires, hazard reductions and more. It retrieves incidents from a feed and shows information of those incidents filtered by distance to Home Assistant's location. + +
+ 
+
+ 
+
- Use [Home Assistant Cloud](/cloud/) to integrate with Google Assistant without any effort. -
- The `google_assistant` component allows you to control things via Google Assistant (on your mobile or tablet) or a Google Home device. +## {% linkable_title Automatic setup via Home Assistant Cloud %} + +With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instance in a few simple clicks to Google Assistant. With Home Assistant Cloud you don't have to deal with dynamic DNS, SSL certificates or opening ports on your router. Just log in via the user interface and a secure connection with the cloud will be established. Home Assistant Cloud requires a paid subscription after a 30-day free trial. + +## {% linkable_title Manual setup %} + The Google Assistant component requires a bit more setup than most due to the way Google requires Assistant Apps to be set up. --To use Google Assistant, your Home Assistant configuration has to be externally accessible with a hostname and SSL certificate. If you haven't already configured that, you should do so before continuing. +
+To use Google Assistant, your Home Assistant configuration has to be [externally accessible with a hostname and SSL certificate](/docs/configuration/remote/). If you haven't already configured that, you should do so before continuing.
## {% linkable_title Migrate to release 0.80 and above %} ++If this is the first time setting up your Google Assistant integration, you can skip this section and continue with the [manual setup instructions](#first-time-setup) below. +
-Since release 0.80, the `Authorization Code` type of `OAuth` account linking is supported. To migrate your configuration, you need: +Since release 0.80, the `Authorization Code` type of `OAuth` account linking is supported. To migrate your existing configuration from release 0.79 or below, you need: 1. Change your `Account linking` setting in [Actions on Google console](https://console.actions.google.com/), look for the `Advanced Options` in the bottom left of the sidebar. - Change `Linking type` to `OAuth` and `Authorization Code`. @@ -48,7 +53,7 @@ Since release 0.80, the `Authorization Code` type of `OAuth` account linking is If you've added Home Assistant to the home screen, you have to first remove it from home screen, otherwise, this HTML5 app will show up instead of a browser. Using it would prevent Home Assistant to redirect back to the `Google Assistant` app. -## {% linkable_title Setup %} +## {% linkable_title First time setup %} You need to create an API Key with the [Google Cloud API Console](https://console.cloud.google.com/apis/api/homegraph.googleapis.com/overview) which allows you to update devices without unlinking and relinking an account (see [below](#troubleshooting-the-request_sync-service)). If you don't provide one, the `google_assistant.request_sync` service is not exposed. It is recommended to set up this configuration key as it also allows the usage of the following command, "Ok Google, sync my devices". Once you have set up this component, you will need to call this service (or command) each time you add a new device that you wish to control via the Google Assistant integration. @@ -97,21 +102,21 @@ Now add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry google_assistant: - project_id: someproject-2d0b8 - api_key: [a Homegraph API Key generated for the Google Actions project] + project_id: YOUR_PROJECT_ID + api_key: YOUR_API_KEY exposed_domains: - - switch - - light - - group + - SWITCH + - LIGHT + - GROUP entity_config: switch.kitchen: - name: Custom Name for Google Assistant + name: CUSTOM_NAME_FOR_GOOGLE_ASSISTANT aliases: - - bright lights - - entry lights + - BRIGHT_LIGHTS + - ENTRY_LIGHTS light.living_room: expose: false - room: living room + room: LIVING_ROOM ``` {% configuration %} diff --git a/source/_components/group.markdown b/source/_components/group.markdown index 5e5232e86aa..81098bd5765 100644 --- a/source/_components/group.markdown +++ b/source/_components/group.markdown @@ -55,13 +55,32 @@ group: - device_tracker.mom_smith ``` -Configuration variables: - -- **view** (*Optional*): If yes then the entry will be shown as a view (tab) at the top. Groups that are set to `view: yes` cannot be used as entities in other views. -- **name** (*Optional*): Name of the group. -- **icon** (*Optional*): If the group is a view, this icon will show at the top in the frontend instead of the name. If the group is a view and both name and icon have been specified, the icon will appear at the top of the frontend and the name will be displayed as the mouse-over text. If it's not a view, then the icon shows when this group is used in another group. -- **control** (*Optional*): Set value to `hidden`. If hidden then the group switch will be hidden. -- **entities** (*Required*): array or comma delimited string, list of entities to group. +{% configuration %} +name: + description: Name of the group. + required: false + type: string +view: + description: "If yes then the entry will be shown as a view (tab) at the top. Groups that are set to `view: yes` cannot be used as entities in other views." + required: false + type: boolean +icon: + description: If the group is a view, this icon will show at the top in the frontend instead of the name. If the group is a view and both name and icon have been specified, the icon will appear at the top of the frontend and the name will be displayed as the mouse-over text. If it's not a view, then the icon shows when this group is used in another group. + required: false + type: string +control: + description: Set value to `hidden`. If hidden then the group switch will be hidden. + required: false + type: string +entities: + description: Array or comma delimited string, list of entities to group. + required: true + type: list +all: + description: Set this to `true` if the group state should only turn *on* if **all** grouped entities are *on*. + required: false + type: boolean +{% endconfiguration %}
@@ -121,7 +140,7 @@ group:
## {% linkable_title Group behavior %}
-When any member of a group is `on` then the group will also be `on`. Similarly with a device tracker, when any member of the group is `home` then the group is `home`.
+By default when any member of a group is `on` then the group will also be `on`. Similarly with a device tracker, when any member of the group is `home` then the group is `home`. If you set the `all` option to `true` though, this behavior is inverted and all members of the group have to be `on` for the group to turn on as well.
## {% linkable_title Customize group order %}
You can also order your groups using [customize](/docs/configuration/customizing-devices/) with `order: ` if they don't show up in the order you want them in.
diff --git a/source/_components/habitica.markdown b/source/_components/habitica.markdown
index fbd51c31267..7da9936d680 100644
--- a/source/_components/habitica.markdown
+++ b/source/_components/habitica.markdown
@@ -20,8 +20,8 @@ To use the component you should use this example configuration:
```yaml
# Minimum viable configuration.yaml entry
habitica:
- - api_user: 'REPLACE_ME_WITH_YOUR_USER_ID'
- api_key: 'REPLACE_ME_WITH_YOUR_API_KEY'
+ - api_user: YOUR_USER_ID
+ api_key: YOUR_API_KEY
```
You can specify several users, providing `api_user` and `api_key` for each.
diff --git a/source/_components/homekit.markdown b/source/_components/homekit.markdown
index 77ec79577f6..d87844743f3 100644
--- a/source/_components/homekit.markdown
+++ b/source/_components/homekit.markdown
@@ -12,17 +12,17 @@ ha_release: 0.64
logo: apple-homekit.png
---
-The `HomeKit` component allows you to forward entities from Home Assistant to Apple `HomeKit`, so they can be controlled from Apple's `Home` app and `Siri`. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later.
+The `HomeKit` component allows you to forward entities from Home Assistant to Apple `HomeKit`, so they can be controlled from Apple's `Home` app and `Siri`. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later. However if you do encounter issues, checkout the [troubleshooting](#troubleshooting) section.
+
+
+ If you want to control `HomeKit` only devices with Home Assistant, check out the [HomeKit controller](/components/homekit_controller/) component. +
It might be necessary to install an additional package: `$ sudo apt-get install libavahi-compat-libdnssd-dev`
-- If you are upgrading Home Assistant from `0.65.x` and have used the HomeKit component, some accessories may not respond or may behave unusually. To fix these problems, you will need to remove the Home Assistant Bridge from your Home, stop Home Assistant and delete the `.homekit.state` file in your configuration folder and follow the Homekit [setup](#setup) steps again. -
- ```yaml # Example configuration.yaml entry configuring HomeKit homekit: @@ -129,9 +129,6 @@ homekit: default: '`switch`' {% endconfiguration %} -- If you use Z-Wave, or `discovery:` you'll need to disable auto-start, see the [section below](#disable-auto-start) for details on how to do this. You'll then need to start the HomeKit component once Z-Wave is ready, or an appropriate delay to allow your entities to be discovered. -
## {% linkable_title Setup %} @@ -145,17 +142,17 @@ homekit: After Home Assistant has started, the entities specified by the filter are exposed to `HomeKit` if they are [supported](#supported-components). To add them: 1. Open the Home Assistant frontend. A new card will display the `pin code`. 1. Open the `Home` app. -2. Choose `Add Accessory`, than select `Don't Have a Code or Can't Scan?` and enter the `pin code`. -4. Confirm the you are adding an `Uncertified Accessory` by clicking on `Add Anyway`. -5. Follow the setup be clicking on `Next` and lastly `Done` in the top right hand corner. -6. The `Home Assistant` Bridge and the Accessories should now be listed in the `Home` app. +2. Click `Add Accessory`, than select `Don't Have a Code or Can't Scan?` and choose the `Home Assistant Bridge`. +4. Confirm that you are adding an `Uncertified Accessory` by clicking on `Add Anyway`. +5. Enter the `PIN` code. +6. Follow the setup be clicking on `Next` and lastly `Done` in the top right hand corner. +7. The `Home Assistant` Bridge and the Accessories should now be listed in the `Home` app. After the setup is completed you should be able to control your Home Assistant components through `Home` and `Siri`. ## {% linkable_title Considerations %} - ### {% linkable_title Accessory ID %} Currently this component uses the `entity_id` to generate a unique `accessory id (aid)` for `HomeKit`. The `aid` is used to identify a device and save all configurations made for it. This however means that if you decide to change an `entity_id` all configurations for this accessory made in the `Home` app will be lost. @@ -175,7 +172,11 @@ A common situation might be if you decide to disable parts of the configuration Depending on your individual setup, it might be necessary to disable `Auto Start` for all accessories to be available for `HomeKit`. Only those entities that are fully setup when the `HomeKit` component is started, can be added. To start `HomeKit` when `auto_start: False`, you can call the service `homekit.start`. -If you have Z-Wave entities you want exposed to HomeKit then you'll need to disable auto start and then start it after the Z-Wave mesh is ready. This is because the Z-Wave entities won't be fully set up until then. This can be automated using an automation: +If you have Z-Wave entities you want exposed to HomeKit then you'll need to disable auto start and then start it after the Z-Wave mesh is ready. This is because the Z-Wave entities won't be fully set up until then. This can be automated using an automation. + +{% raw %} ```yaml @@ -278,38 +279,82 @@ The following components are currently supported: | sensor | CarbonDioxideSensor | All sensors that have `co2` as part of their `entity_id` or `co2` as their `device_class` | | sensor | LightSensor | All sensors that have `lm` or `lx` as their `unit_of_measurement` or `illuminance` as their `device_class` | | switch | Switch | Represented as a switch by default but can be changed by using `type` within `entity_config`. | +| water_heater | WaterHeater | All water_heater devices. | -## {% linkable_title Error reporting %} +## {% linkable_title Troubleshooting %} -If you encounter any issues or bug and want to report them on `GitHub`, please follow these steps to make it easier for others to help and get your issue solved. +### {% linkable_title Deleting the `.homekit.state` file %} + +The `.homekit.state` file can be found in the configurations directory. You might need to enable `view hidden files` to see it. + 1. **Stop** Home Assistant + 2. Delete the `.homekit.state` file + 3. **Start** Home Assistant + +### {% linkable_title Errors during pairing %} + +If you encounter any issues during pairing, make sure to + 1. **Stop** Home Assistant + 2. Delete the `.homekit.state` file + 3. Edit your configuration (see below) + 4. **Start** Home Assistant -1. Enable debugging mode: ```yaml logger: default: warning logs: - homeassistant.components.homekit: debug - pyhap: debug -``` -2. Reproduce the bug / problem you have encountered. -3. Stop Home Assistant and copy the log from the log file. That is necessary since some errors only get logged, when Home Assistant is being shutdown. -4. Follow this link: [home-assistant/issues/new](https://github.com/home-assistant/home-assistant/issues/new?labels=component: homekit) and open a new issue. -5. Fill out all fields and especially include the following information: - - The configuration entries for `homekit` and the `component` that is causing the issue. - - The log / traceback you have generated before. - - Screenshots of the failing entity in the `states` panel. + homeassistant.components.homekit: debug + pyhap: debug -## {% linkable_title Troubleshooting PIN not appearing %} - -In some instances, the PIN will not appear as a persistent status or in the log files despite deleting `.homekit.state`, enabling logging, and reboot. The log files will include the error ```Duplicate AID found when attempting to add accessory```. - -In such cases, modifying your configuration.yaml to add a filter limiting the included entities similar to the following: - -```yaml -filter: - include_domains: - - light +homekit: + filter: + include_entities: + - demo.demo ``` -Restart Home Assistant and re-attempt pairing - a persistent status should now correctly appear. +#### {% linkable_title PIN doesn't appear as persistent status %} +You might have paired the `Home Assistant Bridge` already. If not, delete the `.homekit.state` file ([guide](#deleting-the-homekitstate-file)). + +#### {% linkable_title `Home Assistant Bridge` doesn't appear in the Home App (for pairing) %} +For `Docker` users: make sure to set `network_mode: host`. Other reasons could be network related. Make sure to check your router configuration. For some it helped when the Home Assistant device was using WIFI, not LAN. Remember that the iOS device needs to be in the same local network as the Home Assistant device for paring. + +#### {% linkable_title Pairing hangs - zeroconf error %} +Paining eventually fails, you might see and an error message `NonUniqueNameException`. To resolve this, you need to replace a specific file. See the following git issues for more details: [home-assistant#14567](https://github.com/home-assistant/home-assistant/issues/14567) and [home-assistant#17181](https://github.com/home-assistant/home-assistant/issues/17181) + +#### {% linkable_title Pairing hangs - only works with debug config %} +Pairing works fine when the filter is set to only include `demo.demo`, but fails with normal config. See [specific entity doesn't work](#specific-entity-doesnt-work) + +#### {% linkable_title Duplicate AID found when attempting to add accessory %} +Two of your entities share the same `entity_id`. Either resolve this or configure the [filter](#configure-filter) to exclude them. + + +### {% linkable_title Issues during normal use %} + +#### {% linkable_title Pairing hangs - no error %} +Make sure that you don't try to add more then 100 accessories, see [device limit](#device-limit). In rare cases one of your entities doesn't work with the HomeKit component. Use the [filter](#configure-filter) to find out which one. Feel free to open a new issue in the `home-assistant` repo, so we can resolve it. + +#### {% linkable_title Some of my devices don't show up - Z-Wave / Discovery %} +See [disable auto start](#disable-auto-start) + +#### {% linkable_title My entity doesn't show up %} +Check if the domain of your entity is [supported](#supported-components). If it is, check your [filter](#configure-filter) settings. Make sure the spelling is correct, especially if you use `include_entities`. + +#### {% linkable_title HomeKit doesn't work on second Home Assistant instance %} +To use the HomeKit component with to different Home Assistant instances on the same local network, you need to set a custom name for at least one of them. [config/name](#name) + +#### {% linkable_title Specific entity doesn't work %} +Although we try our best, some entities don't work with the HomeKit component yet. The result will be that either pairing fails completely or all Home Assistant accessories will stop working. Use the filter to identify which entity is causing the issue. It's best to try pairing and step by step including more entities. If it works unpair and repeat until you find the one that is causing the issues. To help others and the developers, please open a new issue here: [home-assistant/issues/new](https://github.com/home-assistant/home-assistant/issues/new?labels=component: homekit) + +#### {% linkable_title Accessories are all listed as not responding %} +See [specific entity doesn't work](#specific-entity-doesnt-work) + +#### {% linkable_title Accessory not responding - after restart or update %} +See [device limit](#device-limit) + +#### {% linkable_title Accessory not responding - randomly %} +Unfortunately that sometimes happens at the moment. It might help to close the `Home` App and delete it from the cache. Usually the accessory should get back to responding after a few minutes at most. + +#### {% linkable_title Accessories not responding / behaving unusual - Upgrade from `0.65.x` %} +To fix this, you need to unpair the `Home Assistant Bridge`, delete the `.homekit.state` file ([guide](#deleting-the-homekitstate-file)) and pair it again. This should only be an issue if you're upgrading from `0.65.x` or below. + +[devices]: https://www.home-assistant.io/docs/configuration/devices/ diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index 64783bc44e2..86ff3df552e 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -34,28 +34,83 @@ homematic: Configuration variables (global): -- **interfaces** (*Required*): Configuration for each XML-RPC interface to integrate into Home Assistant. -- **hosts** (*Optional*): Configuration for each Hub (CCU/Homegear) to integrate into Home Assistant. -- **local_ip** (*Optional*): IP of device running Home Assistant. Override auto-detected value for exotic network setups. -- **local_port** (*Optional*): Port for connection with Home Assistant. By default it is randomly assigned. +{% configuration %} +interfaces: + description: Configuration for each XML-RPC interface to integrate into Home Assistant. + required: true + type: list +hosts: + description: Configuration for each Hub (CCU/Homegear) to integrate into Home Assistant. + required: false + type: list +local_ip: + description: IP of device running Home Assistant. Override auto-detected value for exotic network setups. + required: false + type: string +local_port: + description: Port for connection with Home Assistant. By default it is randomly assigned. + required: false + type: integer +{% endconfiguration %} Configuration variables (interface): -- **host** (*Required*): IP address or Hostname of CCU/Homegear device or Hass.io add-on. -- **port** (*Optional*): Port of CCU/Homegear XML-RPC Server. Wireless: 2001, wired: 2000, IP: 2010, thermostatgroups: 9292. -- **callback_ip** (*Optional*): Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.). -- **callback_port** (*Optional*): Set this, if Home Assistant is reachable under a different port from the CCU (NAT, Docker etc.). -- **resolvenames** (*Optional*): [`metadata`, `json`, `xml`] Try to fetch device names. Defaults to `false` if not specified. -- **jsonport** (*Optional*): Port of CCU JSON-RPC Server. The default is 80, but it may be different when running CCU virtually via Docker. -- **username** (*Optional*): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU. -- **password** (*Optional*): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above. -- **path** (*Optional*): Set to `/groups` when using port 9292. +{% configuration %} +host: + description: IP address or Hostname of CCU/Homegear device or Hass.io add-on. + required: true + type: string +port: + description: "Port of CCU/Homegear XML-RPC Server. Wireless: 2001, wired: 2000, IP: 2010, thermostatgroups: 9292." + required: false + type: integer +callback_ip: + description: Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.). + required: false + type: string +callback_port: + description: Set this, if Home Assistant is reachable under a different IP from the CCU (NAT, Docker etc.). + required: false + type: integer +resolvenames: + description: Try to fetch device names. Defaults to `false` if not specified. + required: false + type: string + default: false +jsonport: + description: Port of CCU JSON-RPC Server. The default is 80, but it may be different when running CCU virtually via Docker. + required: false + type: integer +username: + description: When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU. + required: false + type: string +password: + description: When fetching names via JSON-RPC, you need to specify the password of the user you have configured above. + required: false + type: string +path: + description: Set to `/groups` when using port 9292. + required: false + type: string +{% endconfiguration %} Configuration variables (host): -- **host** (*Required*): IP address of CCU/Homegear device. -- **username** (*Optional*): When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU. -- **password** (*Optional*): When fetching names via JSON-RPC, you need to specify the password of the user you have configured above. +{% configuration %} +host: + description: IP address of CCU/Homegear device. + required: true + type: string +username: + description: When fetching names via JSON-RPC, you need to specify a user with guest-access to the CCU. + required: false + type: string +password: + description: When fetching names via JSON-RPC, you need to specify the password of the user you have configured above. + required: false + type: string +{% endconfiguration %} #### Example configuration with multiple protocols and some other options set: @@ -320,7 +375,7 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi string now = system.Date("%d.%m.%Y %H:%M:%S"); obj.State(now); ``` - + The HomeMatic CCU will execute all active programs which meet their conditions (none in this case) on every reboot. 3. Set up a template sensor in Home Assistant, which contains the value of the system variable: diff --git a/source/_components/http.markdown b/source/_components/http.markdown index 3c3b20ca888..c80fbf4c31c 100644 --- a/source/_components/http.markdown +++ b/source/_components/http.markdown @@ -62,7 +62,7 @@ cors_allowed_origins: required: false type: string, list use_x_forwarded_for: - description: "Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You **must** also whitelist trusted proxies using the `trusted_proxies` setting above for this to work. Non-whitelisted requests with this header will be considered IP spoofing attacks, and the header will, therefore, be ignored." + description: "Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups. You **must** also whitelist trusted proxies using the `trusted_proxies` setting for this to work. Non-whitelisted requests with this header will be considered IP spoofing attacks, and the header will, therefore, be ignored." required: false type: boolean default: false diff --git a/source/_components/ifttt.markdown b/source/_components/ifttt.markdown index 511390b52a5..f2b83c028d8 100644 --- a/source/_components/ifttt.markdown +++ b/source/_components/ifttt.markdown @@ -34,7 +34,8 @@ You can then consume that information with the following automation: ```yaml automation: trigger: - event: ifttt_webhook_received + platform: event + event_type: ifttt_webhook_received event_data: action: call_service action: @@ -48,7 +49,7 @@ automation: ```yaml # Example configuration.yaml entry ifttt: - key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + key: YOUR_API_KEY ``` `key` is your API key which can be obtained by viewing the **Settings** of the [Webhooks applet](https://ifttt.com/services/maker_webhooks/settings). It's the last part of the URL (e.g., https://maker.ifttt.com/use/MYAPIKEY) you will find under **My Applets** > **Webhooks** > **Settings**. diff --git a/source/_components/image_processing.dlib_face_detect.markdown b/source/_components/image_processing.dlib_face_detect.markdown index f4275902565..368d4c78ba4 100644 --- a/source/_components/image_processing.dlib_face_detect.markdown +++ b/source/_components/image_processing.dlib_face_detect.markdown @@ -27,8 +27,18 @@ image_processing: - entity_id: camera.door ``` -Configuration variables: - -- **source** array (*Required*): List of image sources. - - **entity_id** (*Required*): A camera entity id to get picture from. - - **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity. +{% configuration %} +source: + description: List of image sources. + required: true + type: list + keys: + entity_id: + description: A camera entity id to get picture from. + required: true + type: string + name: + description: This parameter allows you to override the name of your `image_processing` entity. + required: false + type: string +{% endconfiguration %} diff --git a/source/_components/image_processing.facebox.markdown b/source/_components/image_processing.facebox.markdown index 5723f5abaa8..f2aa6353685 100644 --- a/source/_components/image_processing.facebox.markdown +++ b/source/_components/image_processing.facebox.markdown @@ -24,7 +24,7 @@ MB_KEY="INSERT-YOUR-KEY-HERE" sudo docker run --name=facebox --restart=always -p 8080:8080 -e "MB_KEY=$MB_KEY" machinebox/facebox ``` -You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USER=my_username" -e "MB_BASICAUTH_PASS=my_password"` but bare in mind that the component does not encrypt these credentials and this approach does not guarantee security on an unsecured network. +You can run Facebox with a username and password by adding `-e "MB_BASICAUTH_USER=my_username" -e "MB_BASICAUTH_PASS=my_password"` but bear in mind that the component does not encrypt these credentials and this approach does not guarantee security on an unsecured network. If you only require face detection (number of faces) you can disable face recognition by adding `-e "MB_FACEBOX_DISABLE_RECOGNITION=true"` to the `docker run` command. @@ -98,7 +98,7 @@ Use the `image_processing.detect_face` events to trigger automations, and breako ## {% linkable_title Service `facebox_teach_face` %} -The service `facebox_teach_face` can be used to teach Facebox faces. +The service `facebox_teach_face` can be used to teach Facebox faces. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | @@ -133,7 +133,7 @@ You can use an automation to receive a notification when you train a face: action: - service: notify.pushbullet data_template: - message: '{{ trigger.event.data.service_data.name }} taught + message: '{{ trigger.event.data.service_data.name }} taught with file {{ trigger.event.data.service_data.file_path }}' title: Face taught notification ``` @@ -166,6 +166,3 @@ you can create an automation to receive notifications on Facebox errors: ``` {% endraw %} -## {% linkable_title Optimising resources %} - -[Image processing components](https://www.home-assistant.io/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. diff --git a/source/_components/image_processing.markdown b/source/_components/image_processing.markdown index 1f1507bf280..d2dfd222ce2 100644 --- a/source/_components/image_processing.markdown +++ b/source/_components/image_processing.markdown @@ -12,17 +12,15 @@ ha_release: 0.36 Image processing enables Home Assistant to process images from [cameras](/components/#camera). Only camera entities are supported as sources. -For interval control, use `scan_interval` in platform. -
If you are running Home Assistant over SSL or from within a container, you will have to setup a base URL (`base_url`) inside the [http component](/components/http/).
## {% linkable_title ALPR %} -Alpr entities attribute have a vehicle counter `vehicles` and all found plates as `plates`. +ALPR entities have a vehicle counter attribute `vehicles` and all found plates are stored in the `plates` attribute. -This event is trigger after OpenALPR found a new license plate. +The `found_plate` event is triggered after OpenALPR has found a new license plate. ```yaml # Example configuration.yaml automation entry @@ -41,9 +39,9 @@ The following event attributes will be present (platform-dependent): `entity_id` ## {% linkable_title Face %} -Face entities attribute have a face counter `total_faces` and all face data as `faces`. +Face entities have a face counter attribute `total_faces` and all face data is stored in the `faces` attribute. -This event is trigger after Microsoft Face found a faces. +The `detect_face` event is triggered after a Face entity has found a face. ```yaml # Example configuration.yaml automation entry @@ -59,3 +57,26 @@ automation: ``` The following event attributes will be present (platform-dependent): `entity_id`, `name`, `confidence`, `age`, `gender`, `motion`, `glasses` + +## {% linkable_title scan_interval and Optimising Resources %} + +Image processing components process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing. + +```yaml +# Example configuration.yaml +sensor: +- platform: _AN_IMAGE_PROCESSING_PLATFORM_ + scan_interval: 10000 +... +automation: +- alias: Scan for faces when motion detected + trigger: + - platform: state + entity_id: sensor.door_motion_sensor + to: 'on' + action: + - service: image_processing.scan + data: + entity_id: image_processing.door +... +``` diff --git a/source/_components/image_processing.microsoft_face_detect.markdown b/source/_components/image_processing.microsoft_face_detect.markdown index 330ff1f0f63..70d59e403c6 100644 --- a/source/_components/image_processing.microsoft_face_detect.markdown +++ b/source/_components/image_processing.microsoft_face_detect.markdown @@ -18,11 +18,15 @@ The `microsoft_face_detect` image processing platform allows you to use the API through Home Assistant. This platform enables you do detect face on camera and fire an event with attributes. -Please refer to the [component](/components/microsoft_face/) configuration on +Please refer to the [Microsoft Face component](/components/microsoft_face/) configuration on how to setup the API key. For using the result inside an automation rule, -take a look at the [component](/components/image_processing/) page. +take a look at the [Image Processing component](/components/image_processing/) page. + ++The free version of the Microsoft Face identify API limits the number of requests possible per month. Therefore, it is strongly recommended that you limit the `scan_interval` when setting up an instance of this entity as detailed on the main [Image Processing component](/components/image_processing/) page. +
### {% linkable_title Configuration %} diff --git a/source/_components/image_processing.microsoft_face_identify.markdown b/source/_components/image_processing.microsoft_face_identify.markdown index da3b931f1ab..aad6ae072cd 100644 --- a/source/_components/image_processing.microsoft_face_identify.markdown +++ b/source/_components/image_processing.microsoft_face_identify.markdown @@ -18,11 +18,15 @@ The `microsoft_face_identify` image processing platform lets you use API through Home Assistant. This platform allow you do identify persons on camera and fire an event with attributes. -Please refer to the [component](/components/microsoft_face/) configuration on +Please refer to the [Microsoft Face component](/components/microsoft_face/) configuration on how to setup the API key. For using the result inside an automation rule, -take a look at the [component](/components/image_processing/) page. +take a look at the [Image Processing component](/components/image_processing/) page. + ++The free version of the Microsoft Face identify API limits the number of requests possible per month. Therefore, it is strongly recommended that you limit the `scan_interval` when setting up an instance of this entity as detailed on the main [Image Processing component](/components/image_processing/) page. +
### {% linkable_title Configuration %} diff --git a/source/_components/image_processing.openalpr_cloud.markdown b/source/_components/image_processing.openalpr_cloud.markdown index 9149f802815..6576c55db3b 100644 --- a/source/_components/image_processing.openalpr_cloud.markdown +++ b/source/_components/image_processing.openalpr_cloud.markdown @@ -26,10 +26,10 @@ take a look at the [component](/components/image_processing/) page. # Example configuration.yaml entry image_processing: - platform: openalpr_cloud - api_key: 'sk_abcxyz123456' + api_key: YOUR_API_KEY region: eu source: - - entity_id: camera.garage + - entity_id: CAMERA.GARAGE ``` {% configuration %} diff --git a/source/_components/insteon.markdown b/source/_components/insteon.markdown index d52e115b918..03e81cd3072 100644 --- a/source/_components/insteon.markdown +++ b/source/_components/insteon.markdown @@ -13,12 +13,8 @@ ha_iot_class: "Local Push" ha_version: 0.77 --- -This component adds "local push" support for INSTEON Modems allowing -linked INSTEON devices to be used within Home Assistant as binary sensors, -lights, fans, sensors and switches. 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. It has also been -tested to work with the [2242] and [2245] Hubs. +This component adds "local push" support for INSTEON Modems allowing linked INSTEON devices to be used within Home Assistant as binary sensors, lights, fans, sensors and switches. 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. It has also been tested to work with the [2242] and [2245] Hubs. [insteonplm]: https://github.com/nugget/python-insteonplm [2413U]: https://www.insteon.com/powerlinc-modem-usb @@ -27,11 +23,9 @@ tested to work with the [2242] and [2245] Hubs. [2245]: https://www.insteon.com/insteon-hub/ [2242]: https://www.insteon.com/support-knowledgebase/2014/9/26/insteon-hub-owners-manual - ### {% linkable_title INSTEON Modem configuration %} -To set up an INSTEON Powerline Modem (PLM) device such as the [2413U], use the -following configuration: +To set up an INSTEON Powerline Modem (PLM) device such as the [2413U], use the following configuration: ```yaml # PLM configuration variables @@ -40,7 +34,7 @@ insteon: ``` To set up an INSTEON Hub model [2245], use the following configuration: - + ```yaml # Hub 2245 configuration variables insteon: @@ -81,92 +75,111 @@ insteon: x10_all_lights_on: HOUSECODE x10_all_lights_off: HOUSECODE ``` -Configuration variables: -- **port** (*Required for PLM setup*): The serial or USB port for your device, - e.g., `/dev/ttyUSB0` or `COM3` -- **host** (*Required for Hub setup*): The host name or IP address of the Hub. -- **ip_port** (*Optional for Hub setup*): The IP port number of the Hub. For - Hub model [2245] (i.e. Hub version 2) the default port is 25105. For the Hub - model [2242] (i.e. Hub version 1) the default port is 9761. Use the Insteon - app to find the port number for your specific Hub. -- **username** (*Required for Hub version 2 setup*): The username to login in - to the local Hub. This is required for Hub [2245] (i.e. Hub version 2) setup. - You can find your Hub username on the bottom of the Hub or you can use the - Insteon app. -- **password** (*Required for Hub version 2 setup*): The password to login in - to the local Hub. This is required for Hub [2245] (i.e. Hub version 2) setup. - You can find your Hub password on the bottom of the Hub or you can use the - Insteon app. -- **hub_version** (*Required for Hub version 1 setup*): The Hub version number - where model [2242] is Hub version 1 and model [2245] is Hub version 2. - (Default is 2) -- **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 a binary_sensor that responds - to the X10 standard command for All Units Off. -- **x10_all_lights_on** (*Optional*): Creates a binary_sensor that responds - to the X10 standard command for All Lights On -- **x10_all_lights_off** (*Optional*): Creates a binary_sensor that responds - to the X10 standard command for All Lights Off + +{% configuration %} +port: + description: The serial or USB port for your device, e.g., `/dev/ttyUSB0` or `COM3`. + required: Required for PLM setup + type: string +host: + description: The host name or IP address of the Hub. + required: Required for Hub setup + type: string +ip_port: + description: The IP port number of the Hub. For Hub model [2245] (i.e. Hub version 2) the default port is 25105. For the Hub model [2242] (i.e. Hub version 1) the default port is 9761. Use the Insteon app to find the port number for your specific Hub. + required: Optional for Hub setup + type: integer +username: + description: The username to login in to the local Hub. You can find your Hub username on the bottom of the Hub or you can use the Insteon app. + required: Required for Hub version 2 setup + type: string +password: + description: The password to login in to the local Hub. You can find your Hub password on the bottom of the Hub or you can use the Insteon app. + required: Required for Hub version 2 setup + type: string +hub_version: + description: The Hub version number where model [2242] is Hub version 1 and model [2245] is Hub version 2. + required: Required for Hub version 1 setup + default: 2 + type: integer +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. + required: true + type: string + cat: + description: is found in the back of the device's User Guide in the form of 0x00 - 0xff. + required: false + type: integer + subcat: + description: is found in the back of the device's User Guide in the form of 0x00 - 0xff. + required: false + type: integer + firmware: + description: are more advanced options and will typically not be used. + required: false + type: string + product_key: + description: are more advanced options and will typically not be used. + required: false + type: integer +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 + required: true + type: string + unitcode: + description: is the X10 unit code values 1 - 16 + required: true + type: integer + platform: + description: "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." + required: true + type: string + dim_steps: + description: is the number of dim/bright steps the device supports. Used for dimmable X10 devices only. + required: false + default: 22 + type: integer +x10_all_units_off: + description: Creates a binary_sensor that responds to the X10 standard command for All Units Off. + required: false + type: string +x10_all_lights_on: + description: Creates a binary_sensor that responds to the X10 standard command for All Lights On + required: false + type: string +x10_all_lights_off: + description: Creates a binary_sensor that responds to the X10 standard command for All Lights Off + required: false + type: string +{% 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 INSTEON Modem -as either a responder or a controller. +In order for a device to be discovered, it must be linked to the INSTEON Modem as either a responder or a controller. ### {% linkable_title Linking Devices to the INSTEON Modem %} -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 Modem 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 Modem module supports All-Linking through [Development Tools] service calls. The following services are available: -- **insteon.add_all_link**: Puts the Insteon Modem (IM) into All-Linking -mode. The IM can be set as a controller or a responder. If the IM is a -controller, put the IM into linking mode then press the SET button on the -device. If the IM is a responder, press the SET button on the device then -put the IM into linking mode. -- **insteon.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 SET button on the corresponding device -to complete the process. -- **insteon.load_all_link_database**: Load the All-Link Database for a -device. WARNING - Loading a device All-Link database may take a LONG time and -may need to be repeated to obtain all records. -- **insteon.print_all_link_database**: Print the All-Link Database for a -device. Requires that the All-Link Database is loaded first. -- **insteon.print_im_all_link_database**: Print the All-Link Database for -the INSTEON Modem (IM). +- **insteon.add_all_link**: Puts the Insteon Modem (IM) into All-Linking mode. The IM can be set as a controller or a responder. If the IM is a controller, put the IM into linking mode then press the SET button on the device. If the IM is a responder, press the SET button on the device then put the IM into linking mode. +- **insteon.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 SET button on the corresponding device to complete the process. +- **insteon.load_all_link_database**: Load the All-Link Database for a device. WARNING - Loading a device All-Link database may take a LONG time and may need to be repeated to obtain all records. +- **insteon.print_all_link_database**: Print the All-Link Database for a device. Requires that the All-Link Database is loaded first. +- **insteon.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/ @@ -174,36 +187,24 @@ carefully, they are important. [Insteon Terminal]: https://github.com/pfrommerd/insteon-terminal [insteonplm_interactive]: https://github.com/nugget/python-insteonplm#command-line-interface -### {% linkable_title Customization %} +### {% linkable_title Customization %} -The only configuration item that is necessary is the PLM port or Hub IP -address, username and password so that Home Assistant can connect to the -INSTEON Modem. 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 necessary is the PLM port or Hub IP address, username and password so that Home Assistant can connect to the INSTEON Modem. 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. +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/ -### {% linkable_title Device Overrides %} +### {% 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 devices 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 devices are built into the Home Assistant platform. Changing the platform is not recommended. -### {% linkable_title Example Configuration with Options%} +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%} ```yaml # Full example of Insteon configuration with customizations and overrides @@ -221,15 +222,12 @@ insteon: device_override: - address: a1b2c3 # Hidden Door Sensor [2845-222] cat: 0x10 - subcat: 0x11 + subcat: 0x11 ``` ### {% linkable_title What NOT to do %} -Insteon Modem 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 Modem 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: @@ -239,26 +237,18 @@ light: ### {% linkable_title Events and Mini-Remotes %} -Mini-Remote devices do not appear as Home Assistant entities. They generate -events. The following events are available: +Mini-Remote devices do not appear as Home Assistant entities, they generate events. The following events are available: - **insteon.button_on** - - **address**: (required) The Insteon device address in lower case without - dots (e.g., 1a2b3c) - - **button**: (Optional) The button id in lower case. For a 4-button remote - the values are `a` to `d`. For an 8 button remote the values are `a` to `g`. For - a one-button remote this field is not used. + - **address**: (required) The Insteon device address in lower case without dots (e.g., 1a2b3c) + - **button**: (Optional) The button id in lower case. For a 4-button remote the values are `a` to `d`. For an 8 button remote the values are `a` to `g`. For a one-button remote this field is not used. - **insteon.button_of** - - **address**: (required) The Insteon device address in lower case without - dots (e.g., 1a2b3c) - - **button**: (Optional) The button id in lower case. For a 4-button remote - the values are a to d. For an 8 button remote the values are `a` to `g`. For - a one-button remote this field is not used. + - **address**: (required) The Insteon device address in lower case without dots (e.g., 1a2b3c) + - **button**: (Optional) The button id in lower case. For a 4-button remote the values are a to d. For an 8 button remote the values are `a` to `g`. For a one-button remote this field is not used. -This allows the mini-remotes to be configured as triggers for automations. Here -is an example of how to use these events for automations: +This allows the mini-remotes to be configured as triggers for automations. Here is an example of how to use these events for automations: -``` +```yaml automation: # 4 or 8 button remote with button c pressed trigger: @@ -292,17 +282,10 @@ automation: ### {% linkable_title Known Issues with the INSTEON Hub %} -The INSTEON Hub has three known issues that are inherent to the design of the -Hub: +The INSTEON Hub has three known issues that are inherent to the design of the Hub: -1. If you see multiple error messages in the log file stating the Hub -connection is closed, and reconnection has failed, this generally requires -the Hub to be restarted to reconnect. +1. If you see multiple error messages in the log file stating the Hub connection is closed, and reconnection has failed, this generally requires the Hub to be restarted to reconnect. -2. You cannot use both Home Assistant and the INSTEON app. If you do, the -changes made in the app will not appear in Home Assistant. Changes made in -Home Assistant will appear in the app after a period of time, however. +2. You cannot use both Home Assistant and the INSTEON app. If you do, the changes made in the app will not appear in Home Assistant. Changes made in Home Assistant will appear in the app after a period of time, however. -3. The Hub response times can be very slow. This is due to the Hub polling -devices frequently. Since only one INSTEON message can be broadcast at a time, -messages to and from Home Assistant can be delayed. +3. The Hub response times can be very slow. This is due to the Hub polling devices frequently. Since only one INSTEON message can be broadcast at a time, messages to and from Home Assistant can be delayed. diff --git a/source/_components/insteon_local.markdown b/source/_components/insteon_local.markdown index c79b46b2e4e..25f8d157650 100644 --- a/source/_components/insteon_local.markdown +++ b/source/_components/insteon_local.markdown @@ -15,4 +15,4 @@ ha_version: 0.36 The `insteon_local` component is depreciated and has been replaced by the [insteon] component. -[insteon]: /component/insteon +[insteon]: /components/insteon diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index bed0e71ccb6..ff8d33a1527 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -15,4 +15,4 @@ ha_version: 0.39 The `insteon_plm` component is depreciated and has been replaced by the [insteon] component. -[insteon]: /component/insteon +[insteon]: /components/insteon diff --git a/source/_components/joaoapps_join.markdown b/source/_components/joaoapps_join.markdown index 61ef1c09c9c..abc7f3eedf5 100644 --- a/source/_components/joaoapps_join.markdown +++ b/source/_components/joaoapps_join.markdown @@ -28,15 +28,15 @@ To set it up, add the following information to your `configuration.yaml` file: # Example configuration.yaml entry notify: - platform: joaoapps_join - api_key: asd97823jb628a34fwsdfwefd5384345tf2d - device_id: d5asdfasdf54645h45h368761dfe5gt8a - device_ids: d5asdfasdf54645h45h368761dfe5gt8a, a4asdfasdf54645h45h368761dfe5gt3b - device_names: Pixel, iPhone - name: Phones + api_key: YOUR_API_KEY + device_id: DEVICE_ID + device_ids: DEVICE_ID_1, DEVICE_ID_2 + device_names: DEVICE_1_NAME, DEVICE_2_NAME + name: NAME joaoapps_join: - - name: android - device_id: group.android - api_key: asd97823jb628a34fwsdfwefd5384345tf2d + - name: NAME_OF_GROUP + device_id: GROUP.GROUP_NAME + api_key: YOUR_API_KEY ``` {% configuration %} diff --git a/source/_components/juicenet.markdown b/source/_components/juicenet.markdown index a6eae2eb3cd..421b981a02e 100644 --- a/source/_components/juicenet.markdown +++ b/source/_components/juicenet.markdown @@ -24,6 +24,9 @@ juicenet: access_token: ACCESS_TOKEN ``` -Configuration variables: - -- **access_token** (*Required*): Your eMotorWerks API Token can be found in the [dashboard](https://dashboard.emotorwerks.com/Manage). +{% configuration %} +access_token: + description: "Your eMotorWerks API Token can be found in the [dashboard](https://dashboard.emotorwerks.com/Manage)." + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/konnected.markdown b/source/_components/konnected.markdown index cd55944cb37..dc7104dba18 100644 --- a/source/_components/konnected.markdown +++ b/source/_components/konnected.markdown @@ -116,6 +116,25 @@ devices: repeat: description: Number of times to repeat a momentary pulse. Set to `-1` to make an infinite repeat. This is useful as an alarm or warning when used with a piezo buzzer. required: false + host: + type: string + required: false + description: Optionally specify the Konnected device's IP address or hostname to set up without discovery. + port: + type: integer + required: false + description: Optionally specify the port number for the Konnected API on the device. Note that the port is different on every device. See help.konnected.io to learn how to determine the port number. + discovery: + type: boolean + required: false + default: true + description: Enable or disable discovery for this device. When `true`, the device will respond to discovery requests on your network. When `false`, the device will not respond to discovery requests, so it's important that you set reserved IP for the device and configure the _host_ and _port_ here. + blink: + type: boolean + required: false + default: true + description: Blink the blue LED upon successful transmission of a state change. + {% endconfiguration%} #### {% linkable_title Configuration Notes %} @@ -188,6 +207,10 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use ### {% linkable_title Revision History %} +#### 0.80 +* Added ability to specify `host` and `port` to set up devices without relying on discovery. +* Added `discovery` and `blink` config options to enable/disable these features. + #### 0.79 * Added `inverse` configuration option for binary sensors. diff --git a/source/_components/lifx.markdown b/source/_components/lifx.markdown new file mode 100644 index 00000000000..11c478c6421 --- /dev/null +++ b/source/_components/lifx.markdown @@ -0,0 +1,132 @@ +--- +layout: page +title: "LIFX" +description: "Instructions on how to integrate LIFX into Home Assistant." +date: 2018-10-08 08:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: lifx.png +ha_category: Light +ha_iot_class: "Local Polling" +ha_release: 0.81 +--- + +The `lifx` component allows you to integrate your [LIFX](https://www.lifx.com) into Home Assistant. + +_Please note, the `lifx` component does not support Windows. The `lifx_legacy` light platform (supporting basic functionality) can be used instead._ + +You can configure the LIFX component by going to the integrations page inside the config panel. + +## {% linkable_title Set state %} + +The LIFX bulbs allow a change of color and brightness even when they are turned off. This way you can control the light during the day so its settings are correct when events for turning on are received, for example from motion detectors or external buttons. + +The normal `light.turn_on` call cannot be used for this because it always turns the power on. Thus, LIFX has its own service call that allows color changes without affecting the current power state. + +### {% linkable_title Service `light.lifx_set_state` %} + +Change the light to a new state. + +| Service data attribute | Description | +| ---------------------- | ----------- | +| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all. +| `transition` | Duration (in seconds) for the light to fade to the new state. +| `zones` | List of integers for the zone numbers to affect (each LIFX Z strip has 8 zones, starting at 0). +| `infrared` | Automatic infrared level (0..255) when light brightness is low (for compatible bulbs). +| `power` | Turn the light on (`True`) or off (`False`). Leave out to keep the power as it is. +| `...` | Use `color_name`, `brightness` etc. from [`light.turn_on`]({{site_root}}/components/light/#service-lightturn_on) to specify the new state. + +## {% linkable_title Light effects %} + +The LIFX platform supports several light effects. You can start these effects with default options by using the `effect` attribute of the normal [`light.turn_on`]({{site_root}}/components/light/#service-lightturn_on) service, for example like this: +```yaml +automation: + - alias: ... + trigger: + # ... + action: + - service: light.turn_on + data: + entity_id: light.office, light.kitchen + effect: lifx_effect_pulse +``` + +However, if you want to fully control a light effect, you have to use its dedicated service call, like this: +```yaml +script: + colorloop_start: + alias: 'Start colorloop' + sequence: + - service: light.lifx_effect_colorloop + data: + entity_id: group.livingroom + brightness: 255 + period: 10 + spread: 30 + change: 35 +``` + +The available light effects and their options are listed below. + +### {% linkable_title Service `light.lifx_effect_pulse` %} + +Run a flash effect by changing to a color and then back. + +| Service data attribute | Description | +| ---------------------- | ----------- | +| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all. +| `color_name` | A color name such as `red` or `green`. +| `rgb_color` | A list containing three integers representing the RGB color you want the light to be. +| `brightness` | Integer between 0 and 255 for how bright the color should be. +| `period` | The duration of a single pulse (in seconds). +| `cycles` | The total number of pulses. +| `mode` | The way to change between colors. Valid modes: `blink` (default), `breathe`, `ping`, `strobe`, `solid`. +| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True). + +### {% linkable_title Service `light.lifx_effect_colorloop` %} + +Run an effect with colors looping around the color wheel. All participating lights will coordinate to keep similar (but not identical) colors. + +| Service data attribute | Description | +| ---------------------- | ----------- | +| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all. +| `brightness` | Number between 0 and 255 indicating brightness of the effect. Leave this out to maintain the current brightness of each participating light. +| `period` | Duration (in seconds) between starting a new color change. +| `transition` | Duration (in seconds) where lights are actively changing color. +| `change` | Hue movement per period, in degrees on a color wheel (ranges from 0 to 359). +| `spread` | Maximum color difference between participating lights, in degrees on a color wheel (ranges from 0 to 359). +| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True). + +### {% linkable_title Service `light.lifx_effect_stop` %} + +Run an effect that does nothing, thereby stopping any other effect that might be running. + +| Service data attribute | Description | +| ---------------------- | ----------- | +| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all. + + +## {% linkable_title Advanced configuration %} + +There are some manual configuration options available. These should only be needed if you have more than one network interface and automatic configuration does not find your LIFX devices. + +```yaml +# Example configuration.yaml entry +lifx: + light: + server: IP_ADDRESS + broadcast: IP_ADDRESS +``` + +{% configuration %} +server: + description: Your server address. Will listen on all interfaces if omitted. + required: false + type: string +broadcast: + description: The broadcast address for discovering lights. + required: false + type: string +{% endconfiguration %} diff --git a/source/_components/light.avion.markdown b/source/_components/light.avion.markdown index 68c40b1aac4..7290fcedb01 100644 --- a/source/_components/light.avion.markdown +++ b/source/_components/light.avion.markdown @@ -15,6 +15,20 @@ ha_release: 0.37 Support for the Avi-on Bluetooth dimmer switch [Avi-On](http://avi-on.com/). +## {% linkable_title Setup %} + +If you want to add your devices manually (like in the example below) then you need to get the API key. The API key can be obtained by executing the following command: + +```bash +$ curl -X POST -H "Content-Type: application/json" \ + -d '{"email": "fakename@example.com", "password": "password"}' \ + https://admin.avi-on.com/api/sessions | jq +``` + +with the email and password fields replaced with those used when registering the device via the mobile app. The pass phrase field of the output should be used as the API key in the configuration. + +## {% linkable_title Configuration %} + To enable these lights, add the following lines to your `configuration.yaml` file: ```yaml @@ -23,16 +37,31 @@ light: - platform: avion ``` -Configuration variables: +{% configuration %} +username: + description: The username used in the Avion app. If username and password are both provided, all associated switches will automatically be added to your configuration. + required: false + type: string +password: + description: The password used in the Avion app. + required: false + type: string +devices: + description: An optional list of devices with their Bluetooth addresses. + required: false + type: list + keys: + name: + description: A custom name to use in the frontend. + required: false + type: string + api_key: + description: The API Key. + required: true + type: string +{% endconfiguration %} -- **username** (*Optional*): The username used in the Avion app. If username and password are both provided, any associated switches will automatically be added to your configuration. -- **password** (*Optional*): The password used in the Avion app. -- **devices** (*Optional*): An optional list of devices with their Bluetooth address, a custom name to use in the frontend and the API key. The API key can be obtained by executing the following command: -``` -curl -X POST -H "Content-Type: application/json" -d '{"email": "fakename@example.com", "password": "password"}' https://admin.avi-on.com/api/sessions | jq -``` - -with the email and password fields replaced with those used when registering the device via the mobile app. The pass phrase field of the output should be used as the API key in the configuration. +## {% linkable_title Full example %} If username and password are not supplied, devices must be configured manually like so: @@ -43,8 +72,8 @@ light: devices: 00:21:4D:00:00:01: name: Light 1 - api_key: Gr35a/rt3RgaRenl9ag8Ba== + api_key: YOUR_API_KEY 00:21:3D:20:00:a1: name: Light 2 - api_key: Gr35a/rt3RgaRenl9ag8Ba== + api_key: YOUR_API_KEY ``` diff --git a/source/_components/light.decora.markdown b/source/_components/light.decora.markdown index b9f0063e3f5..44df220f9da 100644 --- a/source/_components/light.decora.markdown +++ b/source/_components/light.decora.markdown @@ -25,15 +25,28 @@ light: - platform: decora devices: 00:21:4D:00:00:01: - api_key: 0x12345678 + api_key: YOUR_API_KEY ``` -Configuration variables: - -- **devices** array (*Required*): A list of lights to use. - - **[mac address]** (*Required*): The bluetooth address of the switch. - - **name** (*Optional*): The custom name to use in the frontend. - - **api_key** (*Required*): The API key to access the device. +{% configuration %} +devices: + description: A list of lights to use. + required: true + type: map + keys: + mac_address: + required: true + description: The bluetooth address of the switch. + type: string + name: + description: The name to use in the frontend. + required: false + type: string + api_key: + description: The API key to access the device. + required: true + type: string +{% endconfiguration %}If you get an error looking like this: diff --git a/source/_components/light.elkm1.markdown b/source/_components/light.elkm1.markdown new file mode 100644 index 00000000000..2dfa79a4114 --- /dev/null +++ b/source/_components/light.elkm1.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: "Elk-M1 Light" +description: "Instructions how to integrate Elk-M1 light." +date: 2018-10-07 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: elkproducts.png +ha_release: 0.81 +ha_category: Light +ha_iot_class: "Local Push" +--- + +The `elkm1` platform allows you to control your [Elk-M1](https://www.elkproducts.com/m1_controls.html). + +An Elk-M1 light (which can be X10, Insteon, UPB) is represented as a `light`. + +
+Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page. +
diff --git a/source/_components/light.flux_led.markdown b/source/_components/light.flux_led.markdown index d53ebb88a69..426feb16ae1 100644 --- a/source/_components/light.flux_led.markdown +++ b/source/_components/light.flux_led.markdown @@ -40,17 +40,31 @@ light: - platform: flux_led ``` -Configuration variables: - -- **automatic_add** (*Optional*): To enable the automatic addition of lights on startup. -- **devices** (*Optional*): A list of devices with their ip address - -Configuration variables within devices list: - -- **name** (*Optional*): A friendly name for the device. -- **mode** (*Optional*): The chosen brightness mode; options are 'rgbw' and 'rgb', defaults to rgbw. -- **protocol** (*Optional*): Set this to 'ledenet' if you are using a ledenet bulb. - +{% configuration %} +automatic_add: + description: To enable the automatic addition of lights on startup. + required: false + default: false + type: boolean +devices: + description: A list of devices with their ip address + required: false + type: list + keys: + name: + description: A friendly name for the device. + required: false + type: string + mode: + description: "The chosen brightness mode, options are: 'rgbw' and 'rgb'." + required: false + default: rgbw + type: string + protocol: + description: Set this to 'ledenet' if you are using a ledenet bulb. + required: false + type: string +{% endconfiguration %}Depending on your controller or bulb type, there are two ways to configure brightness. diff --git a/source/_components/light.lifx.markdown b/source/_components/light.lifx.markdown index cb6dc00f2f9..511306f4aec 100644 --- a/source/_components/light.lifx.markdown +++ b/source/_components/light.lifx.markdown @@ -13,110 +13,4 @@ ha_iot_class: "Local Polling" ha_release: 0.12 --- -The `lifx` platform allows you to integrate your [LIFX](http://www.lifx.com) into Home Assistant. - -_Please note, the `lifx` platform does not support Windows. The `lifx_legacy` platform (supporting basic functionality) can be used instead._ - -```yaml -# Example configuration.yaml entry -light: - - platform: lifx -``` -{% configuration %} -broadcast: - description: The broadcast address for discovering lights. Only needed if using more than one network interface. Omit if you are unsure. - required: false - type: string -server: - description: Your server address. Will listen on all interfaces if omitted. Omit if you are unsure. - required: false - type: string -{% endconfiguration %} - -## {% linkable_title Set state %} - -The LIFX bulbs allow a change of color and brightness even when they are turned off. This way you can control the light during the day so its settings are correct when events for turning on are received, for example from motion detectors or external buttons. - -The normal `light.turn_on` call cannot be used for this because it always turns the power on. Thus, LIFX has its own service call that allows color changes without affecting the current power state. - -### {% linkable_title Service `light.lifx_set_state` %} - -Change the light to a new state. - -| Service data attribute | Description | -| ---------------------- | ----------- | -| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all. -| `transition` | Duration (in seconds) for the light to fade to the new state. -| `zones` | List of integers for the zone numbers to affect (each LIFX Z strip has 8 zones, starting at 0). -| `infrared` | Automatic infrared level (0..255) when light brightness is low (for compatible bulbs). -| `power` | Turn the light on (`True`) or off (`False`). Leave out to keep the power as it is. -| `...` | Use `color_name`, `brightness` etc. from [`light.turn_on`]({{site_root}}/components/light/#service-lightturn_on) to specify the new state. - -## {% linkable_title Light effects %} - -The LIFX platform supports several light effects. You can start these effects with default options by using the `effect` attribute of the normal [`light.turn_on`]({{site_root}}/components/light/#service-lightturn_on) service, for example like this: -```yaml -automation: - - alias: ... - trigger: - # ... - action: - - service: light.turn_on - data: - entity_id: light.office, light.kitchen - effect: lifx_effect_pulse -``` - -However, if you want to fully control a light effect, you have to use its dedicated service call, like this: -```yaml -script: - colorloop_start: - alias: 'Start colorloop' - sequence: - - service: light.lifx_effect_colorloop - data: - entity_id: group.livingroom - brightness: 255 - period: 10 - spread: 30 - change: 35 -``` - -The available light effects and their options are listed below. - -### {% linkable_title Service `light.lifx_effect_pulse` %} - -Run a flash effect by changing to a color and then back. - -| Service data attribute | Description | -| ---------------------- | ----------- | -| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all. -| `color_name` | A color name such as `red` or `green`. -| `rgb_color` | A list containing three integers representing the RGB color you want the light to be. -| `brightness` | Integer between 0 and 255 for how bright the color should be. -| `period` | The duration of a single pulse (in seconds). -| `cycles` | The total number of pulses. -| `mode` | The way to change between colors. Valid modes: `blink` (default), `breathe`, `ping`, `strobe`, `solid`. -| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True). - -### {% linkable_title Service `light.lifx_effect_colorloop` %} - -Run an effect with colors looping around the color wheel. All participating lights will coordinate to keep similar (but not identical) colors. - -| Service data attribute | Description | -| ---------------------- | ----------- | -| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all. -| `brightness` | Number between 0 and 255 indicating brightness of the effect. Leave this out to maintain the current brightness of each participating light. -| `period` | Duration (in seconds) between starting a new color change. -| `transition` | Duration (in seconds) where lights are actively changing color. -| `change` | Hue movement per period, in degrees on a color wheel (ranges from 0 to 359). -| `spread` | Maximum color difference between participating lights, in degrees on a color wheel (ranges from 0 to 359). -| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True). - -### {% linkable_title Service `light.lifx_effect_stop` %} - -Run an effect that does nothing, thereby stopping any other effect that might be running. - -| Service data attribute | Description | -| ---------------------- | ----------- | -| `entity_id` | String or list of strings that point at `entity_id`s of lights. Else targets all. +For installation instructions, see [the LIFX component](/components/lifx/). diff --git a/source/_components/light.limitlessled.markdown b/source/_components/light.limitlessled.markdown index 5b606c13ec4..426ea1e0569 100644 --- a/source/_components/light.limitlessled.markdown +++ b/source/_components/light.limitlessled.markdown @@ -61,7 +61,7 @@ Configuration variables: - **bridges** array (*Required*): - **host** (*Required*): IP address of the device, eg. `192.168.1.32` - **version** (*Optional*): Bridge version (default is `6`). - - **port** (*Optional*): Bridge port. Defaults to 5987. For older bridges than v6 choose `8899`. + - **port** (*Optional*): Bridge port. Defaults to `5987`. For older bridges than `v6` choose `8899`. - **groups** array (*Required*): The list of available groups. - **number** (*Required*): Group number (`1`-`4`). Corresponds to the group number on the remote. These numbers may overlap only if the type is different. - **name** (*Required*): Any name you'd like. Must be unique among all configured groups. diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index b6409f10043..10604217165 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -88,6 +88,21 @@ effect_list: description: The list of effects the light supports. required: false type: string list +hs_command_topic: + description: "The MQTT topic to publish commands to change the light's color state in HS format (Hue Saturation). + Range for Hue: 0° .. 360°, Range of Saturation: 0..100. + Note: Brightness is sent separately in the `brightness_command_topic`." + required: false + type: string +hs_state_topic: + description: "The MQTT topic subscribed to receive color state updates in HS format. + Note: Brightness is received separately in the `brightness_state_topic`." + required: false + type: string +hs_value_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the HS value." + required: false + type: string on_command_type: description: "Defines when on the payload_on is sent. Using `last` (the default) will send any style (brightness, color, etc) topics first and then a `payload_on` to the `command_topic`. Using `first` will send the `payload_on` and then any style topics. Using `brightness` will only send brightness commands instead of the `payload_on` to turn the light on." required: false @@ -200,7 +215,7 @@ payload_not_available: | RGB Color | ✔ | ✔ | ✔ | | Transitions | ✘ | ✔ | ✔ | | XY Color | ✔ | ✔ | ✘ | -| HS Color | ✘ | ✔ | ✘ | +| HS Color | ✔ | ✔ | ✘ | | White Value | ✔ | ✔ | ✔ | ## {% linkable_title Examples %} @@ -273,3 +288,4 @@ light: - A [basic example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_light) using a nodeMCU board (ESP8266) to control its built-in LED (on/off). - Another [example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_rgb_light) to control a RGB LED (on/off, brightness, and colors). +- [Integration guide](https://github.com/xoseperez/espurna/wiki/HomeAssistant) for the ESPUrna firmware (ESP8285/ESP8266). diff --git a/source/_components/light.mqtt_json.markdown b/source/_components/light.mqtt_json.markdown index 49dfbd502ef..b5b4099a276 100644 --- a/source/_components/light.mqtt_json.markdown +++ b/source/_components/light.mqtt_json.markdown @@ -256,6 +256,23 @@ Home Assistant expects the hue values to be in the range 0 to 360 and the satura } ``` +### {% linkable_title Brightness and RGBW support %} + +To enable a light with brightness, RGB support and a separate white channel (RGBW) in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +light: + - platform: mqtt_json + name: mqtt_json_light_1 + state_topic: "home/rgbw1" + command_topic: "home/rgbw1/set" + brightness: true + rgb: true + white_value: true +``` + + ### {% linkable_title Implementations %} - A full example of custom lighting using this platform and an ESP8266 microcontroller can be found [here](https://github.com/corbanmailloux/esp-mqtt-rgb-led). It supports on/off, brightness, transitions, RGB colors, and flashing. diff --git a/source/_components/light.osramlightify.markdown b/source/_components/light.osramlightify.markdown index d0479693e0c..ac80e46d08a 100644 --- a/source/_components/light.osramlightify.markdown +++ b/source/_components/light.osramlightify.markdown @@ -20,8 +20,20 @@ light: - platform: osramlightify host: 192.168.0.50 ``` -Configuration variables: -- **host** (*Required*): IP address of the Osram Lightify bridge, eg. `192.168.1.50`. -- **allow_lightify_nodes** (*Optional*): (true/false) Edit this to stop homeassistant from importing the lightify lights. -- **allow_lightify_groups** (*Optional*): (true/false) Edit this to stop homeassistant from importing the lightify groups. +{% configuration %} +host: + description: "IP address of the Osram Lightify bridge, e.g., `192.168.1.50`." + required: true + type: string +allow_lightify_nodes: + description: (true/false) Edit this to stop homeassistant from importing the lightify lights. + required: false + default: true + type: boolean +allow_lightify_groups: + description: (true/false) Edit this to stop homeassistant from importing the lightify groups. + required: false + default: true + type: boolean +{% endconfiguration %} diff --git a/source/_components/light.rflink.markdown b/source/_components/light.rflink.markdown index cc56e6de3ee..61e366392e3 100644 --- a/source/_components/light.rflink.markdown +++ b/source/_components/light.rflink.markdown @@ -37,26 +37,68 @@ light: name: Living room ``` -Configuration variables: - -- **automatic_add** (*Optional*): Automatically add new/unconfigured devices to HA if detected (default: True). -- **devices** (*Optional*): A list of devices with their name to use in the frontend. -- **device_defaults**: (*Optional*) - - **fire_event** (*Optional*): Set default `fire_event` for Rflink switch devices (see below). - - **signal_repetitions** (*Optional*): Set default `signal_repetitions` for Rflink switch devices (see below). - -Device configuration variables: - -- **name** (*Optional*): Name for the device, defaults to Rflink ID. -- **type** (*Optional*): Override automatically detected type of the light device, can be: switchable, dimmable, hybrid or toggle. See 'Light Types' below. (default: Switchable) -- **aliases** (*Optional*): Alternative Rflink ID's this device is known by. -- **fire_event** (*Optional*): Fire a `button_pressed` event if this device is turned on or off (default: False). -- **signal_repetitions** (*Optional*): Repeat every Rflink command this number of times (default: 1). -- **fire_event_** (*Optional*): Set default `fire_event` for RFLink switch devices (see below). -- **signal_repetitions** (*Optional*): Set default `signal_repetitions` for RFLink switch devices (see below). -- **group** (*Optional*): Allow light to respond to group commands (ALLON/ALLOFF). (default: yes) -- **group_aliases** (*Optional*): `aliases` which only respond to group commands. -- **no_group_aliases** (*Optional*): `aliases` which do not respond to group commands. +{% configuration %} +device_defaults: + description: The defaults for the devices. + required: false + type: list + keys: + fire_event: + description: Set default `fire_event` for Rflink switch devices (see below). + required: false + type: boolean + signal_repetitions: + description: Set default `signal_repetitions` for Rflink switch devices (see below). + required: false + type: integer +automatic_add: + description: Automatically add new/unconfigured devices to HA if detected. + required: false + default: true + type: boolean +devices: + description: A list of devices with their name to use in the frontend. + required: false + type: list + keys: + name: + description: Name for the device. + required: false + default: Rflink ID + type: string + type: + description: "Override automatically detected type of the light device, can be: switchable, dimmable, hybrid or toggle. See 'Light Types' below." + required: false + default: switchable + type: string + aliases: + description: (deprecated) Alternative Rflink ID's this device is known by. + required: false + type: [list, string] + group_aliases: + description: "(deprecated) `aliases` which only respond to group commands." + required: false + type: [list, string] + no_group_aliases: + description: "(deprecated) `aliases` which do not respond to group commands." + required: false + type: [list, string] + fire_event: + description: Fire a `button_pressed` event if this device is turned on or off. + required: false + default: false + type: boolean + signal_repetitions: + description: Repeat every Rflink command this number of times. + required: false + default: 1 + type: integer + group: + description: Allow light to respond to group commands (ALLON/ALLOFF). + required: false + default: true + type: boolean +{% endconfiguration %} ### {% linkable_title Light state %} @@ -104,4 +146,3 @@ Lights are added automatically when the RFLink gateway intercepts a wireless com ### {% linkable_title Device support %} See [device support](/components/rflink/#device-support) - diff --git a/source/_components/light.rfxtrx.markdown b/source/_components/light.rfxtrx.markdown index c83d9f71fc7..6795a5a2e25 100644 --- a/source/_components/light.rfxtrx.markdown +++ b/source/_components/light.rfxtrx.markdown @@ -54,12 +54,31 @@ light: name: Light_TV ``` -Configuration variables: - -- **devices** (*Required*): A list of devices with their name to use in the frontend. -- **automatic_add** (*Optional*): To enable the automatic addition of new lights. -- **signal_repetitions** (*Optional*): Because the RFXtrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch to try to send each signal repeatedly. -- **fire_event** (*Optional*): Fires an event even if the state is the same as before. Can be used for automations. +{% configuration %} +devices: + description: A list of devices. + required: false + type: list + keys: + name: + description: Override the name to use in the frontend. + required: true + type: string + fire_event: + description: Fires an event even if the state is the same as before. Can be used for automations. + required: false + default: false + type: boolean +automatic_add: + description: To enable the automatic addition of new lights. + required: false + default: false + type: boolean +signal_repetitions: + description: Because the RFXtrx device sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch to try to send each signal repeatedly. + required: false + type: integer +{% endconfiguration %}
If a device ID consists of only numbers, please make sure to surround it with quotes. diff --git a/source/_components/light.tikteck.markdown b/source/_components/light.tikteck.markdown index 1cd3b2fea70..84e28673c76 100644 --- a/source/_components/light.tikteck.markdown +++ b/source/_components/light.tikteck.markdown @@ -28,9 +28,23 @@ light: password: 36478643 ``` -Configuration variables: +{% configuration %} +devices: + description: A list of devices with their bluetooth address. + required: false + type: list + keys: + name: + description: A custom name to use in the frontend. + required: false + type: string + password: + description: The bulb-specific password. + required: true + type: string +{% endconfiguration %} -- **devices**: A list of devices with their bluetooth address, a custom name to use in the frontend and the bulb-specific password. The password can be obtained from an Android device using an app like [aLogcat](https://play.google.com/store/apps/details?id=org.jtb.alogcat&hl=en) or the `adb logcat` command for phones in developer mode. Look for a line like: +The password can be obtained from an Android device using an app like [aLogcat](https://play.google.com/store/apps/details?id=org.jtb.alogcat&hl=en) or the `adb logcat` command for phones in developer mode. Look for a line like: ``` E LedoBleSDK: login =skName=======[Smart Light]=======skPw==[password] diff --git a/source/_components/light.tradfri.markdown b/source/_components/light.tradfri.markdown index 82da9e0d331..e7b44cdfd2b 100644 --- a/source/_components/light.tradfri.markdown +++ b/source/_components/light.tradfri.markdown @@ -1,7 +1,7 @@ --- layout: page title: "IKEA Trådfri lights" -description: "Access and control your ZigBee-based IKEA Trådfri (Tradfri) Lights." +description: "Access and control your Zigbee-based IKEA Trådfri (Tradfri) Lights." date: 2017-04-12 22.04 sidebar: true comments: false diff --git a/source/_components/light.x10.markdown b/source/_components/light.x10.markdown index 45df065a499..6b89fd85c29 100644 --- a/source/_components/light.x10.markdown +++ b/source/_components/light.x10.markdown @@ -30,7 +30,18 @@ light: name: Bedroom Lamp ``` -Configuration variables: - -- **id** (*Required*): Device identifier. Composed of house code and unit id. -- **name** (*Required*): A friendly name for the device. +{% configuration %} +devices: + description: A list of devices. + required: true + type: list + keys: + id: + description: Device identifier. Composed of house code and unit id. + required: true + type: string + name: + description: A friendly name for the device. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/light.xiaomi_miio.markdown b/source/_components/light.xiaomi_miio.markdown index 4597bc7f8fa..79f5a9b36c1 100644 --- a/source/_components/light.xiaomi_miio.markdown +++ b/source/_components/light.xiaomi_miio.markdown @@ -13,7 +13,7 @@ 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. +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, Xiaomi Philips Eyecare Lamp 2 and Philips Zhirui Desk Lamp. ## Features @@ -62,6 +62,17 @@ The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philip - reminder - eyecare_mode +### Philips Zhirui Desk Lamp + +* Power (on, off) +* Brightness +* Scene (1, 2, 3, 4) +* Delayed turn off (Resolution in seconds) +* Attributes + - model + - scene + - delayed_turn_off + Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token to use in the `configuration.yaml` file. To add a Xiaomi Philips Light to your installation, add the following to your configuration.yaml file: @@ -91,7 +102,7 @@ name: type: string default: Xiaomi Philips Light model: - 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. + description: The model of your miio light. Valid values are `philips.light.bulb`, `philips.light.candle`, `philips.light.candle2`, `philips.light.sread1`, `philips.light.ceiling`, `philips.light.zyceiling` and `philips.light.mono1`. 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/light.yeelight.markdown b/source/_components/light.yeelight.markdown index c6019083e95..ac8b651e0f2 100644 --- a/source/_components/light.yeelight.markdown +++ b/source/_components/light.yeelight.markdown @@ -58,36 +58,46 @@ devices: required: false type: boolean default: False + model: + description: "Yeelight model. Possible values are `mono1`, `color1`, `strip1`, `bslamp1`, `ceiling1`, `ceiling2`, `ceiling3`, `ceiling4`. The setting is used to enable model specific features f.e. a particular color temperature range." + required: false + type: string {% endconfiguration %} #### {% linkable_title Music mode %} Per default the bulb limits the amount of requests per minute to 60, a limitation which can be bypassed by enabling the music mode. In music mode the bulb is commanded to connect back to a socket provided by the component and it tries to keep the connection open, which may not be wanted in all use-cases. -**Also note that bulbs in music mode will not update their state to "unavailable" if they are disconnected, which can cause delays in Home Assistant**. +**Also note that bulbs in music mode will not update their state to "unavailable" if they are disconnected, which can cause delays in Home Assistant. Bulbs in music mode may also not react to commands from HASS the first time if the connection is dropped. If you experience this issue, turn the light off and back on again in the frontend and everything will return to normal.** ### {% linkable_title Initial setup %}
Before trying to control your light through Home Assistant, you have to setup your bulb using Yeelight app. ( [Android](https://play.google.com/store/apps/details?id=com.yeelight.cherry&hl=fr), [IOS](https://itunes.apple.com/us/app/yeelight/id977125608?mt=8) ). In the bulb property, you have to enable "LAN Mode" (previously called "Developer mode"). LAN mode may only be available with the latest firmware installed on your bulb. Firmware can be updated in the application after connecting the bulb. -Determine your bulb IP (using router, software, ping ...). +Determine your bulb IP (using router, software, ping...). Information on how to enable "LAN Mode" can be found [here](https://getyeti.co/posts/how-to-control-yeelight-and-your-smarthome-with-yeti).
+### {% linkable_title Supported models %} +This component is tested to work with the following models. If you have a different model and it is working please let us know.
-- **YLDP01YL**: LED Bulb (White) -- **YLDP02YL**: LED Bulb (Color) -- **YLDP03YL**: LED Bulb (Color) - E26 -- **YLDP05YL**: LED Bulb (White) II -- **YLDP06YL**: LED Bulb (Color) II -- **YLDD01YL**: Lightstrip (Color) -- **YLDD02YL**: Lightstrip (Color) -- **MJCTD01YL**: Xiaomi Mijia Bedside Lamp - WIFI Version! -- **MJTD01YL**: Xiaomi Mijia Smart LED Desk Lamp (autodiscovery isn't possible because the device doesn't support mDNS due to the small amount of RAM) -- **YLXD02YL**: Yeelight Ceiling Light 4 (Jiaoyue 650) -- **YLXD01YL**: Yeelight Smart LED Ceiling Light - Youth Version - +| Model ID | Model number | Product name | +|------------|--------------|--------------------------------------------------| +| `mono1` | YLDP01YL | LED Bulb (White) | +| ? | YLDP05YL | LED Bulb (White) - 2nd generation | +| `color1` | YLDP02YL | LED Bulb (Color) | +| `color1` | YLDP03YL | LED Bulb (Color) - E26 | +| `color2` | YLDP06YL | LED Bulb (Color) - 2nd generation | +| `strip1` | YLDD01YL | Lightstrip (Color) | +| `strip1` | YLDD02YL | Lightstrip (Color) | +| `bslamp1` | MJCTD01YL | Xiaomi Mijia Bedside Lamp - WIFI Version! | +| `lamp1` | MJTD01YL | Xiaomi Mijia Smart LED Desk Lamp (autodiscovery isn't possible because the device doesn't support mDNS due to the small amount of RAM) | +| `ceiling1` | YLXD01YL | Yeelight Ceiling Light | +| `ceiling2` | YLXD03YL | Yeelight Ceiling Light - Youth Version | +| ?, may be `ceiling3` | YLXD04YL | Yeelight Ceiling Light (Jiaoyue 450) | +| `ceiling3` | YLXD05YL | Yeelight Ceiling Light (Jiaoyue 480) | +| `ceiling4` | YLXD02YL | Yeelight Ceiling Light (Jiaoyue 650) | ## {% linkable_title Platform Services %} diff --git a/source/_components/light.yeelightsunflower.markdown b/source/_components/light.yeelightsunflower.markdown index 0583084626c..aee2c1d2852 100644 --- a/source/_components/light.yeelightsunflower.markdown +++ b/source/_components/light.yeelightsunflower.markdown @@ -28,15 +28,17 @@ light: host: 192.168.1.59 ``` -Configuration variables: - -- **host** (*Required*): IP address of your Yeelight Sunflower hub. +{% configuration %} +host: + description: IP address of your Yeelight Sunflower hub. + required: true + type: string +{% endconfiguration %}-When the hub is loaded, your lights will appear as devices with their Zigbee IDs as part of the entity name. +When the hub is loaded, your lights will appear as devices with their Zigbee IDs as part of the entity name.
The Yeelight Sunflower hub supports SSDP discovery, but that has not been built into the platform. Let the developer know if that would be helpful to you.
- diff --git a/source/_components/light.zengge.markdown b/source/_components/light.zengge.markdown index b2f46b065d4..6c84769f479 100644 --- a/source/_components/light.zengge.markdown +++ b/source/_components/light.zengge.markdown @@ -15,16 +15,32 @@ ha_release: 0.36 The `zengge` platform allows you to integrate your [Zengge Bluetooth bulbs](http://www.zengge.com/) into Home Assistant. +## {% linkable_title Configuration %} + +To enable the lights, add the following lines to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry light: - platform: zengge devices: - C4:BE:84:51:54:8B: + "C4:BE:84:51:54:8B": name: Living Room ``` -Configuration variables: -- **devices** array (*Required*): List of your devices/bulbs. - - **MAC address** (*Required*): The MAC address of the bulb. - - **name** (*Optional*): Friendly name for the frontend. +{% configuration %} +devices: + description: The list of your devices/bulbs. + required: true + type: list + keys: + mac_address: + description: The MAC address of the bulb. + required: true + type: list + keys: + name: + description: The friendly name for the frontend. + required: false + type: string +{% endconfiguration %} diff --git a/source/_components/light.zha.markdown b/source/_components/light.zha.markdown index 904c1e59de8..0285626c619 100644 --- a/source/_components/light.zha.markdown +++ b/source/_components/light.zha.markdown @@ -1,7 +1,7 @@ --- layout: page -title: "ZigBee Home Automation Light" -description: "Instructions on how to setup ZigBee Home Automation lights within Home Assistant." +title: "Zigbee Home Automation Light" +description: "Instructions on how to setup Zigbee Home Automation lights within Home Assistant." date: 2017-02-22 00:00 sidebar: true comments: false @@ -12,4 +12,4 @@ ha_category: Light ha_iot_class: "Local Polling" --- -To get your ZigBee lights working with Home Assistant, follow the instructions for the general [ZigBee Home Automation component](/components/zha/). +To get your Zigbee lights working with Home Assistant, follow the instructions for the general [Zigbee Home Automation component](/components/zha/). diff --git a/source/_components/light.zigbee.markdown b/source/_components/light.zigbee.markdown index d88f348cb44..9de952bd848 100644 --- a/source/_components/light.zigbee.markdown +++ b/source/_components/light.zigbee.markdown @@ -1,7 +1,7 @@ --- layout: page -title: ZigBee Light -description: "Instructions on how to set up ZigBee lights within Home Assistant." +title: Zigbee Light +description: "Instructions on how to set up Zigbee lights within Home Assistant." date: 2016-01-28 12:38 sidebar: true comments: false @@ -13,7 +13,7 @@ ha_release: 0.12 ha_iot_class: "Local Polling" --- -A ZigBee light in this context is a light connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a light is considered `on` when the ZigBee device's digital output is held `high` and considered `off` when it is held `low`. This behavior can be inverted by setting the `on_state` configuration variable to `low`. +A Zigbee light in this context is a light connected to one of the digital output pins on a Zigbee module. It can simply be switched on and off. By default, a light is considered `on` when the Zigbee device's digital output is held `high` and considered `off` when it is held `low`. This behavior can be inverted by setting the `on_state` configuration variable to `low`. To configure a digital output pin as light, add the following to your `configuration.yaml` file: @@ -34,7 +34,7 @@ pin: required: true type: integer address: - description: The long 64-bit address of the remote ZigBee device whose digital output pin you would like to switch. Do not include this variable if you want to switch the local ZigBee device's pins. + description: The long 64-bit address of the remote Zigbee device whose digital output pin you would like to switch. Do not include this variable if you want to switch the local Zigbee device's pins. required: false type: string on_state: diff --git a/source/_components/lock.lockitron.markdown b/source/_components/lock.lockitron.markdown index 6b320e71086..c97eaf7eb78 100644 --- a/source/_components/lock.lockitron.markdown +++ b/source/_components/lock.lockitron.markdown @@ -14,18 +14,29 @@ ha_release: "0.42" --- The `lockitron` platform allows you to control your [Lockitron](https://lockitron.com/) lock from within Home Assistant. -In order to get the correct `access_token` and `id`, log on to their [developer page](https://api.lockitron.com/), create a new app, and get the access_token they give you. -Then, call the retrieve all locks function on the page and get the id of your lock (make sure you get your lock's id and not the virtual lock they create for you). + +## {% linkable_title Setup %} + +In order to get the correct `access_token` and `id`, log on to their [developer page](https://api.lockitron.com/), create a new app, and get the access_token they give you. Then, call the retrieve all locks function on the page and get the id of your lock (make sure you get your lock's id and not the virtual lock they create for you). + +## {% linkable_title Configuration %} + +To enable the lock, add the following lines to your `configuration.yaml` file: ```yaml lock: - platform: lockitron - access_token: asdf - id: fdsa + access_token: YOUR_ACCESS_TOKEN + id: YOUR_ID ``` -Configuration variables: - -- **access_token** (*Required*): The usernThe security token provided by Lockitron to lock and unlock your lock. -- **id** (*Required*): The lock id given by Lockitron (should be a GUID). - +{% configuration %} +access_token: + description: The security token provided by Lockitron to lock and unlock your lock. + required: true + type: string +id: + description: The lock id given by Lockitron (should be a GUID). + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/lock.template.markdown b/source/_components/lock.template.markdown new file mode 100644 index 00000000000..155ba139001 --- /dev/null +++ b/source/_components/lock.template.markdown @@ -0,0 +1,142 @@ +--- +layout: page +title: "Template Lock" +description: "Instructions on how to integrate Template Locks into Home Assistant." +date: 2018-10-09 19:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Lock +ha_release: 0.81 +ha_iot_class: "Local Push" +logo: home-assistant.png +ha_qa_scale: internal +--- + +The `template` platform creates locks that combines components. + +For example, if you have a garage door with a toggle switch that operates the motor and a sensor that allows you know whether the door is open or closed, you can combine these into a lock that knows whether the garage door is open or closed. + +This can simplify the GUI and make it easier to write automations. You can mark the components you have combined as `hidden` so they don't appear themselves. + +In optimistic mode, the lock will immediately change state after every command. Otherwise, the lock will wait for state confirmation from the template. Try to enable it, if experiencing incorrect lock operation. + +## {% linkable_title Configuration %} + +To enable Template Locks in your installation, add the following to your `configuration.yaml` file: + +{% raw %} +```yaml +# Example configuration.yaml entry +lock: + - platform: template + name: Garage door + value_template: "{{ is_state('sensor.door', 'on') }}" + lock: + service: switch.turn_on + data: + entity_id: switch.door + unlock: + service: switch.turn_off + data: + entity_id: switch.door +``` +{% endraw %} + +{% configuration %} + name: + description: Name to use in the frontend. + required: false + type: string + default: Template Lock + value_template: + description: Defines a template to set the state of the lock. + required: true + type: template + lock: + description: Defines an action to run when the lock is locked. + required: true + type: action + unlock: + description: Defines an action to run when the lock is unlocked. + required: true + type: action + optimistic: + description: Flag that defines if lock works in optimistic mode. + required: false + type: boolean + default: false +{% endconfiguration %} + +## {% linkable_title Considerations %} + +If you are using the state of a platform that takes extra time to load, the Template Lock may get an `unknown` state during startup. This results in error messages in your log file until that platform has completed loading. If you use `is_state()` function in your template, you can avoid this situation. For example, you would replace {% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %} with this equivalent that returns `true`/`false` and never gives an unknown result: {% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %} + +## {% linkable_title Examples %} + +In this section, you find some real-life examples of how to use this lock. + +### {% linkable_title Lock from Switch %} + +This example shows a lock that copies data from a switch. + +{% raw %} +```yaml +lock: + - platform: template + name: Garage Door + value_template: "{{ is_state('switch.source', 'on') }}" + lock: + service: switch.turn_on + data: + entity_id: switch.source + unlock: + service: switch.turn_off + data: + entity_id: switch.source +``` +{% endraw %} + +### {% linkable_title Optimistic Mode %} + +This example shows a lock in optimistic mode. This lock will immediately change state after command and will not wait for state update from the sensor. + +{% raw %} +```yaml +lock: + - platform: template + name: Garage Door + value_template: "{{ is_state('sensor.skylight.state', 'on') }}" + optimistic: true + lock: + service: switch.turn_on + data: + entity_id: switch.source + unlock: + service: switch.turn_off + data: + entity_id: switch.source +``` +{% endraw %} + +### {% linkable_title Sensor and Two Switches %} + +This example shows a lock that takes its state from a sensor, and uses two momentary switches to control a device. + +{% raw %} +```yaml +lock: + - platform: template + name: Garage Door + value_template: "{{ is_state('sensor.skylight.state', 'on') }}" + lock: + service: switch.turn_on + data: + entity_id: switch.skylight_open + unlock: + service: switch.turn_on + data: + entity_id: switch.skylight_close +``` +{% endraw %} diff --git a/source/_components/lutron.markdown b/source/_components/lutron.markdown index 6799e1feb55..66960face43 100644 --- a/source/_components/lutron.markdown +++ b/source/_components/lutron.markdown @@ -32,11 +32,20 @@ lutron: password: integration ``` -Configuration variables: - -- **host** (*Required*): The IP address of the Main Repeater. -- **username** (*Required*): The login name of the user. The user `lutron` always exists, but other users can be added via RadioRA 2 software. -- **password** (*Required*): The password for the user specified above. `integration` is the password for the always-present `lutron` user. +{% configuration %} +host: + description: The IP address of the Main Repeater. + required: true + type: string +username: + description: The login name of the user. The user `lutron` always exists, but other users can be added via RadioRA 2 software. + required: true + type: string +password: + description: The password for the user specified above. `integration` is the password for the always-present `lutron` user. + required: true + type: string +{% endconfiguration %}It is recommended to assign a static IP address to your main repeater. This ensures that it won't change IP addresses, so you won't have to change the `host` if it reboots and comes up with a different IP address. diff --git a/source/_components/mailgun.markdown b/source/_components/mailgun.markdown index e1ecaefc72a..da274fe0a5b 100644 --- a/source/_components/mailgun.markdown +++ b/source/_components/mailgun.markdown @@ -23,12 +23,22 @@ To send messages, use the [Mailgun notify platform][notify]. ```yaml # Example configuration.yaml entry mailgun: - domain: mg.example.com - api_key: XXXXXXXXXXXXX + domain: EXAMPLE.COM + api_key: YOUR_API_KEY ``` -Configuration variables: - -- **domain** (*Required*): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up. -- **api_key** (*Required*): This is the API token that has been generated in your Mailgun account. -- **sandbox** (*Deprecated*): Whether to use the sandboxed domain for outgoing mail. Since the `domain` item is required, it should be set to the sandbox domain name, so this isn't needed. Defaults to `False`. +{% configuration %} +domain: + description: This is the domain name to be used when sending out mail. Needs to be the first custom domain you have set up. + required: true + type: string +api_key: + description: This is the API token that has been generated in your Mailgun account. + required: true + type: string +sandbox: + description: "(**Deprecated**) Whether to use the sandboxed domain for outgoing mail. Since the `domain` item is required, it should be set to the sandbox domain name, so this isn't needed." + required: false + default: false + type: boolean +{% endconfiguration %} diff --git a/source/_components/matrix.markdown b/source/_components/matrix.markdown index d965ea1a9f5..5d22a661c3e 100644 --- a/source/_components/matrix.markdown +++ b/source/_components/matrix.markdown @@ -27,8 +27,6 @@ matrix: name: my_command ``` -Configuration variables: - {% configuration %} username: description: "The matrix username that Home Assistant should use to log in. *Note*: You must specify a full matrix ID here, including the homeserver domain, e.g., '@my_matrix_bot:matrix.org'. Please note also that the '@' character has a special meaning in YAML, so this must always be given in quotes." diff --git a/source/_components/media_player.anthemav.markdown b/source/_components/media_player.anthemav.markdown index 8e59296db99..992edcb42e2 100644 --- a/source/_components/media_player.anthemav.markdown +++ b/source/_components/media_player.anthemav.markdown @@ -35,15 +35,25 @@ media_player: host: IP_ADDRESS ``` -Configuration variables: - -- **host** (*Required*): The host name or the IP address of the device. -- **port** (*Optional*): The port number. Defaults to 14999. -- **name** (*Optional*): The name of the device used in the frontend. +{% configuration %} +host: + description: The host name or the IP address of the device. + required: true + type: string +port: + description: The port number of the device. + required: false + default: 14999 + type: integer +name: + description: The name of the device used in the frontend. + required: false + type: string +{% endconfiguration %} ## Notes and Limitations -- The tuner is currently unsupported as are the `media_player` play, pays, prev, and next controls. +- The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls. - Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant. - Only Zone 1 is currently supported. diff --git a/source/_components/media_player.aquostv.markdown b/source/_components/media_player.aquostv.markdown index 156f50853f0..9535efee1ac 100644 --- a/source/_components/media_player.aquostv.markdown +++ b/source/_components/media_player.aquostv.markdown @@ -27,14 +27,37 @@ media_player: host: 192.168.0.10 ``` -Configuration variables: +{% configuration %} +host: + description: The IP/Hostname of the Sharp Aquos TV, eg. `192.168.0.10`. + required: true + type: string +port: + description: The port of the Sharp Aquos TV. + required: false + default: 10002 + type: int +username: + description: The username of the Sharp Aquos TV. + required: false + default: admin + type: string +password: + description: The password of the Sharp Aquos TV. + required: false + default: password + type: string +name: + description: The name you would like to give to the Sharp Aquos TV. + required: false + type: string +power_on_enabled: + description: If you want to be able to turn on your TV. + required: false + default: false + type: boolean +{% endconfiguration %} -- **host** (*Required*): The IP/Hostname of the Sharp Aquos TV, eg. `192.168.0.10`. -- **port** (*Optional*): The port of the Sharp Aquos TV. Defaults to 10002. -- **username** (*Optional*): The username of the Sharp Aquos TV. Defaults to admin. -- **password** (*Optional*): The password of the Sharp Aquos TV. Defaults to password. -- **name** (*Optional*): The name you would like to give to the Sharp Aquos TV. -- **power_on_enabled** (*Optional*): If you want to be able to turn on your TV. Defaults to False.
When you set **power_on_enabled** as True, you have to turn on your TV on the first time with the remote.
diff --git a/source/_components/media_player.bluesound.markdown b/source/_components/media_player.bluesound.markdown
index 69372c8c332..aadb326f42c 100644
--- a/source/_components/media_player.bluesound.markdown
+++ b/source/_components/media_player.bluesound.markdown
@@ -27,12 +27,26 @@ media_player:
- host: 192.168.1.100
```
-Configuration variables:
-
-- **hosts** (*Optional*): List with your bluesound devices
- - **host** (*Required*): IP-address or hostname of the player
- - **name** (*Optional*): The name of the device used in the frontend
- - **port** (*Optional*): Port of communication to the device (default: 11000)
+{% configuration %}
+hosts:
+ description: List with your Bluesound devices.
+ required: false
+ type: list
+ keys:
+ host:
+ description: The IP address or hostname of the player.
+ required: true
+ type: string
+ name:
+ description: The name of the device used in the frontend.
+ required: false
+ type: string
+ port:
+ description: The port to communicate with the device.
+ required: false
+ default: 11000
+ type: integer
+{% endconfiguration %}
## Advanced configuration example
@@ -49,7 +63,7 @@ media_player:
### {% linkable_title Service `bluesound_join` %}
-Group players together under a single master speaker. That will make a new group or join to exists group.
+Group players together under a single master speaker. That will make a new group or join an existing group.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
@@ -68,7 +82,7 @@ Remove one or more speakers from a group of speakers. If no `entity_id` is provi
Sets a timer that will turn off the speaker. For each time you call this it will increase the time by one step. The steps are (in minutes): 15, 30, 45, 60, 90, 0.
If you increase an ongoing timer of for example 13 minutes, it will increase it to 15. If the timer is set to 90, it will remove the time (hence the 0).
-
+
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s that will have their timers set.
@@ -76,7 +90,7 @@ If you increase an ongoing timer of for example 13 minutes, it will increase it
### {% linkable_title Service `bluesound_clear_sleep_timer` %}
Clear the sleep timer on a speaker, if one is set.
-
+
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s that will have their timers cleared.
diff --git a/source/_components/media_player.braviatv.markdown b/source/_components/media_player.braviatv.markdown
index cf6bd2a4172..e8bb5bf6e4d 100644
--- a/source/_components/media_player.braviatv.markdown
+++ b/source/_components/media_player.braviatv.markdown
@@ -15,7 +15,7 @@ ha_iot_class: "Local Polling"
The `braviatv` platform allows you to control a [Sony Bravia TV](http://www.sony.com).
-Almost all [Sony Bravia TV 2013 and newer](http://info.tvsideview.sony.net/en_ww/home_device.html#bravia) are supported. A more generic method for older TVs connected to a Raspberry Pi with HDMI-CEC is explained further below.
+Almost all [Sony Bravia TV 2013 and newer](http://info.tvsideview.sony.net/en_ww/home_device.html#bravia) are supported. A more generic method for older TVs connected to a Raspberry Pi with HDMI-CEC is explained further below.
You will need to configure your TV to allow the Home Assistant for remote usage. To do that, ensure that your TV is turned on. Open the configuration popup on Home Assistant and enter a random PIN (for example 0000). After that, the TV will show you a PIN and Home Assistant will allow you to re-enter that PIN. Enter the PIN shown on your TV and Home Assistant will be able to control your Sony Bravia TV.
@@ -28,10 +28,17 @@ media_player:
host: 192.168.0.10
```
-Configuration variables:
-
-- **host** (*Required*): The IP of the Sony Bravia TV, eg. 192.168.0.10
-- **name** (*Optional*): The name to use on the frontend.
+{% configuration %}
+host:
+ description: The IP of the Sony Bravia TV, e.g., 192.168.0.10
+ required: true
+ type: string
+name:
+ description: The name to use on the frontend.
+ required: false
+ default: Sony Bravia TV
+ type: string
+{% endconfiguration %}
You are also able to configure the TV manually by placing a `bravia.conf` file in your [configuration directory](/docs/configuration/) with the following information - please update the details to match your setup:
@@ -58,7 +65,7 @@ switch:
value_template: {% raw %}'{{ value == "power status: on" }}{% endraw %}'
```
-Using `cec-client` is a great method to turn your TV off/on, however the trade off is if you're using Kodi, it will no longer be able to control your TV using the TV Remote.
+Using `cec-client` is a great method to turn your TV off/on, however the trade off is if you're using Kodi, it will no longer be able to control your TV using the TV Remote.
This is because only one process can control the CEC functionality within the Raspberry Pi at a time and running the above commands terminates the functionality inside libCEC within Kodi. Kodi must be restarted for TV remove functionality to work again.
diff --git a/source/_components/media_player.channels.markdown b/source/_components/media_player.channels.markdown
index 12138976e26..98d7f60b9a8 100644
--- a/source/_components/media_player.channels.markdown
+++ b/source/_components/media_player.channels.markdown
@@ -28,11 +28,22 @@ media_player:
host: 192.168.1.50
```
-Configuration variables:
-
-- **host** (*Required*): The IP of the device running Channels, e.g., 192.168.1.50
-- **port** (*Optional*): The port where Channels is accessible, defaults to 57000.
-- **name** (*Optional*): The name of the Channels instance in Home Assistant, eg. Family Room Channels. Defaults to Channels.
+{% configuration %}
+host:
+ description: The IP address of the device running Channels, e.g., 192.168.1.50.
+ required: true
+ type: string
+port:
+ description: The port where Channels is accessible.
+ required: false
+ default: 57000
+ type: integer
+name:
+ description: The name of the Channels instance in Home Assistant, e.g., Family Room Channels.
+ required: false
+ default: Channels
+ type: string
+{% endconfiguration %}
### {% linkable_title Service `channels_seek_forward` %}
diff --git a/source/_components/media_player.clementine.markdown b/source/_components/media_player.clementine.markdown
index 781ac147a56..add0d5b2a80 100644
--- a/source/_components/media_player.clementine.markdown
+++ b/source/_components/media_player.clementine.markdown
@@ -25,12 +25,26 @@ media_player:
host: 192.168.0.20
```
-Configuration variables:
-
-- **host** (*Required*): The IP address of the Clementine Player (eg. 192.168.0.20).
-- **port** (*Optional*): The remote control port (default is: 5500).
-- **access_token** (*Optional*): The authorization code needed to connect.
-- **name** (*Optional*): The name you would like to give to the Clementine player. The default is "Clementine Remote".
+{% configuration %}
+host:
+ description: The IP address of the Clementine Player e.g., 192.168.0.20.
+ required: true
+ type: string
+port:
+ description: The remote control port.
+ required: false
+ default: 5500
+ type: integer
+access_token:
+ description: The authorization code needed to connect.
+ required: false
+ type: integer
+name:
+ description: The name you would like to give to the Clementine player.
+ required: false
+ default: Clementine Remote
+ type: string
+{% endconfiguration %}
Remember that Clementine must be configured to accept connections through its network remote control protocol.
diff --git a/source/_components/media_player.cmus.markdown b/source/_components/media_player.cmus.markdown
index 1415de1e547..ce5406887b3 100644
--- a/source/_components/media_player.cmus.markdown
+++ b/source/_components/media_player.cmus.markdown
@@ -33,9 +33,23 @@ media_player:
password: YOUR_PASSWORD
```
-Configuration variables:
-
-- **host** (*Optional*): Hostname or IP address of the machine running cmus. Note if a remote cmus is configured that instance must be configured to listen to remote connections, which also requires a password to be set.
-- **password** (*Required if host is set*): Password for your cmus player.
-- **port** (*Optional*): Port of the cmus socket, defaults to 3000.
-- **name** (*Optional*): The name you'd like to give the cmus player in Home Assistant
+{% configuration %}
+host:
+ description: Hostname or IP address of the machine running cmus. Note if a remote cmus is configured that instance must be configured to listen to remote connections, which also requires a password to be set.
+ required: inclusive
+ type: string
+password:
+ description: Password for your cmus player.
+ required: inclusive
+ type: string
+port:
+ description: Port of the cmus socket.
+ required: false
+ default: 3000
+ type: integer
+name:
+ description: The name you'd like to give the cmus player in Home Assistant.
+ required: false
+ default: cmus
+ type: string
+{% endconfiguration %}
diff --git a/source/_components/media_player.directv.markdown b/source/_components/media_player.directv.markdown
index f7f6559619e..d27b10e1101 100644
--- a/source/_components/media_player.directv.markdown
+++ b/source/_components/media_player.directv.markdown
@@ -22,13 +22,27 @@ To ensure that your DirecTV boxes are always found and configured, they should b
media_player:
- platform: directv
```
-Configuration variables:
-
-- **host** (*Optional*): Use only if you don't want to scan for devices.
-- **port** (*Optional*): The port your receiver is using. Defaults to `8080`.
-- **name** (*Optional*): Use to give a specific name to the device.
-- **device** (*Optional*): Use to specify a particular receiver in a Genie setup.
+{% configuration %}
+host:
+ description: The IP address or the hostname of the device. Use only if you don't want to scan for devices.
+ required: false
+ type: string
+port:
+ description: The port your receiver is using.
+ required: false
+ default: 8080
+ type: integer
+name:
+ description: Use to give a specific name to the device.
+ required: false
+ default: DirecTV Receiver
+ type: string
+device:
+ description: Use to specify a particular receiver in a Genie setup.
+ required: false
+ type: string
+{% endconfiguration %}
To find valid device IDs, open `http://
Note that python-firetv has support for multiple Amazon Fire TV devices. If you have more than one configured, be sure to specify the device ID in `device`. Run `firetv-server -h` and/or view the source for complete capabilities.
diff --git a/source/_components/media_player.frontier_silicon.markdown b/source/_components/media_player.frontier_silicon.markdown
index c7887e9c8b7..9ab51e42d40 100644
--- a/source/_components/media_player.frontier_silicon.markdown
+++ b/source/_components/media_player.frontier_silicon.markdown
@@ -37,11 +37,23 @@ media_player:
host: IP_ADDRESS
```
-Configuration variables:
-
-- **host** (*Required*): The host name or the IP address of the device. Defaults to 192.168.1.11.
-- **port** (*Optional*): The port number. Defaults to 80.
-- **password** (*Optional*): PIN code of the Internet Radio. Defaults to 1234.
+{% configuration %}
+host:
+ description: The host name or the IP address of the device.
+ required: true
+ default: 192.168.1.11
+ type: string
+port:
+ description: The port number of the device.
+ required: false
+ default: 80
+ type: integer
+password:
+ description: PIN code of the Internet Radio.
+ required: false
+ default: 1234
+ type: string
+{% endconfiguration %}
Some models use a separate port (2244) for API access, this can be verified by visiting http://[host]:[port]/device.
@@ -80,7 +92,7 @@ is based on [tiwillam]'s fsapi project. Special thanks to both developers, this
## Notes and Limitations
-The Frontier Silicon API does not provide a multi-user environment. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated. This renders the usage of [UNDOK] almost impossible, as the Home Assistant component polls the device state every 30 seconds or issues a command by creating a new session.
+The Frontier Silicon API does not provide a multi-user environment. There is always a single user (session) controlling a device, which means that once Home Assistant connects to a device all other sessions will be invalidated. This renders the usage of [UNDOK] almost impossible, as the Home Assistant component polls the device state every 30 seconds or issues a command by creating a new session.
*If you want to prevent Home Assistant to auto connect to your device, simply change the PIN code of the device to something else than: 1234*
The access token will not change until you factory reset your TV.
When using api_version: 5 changing sources switches tv channels. Additionally this allows setting the volume level.
This platform now uses the web interface of the Logitech Media Server to send commands. The default port of the web interface is 9000. It is the same port that you use to access the LMS through your web browser. Originally, this platform used the telnet interface, which defaults to 9090. If you previously specified the port in your configuration file, you will likely need to update it.
-Not all features of MySensors 2.0 are yet supported by Home Assistant. As more features are added, they will be described here in the documentation. Go to the MySensors platform pages under "related components" to see what message types are currently supported.
+Not all features of MySensors 2.0 are supported by Home Assistant yet. As more features are added, they will be described here in the documentation. Go to the MySensors platform pages under "related components" to see what message types are currently supported.
+This component will be removed from Home Assistant in the future. Slack has taken over Hipchat and Stride and will therefore stop these platforms. For more information: announcement.
+
+If you want to add new chat IDs then you will need to disable the active configuration to actually see the result with the IDs, otherwise you may only get empty results array.
+
- sleekxmpp, as of version 1.3.2, does not support >TLS1. If you are running your own XMPP server (e.g., Prosody, ejabberd) make sure to allow using TLS1.
+ Pre Home Assistant 0.81 `sleekxmpp` was used to connect to XMPP servers. `sleekxmpp` as of version 1.3.2, does not support > TLS v1. If you are running your own XMPP server (e.g., Prosody, ejabberd) make sure to allow using TLS v1.
+
+ Home Assistant after 0.81 uses `slixmpp`, which also supports TLS v1.1 and TLS v1.2.
Verify that your credentials work on [Yesss.at's website](https://yesss.at). Using the wrong credentials three times in a row will get you suspended for one hour.
diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown
index 29e6c039ed9..992fd9700da 100644
--- a/source/_components/octoprint.markdown
+++ b/source/_components/octoprint.markdown
@@ -14,25 +14,113 @@ ha_release: 0.19
ha_iot_class: "Local Polling"
---
-[OctoPrint](http://octoprint.org/) is a web interface for your 3D printer. This is the main component to integrate OctoPrint sensors, you will have to setup sensors and binary sensors separately.
+[OctoPrint](http://octoprint.org/) is a web interface for your 3D printer. This is the main component to integrate OctoPrint sensors.
-To get started with the OctoPrint API, please follow the directions on their [site](http://docs.octoprint.org/en/master/api/general.html). Once OctoPrint is configured you will need to add your API key and host to your `configuration.yaml`.
+## {% linkable_title Configuration %}
+To get started with the OctoPrint API, please follow the directions on their [site](http://docs.octoprint.org/en/master/api/general.html). Once OctoPrint is configured you will need to add your API key and host to your `configuration.yaml`.
```yaml
octoprint:
host: YOUR_OCTOPRINT_HOST
api_key: YOUR_API_KEY
- bed: false
- number_of_tools: 1
```
-Configuration variables:
+{% configuration %}
+octoprint:
+ type: list
+ required: true
+ keys:
+ host:
+ description: IP address or hostname of Octoprint host.
+ required: true
+ type: string
+ api_key:
+ description: The retrieved API key.
+ required: true
+ type: string
+ name:
+ description: The name for this printer, must be unique if multiple printers are defined.
+ required: false
+ type: string
+ default: OctoPrint
+ port:
+ description: The port of the Octoprint server.
+ required: false
+ type: integer
+ default: 80
+ ssl:
+ description: Enable or disable SSL/TLS.
+ required: false
+ type: boolean
+ default: false
+ bed:
+ description: If the printer has a heated bed.
+ required: false
+ type: boolean
+ default: false
+ number_of_tools:
+ description: Number of temperature adjustable tools, e.g., nozzle.
+ required: false
+ type: integer
+ default: 1
+ sensors:
+ description: Configuration for the sensors.
+ required: false
+ type: map
+ keys:
+ monitored_conditions:
+ description: The sensors to activate.
+ type: list
+ default: all (`Current State`, `Temperatures`, `Job Percentage`, `Time Elapsed`, `Time Remaining`)
+ keys:
+ "Current State":
+ description: Text of current state.
+ "Temperatures":
+ description: Temperatures of all available tools, eg. `print`, `head`, `print bed`, etc. These will be displayed as `tool0`, `tool1`, or `toolN` please refer to your OctoPrint frontend to associate the tool number with an actual device.
+ "Job Percentage":
+ description: Percentage of the job.
+ "Time Elapsed":
+ description: Time elapsed on current print job, in seconds.
+ "Time Remaining":
+ description: Time remaining on current print job, in seconds.
+ binary_sensors:
+ description: Configuration for the binary sensors.
+ required: false
+ type: map
+ keys:
+ monitored_conditions:
+ description: The sensors to activate.
+ type: list
+ default: all (`Printing`, `Printing Error`)
+ keys:
+ "Printing":
+ description: State of the printer.
+ "Printing Error":
+ description: Error while printing.
+{% endconfiguration %}
-- **host** (*Required*): IP address or hostname of Octoprint host.
-- **api_key** (*Required*): The retrieved api key.
-- **bed** (*Optional*): If the printer has a heated bed.
-- **number_of_tools** (*Optional*): Number of temperature adjustable tools. i.e. nozzle.
+
+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.
+
+The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat.
+
-The "Limited" plan (which is what new users are given by default) is limited to 500 API requests per day. In order to leave a buffer, the `openuv` component queries the API every 30 minutes by default. This value can be modifed (via the `scan_interval` key), but please note that over-running the API will require
-you to upgrade to a paid plan (and may disable your access in the meantime).
+The "Limited" plan (which is what new users are given by default) is limited to 500 API requests per day. In order to leave a buffer, the `openuv` component queries the API every 30 minutes by default. This value can be modifed (via the `scan_interval` key), but please note that over-running the API will require you to upgrade to a paid plan (and may disable your access in the meantime).
-The above guidelines constitute estimates and are intended to help informed decision making. They should not replace analysis, advice, or diagnosis from a trained medical professional.
+The above guidelines constitute estimates and are intended to help informed decision making. They should not replace analysis, advice or diagnosis from a trained medical professional.
**Water-saving suggestion:**
-Unix Socket connections always bring performance advantages over TCP, if the database on the same host as the `recorder` instance (i.e. `localhost`).
@@ -72,4 +69,3 @@ That's it. You can copy and paste your new `client id` and `client secret` in yo
in the side bar. Using your web browsers search tool to find the `hangouts.conversations` entity. You will find something like bellow
+The conversations has to be precreated, the conversation id can be obtained from the `hangouts.conversations` entity, this can be found in with the states developer tool that is shown as this icon in the side bar. Using your web browsers search tool to find the `hangouts.conversations` entity. You will find something like below.
```
0: {
diff --git a/source/_components/notify.hipchat.markdown b/source/_components/notify.hipchat.markdown
index 877bcd8cd82..b4f81a989ce 100644
--- a/source/_components/notify.hipchat.markdown
+++ b/source/_components/notify.hipchat.markdown
@@ -12,6 +12,12 @@ ha_category: Notifications
ha_release: "0.52"
---
+
+
+Hipchat will be discontinued after February 15th, 2019. This to give customers the opportunity to make a switch.
+
diff --git a/source/_components/recorder.markdown b/source/_components/recorder.markdown
index 230ac6b1bc0..afda7241aad 100644
--- a/source/_components/recorder.markdown
+++ b/source/_components/recorder.markdown
@@ -13,13 +13,13 @@ ha_release: pre 0.7
ha_qa_scale: internal
---
-The `recorder` component is storing details in a database which then are handled by the [`history` component](/components/history/).
+The `recorder` component is responsible for storing details in a database, which then are handled by the [`history` component](/components/history/).
-Home Assistant uses [SQLAlchemy](http://www.sqlalchemy.org/) as Object Relational Mapper (ORM). This means that you can now use **any** SQL backend for the recorder that is supported by SQLAlchemy, like [MySQL](https://www.mysql.com/), [MariaDB](https://mariadb.org/), [PostgreSQL](https://www.postgresql.org/), or [MS SQL Server](https://www.microsoft.com/en-us/sql-server/).
+Home Assistant uses [SQLAlchemy](http://www.sqlalchemy.org/), which is an Object Relational Mapper (ORM). This means that you can use **any** SQL backend for the recorder that is supported by SQLAlchemy, like [MySQL](https://www.mysql.com/), [MariaDB](https://mariadb.org/), [PostgreSQL](https://www.postgresql.org/), or [MS SQL Server](https://www.microsoft.com/en-us/sql-server/).
The default database engine is [SQLite](https://www.sqlite.org/) which doesn't require any configuration. The database is stored in your Home Assistant configuration directory (`.homeassistant`) and called `home-assistant_v2.db`.
-To change the defaults for `recorder` component in your installation, add the following to your `configuration.yaml` file:
+To change the defaults for the `recorder` component in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -33,7 +33,7 @@ recorder:
type: map
keys:
db_url:
- description: The URL which points to your database.
+ description: The URL that points to your database.
required: false
type: URL
purge_keep_days:
@@ -47,7 +47,7 @@ recorder:
default: 1
type: integer
exclude:
- description: Configure which components should be excluded
+ description: Configure which components should be excluded from recordings.
required: false
type: map
keys:
@@ -74,7 +74,7 @@ recorder:
type: List
{% endconfiguration %}
-Define domains and entities to `exclude` (aka. blacklist). This is convenient when you are basically happy with the information recorded, but just want to remove some entities or domains. Usually, these are entities/domains which do not change (like `weblink`) or rarely change (`updater` or `automation`).
+Defining domains and entities to `exclude` (aka. blacklist) is convenient when you are basically happy with the information recorded, but just want to remove some entities or domains. Usually, these are entities/domains that do not change (like `weblink`) or rarely change (like `updater` or `automation`).
```yaml
# Example configuration.yaml entry with exclude
@@ -92,7 +92,7 @@ recorder:
- sensor.date
```
-Define domains and entities to record by using the `include` configuration (aka. whitelist). If you have a lot of entities in your system and your `exclude` lists possibly get very large, it might be better just to define the entities or domains to record.
+define domains and entities to record by using the `include` configuration (aka. whitelist) is convenient if you have a lot of entities in your system and your `exclude` lists possibly get very large, so it might be better just to define the entities or domains to record.
```yaml
# Example configuration.yaml entry with include
@@ -104,7 +104,7 @@ recorder:
- media_player
```
-Use the `include` list to define the domains/entities to record, and exclude some of them within the `exclude` list. This makes sense if you, for instance, include the `sensor` domain, but want to exclude some specific sensors. Instead of adding every sensor entity to the `include` `entities` list just include the `sensor` domain and exclude the sensor entities you are not interested in.
+You can also use the `include` list to define the domains/entities to record, and exclude some of those within the `exclude` list. This makes sense if you, for instance, include the `sensor` domain, but want to exclude some specific sensors. Instead of adding every sensor entity to the `include` `entities` list just include the `sensor` domain and exclude the sensor entities you are not interested in.
```yaml
# Example configuration.yaml entry with include and exclude
@@ -120,7 +120,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 the 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`).
+If you only want to hide events from your history, take a look at the [`history` component](/components/history/). The same goes for the [logbook](/components/logbook/). But if you have privacy concerns about certain events or want them in neither the history or logbook, you should use the `exclude`/`include` options of the `recorder` component. That way they aren't even in your database, you can reduce storage and keep the database small by excluding certain often-logged events (like `sensor.last_boot`).
### {% linkable_title Service `purge` %}
@@ -133,7 +133,7 @@ Call the service `recorder.purge` to start a purge task which deletes events and
### {% linkable_title Restore State %}
-If the `recorder` component is activated then some components support `restore_state` which will restore the state of the entity after Home Assistant is started to the state before Home Assistant was stopped. Please make sure that you do not exclude the entities for which you want the state to be restored from your recordings. An incomplete list of components that currently support `restore_state`:
+If the `recorder` component is activated then some components support `restore_state`, which will restore the state of the entity after Home Assistant is started to the state before Home Assistant was stopped. Please make sure that you do not exclude the entities for which you want the state to be restored from your recordings. An incomplete list of components that currently support `restore_state`:
* [`input_boolean`](/components/input_boolean/#restore-state)
* [`input_number`](/components/input_number/#restore-state)
@@ -144,7 +144,7 @@ If the `recorder` component is activated then some components support `restore_s
## {% linkable_title Custom database engines %}
-| Database engine | `db_url` |
+| Database engine | `db_url` |
| :---------------|:---------------------------------------------------------|
| SQLite | `sqlite:////PATH/TO/DB_NAME` |
| MariaDB | `mysql://SERVER_IP/DB_NAME?charset=utf8` |
@@ -163,7 +163,7 @@ If you use MariaDB 10 you need to add port 3307 (or another port depending on wh
If you want to use Unix Sockets for PostgreSQL you need to modify the `pg_hba.conf`. See [PostgreSQL](#postgresql)
@@ -196,7 +196,7 @@ $ sudo systemctl daemon-reload ## {% linkable_title Installation notes %} -Not all Python bindings for the chosen database engine can be installed directly. This section contains additional details which should help you to get it working. +Not all Python bindings for the chosen database engine can be installed directly. This section contains additional details that should help you to get it working. ### {% linkable_title MariaDB and MySQL %} @@ -208,7 +208,7 @@ homeassistant@homeassistant:~$ source /srv/homeassistant/bin/activate (homeassistant) homeassistant@homeassistant:~$ pip3 install mysqlclient ``` -For MariaDB you may have to install a few dependencies. If you're using MariaDB version 10.2, libmariadbclient-dev was renamed to libmariadb-dev, please install the correct package based on your MariaDB version. +For MariaDB you may have to install a few dependencies. If you're using MariaDB version 10.2, `libmariadbclient-dev` was renamed to `libmariadb-dev`; please install the correct package based on your MariaDB version. On the Python side we use the `mysqlclient`: @@ -224,7 +224,7 @@ $ sudo apt-get install default-libmysqlclient-dev libssl-dev $ pip3 install mysqlclient ``` -After installing the dependencies, it is required to create the database manually. During the startup, Home Assistant will look for the database specified in the `db_url`. If the database doesn't exist, it will not automatically create it for you. +After installing the dependencies, it is required to create the database manually. During the startup, Home Assistant will look for the database specified in the `db_url`. If the database doesn't exist, it will not automatically create it for you. Once Home Assistant finds the database, with the right level of permissions, all the required tables will then be automatically created and the data will be populated accordingly. @@ -246,7 +246,7 @@ Where `DB_NAME` is the name of your database and `USER_NAME` is the name of the Reload the PostgreSQL configuration after that: ```bash $ sudo -i -u postgres psql -c "SELECT pg_reload_conf();" - pg_reload_conf + pg_reload_conf ---------------- t (1 row) diff --git a/source/_components/remember_the_milk.markdown b/source/_components/remember_the_milk.markdown index 70abbed77e4..96840dc1cba 100644 --- a/source/_components/remember_the_milk.markdown +++ b/source/_components/remember_the_milk.markdown @@ -27,8 +27,8 @@ To be able to use this component, you need a Remember The Milk account and you n remember_the_milk: - name: your_rtm_account - api_key:+Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page. +
diff --git a/source/_components/scene.markdown b/source/_components/scene.markdown index 48998818971..f0bb6a2b479 100644 --- a/source/_components/scene.markdown +++ b/source/_components/scene.markdown @@ -34,10 +34,16 @@ scene: source: HDMI 1 ``` -Configuration variables: - -- **name** (*Required*): Friendly name of scene. -- **entities** (*Required*): Entities to control. +{% configuration %} +name: + description: Friendly name of scene. + required: true + type: string +entities: + description: Entities to control. + required: true + type: list +{% endconfiguration %} As you can see, there are two ways to define the states of each `entity_id`: diff --git a/source/_components/sensor.airvisual.markdown b/source/_components/sensor.airvisual.markdown index a78e18c417c..9a270ac2fee 100644 --- a/source/_components/sensor.airvisual.markdown +++ b/source/_components/sensor.airvisual.markdown @@ -21,26 +21,14 @@ This platform requires an AirVisual API key, which can be obtained [here](https: The "Community" API key is limited to 10,000 calls per month. In order to leave a buffer, the `airvisual` platform queries the API every 10 minutes by default. Modification of this (via the `scan_interval` key) to a too-low value may result in your API key being deactivated. -## {% linkable_title Configuration via Latitude/Longitude %} +## {% linkable_title Configuration %} To enable the platform and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file: ```yaml sensor: - platform: airvisual - api_key: abc123 - monitored_conditions: - - us - - cn - show_on_map: false - scan_interval: 30 - # Configure by latitude/longitude: - latitude: 42.81212 - longitude: 108.12422 - # Or configure by location: - city: Los Angeles - state: California - country: USA + api_key: YOUR_AIRVISUAL_API_KEY ``` {% configuration %} @@ -87,6 +75,37 @@ country: type: string {% endconfiguration %} +## {% linkable_title Example Configurations %} + +Configuration using custom Latitude and Longitude: + +```yaml +sensor: + - platform: airvisual + api_key: YOUR_AIRVISUAL_API_KEY + monitored_conditions: + - cn + show_on_map: false + scan_interval: 30 + latitude: 42.81212 + longitude: 108.12422 +``` + +Configuration using city, state, and country: + +```yaml +sensor: + - platform: airvisual + api_key: YOUR_AIRVISUAL_API_KEY + monitored_conditions: + - us + show_on_map: false + scan_interval: 30 + city: Los Angeles + state: California + country: USA +``` + ## {% linkable_title Determining the City/State/Country %} To easily determine the proper values for a particular location, use the [AirVisual region directory](https://airvisual.com/world). Once you browse to the particular city you want, take note of the breadcrumb title, which is of the form `country > state/region > city`. Use this information to fill out `configuration.yaml`. diff --git a/source/_components/sensor.api_streams.markdown b/source/_components/sensor.api_streams.markdown index 0a5e744e645..ead045f7237 100644 --- a/source/_components/sensor.api_streams.markdown +++ b/source/_components/sensor.api_streams.markdown @@ -1,7 +1,7 @@ --- layout: page -title: "API Stream Sensor" -description: "Instructions on how to count clients using the API stream within Home Assistant." +title: "API Streams Sensor" +description: "Instructions on how to count clients using the API streams within Home Assistant." date: 2016-11-19 10:00 sidebar: true comments: false @@ -12,9 +12,10 @@ ha_category: Utility ha_release: 0.33 ha_iot_class: "Local Push" ha_qa_scale: internal +redirect_from: /components/sensor.api_stream/ --- -The `api_streams` sensor platform shows how many clients are connected to the stream API +The `api_streams` sensor platform shows how many clients are connected to the stream API. ## {% linkable_title Configuration %} diff --git a/source/_components/sensor.bloomsky.markdown b/source/_components/sensor.bloomsky.markdown index d2e1ca31a50..1c3ef6acfa7 100644 --- a/source/_components/sensor.bloomsky.markdown +++ b/source/_components/sensor.bloomsky.markdown @@ -33,15 +33,24 @@ sensor: - Voltage ``` -Configuration variables: - -- **monitored_conditions** array (*Required*): The sensors that you wish to monitor on all of your devices. Select from these options: - - Humidity - - Luminance - - Pressure - - Temperature - - UVIndex - - Voltage - +{% configuration %} +monitored_conditions: + description: "The sensors that you wish to monitor on all of your devices. Select from these options:" + required: true + type: list + keys: + humidity: + description: Humidity + luminance: + description: Luminance + pressure: + description: Pressure + temperature: + description: Temperature + uvindex: + description: UVIndex + voltage: + description: Voltage +{% endconfiguration %} More conditions are available using the [BloomSky binary sensor](/components/binary_sensor.bloomsky) component. diff --git a/source/_components/sensor.bom.markdown b/source/_components/sensor.bom.markdown index c3cc033404c..b5dd07a02c8 100644 --- a/source/_components/sensor.bom.markdown +++ b/source/_components/sensor.bom.markdown @@ -116,7 +116,7 @@ monitored_conditions: swell_dir_worded: description: Swell direction. swell_height: - description: Swell hight in m. + description: Swell height in m. swell_period: description: Swell period. vis_km: diff --git a/source/_components/sensor.dublin_bus_transport.markdown b/source/_components/sensor.dublin_bus_transport.markdown index 6c32206895d..f980877ba11 100644 --- a/source/_components/sensor.dublin_bus_transport.markdown +++ b/source/_components/sensor.dublin_bus_transport.markdown @@ -13,10 +13,9 @@ ha_iot_class: "Cloud Polling" ha_release: 0.36 --- - The `dublin_bus_transport` sensor will give you the time until the next two departures from a Dublin bus stop using the RTPI information. -The [Dublin Bus](https://www.dublinbus.ie/RTPI/) website can help to determine the id of your bus stop. You can check if this is correct by going to +The [Dublin Bus](https://www.dublinbus.ie/RTPI/) website can help to determine the id of your bus stop. You can check if this is correct by going to https://data.dublinked.ie/cgi-bin/rtpi/realtimebusinformation?stopid=[Stop ID] @@ -29,10 +28,20 @@ sensor: stopid: STOP_ID ``` -Configuration variables: - -- **stopid** (*Required*): The ID of the bus stop to get the information for. -- **route** (*Optional*): Only show a single bus route at the stop. This is the same as the bus number, e.g., `83`. -- **name** (*Optional*): A friendly name for this sensor. +{% configuration %} +stopid: + description: The ID of the bus stop to get the information for. + required: true + type: string +route: + description: Only show a single bus route at the stop. This is the same as the bus number, e.g., `83`. + required: false + type: string +name: + description: A friendly name for this sensor. + required: false + default: Next Bus + type: string +{% endconfiguration %} The public RTPI information is coming from [Dub Linked](https://data.dublinked.ie/). diff --git a/source/_components/sensor.dyson.markdown b/source/_components/sensor.dyson.markdown index 8a1cd8a1efb..c92b2f7d669 100644 --- a/source/_components/sensor.dyson.markdown +++ b/source/_components/sensor.dyson.markdown @@ -21,4 +21,4 @@ You have first to setup the [Dyson component](/components/dyson/) ### {% linkable_title Supported fan devices %} - Pure Cool link (desk and tower) -- Pure Hot+cool link (but heating is not yet supported) +- Pure Hot+cool link (see [climate](/components/climate.dyson/) for thermal control) diff --git a/source/_components/sensor.eliqonline.markdown b/source/_components/sensor.eliqonline.markdown index b87f019f0ef..81f64598802 100644 --- a/source/_components/sensor.eliqonline.markdown +++ b/source/_components/sensor.eliqonline.markdown @@ -13,7 +13,6 @@ ha_release: "0.10" ha_iot_class: "Cloud Polling" --- - Integrate your [ELIQ Online](http://eliq.io) smart meter information into Home Assistant. To get an [access token](https://my.eliq.io/user/settings/api) and the [Channel ID](https://my.eliq.io/user/settings/locations), log in to your account. To enable this sensor in your installation, add the following to your `configuration.yaml` file: @@ -26,11 +25,20 @@ sensor: channel_id: CHANNEL_ID ``` -Configuration variables: - -- **access_token** (*Required*): The Access Token for your account. -- **channel_id** (*Required*): Channel ID (as integer) of your device. -- **name** (*Optional*): The name of the sensor, eg. the city. +{% configuration %} +access_token: + description: The Access Token for your account. + required: true + type: string +channel_id: + description: Channel ID (as integer) of your device. + required: true + type: integer +name: + description: The name of the sensor, e.g., the city. + required: false + default: ELIQ Online + type: string +{% endconfiguration %} For details please check the [API documentation](https://eliq.zendesk.com/hc/en-us/articles/115002708449-API-Eliq-Online). - diff --git a/source/_components/sensor.elkm1.markdown b/source/_components/sensor.elkm1.markdown new file mode 100644 index 00000000000..97216415589 --- /dev/null +++ b/source/_components/sensor.elkm1.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: "Elk-M1 Sensor" +description: "Instructions on how to integrate Elk-M1 counters, keypads, panel, settings, and zones." +date: 2018-10-11 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: elkproducts.png +ha_release: 0.81 +ha_category: Sensor +ha_iot_class: "Local Push" +--- + +The `elkm1` platform allows you to control your [Elk-M1](https://www.elkproducts.com/m1_controls.html). + +Elk-M1 counters, keypads, panel, settings, and zones are represented as `sensor` entities. + ++Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page. +
diff --git a/source/_components/sensor.fido.markdown b/source/_components/sensor.fido.markdown index 4331701e3e4..00694b0d71b 100644 --- a/source/_components/sensor.fido.markdown +++ b/source/_components/sensor.fido.markdown @@ -33,28 +33,62 @@ sensor: ``` Configuration variables: - -- **username** (*Required*): You Fido username (your Fido phone number or your email). -- **password** (*Required*): Your Fido password. -- **number** (*Optional*): Your Fido phone number (it will use your username if empty). -- **monitored_variables** array (*Required*): Variables to monitor. - - **fido_dollar**: Your Fido dollar balance - - **balance**: Your account balance - - **data_used**: Current data used - - **data_limit**: Current data limit - - **data_remaining**: Current data remaining - - **text_used**: SMS sent - - **text_limit**: SMS limit - - **text_remaining**: SMS remaining - - **mms_used**: MMS sent - - **mms_limit**: MMS limit - - **mms_remaining**: MMS remaining - - **text_int_used**: International SMS sent - - **text_int_limit**: International SMS limit - - **text_int_remaining**: International SMS remaining - - **talk_used**: Talk time used - - **talk_limit**: Talk time limit - - **talt_remaining**: Talk time remaining - - **other_talk_used**: Other talk time used (It could be international calls) - - **other_talk_limit**: Other talk time limit - - **other_talt_remaining**: Other talk time remaining +{% configuration %} +username: + description: Your Fido username (your Fido phone number or your email). + required: true + type: string +password: + description: Your Fido password. + required: true + type: string +number: + description: Your Fido phone number (it will use your username if empty). + required: false + type: string +monitored_variables: + description: Variables to monitor. + required: true + type: list + keys: + fido_dollar: + description: Your Fido dollar balance + balance: + description: Your account balance + data_used: + description: Current data used + data_limit: + description: Current data limit + data_remaining: + description: Current data remaining + text_used: + description: SMS sent + text_limit: + description: SMS limit + text_remaining: + description: SMS remaining + mms_used: + description: MMS sent + mms_limit: + description: MMS limit + mms_remaining: + description: MMS remaining + text_int_used: + description: International SMS sent + text_int_limit: + description: International SMS limit + text_int_remaining: + description: International SMS remaining + talk_used: + description: Talk time used + talk_limit: + description: Talk time limit + talt_remaining: + description: Talk time remaining + other_talk_used: + description: Other talk time used (It could be international calls) + other_talk_limit: + description: Other talk time limit + other_talt_remaining: + description: Other talk time remaining +{% endconfiguration %} diff --git a/source/_components/sensor.fritzbox_netmonitor.markdown b/source/_components/sensor.fritzbox_netmonitor.markdown index 5a4c3f858a7..240ffcf6641 100644 --- a/source/_components/sensor.fritzbox_netmonitor.markdown +++ b/source/_components/sensor.fritzbox_netmonitor.markdown @@ -17,7 +17,7 @@ The `fritzbox_netmonitor` sensor monitors the network statistics exposed by [AVM
It might be necessary to install additional packages: $ sudo apt-get install libxslt-dev libxml2-dev python3-lxml
-If you are working with the All-in-One installation, you may also need to execute also within your virtual environment the command pip install lxml; be patient this will take a while.
+If you are working with the All-in-One installation, you may also need to execute also within your virtual environment the command pip3 install lxml; be patient this will take a while.
-The reference point for comparing the distance is defined by `latitude` and `longitude` in the basic configuration.
+The reference point for comparing the distance is by default defined by `latitude` and `longitude` in the basic configuration.
Only entries of the feed are considered that define a location as `point` or `polygon` in *georss.org* format or as *WGS84 latitude/longitude*.
@@ -54,6 +54,16 @@ name:
required: false
type: string
default: Event Service
+latitude:
+ description: Latitude of the coordinates around which events are considered.
+ required: false
+ type: string
+ default: Latitude defined in your `configuration.yaml`
+longitude:
+ description: Longitude of the coordinates around which events are considered.
+ required: false
+ type: string
+ default: Longitude defined in your `configuration.yaml`
radius:
description: The distance in kilometers around the Home Assistant's coordinates in which events are considered.
required: false
diff --git a/source/_components/sensor.google_travel_time.markdown b/source/_components/sensor.google_travel_time.markdown
index 044dd34c9ea..b9d1c5b5596 100644
--- a/source/_components/sensor.google_travel_time.markdown
+++ b/source/_components/sensor.google_travel_time.markdown
@@ -36,17 +36,64 @@ sensor:
destination: Paris, France
```
-Configuration variables:
-
-- **api_key** (*Required*): Your application's API key (get one by following the instructions above). This key identifies your application for purposes of quota management.
-- **origin** (*Required*): The starting point for calculating travel distance and time. You can supply one or more locations separated by the pipe character, in the form of an address, latitude/longitude coordinates, or a [Google place ID](https://developers.google.com/places/place-id). When specifying the location using a Google place ID, the ID must be prefixed with `place_id:`.
-- **destination** (*Required*): One or more locations to use as the finishing point for calculating travel distance and time. The options for the destinations parameter are the same as for the origins parameter, described above.
-- **name** (*Optional*): A name to display on the sensor. The default is "Google Travel Time - [Travel Mode]" where [Travel Mode] is the mode set in options for the sensor (see option "mode" below).
-- **options** (*Optional*): A dictionary containing parameters to add to all requests to the Distance Matrix API. A full listing of available options can be found [here](https://developers.google.com/maps/documentation/distance-matrix/intro#RequestParameters).
- - **mode** (*Optional*): The travel mode used to calculate the directions/time. Can be `driving` (*Default*), `bicycling`, `transit` or `walking`.
- - **departure_time** (*Optional*): Can be `now`, a Unix timestamp, or a 24 hour time string like `08:00:00`. If you provide a time string, it will be combined with the current date to get travel time for that moment.
- - **arrival_time** (*Optional*): See notes above for `departure_time`. `arrival_time` cannot be `now`, only a Unix timestamp or time string. You can not provide both `departure_time` and `arrival_time`. If you do provide both, `arrival_time` will be removed from the request.
- - **units** (*Optional*): Set the unit for the sensor in metric or imperial, otherwise the default unit the same as the unit set in `unit_system:`.
+{% configuration %}
+api_key:
+ description: Your application's API key (get one by following the instructions above). This key identifies your application for purposes of quota management.
+ required: true
+ type: string
+origin:
+ description: "The starting point for calculating travel distance and time. You can supply one or more locations separated by the pipe character, in the form of an address, latitude/longitude coordinates, or a [Google place ID](https://developers.google.com/places/place-id). When specifying the location using a Google place ID, the ID must be prefixed with `place_id:`."
+ required: true
+ type: string
+destination:
+ description: One or more locations to use as the finishing point for calculating travel distance and time. The options for the destinations parameter are the same as for the origins parameter, described above.
+ required: true
+ type: string
+name:
+ description: A name to display on the sensor. The default is "Google Travel Time - [Travel Mode]" where [Travel Mode] is the mode set in options for the sensor (see option "mode" below).
+ required: false
+ type: string
+travel_mode:
+ description: "You can choose between: `driving`, `walking`, `bicycling` or `transit`."
+ required: false
+ type: string
+options:
+ description: "A dictionary containing parameters to add to all requests to the Distance Matrix API. A full listing of available options can be found [here](https://developers.google.com/maps/documentation/distance-matrix/intro#RequestParameters)."
+ required: false
+ type: list
+ keys:
+ mode:
+ description: The travel mode used to calculate the directions/time. Can be `driving`, `bicycling`, `transit` or `walking`.
+ required: false
+ default: driving
+ type: string
+ language:
+ description: "You can choose from a lot of languages: `ar`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `es`, `eu`, `fa`, `fi`, `fr`, `gl`, `gu`, `hi`, `hr`, `hu`, `id`, `it`, `iw`, `ja`, `kn`, `ko`, `lt`, `lv`, `ml`, `mr`, `nl`, `no`, `pl`, `pt`, `pt-BR`, `pt-PT`, `ro`, `ru`, `sk`, `sl`, `sr`, `sv`, `ta`, `te`, `th`, `tl`, `tr`, `uk`, `vi`, `zh-CN` and `zh-TW`."
+ required: false
+ type: string
+ departure_time:
+ description: Can be `now`, a Unix timestamp, or a 24 hour time string like `08:00:00`. If you provide a time string, it will be combined with the current date to get travel time for that moment.
+ required: exclusive
+ type: [time, string]
+ arrival_time:
+ description: See notes above for `departure_time`. `arrival_time` cannot be `now`, only a Unix timestamp or time string. You can not provide both `departure_time` and `arrival_time`. If you do provide both, `arrival_time` will be removed from the request.
+ required: exclusive
+ type: [time, string]
+ avoid:
+ description: "Indicate what google should avoid when calculating the travel time, you can choose from: `tolls`, `highways`, `ferries`, `indoor`."
+ required: false
+ type: string
+ transit_model:
+ description: "If you opted for `transit` at `travel_mode`, you can use this variable to specify which public transport you want to use: `bus`, `subway`, `train`, `tram` or `rail`."
+ transit_routing_preference:
+ description: "for the travel time calculation for public transport you can also specify the preference for: `less_walking` or `fewer_transfers`."
+ required: false
+ type: string
+ units:
+ description: "Set the unit for the sensor in metric or imperial, otherwise the default unit the same as the unit set in `unit_system:`."
+ required: false
+ type: string
+{% endconfiguration %}
## {% linkable_title Dynamic Configuration %}
@@ -115,5 +162,6 @@ You can also use the `sensor.google_travel_sensor_update` service to update the
- fri
action:
- service: sensor.google_travel_sensor_update
- entity_id: sensor.morning_commute
+ data:
+ entity_id: sensor.morning_commute
```
diff --git a/source/_components/sensor.google_wifi.markdown b/source/_components/sensor.google_wifi.markdown
index 303c89ed0a6..1924ec2f29f 100644
--- a/source/_components/sensor.google_wifi.markdown
+++ b/source/_components/sensor.google_wifi.markdown
@@ -16,7 +16,7 @@ ha_release: "0.50"
The `google_wifi` sensor platform is displaying the exposed status of a [Google Wifi](https://madeby.google.com/wifi/) (or OnHub) router.
-The sensor is able to report network status, up-time, current IP address, and firmware versions.
+The sensor is able to report network status, up-time, current IP address and firmware versions.
To enable this sensor, add the following lines to your `configuration.yaml` file:
@@ -26,15 +26,32 @@ sensor:
- platform: google_wifi
```
-Configuration variables:
-
-- **host** (*Optional*): The address to retrieve status from the router. Defaults to `testwifi.here` (other options include `onhub.here` and your router's IP such as `192.168.86.1`).
-- **name** (*Optional*): Name to give the Google Wifi sensor. Defaults to `google_wifi`.
-- **monitored_conditions** array (*Optional*): Defines the data to monitor as sensors. Defaults to all of the listed options below.
- - **current_version**: Current firmware version of the router.
- - **new_version**: Latest available firmware version. If router is up-to-date, this value defaults to `Latest`.
- - **uptime**: Days since router has been turned on.
- - **last_restart**: Date of last restart. Format is `YYYY-MM-DD HH:mm:SS`.
- - **local_ip**: Local public IP address.
- - **status**: Reports whether the router is or is not connected to the internet.
-
+{% configuration %}
+host:
+ description: The address to retrieve status from the router. Valid options are `testwifi.here`, in some cases `onhub.here` or the router's IP address such as 192.168.86.1.
+ required: false
+ default: testwifi.here
+ type: string
+name:
+ description: Name to give the Google Wifi sensor.
+ required: false
+ default: google_wifi
+ type: string
+monitored_conditions:
+ description: Defines the data to monitor as sensors. Defaults to all of the listed options below.
+ required: false
+ type: map
+ keys:
+ current_version:
+ description: Current firmware version of the router.
+ new_version:
+ description: Latest available firmware version. If router is up-to-date, this value shows to `Latest`.
+ uptime:
+ description: Days since router has been turned on.
+ last_restart:
+ description: Date of last restart. Format is `YYYY-MM-DD HH:mm:SS`.
+ local_ip:
+ description: Local public IP address.
+ status:
+ description: Reports whether the router is or is not connected to the internet.
+{% endconfiguration %}
diff --git a/source/_components/sensor.hddtemp.markdown b/source/_components/sensor.hddtemp.markdown
index 0116bedde19..4146109d07a 100644
--- a/source/_components/sensor.hddtemp.markdown
+++ b/source/_components/sensor.hddtemp.markdown
@@ -30,10 +30,24 @@ sensor:
- /dev/sda1
```
-Configuration variables:
-
-- **name** (*Optional*): Friendly name to use for the frontend. Default to "HD Temperature".
-- **host** (*Optional*): Host where `hddtemp` is running. Default to `localhost`.
-- **port** (*Optional*): Port that is used by `hddtemp` . Default to `7634`.
-- **disks** (*Optional*): Disk to be monitored. Example: `/dev/sda1`
-
+{% configuration %}
+name:
+ description: Friendly name to use for the frontend.
+ required: false
+ default: HD Temperature
+ type: string
+host:
+ description: Host where `hddtemp` is running.
+ required: false
+ default: localhost
+ type: string
+port:
+ description: Port that is used by `hddtemp`.
+ required: false
+ default: 7634
+ type: integer
+disks:
+ description: "Disk to be monitored. Example: `/dev/sda1`."
+ required: false
+ type: list
+{% endconfiguration %}
diff --git a/source/_components/sensor.hp_ilo.markdown b/source/_components/sensor.hp_ilo.markdown
index f242584b9db..c7f8594cafb 100644
--- a/source/_components/sensor.hp_ilo.markdown
+++ b/source/_components/sensor.hp_ilo.markdown
@@ -39,17 +39,47 @@ sensor:
sensor_type: SENSOR TYPE
```
-Configuration variables:
-
-- **host** (*Required*): The hostname or IP address on which the ILO can be reached.
-- **port** (*Optional*): The port on which the ILO can be reached, defaults to port `443`.
-- **username** (*Required*): The username used to connect to the ILO.
-- **password** (*Required*): The password used to connect to the ILO.
-- **monitored_variables** array (*Optional*): Sensors created from the ILO data. Defaults to an empty list (no sensors are created).
- - **name** (*Required*): The sensor name.
- - **sensor_type** (*Required*): The sensor type, has to be one of the specified valid sensor types.
- - **unit_of_measurement** (*Optional*): The sensors' unit of measurement.
- - **value_template** (*Optional*): When a Jinja2 template is specified here, the created sensor will output the template result. The ILO response can be referenced with the `ilo_data` variable.
+{% configuration %}
+host:
+ description: The hostname or IP address on which the ILO can be reached.
+ required: true
+ type: string
+port:
+ description: The port on which the ILO can be reached.
+ required: false
+ default: 443
+ type: string
+username:
+ description: The username used to connect to the ILO.
+ required: true
+ type: string
+password:
+ description: The password used to connect to the ILO.
+ required: true
+ type: string
+monitored_variables:
+ description: Sensors created from the ILO data.
+ required: false
+ default: Defaults to an empty list (no sensors are created).
+ type: list
+ keys:
+ name:
+ description: The sensor name.
+ required: true
+ type: string
+ sensor_type:
+ description: The sensor type, has to be one of the valid sensor types specified below.
+ required: true
+ type: string
+ unit_of_measurement:
+ description: The sensors' unit of measurement.
+ required: false
+ type: string
+ value_template:
+ description: When a Jinja2 template is specified here, the created sensor will output the template result. The ILO response can be referenced with the `ilo_data` variable.
+ required: false
+ type: template
+{% endconfiguration %}
Valid sensor_types:
- **server_name**: Get the name of the server this iLO is managing.
diff --git a/source/_components/sensor.htu21d.markdown b/source/_components/sensor.htu21d.markdown
index fbb513aef4a..687bb02df60 100644
--- a/source/_components/sensor.htu21d.markdown
+++ b/source/_components/sensor.htu21d.markdown
@@ -13,7 +13,6 @@ ha_release: 0.48
ha_iot_class: "Local Push"
---
-
The `htu21d` sensor platform allows you to read the temperature and humidity from a [HTU21D sensor](http://www.datasheetspdf.com/PDF/HTU21D/779951/1) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins).
Tested devices:
@@ -30,11 +29,18 @@ sensor:
- platform: htu21d
```
-Configuration variables:
-
-- **name** (*Optional*): The name of the sensor
-- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
-
+{% configuration %}
+name:
+ description: The name of the sensor.
+ required: false
+ default: i2c_bus
+ type: string
+i2c_bus:
+ description: I2c bus where the sensor is.
+ required: false
+ default: 1 (for Raspberry Pi 2 and 3)
+ type: integer
+{% endconfiguration %}
## {% linkable_title Customizing the sensor data %}
diff --git a/source/_components/sensor.huawei_lte.markdown b/source/_components/sensor.huawei_lte.markdown
index 682d3bc0518..673ac3186f8 100644
--- a/source/_components/sensor.huawei_lte.markdown
+++ b/source/_components/sensor.huawei_lte.markdown
@@ -15,12 +15,15 @@ ha_release: 0.79
The `huawei_lte` sensor platform allows you to monitor Huawei LTE routers.
-This requires you to have set up the [Huawei LTE component](/components/huawei_lte/).
+## {% linkable_title Configuration %}
+
+This platform requires you to have set up the [Huawei LTE component](/components/huawei_lte/).
+
+The names for the item you want to monitor are dot separated paths to information returned by the router. The data set varies by router model. To see what your router provides, set logging level to debug and watch `homeassistant.components.huawei_lte` debug entries. The configuration variable description contains a few example paths just to illustrate the syntax. These may not be available on all routers or their semantics may differ, and there are quite likely many more that are not listed here.
## {% linkable_title Configuration %}
-To enable the sensor, add the following lines to your
-`configuration.yaml` file:
+To enable the sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@@ -33,19 +36,40 @@ sensor:
- traffic_statistics.TotalConnectTime
```
-Configuration variables:
-
-**monitored_conditions** array (*Optional*): Defines the data to monitor as sensors. Defaults to a few generally available data items expected to be available on most boxes. The names here are dot separated paths to information returned by the router. The data set varies by router model; to see what your router provides, set logging level to debug and watch homeassistant.components.huawei_lte debug entries. The following list contains a few example paths just to illustrate the syntax; these may not be available on all routers or their semantics may differ, and there are quite likely many more that are not listed here.
-
- - **device_information.SoftwareVersion**: Software version.
- - **device_information.WanIPAddress**: WAN interface IP address.
- - **device_information.WanIPv6Address**: WAN interface IP address.
- - **device_signal.rsrq**: The signal RSRQ value.
- - **device_signal.rsrp**: The signal RSRP value.
- - **device_signal.rssi**: The signal RSSI value.
- - **device_signal.sinr**: The signal SINR value.
- - **traffic_statistics.CurrentDownloadRate**: Current download rate, bytes/sec.
- - **traffic_statistics.CurrentUploadRate**: Current upload rate, bytes/sec.
- - **traffic_statistics.TotalUpload**: Total bytes uploaded since last reset.
- - **traffic_statistics.TotalDownload**: Total bytes downloaded since last reset.
- - **traffic_statistics.TotalConnectTime**: Total time connected since last reset.
+{% configuration %}
+monitored_conditions:
+ description: Defines the data to monitor as sensors. Defaults to a few generally available data items expected to be available on most boxes.
+ required: false
+ default: Below is indicated which conditions are the default.
+ type: list
+ keys:
+ device_information.SoftwareVersion:
+ description: Software version.
+ device_information.WanIPAddress:
+ description: WAN interface IPv4 address.
+ default: default
+ device_information.WanIPv6Address:
+ description: WAN interface IPv6 address.
+ device_signal.rsrq:
+ description: The signal RSRQ value.
+ default: default
+ device_signal.rsrp:
+ description: The signal RSRP value.
+ default: default
+ device_signal.rssi:
+ description: The signal RSSI value.
+ default: default
+ device_signal.sinr:
+ description: The signal SINR value.
+ default: default
+ traffic_statistics.CurrentDownloadRate:
+ description: Current download rate, bytes/sec.
+ traffic_statistics.CurrentUploadRate:
+ description: Current upload rate, bytes/sec.
+ traffic_statistics.TotalUpload:
+ description: Total bytes uploaded since last reset.
+ traffic_statistics.TotalDownload:
+ description: Total bytes downloaded since last reset.
+ traffic_statistics.TotalConnectTime:
+ description: Total time connected since last reset.
+{% endconfiguration %}
diff --git a/source/_components/sensor.hydroquebec.markdown b/source/_components/sensor.hydroquebec.markdown
index 891f74ae21c..a6fabbbb3cd 100644
--- a/source/_components/sensor.hydroquebec.markdown
+++ b/source/_components/sensor.hydroquebec.markdown
@@ -34,26 +34,58 @@ sensor:
- period_total_days
```
-Configuration variables:
-
-- **username** (*Required*): Username used to log into the Hydro-Québec site.
-- **password** (*Required*): Password used to log into the Hydro-Québec site.
-- **contract** (required since HA 4.0) Your contract number with Hydro-Québec
-- **monitored_variables** array (*Required*): Variables to monitor.
- - **balance** : Current balance
- - **period_total_bill** : Current period bill
- - **period_length**: Current period length
- - **period_total_days**: Total number of days in this period
- - **period_mean_daily_bill**: Period daily average bill
- - **period_mean_daily_consumption**: Period daily average consumption
- - **period_total_consumption**: Total Consumption
- - **period_lower_price_consumption**: Period Lower price consumption
- - **period_higher_price_consumption**: Period Higher price consumption
- - **period_average_temperature**: Period Average temperature
- - **yesterday_total_consumption**: Yesterday total consumption
- - **yesterday_lower_price_consumption**: Yesterday lower price consumption
- - **yesterday_higher_price_consumption**: Yesterday higher price consumption
- - **yesterday_average_temperature**: Yesterday Average temperature
+{% configuration %}
+username:
+ description: Username used to log into the Hydro-Québec site.
+ required: true
+ type: string
+password:
+ description: Password used to log into the Hydro-Québec site.
+ required: true
+ type: string
+contract:
+ description: Your contract number with Hydro-Québec.
+ required: true
+ type: string
+name:
+ description: A friendly name for this sensor.
+ required: false
+ default: HydroQuebec
+ type: string
+monitored_variables:
+ description: Variables to monitor.
+ required: true
+ type: list
+ keys:
+ balance:
+ description: Current balance
+ period_total_bill:
+ description: Current period bill
+ period_length:
+ description: Current period length
+ period_total_days:
+ description: Total number of days in this period
+ period_mean_daily_bill:
+ description: Period daily average bill
+ period_mean_daily_consumption:
+ description: Period daily average consumption
+ period_total_consumption:
+ description: Total consumption
+ period_lower_price_consumption:
+ description: Period lower price consumption
+ period_higher_price_consumption:
+ description: Period higher price consumption
+ period_average_temperature:
+ description: Period average temperature
+ yesterday_total_consumption:
+ description: Yesterday total consumption
+ yesterday_lower_price_consumption:
+ description: Yesterday lower price consumption
+ yesterday_higher_price_consumption:
+ description: Yesterday higher price consumption
+ yesterday_average_temperature:
+ description: Yesterday average temperature
+{% endconfiguration %}
To find your contract id, go to the [Hydro-Québec website](https://www.hydroquebec.com/portail/)
and connect to your account.
diff --git a/source/_components/sensor.imap.markdown b/source/_components/sensor.imap.markdown
index f09956e9648..27ae8f63c78 100644
--- a/source/_components/sensor.imap.markdown
+++ b/source/_components/sensor.imap.markdown
@@ -30,11 +30,31 @@ sensor:
password: YOUR_PASSWORD
```
-Configuration variables:
-
-- **server** (*Required*): The IP address or hostname of the IMAP server.
-- **port** (*Optional*): The port where the server is accessible.
-- **name** (*Optional*): Name of the IMAP sensor.
-- **username** (*Required*): Username for the IMAP server.
-- **password** (*Required*): Password for the IMAP server.
-- **folder** (*Optional*): The IMAP folder to watch.
+{% configuration %}
+server:
+ description: The IP address or hostname of the IMAP server.
+ required: true
+ type: string
+port:
+ description: The port where the server is accessible.
+ required: false
+ default: 993
+ type: integer
+name:
+ description: Name of the IMAP sensor.
+ required: false
+ type: string
+username:
+ description: Username for the IMAP server.
+ required: true
+ type: string
+password:
+ description: Password for the IMAP server.
+ required: true
+ type: string
+folder:
+ description: The IMAP folder to watch.
+ required: false
+ default: inbox
+ type: string
+{% endconfiguration %}
diff --git a/source/_components/sensor.imap_email_content.markdown b/source/_components/sensor.imap_email_content.markdown
index e67340b7ef7..706b10b3e25 100644
--- a/source/_components/sensor.imap_email_content.markdown
+++ b/source/_components/sensor.imap_email_content.markdown
@@ -32,17 +32,43 @@ sensor:
- example@gmail.com
```
-Configuration variables:
-
-- **server** (*Required*): The IP address or hostname of the IMAP server.
-- **port** (*Required*): The port where the server is accessible.
-- **name** (*Optional*): Name of the IMAP sensor to use in the frontend.
-- **username** (*Required*): Username for the IMAP server.
-- **password** (*Required*): Password for the IMAP server.
-- **senders** (*Required*): A list of sender email addresses that are allowed to report state via email. Only emails received from these addresses will be processed.
-- **value_template** (*Optional*): If specified this template will be used to render the state of the sensor. If a template is not supplied the message subject will be used for the sensor value. The following attributes will be supplied to the template:
-
- * **from**: The from address of the email
- * **body**: The body of the email
- * **subject**: The subject of the email
- * **date**: The date and time the email was sent
+{% configuration %}
+server:
+ description: The IP address or hostname of the IMAP server.
+ required: true
+ type: string
+port:
+ description: The port where the server is accessible.
+ required: false
+ default: 993
+ type: integer
+name:
+ description: Name of the IMAP sensor.
+ required: false
+ type: string
+username:
+ description: Username for the IMAP server.
+ required: true
+ type: string
+password:
+ description: Password for the IMAP server.
+ required: true
+ type: string
+senders:
+ description: A list of sender email addresses that are allowed to report state via email. Only emails received from these addresses will be processed.
+ required: true
+ type: string
+value_template:
+ description: If specified this template will be used to render the state of the sensor. If a template is not supplied the message subject will be used for the sensor value. The following attributes will be supplied to the template.
+ required: false
+ type: template
+ keys:
+ from:
+ description: The from address of the email.
+ body:
+ description: The body of the email.
+ subject:
+ description: The subject of the email.
+ date:
+ description: The date and time the email was sent.
+{% endconfiguration %}
diff --git a/source/_components/sensor.influxdb.markdown b/source/_components/sensor.influxdb.markdown
index 66680379f7d..2e054847848 100644
--- a/source/_components/sensor.influxdb.markdown
+++ b/source/_components/sensor.influxdb.markdown
@@ -27,24 +27,77 @@ sensor:
measurement: '"°C"'
```
+{% configuration %}
+host:
+ description: IP address of your database host, e.g. 192.168.1.10.
+ required: false
+ default: localhost
+ type: string
+port:
+ description: Port to use.
+ required: false
+ default: 8086
+ type: string
+username:
+ description: The username of the database user.
+ required: false
+ type: string
+password:
+ description: The password for the database user account.
+ required: false
+ type: string
+ssl:
+ description: Use https instead of http to connect.
+ required: false
+ default: false
+ type: boolean
+verify_ssl:
+ description: Verify SSL certificate for https request.
+ required: false
+ default: false
+ type: boolean
+queries:
+ description: List of queries.
+ required: true
+ type: list
+ keys:
+ name:
+ description: The name of the sensor.
+ required: true
+ type: string
+ unit_of_measurement:
+ description: Defines the units of measurement of the sensor, if any.
+ required: false
+ type: string
+ measurement:
+ description: Defines the measurement name in InfluxDB (the FROM clause of the query).
+ required: true
+ type: string
+ where:
+ description: Defines the data selection clause (the where clause of the query).
+ required: true
+ type: string
+ value_template:
+ description: Defines a [template](/docs/configuration/templating/#processing incoming data) to extract a value from the payload.
+ required: false
+ type: template
+ database:
+ description: Name of the database to use.
+ required: false
+ default: home_assistant
+ type: string
+ group_function:
+ description: The group function to be used.
+ required: false
+ default: mean
+ type: string
+ field:
+ description: The field name to select.
+ required: true
+ type: string
+ default: value
+{% endconfiguration %}
-Configuration variables for the server:
-
-- **host** (*Optional*): IP address of your database host, eg. 192.168.1.10. Defaults to `localhost`.
-- **port** (*Optional*): Port to use. Defaults to 8086.
-- **username** (*Optional*): The username of the database user.
-- **password** (*Optional*): The password for the database user account.
-- **ssl** (*Optional*): Use `https` instead of `http` to connect. Defaults to `false`.
-- **verify_ssl** (*Optional*): Verify SSL certificate for `https` request. Defaults to `false`.
-- **queries** array (*Required*): List of queries
- - **name** (*Required*): The name of the sensor.
- - **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
- - **measurement** (*Required*): Defines the measurement name in InfluxDB (the from clause of the query).
- - **where** (*Required*): Defines the data selection clause (the where clause of the query).
- - **value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
- - **database** (*Optional*): Name of the database to use. Defaults to `home_assistant`.
- - **group_function** (*Optional*): The group function to be used. Defaults to `mean`.
- - **field** (*Optional*): The field name to select. Defaults to value.
## {% linkable_title Examples %}
diff --git a/source/_components/sensor.irish_rail_transport.markdown b/source/_components/sensor.irish_rail_transport.markdown
index f107633701a..120e887a657 100644
--- a/source/_components/sensor.irish_rail_transport.markdown
+++ b/source/_components/sensor.irish_rail_transport.markdown
@@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.57
---
-
The `irish_rail_transport` sensor will give you the time until the next two departures (within 90 minutes) from an Irish Rail station using the RTPI information.
A station name is the full station name as specified on the Irish Rail search site, for example, `Tara Street` or `Dublin Connolly`.
@@ -28,13 +27,29 @@ sensor:
name: "To Greystones"
```
-Configuration variables:
-
-- **station** (*Required*): The name of the station.
-- **direction** (*Optional*): The direction of the train. Typically either `Northbound` or `Southbound`.
-- **destination** (*Optional*): The name of the destination station to filter by.
-- **stops_at** (*Optional*): An optional filter based on the name of a station that the train stops at.
-- **name** (*Optional*): A friendly name for this sensor.
+{% configuration %}
+station:
+ description: The name of the station.
+ required: true
+ type: string
+direction:
+ description: The direction of the train. Typically either `Northbound` or `Southbound`.
+ required: false
+ type: string
+destination:
+ description: The name of the destination station to filter by.
+ required: false
+ type: string
+stops_at:
+ description: An optional filter based on the name of a station that the train stops at.
+ required: false
+ type: string
+name:
+ description: A friendly name for this sensor.
+ required: false
+ default: Next Train
+ type: string
+{% endconfiguration %}
Using the `stops_at` option will cause an extra request per train found. Therefore, if you are looking at a busy station, it is recommended that you also use at least one other filter. For example:
diff --git a/source/_components/sensor.logi_circle.markdown b/source/_components/sensor.logi_circle.markdown
index aa42c0218c8..80df3bc9ae4 100644
--- a/source/_components/sensor.logi_circle.markdown
+++ b/source/_components/sensor.logi_circle.markdown
@@ -29,15 +29,26 @@ sensor:
- platform: logi_circle
```
-Configuration variables:
-
-- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions supported by your camera will be enabled.
- - **battery_level**: Return the battery level percentage from the camera.
- - **last_activity_time**: Return the timestamp from the last time the Logi Circle camera detected any activity.
- - **privacy_mode**: Return the privacy mode status from the camera.
- - **signal_strength_category**: Return the WiFi signal level from the camera.
- - **signal_strength_percentage**: Return the WiFi signal percentage from the camera.
- - **speaker_volume**: Return the relative speaker volume from the camera (0-100%).
- - **streaming_mode**: Return the streaming mode status from the camera.
+{% configuration %}
+monitored_conditions:
+ description: Conditions to display in the frontend. The following conditions can be monitored. If not specified, all conditions supported by your camera will be enabled.
+ required: false
+ type: list
+ keys:
+ battery_level:
+ description: Return the battery level percentage from the camera.
+ last_activity_time:
+ description: Return the timestamp from the last time the Logi Circle camera detected any activity.
+ privacy_mode:
+ description: Return the privacy mode status from the camera.
+ signal_strength_category:
+ description: Return the WiFi signal level from the camera.
+ signal_strength_percentage:
+ description: Return the WiFi signal percentage from the camera.
+ speaker_volume:
+ description: Return the relative speaker volume from the camera (0-100%).
+ streaming_mode:
+ description: Return the streaming mode status from the camera.
+{% endconfiguration %}
Currently it supports all 1st and 2nd generation cameras. Cameras without an internal battery will not expose a `battery_level` sensor.
\ No newline at end of file
diff --git a/source/_components/sensor.london_underground.markdown b/source/_components/sensor.london_underground.markdown
index 45c7cce409b..57a1a5c1a5f 100644
--- a/source/_components/sensor.london_underground.markdown
+++ b/source/_components/sensor.london_underground.markdown
@@ -38,8 +38,11 @@ sensor:
- Waterloo & City
```
-Configuration variables:
-
-- **line** (*Required*): Enter the name of at least one line.
+{% configuration %}
+line:
+ description: Enter the name of at least one line.
+ required: true
+ type: list
+{% endconfiguration %}
Powered by TfL Open Data [TFL](https://api.tfl.gov.uk/).
diff --git a/source/_components/sensor.loopenergy.markdown b/source/_components/sensor.loopenergy.markdown
index b3369c6fc52..8288ea2b430 100644
--- a/source/_components/sensor.loopenergy.markdown
+++ b/source/_components/sensor.loopenergy.markdown
@@ -52,14 +52,34 @@ sensor:
gas_secret: 'GAS_SECRET'
```
-Configuration variables:
-
-- **electricity_serial** (*Required*): Serial number of your electricity sensor
-- **electricity_secret** (*Required*): Secret key for your electricity sensor
-- **gas_serial** (*Optional*): Serial number for your gas sensor.
-- **gas_secret** (*Optional*): Secret key for your gas sensor.
-- **gas_type** (*Optional*): Type of meter `imperial` or `metric`. Defaults to `metric`.
-- **gas_calorific** (*Optional*): Calorific value of your gas supply (usually on your gas bill). Defaults to 39.11.
+{% configuration %}
+electricity_serial:
+ description: Serial number of your electricity sensor.
+ required: true
+ type: string
+electricity_secret:
+ description: Secret key for your electricity sensor.
+ required: true
+ type: string
+gas_serial:
+ description: Serial number for your gas sensor.
+ required: true
+ type: string
+gas_secret:
+ description: Secret key for your gas sensor.
+ required: true
+ type: string
+gas_type:
+ description: Type of meter `imperial` or `metric`.
+ required: false
+ default: metric
+ type: string
+gas_calorific:
+ description: Calorific value of your gas supply (usually on your gas bill).
+ required: false
+ default: 39.11
+ type: float
+{% endconfiguration %}
The electricity readings are updated every 10 seconds and the gas readings every 15 minutes.
diff --git a/source/_components/sensor.lyft.markdown b/source/_components/sensor.lyft.markdown
index c86b811e161..6241bad852f 100644
--- a/source/_components/sensor.lyft.markdown
+++ b/source/_components/sensor.lyft.markdown
@@ -13,10 +13,8 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.41
---
-
The `lyft` sensor will give you time and price estimates for all available [Lyft](https://lyft.com) products at the given `start_latitude` and `start_longitude`.The `ATTRIBUTES` are used to provide extra information about products, such as vehicle capacity and fare rates. If an `end_latitude` and `end_longitude` are specified, a price estimate will also be provided. One sensor will be created for each product at the given `start` location, for pickup time. A second sensor for each product, for estimated price, will be created if a destination is specified. The sensor is powered by the official Lyft [API](https://developer.lyft.com/reference/).
-
You must create an application [here](https://www.lyft.com/developers/manage) to obtain a `client_id` and `client_secret`.
To enable this sensor, add the following lines to your `configuration.yaml` file:
@@ -27,20 +25,41 @@ sensor:
- platform: lyft
client_id: CLIENT_ID
client_secret: CLIENT_SECRET
- start_latitude: 37.8116380
+ start_latitude: 37.8116380
```
-Configuration variables:
+{% configuration %}
+client_id:
+ description: "A client id obtained from [developer.lyft.com](https://developer.lyft.com) after [creating an app](https://www.lyft.com/developers/manage)."
+ required: true
+ type: string
+client_secret:
+ description: "A client secret obtained from [developer.lyft.com](https://developer.lyft.com) after [creating an app](https://www.lyft.com/developers/manage)."
+ required: true
+ type: string
+start_latitude:
+ description: The starting latitude for a trip.
+ required: true
+ type: float
+start_longitude:
+ description: The starting longitude for a trip.
+ required: true
+ type: float
+end_latitude:
+ description: The ending latitude for a trip. While `end_latitude` is optional, providing an `end_latitude`/`end_longitude` allows price estimates as well as time.
+ required: false
+ type: float
+end_longitude:
+ description: The ending longitude for a trip. While `end_longitude` is optional, providing an `end_latitude`/`end_longitude` allows price estimates as well as time.
+ required: false
+ type: float
+product_ids:
+ description: A list of Lyft product IDs.
+ required: false
+ type: [list, string]
+{% endconfiguration %}
-- **client_id** (*Required*): A client id obtained from [developer.lyft.com](https://developer.lyft.com) after [creating an app](https://www.lyft.com/developers/manage).
-- **client_secret** (*Required*) A client secret obtained from [developer.lyft.com](https://developer.lyft.com) after [creating an app](https://www.lyft.com/developers/manage).
-- **start_latitude** (*Required*): The starting latitude for a trip.
-- **start_longitude** (*Required*): The starting longitude for a trip.
-- **end_latitude** (*Optional*): The ending latitude for a trip. While `end_latitude` is optional, providing an `end_latitude`/`end_longitude` allows price estimates as well as time.
-- **end_longitude** (*Optional*): The ending longitude for a trip. While `end_longitude` is optional, providing an `end_latitude`/`end_longitude` allows price estimates as well as time.
-- **product_ids** (*Optional*): A list of Lyft product IDs.
-
-A full configuration entry could look like the sample below:
+A full configuration entry could look like the sample below:
```yaml
# Example configuration.yaml entry
@@ -48,7 +67,7 @@ sensor:
- platform: lyft
client_id: CLIENT_ID
client_secret: CLIENT_SECRET
- start_latitude: 37.8116380
+ start_latitude: 37.8116380
start_longitude: -122.2648050
end_latitude: 37.615223
end_longitude: -122.389977
diff --git a/source/_components/sensor.metoffice.markdown b/source/_components/sensor.metoffice.markdown
index 38447940de0..de9f1eca3dc 100644
--- a/source/_components/sensor.metoffice.markdown
+++ b/source/_components/sensor.metoffice.markdown
@@ -41,27 +41,54 @@ sensor:
Your location will be detected from your home `latitude` and `longitude` settings.
-Configuration variables:
-
-- **api_key** (*Required*): Your personal API key from the [Datapoint website](https://www.metoffice.gov.uk/datapoint).
-- **name** (*Optional*): Additional name for the sensors. Default to platform name.
-- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml`.
-- **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml`.
-- **monitored_conditions** array (*Required*): Conditions to display in the frontend.
- - **weather**: A human-readable text summary of the current conditions.
- - **temperature**: The current temperature.
- - **feels_like_temperature**: A numerical value representing the apparent (or "feels like") temperature.
- - **wind_speed**: The wind speed.
- - **wind_direction**: Where the wind is coming from.
- - **wind_gust**: If there are wind gusts.
- - **visibility**: The average visibility.
- - **visibility_distance**: The visibility distance.
- - **uv**: The UV index.
- - **precipitation**: The average expected intensity of precipitation occurring.
- - **humidity**: The relative humidity.
+{% configuration %}
+api_key:
+ description: "Your personal API key from the [Datapoint website](https://www.metoffice.gov.uk/datapoint)."
+ required: true
+ type: string
+name:
+ description: Additional name for the sensors.
+ required: false
+ defaults: Met Office
+ type: string
+latitude:
+ description: "Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml`."
+ required: inclusive
+ type: float
+longitude:
+ description: "Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml`."
+ required: inclusive
+ type: float
+monitored_conditions:
+ description: Conditions to display in the frontend.
+ required: true
+ type: list
+ keys:
+ weather:
+ description: A human-readable text summary of the current conditions.
+ temperature:
+ description: The current temperature.
+ feels_like_temperature:
+ description: A numerical value representing the apparent (or "feels like") temperature.
+ wind_speed:
+ description: The wind speed.
+ wind_direction:
+ description: Where the wind is coming from.
+ wind_gust:
+ description: If there are wind gusts.
+ visibility:
+ description: The average visibility.
+ visibility_distance:
+ description: The visibility distance.
+ uv:
+ description: The UV index.
+ precipitation:
+ description: The average expected intensity of precipitation occurring.
+ humidity:
+ description: The relative humidity.
+{% endconfiguration %}
This sensor is an alternative to the [`metoffice`](/components/weather.metoffice/) weather platform. The weather platform is easier to configure but less customizable.
- diff --git a/source/_components/sensor.mfi.markdown b/source/_components/sensor.mfi.markdown index a0aeac788de..6f179909a3f 100644 --- a/source/_components/sensor.mfi.markdown +++ b/source/_components/sensor.mfi.markdown @@ -29,12 +29,32 @@ sensor: password: YOUR_PASSWORD ``` -Configuration variables: - -- **host** (*Required*): The IP address or hostname of your mFi controller. -- **port** (*Optional*): The port of your mFi controller. Defaults to 6443 for TLS, otherwise 6080. -- **username** (*Required*): The mFi admin username. -- **password** (*Required*): The mFi admin user's password. -- **ssl** (*Optional*): If `True`, use SSL/TLS to contact the mFi controller. Defaults to `True`. -- **verify_ssl** (*Optional*): Set this to `False` if your mFi controller has a self-signed certificate. Defaults to `True`. - +{% configuration %} +host: + description: The IP address or hostname of your mFi controller. + required: true + type: string +port: + description: The port of your mFi controller. + required: false + default: 6080 (6443 for TLS) + type: integer +username: + description: The mFi admin username. + required: true + type: string +password: + description: The mFi admin user's password. + required: true + type: string +ssl: + description: If `true`, use SSL/TLS to contact the mFi controller. + required: false + default: true + type: boolean +verify_ssl: + description: Set this to `false` if your mFi controller has a self-signed certificate. + required: false + default: true + type: boolean +{% endconfiguration %} diff --git a/source/_components/sensor.miflora.markdown b/source/_components/sensor.miflora.markdown index db6452c2c5e..9bf2c573072 100644 --- a/source/_components/sensor.miflora.markdown +++ b/source/_components/sensor.miflora.markdown @@ -13,7 +13,7 @@ ha_release: 0.29 ha_iot_class: "Local Polling" --- -The `miflora` sensor platform allows one to monitor plant soil and air conditions. The [Mi Flora plant sensor](https://xiaomi-mi.com/sockets-and-sensors/xiaomi-huahuacaocao-flower-care-smart-monitor/) is a small Bluetooth Low Energy device that monitors the moisture and conductivity of the soil as well as ambient light and temperature. Since only one BLE device can be polled at a time, the library implements locking to prevent polling more than one device at a time. +The `miflora` sensor platform allows one to monitor plant soil and air conditions. The [Mi Flora plant sensor](https://www.huahuacaocao.com/product) is a small Bluetooth Low Energy device that monitors the moisture and conductivity of the soil as well as ambient light and temperature. Since only one BLE device can be polled at a time, the library implements locking to prevent polling more than one device at a time. # Install Bluetooth Backend Before configuring Home Assistant you need a Bluetooth backend and the MAC address of your sensor. Depending on your operating system, you may have to configure the proper Bluetooth backend for your system: diff --git a/source/_components/sensor.min_max.markdown b/source/_components/sensor.min_max.markdown index be649657ae8..0d389c88664 100644 --- a/source/_components/sensor.min_max.markdown +++ b/source/_components/sensor.min_max.markdown @@ -14,7 +14,6 @@ ha_release: "0.31" ha_qa_scale: internal --- - The `min_max` sensor platform consumes the state from other sensors to determine the minimum, maximum, latest (last) and the mean of the collected states. The sensor will always show you the lowest/highest/latest value which was received from all monitored sensors. If you have spikes in your values, it's recommended to filter/equalize your values with a [statistics sensor](/components/sensor.statistics/) first. This sensor is an alternative to the [template sensor](/components/sensor.template/)'s `value_template:` to get the average of multiple sensors. @@ -44,10 +43,23 @@ sensor: - sensor.office_temperature ``` -Configuration variables: - -- **entity_ids** (*Required*): At least two entities to monitor. The unit of measurement of the first entry will be the one that's used. All entities must use the same unit of measurement. -- **type** (*Optional*): The type of sensor: `min`, `max`, `last` or `mean`. Defaults to `max`. -- **name** (*Optional*): Name of the sensor to use in the frontend. -- **round_digits** (*Optional*): Round mean value to specified number of digits. Defaults to 2. - +{% configuration %} +entity_ids: + description: At least two entities to monitor. The unit of measurement of the first entry will be the one that's used. All entities must use the same unit of measurement. + required: true + type: [list, string] +type: + description: "The type of sensor: `min`, `max`, `last` or `mean`." + required: false + default: max + type: string +name: + description: Name of the sensor to use in the frontend. + required: false + type: string +round_digits: + description: Round mean value to specified number of digits. + required: false + type: integer + default: 2 +{% endconfiguration %} diff --git a/source/_components/sensor.mitemp_bt.markdown b/source/_components/sensor.mitemp_bt.markdown index bf54f976824..d7bdbccaffe 100644 --- a/source/_components/sensor.mitemp_bt.markdown +++ b/source/_components/sensor.mitemp_bt.markdown @@ -19,12 +19,12 @@ The `mitemp_bt` sensor platform allows one to monitor room temperature and humid Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system: -- On [Hass.io](/hassio/installation/): mitemp_bt will work out of the box. +- On [Hass.io](/hassio/installation/): `mitemp_bt` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does). - On a [generic Docker installation](https://www.home-assistant.io/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host. - On other Linux systems: - Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one. - - Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth`, `bluez-deprecated` -- Windows and MacOS are currently not supported by the btlewrap library. + - Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`. +- Windows and MacOS are currently not supported by the `btlewrap` library. ## {% linkable_title Configuration %} @@ -114,6 +114,8 @@ adapter: Note that by default the sensor is only polled once every 5 minutes. This means with the `median: 3` setting will take as least 15 minutes before the sensor will report a value after a Home Assistant restart. Even though the hardware is able to provide new values every second, room temperatures don't change that quickly. Reducing polling intervals will have a negative effect on the battery life. +## {% linkable_title Full example %} + A full configuration example could look like the one below: ```yaml diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index 8b8a0fc07b6..f29e5299776 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -33,7 +33,7 @@ state_topic: required: true type: string name: - description: Name of the MQTT sensor. + description: The name of the MQTT sensor. required: false type: string default: MQTT Sensor @@ -47,7 +47,7 @@ unit_of_measurement: required: false type: string icon: - description: Icon for the sensor. + description: The icon for the sensor. required: false type: icon expire_after: @@ -91,6 +91,35 @@ device_class: required: false type: device_class default: None +device: + description: 'Information about the device this sensor is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.' + required: false + type: map + keys: + identifiers: + description: 'A list of IDs that uniquely identify the device. For example a serial number.' + required: false + type: list, string + connections: + description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' + required: false + type: list + manufacturer: + description: 'The manufacturer of the device.' + required: false + type: string + model: + description: 'The model of the device.' + required: false + type: string + name: + description: 'The name of the device.' + required: false + type: string + sw_version: + description: 'The firmware version of the device.' + required: false + type: string {% endconfiguration %} ## {% linkable_title Examples %} @@ -99,18 +128,18 @@ In this section you find some real-life examples of how to use this sensor. ### {% linkable_title JSON attributes configuration %} -The example sensor below shows a configuration example which uses JSON in the state topic to add extra attributes. It also makes use of the availability topic. Attributes can then be extracted in [Templates](/docs/configuration/templating/#attributes). For example, to extract the `ClientName` attribute from the sensor below, use a template similar to: {% raw %}`{{ state_attr('sensor.bs_rssi', 'ClientName') }}`{% endraw %}. +The example sensor below shows a configuration example which uses JSON in the state topic to add extra attributes. It also makes use of the `availability` topic. Attributes can then be extracted in [Templates](/docs/configuration/templating/#attributes). For example, to extract the `ClientName` attribute from the sensor below, use a template similar to: {% raw %}`{{ state_attr('sensor.bs_rssi', 'ClientName') }}`{% endraw %}. {% raw %} ```yaml # Example configuration.yaml entry sensor: - platform: mqtt - name: "BS RSSI" - state_topic: "HUISHS/BunnyShed/NodeHealthJSON" + name: "RSSI" + state_topic: "home/sensor1/infojson" unit_of_measurement: 'dBm' value_template: "{{ value_json.RSSI }}" - availability_topic: "HUISHS/BunnyShed/status" + availability_topic: "home/sensor1/status" payload_available: "online" payload_not_available: "offline" json_attributes: diff --git a/source/_components/sensor.nederlandse_spoorwegen.markdown b/source/_components/sensor.nederlandse_spoorwegen.markdown index bbdee43f633..fca03b35dde 100644 --- a/source/_components/sensor.nederlandse_spoorwegen.markdown +++ b/source/_components/sensor.nederlandse_spoorwegen.markdown @@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling" ha_release: "0.57" --- - This sensor will provide you with time table information of the [Nederlandse Spoorwegen](https://www.ns.nl/) train service in the Netherlands. You must create an application [here](https://www.ns.nl/ews-aanvraagformulier/) to obtain a `password`. @@ -36,15 +35,37 @@ sensor: via: Zl ``` -Configuration variables: - -- **email** (*Required*): The email address you used to request the API password. -- **password** (*Required*): The API password provided by the Nederlandse Spoorwegen. -- **routes** array (*Required*): List of traveling routes. - - **name** (*Required*): Name of the route. - - **from** (*Required*): The start station. - - **to** (*Required*): Direction of the traveling. - - **via** (*Optional*): Optional other station you wish to visit in between. +{% configuration %} +email: + description: The email address you used to request the API password. + required: true + type: string +password: + description: The API password provided by the Nederlandse Spoorwegen. + required: true + type: string +routes: + description: List of traveling routes. + required: false + type: list + keys: + name: + description: Name of the route. + required: true + type: string + frome: + description: The start station. + required: true + type: string + to: + description: Direction of the traveling. + required: true + type: string + via: + description: Optional other station you wish to visit in between. + required: false + type: string +{% endconfiguration %} The data are coming from [Nederlandse Spoorwegen](https://www.ns.nl/). diff --git a/source/_components/sensor.nest.markdown b/source/_components/sensor.nest.markdown index 99d40e63016..801198eb46b 100644 --- a/source/_components/sensor.nest.markdown +++ b/source/_components/sensor.nest.markdown @@ -13,7 +13,6 @@ ha_release: pre 0.7 ha_iot_class: "Cloud Push" --- - The `nest` sensor platform lets you monitor sensors connected to your [Nest](https://nest.com) devices.@@ -23,6 +22,7 @@ You must have the [Nest component](/components/nest/) configured to use these se ## {% linkable_title Configuration %} To enable sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings: + ```yaml # Example configuration.yaml entry nest: @@ -34,9 +34,12 @@ nest: By default all sensors for your available Nest devices will be monitored. Leave `monitored_conditions` blank to disable all sensors for the [Nest component](/components/nest/). -Configuration variables: - -- **monitored_conditions** array (*Optional*): States to monitor. +{% configuration %} +monitored_conditions: + description: States to monitor. + required: false + type: list +{% endconfiguration %} The following conditions are available by device: diff --git a/source/_components/sensor.nest_weather.markdown b/source/_components/sensor.nest_weather.markdown index 971e72cb162..a8ab4c4c460 100644 --- a/source/_components/sensor.nest_weather.markdown +++ b/source/_components/sensor.nest_weather.markdown @@ -16,7 +16,6 @@ ha_iot_class: "Cloud Polling" **This platform is currently not available. It's possible that `nest_weather` will be removed in the future.**
- The `nest` weather sensor platform let you monitor current weather conditions based on the location of your [Nest](https://nest.com) thermostat.@@ -32,12 +31,20 @@ sensor: - 'weather_temperature' ``` -Configuration variables: - -- **monitored_conditions** array (*Required*): States to monitor. - - 'weather_temperature' - - 'weather_humidity' - - 'weather_condition' - - 'wind_speed' - - 'wind_direction' - +{% configuration %} +monitored_conditions: + description: States to monitor. + required: true + type: list + keys: + weather_temperature: + description: The current temperture + weather_humidity: + description: The current humidity + weather_condition: + description: The weather conditions + wind_speed: + description: The wind speed + wind_direction: + description: The wind direction +{% endconfiguration %} diff --git a/source/_components/sensor.neurio_energy.markdown b/source/_components/sensor.neurio_energy.markdown index 03f9c22b581..ea56901adba 100644 --- a/source/_components/sensor.neurio_energy.markdown +++ b/source/_components/sensor.neurio_energy.markdown @@ -13,7 +13,6 @@ ha_iot_class: "Cloud Polling" ha_release: 0.14 --- - Integrate your [Neurio](http://neur.io/) meter information into Home Assistant. To get an API key and secret, login to your [Neurio account](https://my.neur.io/#settings/applications/register) and register an application. Note the Homepage URL and Callback URL are optional. To enable this sensor in your installation, add the following to your `configuration.yaml` file: @@ -27,12 +26,20 @@ sensor: ``` Two sensors will be created with the following names: -- **Energy Usage**: Current active power usage in Watts. Updated every 10 seconds. +- **Energy Usage**: Current active power usage in Watts. Updated every 10 seconds. - **Daily Energy Usage**: Daily power usage in kWh. Updated every 2.5 minutes. -Configuration variables: - -- **api_key** (*Required*): The API key for your account/application. -- **api_secret** (*Required*): The API secret for your account/application. -- **sensor_id** (*Optional*): The sensor ID will be auto-detected but can be set if you have more then one sensor. - +{% configuration %} +api_key: + description: The API key for your account/application. + required: true + type: string +api_secret: + description: The API secret for your account/application. + required: true + type: string +sensor_id: + description: The sensor ID will be auto-detected but can be set if you have more then one sensor. + required: false + type: string +{% endconfiguration %} diff --git a/source/_components/sensor.octoprint.markdown b/source/_components/sensor.octoprint.markdown index c9f3aed618a..c2998392855 100644 --- a/source/_components/sensor.octoprint.markdown +++ b/source/_components/sensor.octoprint.markdown @@ -17,34 +17,5 @@ ha_iot_class: "Local Polling" The `octoprint` sensor platform let you monitor various states of your 3D printer and its print jobs.
-You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor. -
- -To set it up, add the following information to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -sensor: - - platform: octoprint - name: OctoPrint - monitored_conditions: - - Current State - - Temperatures - - Job Percentage - - Time Elapsed - - Time Remaining -``` - -Configuration variables: - -- **name** (*Optional*): The name of the sensor. Default is 'OctoPrint'. -- **monitored_conditions** array (*Required*): States to monitor. - - **Current State**: Text of current state. - - **Temperatures**: Temperatures of all available tools, eg. `print`, `head`, `print bed`, etc. These will be displayed as `tool0`, `tool1`, or `toolN` please refer to your OctoPrint frontend to associate the tool number with an actual device. - - **Job Percentage**: Percentage of the job. - - **Time Elapsed**: Time elapsed on current print job, in seconds. - - **Time Remaining**: Time remaining on current print job, in seconds. - --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. +You must have the [OctoPrint component](/components/octoprint/) configured to use this sensor. After configuring that component, sensors automatically appear.
diff --git a/source/_components/sensor.ohmconnect.markdown b/source/_components/sensor.ohmconnect.markdown index 7f564a76d3c..ed30d3f2664 100644 --- a/source/_components/sensor.ohmconnect.markdown +++ b/source/_components/sensor.ohmconnect.markdown @@ -13,22 +13,33 @@ ha_iot_class: "Cloud Polling" ha_release: 0.26 --- - The `ohmconnect` sensor will show you the current [OhmConnect](https://www.ohmconnect.com/) status for the given OhmConnect ID. -> OhmConnect monitors real-time conditions on the electricity grid. When dirty and unsustainable power plants turn on, our users receive a notification to save energy. By saving energy at that time, California does not have to turn on additional power plants and California's energy authorities pay you for that. +OhmConnect monitors real-time conditions on the electricity grid. When dirty and unsustainable power plants turn on, our users receive a notification to save energy. By saving energy at that time, California does not have to turn on additional power plants and California's energy authorities pay you for that. +## {% linkable_title Configuration %} -You can find your OhmConnect ID under "Open Source Projects" on the [settings page](https://login.ohmconnect.com/settings). It's the string after the last `/` in the URL, i.e. for the URL `https://login.ohmconnect.com/verify-ohm-hour/AbCd1e` your ID is `AbCd1e`. +You can find your OhmConnect ID under "Open Source Projects" on the [settings page](https://login.ohmconnect.com/settings). It's the string after the last `/` in the URL, e.g., for the URL `https://login.ohmconnect.com/verify-ohm-hour/AbCd1e` your ID is `AbCd1e`. + +## {% linkable_title Configuration %} + +To enable the OhMConnect sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry sensor: - platform: ohmconnect - id: AbCd1e + id: YOUR_OHMCONNECT_ID ``` -Configuration variables: - -- **id** (*Required*): Your OhmConnect ID which can be found on the settings page. -- **name** (*Optional*): A name to display on the sensor. The default is "OhmConnect Status". +{% configuration %} +id: + description: Your OhmConnect ID. + required: true + type: string +name: + description: A name to display on the sensor. + required: false + default: OhmConnect Status + type: string +{% endconfiguration %} diff --git a/source/_components/sensor.openevse.markdown b/source/_components/sensor.openevse.markdown index df249bd1137..99c3769357f 100644 --- a/source/_components/sensor.openevse.markdown +++ b/source/_components/sensor.openevse.markdown @@ -29,14 +29,28 @@ sensor: - status ``` -Configuration variables: - -- **host** (*Required*): The IP address or hostname of your charger -- **monitored_variables** array (*Required*): Conditions to display on the frontend. - - **status**: The status of the charger (i.e., "Connected", "Charging", etc.) - - **charge_time**: The number of minutes the charging has been charging, or 0 if it is not charging. - - **rtc_temp**: The temperature reported by the real time clock sensor, or 0 if the sensor is not installed. - - **ir_temp**: The temperature reported by the IR remote sensor, or 0 if the sensor is not installed. - - **ambient_temp**: The temperature reported by the ambient sensor, or 0 if the sensor is not installed. - - **usage_session**: The energy usage for the current charging session. - - **usage_total**: The total energy usage for the device. +{% configuration %} +host: + description: The IP address or hostname of your charger. + required: true + type: string +monitored_variables: + description: Conditions to display on the frontend. + required: true + type: list + keys: + status: + description: The status of the charger (i.e., "Connected", "Charging", etc.). + charge_time: + description: The number of minutes the charging has been charging, or 0 if it is not charging. + rtc_temp: + description: The temperature reported by the real time clock sensor, or 0 if the sensor is not installed. + ir_temp: + description: The temperature reported by the IR remote sensor, or 0 if the sensor is not installed. + ambient_temp: + description: The temperature reported by the ambient sensor, or 0 if the sensor is not installed. + usage_session: + description: The energy usage for the current charging session. + usage_total: + description: The total energy usage for the device. +{% endconfiguration %} diff --git a/source/_components/sensor.opentherm_gw.markdown b/source/_components/sensor.opentherm_gw.markdown new file mode 100644 index 00000000000..108b7ac09ed --- /dev/null +++ b/source/_components/sensor.opentherm_gw.markdown @@ -0,0 +1,24 @@ +--- +layout: page +title: "OpenTherm Gateway Sensor" +description: "Expose internal data from the OpenTherm Gateway." +date: 2018-10-10 12:23 +sidebar: true +comments: false +sharing: true +footer: true +logo: opentherm.png +ha_category: Sensor +ha_release: 0.81 +ha_iot_class: "Local Push" +--- + +The `opentherm_gw` sensor platform is used to expose internal data from the [OpenTherm Gateway](http://otgw.tclcode.com/) in Home Assistant. + +# {% linkable_title Configuration %} + +Configuration of this platform is achieved through the [OpenTherm Gateway Hub](/components/opentherm_gw/) configuration. + ++The OpenTherm protocol is based on polling. The thermostat sends requests to the boiler at specific intervals. As a result, it may take some time for changes to propagate between Home Assistant and the thermostat. +
diff --git a/source/_components/sensor.otp.markdown b/source/_components/sensor.otp.markdown index 2364e986398..5e753501752 100644 --- a/source/_components/sensor.otp.markdown +++ b/source/_components/sensor.otp.markdown @@ -27,10 +27,17 @@ sensor: token: SHARED_SECRET_TOKEN ``` -Configuration variables: - -- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `OTP Sensor`. -- **token** (*Required*): The shared secret you use in your OTP generator (e.g., Google Authenticator on your phone) +{% configuration %} +name: + description: Name of the sensor to use in the frontend. + required: false + default: OTP Sensor + type: string +token: + description: The shared secret you use in your OTP generator (e.g., Google Authenticator on your phone). + required: true + type: string +{% endconfiguration %} ## Generating a token @@ -48,6 +55,7 @@ To run in a Docker container: $ docker exec -it home-assistant python -c 'import pyotp; print("Token:", pyotp.random_base32())' Token: IHEDPEBEVA2WVHB7 ``` + Copy and paste the token into your Home Assistant configuration and add it to your OTP generator. Verify that they generate the same code.diff --git a/source/_components/sensor.pilight.markdown b/source/_components/sensor.pilight.markdown index 78e5b61abf4..13ed0303ffa 100644 --- a/source/_components/sensor.pilight.markdown +++ b/source/_components/sensor.pilight.markdown @@ -13,7 +13,6 @@ ha_release: 0.31 ha_iot_class: depends --- - This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g., _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up. ## {% linkable_title Configuration %} @@ -29,18 +28,30 @@ sensor: uuid: '0000-b8-27-eb-f447d3' ``` -Configuration variables: - -- **variable** (*Required*): The variable name in the data stream that defines the sensor value. -- **payload** (*Required*): Message payload identifiers. Only if all identifiers are matched the sensor value is set. -- **name** (*Optional*): Name of the sensor. -- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any. +{% configuration %} +variable: + description: The variable name in the data stream that defines the sensor value. + required: true + type: string +payload: + description: Message payload identifiers. Only if all identifiers are matched the sensor value is set. + required: true + type: string +name: + description: Name of the sensor. + required: false + default: Pilight Sensor + type: string +unit_of_measurement: + description: Defines the units of measurement of the sensor, if any. + required: false + type: string +{% endconfiguration %} ## {% linkable_title Example: Weather station %} This section shows a real life example how to use values of a weather station. - ```yaml # Example configuration.yaml entry sensor: diff --git a/source/_components/sensor.plex.markdown b/source/_components/sensor.plex.markdown index 34781716237..30646976192 100644 --- a/source/_components/sensor.plex.markdown +++ b/source/_components/sensor.plex.markdown @@ -27,13 +27,41 @@ sensor: - platform: plex ``` -Configuration variables: - -- **host** (*Optional*): The IP address of your Plex server. Defaults to `localhost`. -- **port** (*Optional*): The port of your Plex Server. Defaults to `32400`. -- **name** (*Optional*): Name of the Plex server. Defaults to "Plex". -- **username** (*Optional*): The username for the remote Plex server. -- **password** (*Optional*): The password for your given account on the remote Plex server. -- **server** (*Optional*): The name of your remote Plex server. -- **token** (*Optional*): X-Plex-Token of your remote Plex server. -- **ssl** (*Optional*): Use HTTPS to connect to Plex server, *NOTE* host *must not* be an IP when this option is enabled. Defaults to "False" +{% configuration %} +host: + description: The IP address of your Plex server. + required: false + default: localhost + type: string +port: + description: The port of your Plex Server. + required: false + default: 32400 + type: integer +name: + description: Name of the Plex server. + required: false + default: Plex + type: string +username: + description: The username for the remote Plex server. + required: false + type: string +password: + description: The password for your given account on the remote Plex server. + required: false + type: string +server: + description: The name of your remote Plex server. + required: false + type: string +token: + description: X-Plex-Token of your remote Plex server. + required: false + type: string +ssl: + description: Use HTTPS to connect to Plex server, *NOTE* host *must not* be an IP when this option is enabled. + required: false + default: false + type: boolean +{% endconfiguration %} diff --git a/source/_components/sensor.pocketcasts.markdown b/source/_components/sensor.pocketcasts.markdown index 0a1c0d1fce8..10fcc6003e7 100644 --- a/source/_components/sensor.pocketcasts.markdown +++ b/source/_components/sensor.pocketcasts.markdown @@ -27,7 +27,13 @@ sensor: password: YOUR_PASSWORD ``` -Configuration variables: - -- **username** (*Required*): The username to access the PocketCasts service. -- **password** (*Required*): The password for the given username. +{% configuration %} +username: + description: The username to access the PocketCasts service. + required: true + type: string +password: + description: The password for the given username. + required: true + type: string +{% endconfiguration %} diff --git a/source/_components/sensor.pushbullet.markdown b/source/_components/sensor.pushbullet.markdown index bd8ee0eda5a..8d516949e9e 100644 --- a/source/_components/sensor.pushbullet.markdown +++ b/source/_components/sensor.pushbullet.markdown @@ -13,11 +13,16 @@ ha_release: 0.44 ha_iot_class: "Cloud Polling" --- -The `pushbullet` sensor platform reads messages from [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends. -This sensor platform provides sensors that show the properties of the latest received Pushbullet notification mirror. +The `pushbullet` sensor platform reads messages from [Pushbullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers, and friends. This sensor platform provides sensors that show the properties of the latest received Pushbullet notification mirror. + +## {% linkable_title Setup %} Notification Mirroring allows users to see their Android device's notifications on their computer. It must be first enabled in the app and is currently only available on the Android platform. For more information, please see [this announcement](https://blog.pushbullet.com/2013/11/12/real-time-notification-mirroring-from-android-to-your-computer/) on the Pushbullet Blog. +Go to [https://www.pushbullet.com/#settings/account](https://www.pushbullet.com/#settings/account) to retrieve your API key/access token. + +## {% linkable_title Configuration %} + To enable the Pushbullet sensor in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -29,21 +34,37 @@ sensor: - body ``` -Configuration variables: +{% configuration %} +api_key: + description: Your Pushbullet API key. + required: true + type: string +monitored_conditions: + description: Properties of the push to monitor. + required: false + default: "`body` and `title`" + type: list + keys: + application_name: + description: The application sending the push. + body: + description: Body of the message. + notification_id: + description: ID of the notification. + notification_tag: + description: Tag (if the application sending supports it). + package_name: + description: Name of the sender's package. + receiver_email: + description: The email of the push's target. + sender_email: + description: The sender of the push. + source_device_iden: + description: ID of the sender's device. + title: + description: Title of the push. + type: + description: Type of push. +{% endconfiguration %} -- **api_key** (*Required*): Enter the API key for Pushbullet. Go to [https://www.pushbullet.com/#settings/account](https://www.pushbullet.com/#settings/account) to retrieve your API key/access token. - -- **monitored_conditions** array (*Optional*): Properties of the push to monitor. Defaults to `body` and `title`. - - **application_name**: The application sending the push. - - **body**: Body of the message. - - **notification_id**: ID of the notification. - - **notification_tag**: Tag (if the application sending supports it). - - **package_name**: Name of the sender's package. - - **receiver_email**: The email of the push's target. - - **sender_email**: The sender of the push. - - **source_device_iden**: ID of the sender's device. - - **title**: Title of the push. - - **type**: Type of push. - - All properties will be displayed as attributes. The properties array are just for logging the sensor readings for multiple properties. diff --git a/source/_components/sensor.pvoutput.markdown b/source/_components/sensor.pvoutput.markdown index a61f6614590..36e3f43ab6e 100644 --- a/source/_components/sensor.pvoutput.markdown +++ b/source/_components/sensor.pvoutput.markdown @@ -27,10 +27,21 @@ sensor: scan_interval: 120 ``` -Configuration variables: - -- **api_key** (*Required*): Your API key. A read-only key is fine. -- **system_id** (*Required*): The ID of your station. +{% configuration %} +api_key: + description: Your API key. A read-only key is fine. + required: true + type: string +system_id: + description: The ID of your station. + required: true + type: string +name: + description: Name of the sensor. + required: false + default: PVOutput + type: string +{% endconfiguration %}
It's recommended to set `scan_interval:` according to a value greater than 60 seconds. The service only allows 60 requests per hour but the sensor's default is 30 seconds. diff --git a/source/_components/sensor.raincloud.markdown b/source/_components/sensor.raincloud.markdown index 9435f1a7782..138eb20da16 100644 --- a/source/_components/sensor.raincloud.markdown +++ b/source/_components/sensor.raincloud.markdown @@ -25,10 +25,19 @@ sensor: - platform: raincloud ``` -Configuration variables: - -- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. If not specified, all conditions below will be enabled by default. The following conditions can be monitored. - - **battery**: Return the battery level the Melnor RainCloud faucet. - - **next_cycle**: Return the next schedulle watering cycle per zone. - - **rain_delay**: Return the number of days the automatic watering will be delayed due to raining per zone. - - **watering_time**: Return the watering remaining minutes per zone. +{% configuration %} +monitored_conditions: + description: Conditions to display in the frontend. The following conditions can be monitored. + required: false + default: If not specified, all conditions below will be enabled. + type: list + keys: + battery: + description: Return the battery level the Melnor RainCloud faucet. + next_cycle: + description: Return the next schedulle watering cycle per zone. + rain_delay: + description: Return the number of days the automatic watering will be delayed due to raining per zone. + watering_time: + description: Return the watering remaining minutes per zone. +{% endconfiguration %} diff --git a/source/_components/sensor.rest.markdown b/source/_components/sensor.rest.markdown index 7e756ce6a3d..bae594e5f4a 100644 --- a/source/_components/sensor.rest.markdown +++ b/source/_components/sensor.rest.markdown @@ -43,7 +43,7 @@ resource: type: string default: string method: - description: The method of the request. + description: The method of the request. Either `POST` or `GET`. required: false type: string default: GET diff --git a/source/_components/sensor.rflink.markdown b/source/_components/sensor.rflink.markdown index 60306416cb4..7254bbf2f27 100644 --- a/source/_components/sensor.rflink.markdown +++ b/source/_components/sensor.rflink.markdown @@ -34,17 +34,35 @@ sensor: sensor_type: temperature ``` -Configuration variables: - -- **automatic_add** (*Optional*): Automatically add new/unconfigured devices to HA if detected (default: True). -- **devices** (*Optional*): A list of devices with their name to use in the frontend. - -Device configuration variables: - -- **sensor_type** (*Required*): Override automatically detected type of sensor. For list of values see below. -- **name** (*Optional*): Name for the device, defaults to RFLink ID. -- **unit_of_measurement** (*Optional*): Override automatically detected unit of sensor. -- **aliases** (*Optional*): Alternative RFLink ID's this device is known by. +{% configuration %} +automatic_add: + description: Automatically add new/unconfigured devices to Home Assistant if detected. + required: false + default: true + type: boolean +devices: + description: A list of devices with their name to use in the frontend. + required: false + type: list + keys: + name: + description: Name for the device. + required: false + default: RFLink ID + type: string + sensor_type: + description: Override automatically detected type of sensor. For list of values see below. + required: true + type: string + unit_of_measurement: + description: Override automatically detected unit of sensor. + required: false + type: string + aliases: + description: "(deprecated) Alternative RFLink ID's this device is known by." + required: false + type: [list, string] +{% endconfiguration %} Sensor type values: @@ -92,4 +110,3 @@ Sensors are added automatically when the RFLink gateway intercepts a wireless co ### {% linkable_title Device support %} See [device support](/components/rflink/#device-support) - diff --git a/source/_components/sensor.rfxtrx.markdown b/source/_components/sensor.rfxtrx.markdown index 3378d7b03f9..6f12abc4173 100644 --- a/source/_components/sensor.rfxtrx.markdown +++ b/source/_components/sensor.rfxtrx.markdown @@ -56,7 +56,7 @@ sensor: - Temperature ``` -Only these data_type are valid : +Only these data_type are valid: - *Temperature* - *Humidity* @@ -88,12 +88,31 @@ sensor: - Temperature ``` -Configuration variables: - -- **devices** (*Optional*): A list of devices with their name to use in the frontend. -- **automatic_add** (*Optional*): To enable the automatic addition of new lights. -- **data_type** (*Optional*): Which data type the sensor should show -- **fire_event** (*Optional*): Fires an event even if the state is the same as before. Can be used for automations. +{% configuration %} +devices: + description: A list of devices. + required: false + type: list + keys: + name: + description: Override the name to use in the frontend. + required: false + type: string + fire_event: + description: Fires an event even if the state is the same as before. Can be used for automations. + required: false + default: false + type: boolean + data_type: + description: Which data type the sensor should show. + required: false + type: list +automatic_add: + description: To enable the automatic addition of new lights. + required: false + default: false + type: boolean +{% endconfiguration %}
If a device ID consists of only numbers, please make sure to surround it with quotes.
diff --git a/source/_components/sensor.rmvtransport.markdown b/source/_components/sensor.rmvtransport.markdown
index 6e5abe5de27..0ecb8212fd6 100644
--- a/source/_components/sensor.rmvtransport.markdown
+++ b/source/_components/sensor.rmvtransport.markdown
@@ -28,39 +28,52 @@ sensor:
```
{% configuration %}
-name:
- description: Name to use in the frontend.
+timeout:
+ description: Specify the timeout for the API calls.
required: false
- default: The default is the station name.
- type: string
-stationId:
- description: ID of the stop or station, e.g., 3000010. Visit [the RMV OpenData web site](https://opendata.rmv.de) to find a list of valid IDs.
+ default: 10
+ type: integer
+next_departure:
+ description: One or multiple departure sensors.
required: true
- type: string
-destinations:
- description: "One or multiple final stop names, e.g., 'Frankfurt (Main) Hauptbahnhof' or ['Frankfurt (Main) Hauptbahnhof','Frankfurt (Main) Stadion']. This can be used to only consider a particular direction of travel."
- required: false
- type: [string]
-lines:
- description: "One or more line numbers, e.g., `'S8'` or `['S8', 'RB33', '41']`"
- required: false
- default: The default is the station name.
- type: [string, integer]
-products:
- description: "One or more modes of transport `['U-Bahn', 'Tram', 'Bus', 'S-Bahn', 'RB', 'RE', 'EC', 'IC', 'ICE']`."
- required: false
- default: Defaults to all.
- type: [string]
-time_offset:
- description: Do not display departures leaving sooner than this number of minutes. Useful if you are a couple of minutes away from the stop.
- required: false
- default: The defaults is 0.
- type: integer
-max_journeys:
- description: Specify the maximal number of journeys.
- required: false
- default: The default is 5.
- type: integer
+ type: list
+ keys:
+ name:
+ description: Name to use in the frontend.
+ required: false
+ default: The default is the station name.
+ type: string
+ station:
+ description: "ID of the stop or station, e.g. `3000010`. Visit [the RMV OpenData web site](https://opendata.rmv.de) to find a list of valid IDs."
+ required: true
+ type: string
+ destinations:
+ description: "One or multiple final stop names, e.g., 'Frankfurt (Main) Hauptbahnhof' or ['Frankfurt (Main) Hauptbahnhof','Frankfurt (Main) Stadion']. This can be used to only consider a particular direction of travel."
+ required: false
+ type: [string]
+ direction:
+ description: "Name of a stop or station, e.g., 'Frankfurt (Main) Hauptbahnhof'. This can be used to only consider a particular direction of travel."
+ required: false
+ type: [string]
+ lines:
+ description: "One or more line numbers, e.g., `'S8'` or `['S8', 'RB33', '41']`"
+ required: false
+ type: [string, int]
+ products:
+ description: "One or more modes of transport `['U-Bahn', 'Tram', 'Bus', 'S-Bahn', 'RB', 'RE', 'EC', 'IC', 'ICE']`."
+ required: false
+ default: ['U-Bahn', 'Tram', 'Bus', 'S-Bahn', 'RB', 'RE', 'EC', 'IC', 'ICE']
+ type: [string]
+ time_offset:
+ description: Do not display departures leaving sooner than this number of minutes. Useful if you are a couple of minutes away from the stop.
+ required: false
+ default: 0
+ type: integer
+ max_journeys:
+ description: Specify the maximal number of journeys.
+ required: false
+ default: 5
+ type: integer
{% endconfiguration %}
## {% linkable_title Examples %}
@@ -73,6 +86,8 @@ The example below shows a full configuration with three sensors that showcase th
# Example configuration.yaml entry
sensor:
- platform: rmvtransport
+ scan_interval: 120
+ timeout: 10
next_departure:
- station: 3000010
time_offset: 5
diff --git a/source/_components/sensor.rtorrent.markdown b/source/_components/sensor.rtorrent.markdown
new file mode 100644
index 00000000000..03dc91fe300
--- /dev/null
+++ b/source/_components/sensor.rtorrent.markdown
@@ -0,0 +1,57 @@
+---
+layout: page
+title: "rtorrent Sensor"
+description: "Instructions on how to integrate rtorrent sensors within Home Assistant."
+date: 2018-10-14 05:40
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: rtorrent.png
+ha_category: Downloading
+ha_release: 0.81
+ha_iot_class: "Local Polling"
+---
+
+The `rtorrent` platform allows you to monitor your downloads with [rtorrent](https://rakshasa.github.io/rtorrent/) from within Home Assistant and setup automations based on the information.
+
+To enable this sensor, add the following lines to your `configuration.yaml`:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+ - platform: rtorrent
+ url: 'http://
+If you do not supply an `entity_id` in the configuration you will need to run the service `homeassistant.update_entity` to update the sensor.
+
- This sensor doesn't work anymore as [Yahoo!](https://yahoo.uservoice.com/forums/382977-finance/suggestions/32103877-yahoo-stock-quote-api-please-bring-back) decommissioned the service in early November 2017. A repleacement is the [`alpha_vantage` sensor](/components/sensor.alpha_vantage/).
+ This sensor doesn't work anymore as [Yahoo!](https://yahoo.uservoice.com/forums/382977-finance/suggestions/32103877-yahoo-stock-quote-api-please-bring-back) decommissioned the service in early November 2017. A replacement is the [`alpha_vantage` sensor](/components/sensor.alpha_vantage/).
You must have the [ZoneMinder component](/components/zoneminder/) configured to use this sensor.
diff --git a/source/_components/simplisafe.markdown b/source/_components/simplisafe.markdown
new file mode 100644
index 00000000000..74ecfe42e5b
--- /dev/null
+++ b/source/_components/simplisafe.markdown
@@ -0,0 +1,41 @@
+---
+layout: page
+title: "SimpliSafe"
+description: "Instructions on how to integrate SimpliSafe into Home Assistant."
+date: 2018-10-05 14:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: simplisafe.png
+ha_release: 0.81
+ha_category: Alarm
+---
+
+The `simplisafe` component integrates SimpliSafe home security (V2 and V3)
+systems into Home Assistant. Multiple SimpliSafe accounts can be accommodated.
+
+To enable this component, add the following lines to your `configuration.yaml`:
+
+```yaml
+# Example configuration.yaml entry
+simplisafe:
+ accounts:
+ - username: user@email.com
+ password: password123
+```
+
+{% configuration %}
+username:
+ description: The email address of a SimpliSafe account.
+ required: true
+ type: string
+password:
+ description: The password of a SimpliSafe account.
+ required: true
+ type: string
+code:
+ description: A code to enable or disable the alarm in the frontend.
+ required: false
+ type: string
+{% endconfiguration %}
diff --git a/source/_components/smappee.markdown b/source/_components/smappee.markdown
index 846fd2e33ef..79f6f32d8dc 100644
--- a/source/_components/smappee.markdown
+++ b/source/_components/smappee.markdown
@@ -59,11 +59,11 @@ host_password:
required: false
type: string
client_id:
- description: Your Smappee API client_id.
+ description: Your Smappee API client ID.
required: false
type: string
client_secret:
- description: Your Smappee API client_secret.
+ description: Your Smappee API client secret.
required: false
type: string
username:
diff --git a/source/_components/smhi.markdown b/source/_components/smhi.markdown
new file mode 100644
index 00000000000..e2a7d2dd440
--- /dev/null
+++ b/source/_components/smhi.markdown
@@ -0,0 +1,54 @@
+---
+layout: page
+title: "SMHI"
+description: "Instructions on how to integrate SMHI forecasts within Home Assistant."
+date: 2018-09-23 20:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+featured: true
+logo: smhi.png
+ha_category: Hub
+ha_release: 0.81
+ha_iot_class: "Cloud Polling"
+---
+
+The `smhi` component adds support for the [SMHI.se](https://www.smhi.se/) web service as a source for meteorological data for your location.
+
+## {% linkable_title Configuration %}
+
+The SMHI weather service is free under the Creative Commons Attribution 4.0, international license. Weather data will be pulled once every 30 minutes.
+
+To add SMHI weather forecast to your installation, go to the Integrations page inside the config panel and add a location by providing the longitude and latitude of your location.
+
+If the location is configured in Home Assistant, it will be selected as the default location. After that, you can add additional locations.
+
+
+You can only add locations through the integrations page, not in configuration files.
+
+Only location close to Sweden can be added. See [SMHI.se area](http://opendata.smhi.se/apidocs/metfcst/geographic_area.html) for more details what locations are supported.
+ If no **host** is given the platform will try to auto-discover all devices on the network, that are listening on the given **port_recv**.
+Full configuration details can be found on the main [Elk-M1 component](/components/elkm1/) page.
+
diff --git a/source/_components/switch.netio.markdown b/source/_components/switch.netio.markdown
index f5c4a9742f5..c50157850d0 100644
--- a/source/_components/switch.netio.markdown
+++ b/source/_components/switch.netio.markdown
@@ -13,7 +13,6 @@ ha_iot_class: "Local Polling"
ha_release: 0.24
---
-
The `netio` switch platform allows you to control your [Netio](http://www.netio-products.com/en/overview/) Netio4, Netio4 All, and Netio 230B. These are smart outlets controllable through Ethernet and/or WiFi that reports consumptions (Netio4all).
To use Netio devices in your installation, add the following to your `configuration.yaml` file:
@@ -31,18 +30,33 @@ switch:
4: Lamp
```
-Configuration variables:
-
-- **host** (*Required*): The IP address of your Netio plug, eg. `http://192.168.1.32`.
-- **port** (*Optional*): The port to communicate with the switch. Defaults to `1234`.
-- **username** (*Required*): The username for your plug.
-- **password** (*Required*): The password for your plug.
-- **outlets** (*Required*) array: List of all outlets.
- - **[No.]: [Name]** (*Required*): Identification of an outlet.
+{% configuration %}
+host:
+ description: "The IP address of your Netio plug, e.g., `http://192.168.1.32`."
+ required: true
+ type: string
+port:
+ description: The port to communicate with the switch.
+ required: true
+ default: 1234
+ type: integer
+username:
+ description: The username for your plug.
+ required: true
+ default: admin
+ type: string
+password:
+ description: The password for your plug.
+ required: true
+ type: string
+outlets:
+ description: "List of all outlets. Consisting of a number and a name [No.]: [Name]."
+ required: false
+ type: list
+{% endconfiguration %}
To get pushed updates from the Netio devices, one can add this Lua code in the device interface as an action triggered on "Netio" "System variables updated" with an 'Always' schedule:
-
```lua
-- this will send socket and consumption status updates via CGI
-- to given address. Associate with 'System variables update' event
@@ -64,4 +78,3 @@ local qs = table.concat(output, '&')
local url = string.format('http://%s%s?%s', address, path, qs)
devices.system.CustomCGI{url=url}
```
-
diff --git a/source/_components/switch.orvibo.markdown b/source/_components/switch.orvibo.markdown
index 656bcd4a223..fb94b023439 100644
--- a/source/_components/switch.orvibo.markdown
+++ b/source/_components/switch.orvibo.markdown
@@ -34,11 +34,28 @@ switch:
name: "My Socket"
```
-Configuration variables:
-
-- **discovery** (*Optional*): Whether to discover sockets. Defaults to `true`.
-- **switches** (*Optional*):
- - **host** (*Required*): IP address of your socket, eg. `192.168.1.10`.
- - **mac** (*Optional*): MAC address of the socket, eg "AA:BB:CC:DD:EE:FF". This is required if the socket is connected to a different subnet to the machine running Home Assistant.
- - **name** (*Optional*): Your name for the socket.
-
+{% configuration %}
+discovery:
+ description: Whether to discover sockets.
+ required: false
+ default: true
+ type: boolean
+switches:
+ description: A list of Orvibo switches.
+ required: false
+ type: list
+ keys:
+ host:
+ description: "IP address of your socket, e.g., 192.168.1.10."
+ required: true
+ type: string
+ mac:
+ description: "MAC address of the socket, e.g., `AA:BB:CC:DD:EE:FF`. This is required if the socket is connected to a different subnet to the machine running Home Assistant."
+ required: false
+ type: string
+ name:
+ description: Your name for the socket.
+ required: false
+ default: Orvibo S20 Switch
+ type: string
+{% endconfiguration %}
diff --git a/source/_components/switch.pilight.markdown b/source/_components/switch.pilight.markdown
index d70f748cfa5..40bdbd0a86b 100644
--- a/source/_components/switch.pilight.markdown
+++ b/source/_components/switch.pilight.markdown
@@ -37,14 +37,34 @@ switch:
'off': 1
```
-Configuration variables:
-
-- **switches** array (*Required*): The list that contains all command switches.
- - **[entry]** (*Required*): Name of the command switch. Multiple entries are possible.
- - **on_code** (*Required*): The code to turn the device on.
- - **off_code** (*Required*): The code to turn the device off.
- - **on_code_receive** (*Optional*): If given, this command will turn the switch on if it is received by pilight.
- - **off_code_receive** (*Optional*): If given, this command will turn the switch off if it is received by pilight.
+{% configuration %}
+switches:
+ description: The list that contains all command switches.
+ required: true
+ type: string
+ keys:
+ entry:
+ description: Name of the command switch. Multiple entries are possible.
+ required: true
+ type: list
+ keys:
+ on_code:
+ description: The code to turn the device on.
+ required: true
+ type: list
+ off_code:
+ description: The code to turn the device off.
+ required: true
+ type: list
+ on_code_receive:
+ description: If given, this command will turn the switch on if it is received by pilight.
+ required: false
+ type: list
+ off_code_receive:
+ description: If given, this command will turn the switch off if it is received by pilight.
+ required: false
+ type: list
+{% endconfiguration %}
Variables for the different codes (`on_code` and `off_code`):
diff --git a/source/_components/switch.pulseaudio_loopback.markdown b/source/_components/switch.pulseaudio_loopback.markdown
index 6248f9910eb..9603337f58a 100644
--- a/source/_components/switch.pulseaudio_loopback.markdown
+++ b/source/_components/switch.pulseaudio_loopback.markdown
@@ -13,7 +13,6 @@ ha_release: 0.16
ha_iot_class: "Local Polling"
---
-
The goal behind this switch is to allow a very flexible whole home audio system based upon [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/).
For example, for a system with a 7.1 surround sound card, and 3 instances of [MPD](https://www.musicpd.org/) running, it is possible to quickly route the output of any MPD instance to any of the 8 possible (4 stereo) channels on the sound card, by loading/unloading a loopback module. This loading/unloading functionality is provided by this component. When the switch is `on`, the loopback module is loaded. When the switch is `off`, the module is not loaded.
@@ -30,17 +29,42 @@ switch:
- platform: pulseaudio_loopback
```
-Configuration variables:
-
-- **sink_name** (*Required*): The name of the Pulseaudio sink that will receive the audio.
-- **source_name** (*Required*): The name of the Pulseaudio source that will supply the audio.
-- **name** (*Optional*): Name of the switch.
-- **host** (*Optional*): The IP address or host name of the PulseAudio server. If not specified, 127.0.0.1 is used.
-- **port** (*Optional*): The port that Pulseaudio is listening on. Defaults to 4712.
-- **buffer_size** (*Optional*): How much data to load from Pulseaudio at once. Default is 1KB.
-- **tcp_timeout** (*Optional*): How long to wait for a response from Pulseaudio before giving up. Default is 3 seconds.
+{% configuration %}
+sink_name:
+ description: The name of the Pulseaudio sink that will receive the audio.
+ required: true
+ type: string
+source_name:
+ description: The name of the Pulseaudio source that will supply the audio.
+ required: true
+ type: string
+name:
+ description: Name of the switch.
+ required: false
+ default: paloopback
+ type: string
+host:
+ description: The IP address or host name of the PulseAudio server.
+ required: false
+ default: localhost
+ type: string
+port:
+ description: The port that Pulseaudio is listening on.
+ required: false
+ default: 4712
+ type: integer
+buffer_size:
+ description: How much data to load from Pulseaudio at once.
+ required: false
+ default: 1024
+ type: integer
+tcp_timeout:
+ description: How long to wait for a response from Pulseaudio before giving up.
+ required: false
+ default: 3
+ type: integer
+{% endconfiguration %}
This component relies on raw TCP commands to PulseAudio. In order for PulseAudio to accept commands with this component, `module-cli-protocol` must be loaded on the PulseAudio server.
This component and the [rfxtrx binary sensor](/components/binary_sensor.rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`. Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `False`.
diff --git a/source/_components/switch.rpi_gpio.markdown b/source/_components/switch.rpi_gpio.markdown
index f6d62a4935b..901734b1ee0 100644
--- a/source/_components/switch.rpi_gpio.markdown
+++ b/source/_components/switch.rpi_gpio.markdown
@@ -29,11 +29,22 @@ switch:
12: Light Desk
```
-Configuration variables:
-
-- **ports** array (*Required*): Array of used ports.
- - **port: name** (*Required*): Port numbers and corresponding names (GPIO #).
-- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).
+{% configuration %}
+ports:
+ description: Array of used ports.
+ required: true
+ type: list
+ keys:
+ port:
+ description: Port numbers and corresponding names (GPIO #).
+ required: true
+ type: [integer, string]
+invert_logic:
+ description: If true, inverts the output logic to ACTIVE LOW.
+ required: false
+ default: false
+ type: boolean
+{% endconfiguration %}
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.
@@ -51,5 +62,3 @@ switch:
ports:
17: Speaker Relay
```
-
-
diff --git a/source/_components/switch.rpi_pfio.markdown b/source/_components/switch.rpi_pfio.markdown
index 57f4ba2a6dc..3efa04537f4 100644
--- a/source/_components/switch.rpi_pfio.markdown
+++ b/source/_components/switch.rpi_pfio.markdown
@@ -31,10 +31,24 @@ switch:
name: Light Desk
```
-Configuration variables:
-
-- **ports** array (*Required*): Array of used ports.
- - **num** (*Required*): Port number.
- - **name** (*Required*): Port name.
- - **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).
-
+{% configuration %}
+ports:
+ description: Array of used ports.
+ required: true
+ type: list
+ keys:
+ num:
+ description: Port number.
+ required: true
+ type: list
+ keys:
+ name:
+ description: Port name.
+ required: true
+ type: string
+ invert_logic:
+ description: If true, inverts the output logic to ACTIVE LOW.
+ required: false
+ default: false
+ type: boolean
+{% endconfiguration %}
diff --git a/source/_components/switch.rpi_rf.markdown b/source/_components/switch.rpi_rf.markdown
index 43d2e5a30d5..0c7b52f53b1 100644
--- a/source/_components/switch.rpi_rf.markdown
+++ b/source/_components/switch.rpi_rf.markdown
@@ -43,13 +43,41 @@ switch:
signal_repetitions: 15
```
-Configuration variables:
-
-- **gpio** (*Required*): GPIO to which the data line of the TX module is connected.
-- **switches:** (*Required*): The array that contains all switches.
- - **[entry]** (*Required*): Name of the switch. Multiple entries are possible.
- - **code_on** (*Required*): Decimal code(s) to switch the device on. To run multiple codes in a sequence, separate the individual codes with commas ','.
- - **code_off** (*Required*): Decimal code(s) to switch the device off. To run multiple codes in a sequence, separate the individual codes with commas ','.
- - **protocol** (*Optional*): RF Protocol (Default is `1`).
- - **pulselength** (*Optional*): Pulselength (Default is the protocol default).
- - **signal_repetitions** (*Optional*): Number of times to repeat transmission (default is 10, can increase to try to improve reliability).
+{% configuration %}
+gpio:
+ description: GPIO to which the data line of the TX module is connected.
+ required: true
+ type: integer
+switches:
+ description: The array that contains all switches.
+ required: true
+ type: list
+ keys:
+ entry:
+ description: Name of the switch. Multiple entries are possible.
+ required: true
+ type: list
+ keys:
+ code_on:
+ description: Decimal code(s) to switch the device on. To run multiple codes in a sequence, separate the individual codes with commas ','.
+ required: true
+ type: list
+ code_off:
+ description: Decimal code(s) to switch the device off. To run multiple codes in a sequence, separate the individual codes with commas ','.
+ required: true
+ type: list
+ protocol:
+ description: RF Protocol.
+ required: false
+ default: 1
+ type: integer
+ pulselength:
+ description: Pulselength
+ required: false
+ type: integer
+ signal_repetitions:
+ description: Number of times to repeat transmission
+ required: false
+ default: 10
+ type: integer
+{% endconfiguration %}
diff --git a/source/_components/switch.scsgate.markdown b/source/_components/switch.scsgate.markdown
index 35e1f6b7f8e..1f0cdb6cf84 100644
--- a/source/_components/switch.scsgate.markdown
+++ b/source/_components/switch.scsgate.markdown
@@ -26,6 +26,9 @@ switch:
scs_id: XXXXX
```
-Configuration variables:
-
-- **devices** (*Required*): A list of devices with their name to use in the frontend.
+{% configuration %}
+devices:
+ description: A list of devices with their name to use in the frontend.
+ required: true
+ type: list
+{% endconfiguration %}
diff --git a/source/_components/switch.telnet.markdown b/source/_components/switch.telnet.markdown
index ef1345cd5bf..7a11cff4cf1 100644
--- a/source/_components/switch.telnet.markdown
+++ b/source/_components/switch.telnet.markdown
@@ -12,33 +12,64 @@ ha_release: 0.54
ha_iot_class: "Local Polling"
---
-
The `telnet` switch platform allows you to control devices with telnet commands.
To enable this switch, add the following lines to your `configuration.yaml` file:
+{% raw %}
```yaml
# Example configuration.yaml entry
switch:
platform: telnet
switches:
projector:
- resource: "host_or_ip"
+ resource: THE_IP_ADDRESS
port: 4002
command_on: "PWR ON"
command_off: "PWR OFF"
command_state: "PWR?"
- value_template: '{% raw %}{{ value == "PWR=01" }}{% endraw %}'
+ value_template: '{{ value == "PWR=01" }}'
```
+{% endraw %}
-Configuration variables:
-
-- **switches** (*Required*): The array that contains all switches.
- - **identifier** (*Required*): Name of the switch as slug. Multiple entries are possible.
- - **resource** (*Required*): Host or IP of the device.
- - **port** (*Optional*): Port to connect to. Default is 23 if not defined.
- - **command_on** (*Required*): Command to turn device on.
- - **command_off** (*Required*): Command to turn device off.
- - **command_state** (*Optional*): Command to determine the state of the switch. If not defined the switch will assume successful state changes.
- - **value_template** (*Optional*): The template evaluating to `true` will indicate that the switch is on.
- - **name** (*Optional*): The name used to display the switch in the frontend.
+{% configuration %}
+switches:
+ description: The array that contains all switches.
+ required: true
+ type: list
+ keys:
+ identifier:
+ description: Name of the switch as slug. Multiple entries are possible.
+ required: true
+ type: list
+ keys:
+ resource:
+ description: Host name or IP address of the device.
+ required: true
+ type: string
+ port:
+ description: Port to connect to.
+ required: false
+ default: 23
+ type: integer
+ command_on:
+ description: Command to turn device on.
+ required: true
+ type: string
+ command_off:
+ description: Command to turn device off.
+ required: true
+ type: string
+ command_state:
+ description: Command to determine the state of the switch. If not defined the switch will assume successful state changes.
+ required: false
+ type: string
+ value_template:
+ description: The template evaluating to `true` will indicate that the switch is on.
+ required: false
+ type: template
+ name:
+ description: The name used to display the switch in the frontend.
+ required: false
+ type: string
+{% endconfiguration %}
diff --git a/source/_components/switch.tradfri.markdown b/source/_components/switch.tradfri.markdown
index 411b8883ed1..95069570664 100644
--- a/source/_components/switch.tradfri.markdown
+++ b/source/_components/switch.tradfri.markdown
@@ -1,7 +1,7 @@
---
layout: page
title: "IKEA Trådfri Switch"
-description: "Access and control your ZigBee-based IKEA Trådfri (Tradfri) Switches."
+description: "Access and control your Zigbee-based IKEA Trådfri (Tradfri) Switches."
date: 2018-09-30 19.22
sidebar: true
comments: false
diff --git a/source/_components/switch.unifi.markdown b/source/_components/switch.unifi.markdown
new file mode 100644
index 00000000000..40376ec6daf
--- /dev/null
+++ b/source/_components/switch.unifi.markdown
@@ -0,0 +1,20 @@
+---
+layout: page
+title: "UniFi Switches"
+description: "Instructions on how to integrate POE control switches from UniFi into Home Assistant."
+date: 2018-10-15 22:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: ubiquiti.png
+ha_category: Switch
+ha_release: "0.81"
+ha_iot_class: "Local Polling"
+---
+
+See the [UniFi main component](/components/unifi/) for configuration instructions.
+
+Switches are network devices that are powered by POE switches from Ubuiqitis UniFi line of networking gear.
+
+Note that POE control actually configures the network port of the switch which the device is connected to.
diff --git a/source/_components/switch.zha.markdown b/source/_components/switch.zha.markdown
index c5c7eee2c5d..e23f6751ff3 100644
--- a/source/_components/switch.zha.markdown
+++ b/source/_components/switch.zha.markdown
@@ -1,7 +1,7 @@
---
layout: page
-title: "ZigBee Home Automation Switch"
-description: "Instructions on how to setup ZigBee Home Automation switches within Home Assistant."
+title: "Zigbee Home Automation Switch"
+description: "Instructions on how to setup Zigbee Home Automation switches within Home Assistant."
date: 2017-02-22 00:00
sidebar: true
comments: false
@@ -12,4 +12,4 @@ ha_category: Switch
ha_iot_class: "Local Polling"
---
-To get your ZigBee switches working with Home Assistant, follow the instructions for the general [ZigBee Home Automation component](/components/zha/).
+To get your Zigbee switches working with Home Assistant, follow the instructions for the general [Zigbee Home Automation component](/components/zha/).
diff --git a/source/_components/switch.zigbee.markdown b/source/_components/switch.zigbee.markdown
index 15f2dd2386e..912b0e5bb30 100644
--- a/source/_components/switch.zigbee.markdown
+++ b/source/_components/switch.zigbee.markdown
@@ -1,7 +1,7 @@
---
layout: page
-title: "ZigBee Switch"
-description: "Instructions on how to set up ZigBee switches within Home Assistant."
+title: "Zigbee Switch"
+description: "Instructions on how to set up Zigbee switches within Home Assistant."
date: 2016-01-28 11:52
sidebar: true
comments: false
@@ -13,7 +13,7 @@ ha_release: 0.12
ha_iot_class: "Local Polling"
---
-A ZigBee switch in this context is a device connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a switch is considered `on` when the ZigBee device's digital output is held `high` and considered `off` when it is held `low`. This behavior can be inverted by setting the `on_state` configuration variable to `low`.
+A Zigbee switch in this context is a device connected to one of the digital output pins on a Zigbee module. It can simply be switched on and off. By default, a switch is considered `on` when the Zigbee device's digital output is held `high` and considered `off` when it is held `low`. This behavior can be inverted by setting the `on_state` configuration variable to `low`.
To configure a digital output pin as switch, add the following to your `configuration.yaml` file:
@@ -36,7 +36,7 @@ pin:
required: true
type: integer
address:
- description: The long 64-bit address of the remote ZigBee device whose digital output pin you would like to switch. Do not include this variable if you want to switch the local ZigBee device's pins.
+ description: The long 64-bit address of the remote Zigbee device whose digital output pin you would like to switch. Do not include this variable if you want to switch the local Zigbee device's pins.
required: false
type: string
on_state:
diff --git a/source/_components/tado.markdown b/source/_components/tado.markdown
index cfb7294289c..f78c99ae627 100644
--- a/source/_components/tado.markdown
+++ b/source/_components/tado.markdown
@@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
The `tado` component platform is used as an interface to the [my.tado.com](https://my.tado.com/webapp/#/account/sign-in) website. It adds climate devices for every tado zone and sensors for some additional information of the zones.
+## {% linkable_title Configuration %}
+
To use your tado thermostats in your installation, add the following to your `configuration.yaml` file:
```yaml
@@ -26,11 +28,11 @@ tado:
{% configuration %}
username:
- description: Username for my.tado.com.
+ description: Your username for my.tado.com.
required: true
type: string
password:
- description: Password for my.tado.com.
+ description: Your password for my.tado.com.
required: true
type: string
{% endconfiguration %}
diff --git a/source/_components/tahoma.markdown b/source/_components/tahoma.markdown
index 03734815e39..323d51bee5a 100644
--- a/source/_components/tahoma.markdown
+++ b/source/_components/tahoma.markdown
@@ -13,9 +13,10 @@ ha_release: 0.59
ha_iot_class: "Cloud Polling"
---
-
The `Tahoma` component platform is used as an interface to the [tahomalink.com](https://www.tahomalink.com) website. It adds covers, scenes and a sun sensor from the Tahoma platform.
+## {% linkable_title Configuration %}
+
To use your Tahoma devices in your installation, add the following to your `configuration.yaml` file:
```yaml
@@ -28,15 +29,15 @@ tahoma:
{% configuration %}
username:
- description: Username for tahomalink.com
+ description: Your username for tahomalink.com.
required: true
type: string
password:
- description: Password for tahomalink.com
+ description: Your password for tahomalink.com.
required: true
type: string
exclude:
- description: Excludes devices
+ description: List of devices to exclude.
required: false
type: list
{% endconfiguration %}
diff --git a/source/_components/telegram_bot.broadcast.markdown b/source/_components/telegram_bot.broadcast.markdown
index 4fc78da1277..4b820fac4a4 100644
--- a/source/_components/telegram_bot.broadcast.markdown
+++ b/source/_components/telegram_bot.broadcast.markdown
@@ -14,14 +14,15 @@ ha_release: 0.48
Telegram implementation to support **sending messages only**. Your Home Assistant instance does not have to be exposed to the Internet and there is no polling to receive messages sent to the bot.
+## {% linkable_title Configuration %}
+
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
-
telegram_bot:
- platform: broadcast
- api_key: 
diff --git a/source/_components/sensor.zha.markdown b/source/_components/sensor.zha.markdown
index 03c0687d278..993031476f5 100644
--- a/source/_components/sensor.zha.markdown
+++ b/source/_components/sensor.zha.markdown
@@ -1,7 +1,7 @@
---
layout: page
-title: "ZigBee Home Automation Sensor"
-description: "Instructions on how to setup ZigBee Home Automation sensors within Home Assistant."
+title: "Zigbee Home Automation Sensor"
+description: "Instructions on how to setup Zigbee Home Automation sensors within Home Assistant."
date: 2017-02-22 00:00
sidebar: true
comments: false
@@ -12,5 +12,5 @@ ha_category: Sensor
ha_iot_class: "Local Polling"
---
-To get your ZigBee sensors working with Home Assistant, follow the instructions for the general [ZigBee Home Automation Component](/components/zha/).
+To get your Zigbee sensors working with Home Assistant, follow the instructions for the general [Zigbee Home Automation Component](/components/zha/).
diff --git a/source/_components/sensor.zigbee.markdown b/source/_components/sensor.zigbee.markdown
index ad1aa6a0388..4eabd0b71d2 100644
--- a/source/_components/sensor.zigbee.markdown
+++ b/source/_components/sensor.zigbee.markdown
@@ -1,7 +1,7 @@
---
layout: page
-title: ZigBee Sensor
-description: "Instructions on how to set up ZigBee sensors within Home Assistant."
+title: Zigbee Sensor
+description: "Instructions on how to set up Zigbee sensors within Home Assistant."
date: 2016-01-28 10:08
sidebar: true
comments: false
@@ -13,7 +13,7 @@ ha_release: 0.12
ha_iot_class: "Local Polling"
---
-There are two types of [ZigBee](http://www.zigbee.org/) sensor available to Home Assistant:
+There are two types of [Zigbee](http://www.zigbee.org/) sensor available to Home Assistant:
- [Analog input pin](#analog-input-pin)
- [Temperature sensor](#temperature-sensor) (XBee Pro)
@@ -24,7 +24,7 @@ To configure an analog input pin sensor, add the following to your `configuratio
# Example configuration.yaml entry
sensor:
- platform: zigbee
- name: My Analog ZigBee Input
+ name: My Analog Zigbee Input
type: analog
pin: 0
address: 0013A2004233D138
@@ -44,7 +44,7 @@ pin:
required: false
type: integer
address:
- description: The long 64-bit address of the remote ZigBee device whose pin you would like to sample. Do not include this variable if you want to sample the local ZigBee device's pins.
+ description: The long 64-bit address of the remote Zigbee device whose pin you would like to sample. Do not include this variable if you want to sample the local Zigbee device's pins.
required: false
type: string
max_volts:
@@ -58,7 +58,7 @@ max_volts:
### {% linkable_title Analog Input Pin %}
-The analog input pins on an XBee (non-Pro) will read 0V to 1.2 V. This is translated by the [xbee-helper](https://github.com/flyte/xbee-helper) library into a percentage. The maximum voltage your ZigBee device will read is configurable using the `max_volts` configuration variable.
+The analog input pins on an XBee (non-Pro) will read 0V to 1.2 V. This is translated by the [xbee-helper](https://github.com/flyte/xbee-helper) library into a percentage. The maximum voltage your Zigbee device will read is configurable using the `max_volts` configuration variable.
To configure an analog input pin sensor, add the following to your `configuration.yaml` file:
@@ -66,7 +66,7 @@ To configure an analog input pin sensor, add the following to your `configuratio
## Example configuration.yaml entry
sensor:
- platform: zigbee
- name: My Analog ZigBee Input
+ name: My Analog Zigbee Input
type: analog
pin: 0
address: 0013A2004233D138
@@ -84,7 +84,7 @@ To configure a temperature sensor device, add the following to your `configurati
# Example configuration.yaml entry
sensor:
- platform: zigbee
- name: Living Room Temperature ZigBee
+ name: Living Room Temperature Zigbee
type: temperature
address: 0013A20050E752C5
```
diff --git a/source/_components/sensor.zoneminder.markdown b/source/_components/sensor.zoneminder.markdown
index 654c6e57e71..b1c6f6af8a4 100644
--- a/source/_components/sensor.zoneminder.markdown
+++ b/source/_components/sensor.zoneminder.markdown
@@ -13,7 +13,7 @@ ha_release: 0.31
ha_iot_class: "Local Polling"
---
-The `zoneminder` sensor platform lets you monitor the current state of your [ZoneMinder](https://www.zoneminder.com) install including the number of events and the current state of the cameras.
+The `zoneminder` sensor platform lets you monitor the current state of your [ZoneMinder](https://www.zoneminder.com) install including the number of events, the current state of the cameras and ZoneMinder's current run state.
**Services** from the **Developer Tools**. Choose **timer** from the list of **Domains**, select the **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**.
@@ -95,7 +110,7 @@ Select **Integrations** -> **UniFi Controller**.
+
+Enter `host address`, `user name` and `password` and then continue to select which `site` you want to connect to Home Assistant. The user must have administrator privileges.
+
+## {% linkable_title Debugging component %}
+
+If you have problems with UniFi or the component you can add debug prints to the log.
+
+```yaml
+logger:
+ default: info
+ logs:
+ aiounifi: debug
+ homeassistant.components.unifi: debug
+ homeassistant.components.switch.unifi: debug
+```
diff --git a/source/_components/upcloud.markdown b/source/_components/upcloud.markdown
index a54fa0e37eb..9b5807e536b 100644
--- a/source/_components/upcloud.markdown
+++ b/source/_components/upcloud.markdown
@@ -13,7 +13,6 @@ logo: upcloud.png
ha_iot_class: Cloud Polling
---
-
The `upcloud` component allows you to access the information about your [UpCloud](https://www.upcloud.com/) servers from Home Assistant.
## {% linkable_title Setup %}
diff --git a/source/_components/updater.markdown b/source/_components/updater.markdown
index 2b6c2997a7a..873fab8fef2 100644
--- a/source/_components/updater.markdown
+++ b/source/_components/updater.markdown
@@ -14,7 +14,9 @@ ha_qa_scale: internal
The `updater` component will check daily for new releases. It will show a badge in the frontend if a new version is found. As [Hass.io](/hassio/) has its own schedule for release it doesn't make sense to use this component on Hass.io.
-The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91). For further information about the Updater's data, please check the [detailed overview](/docs/backend/updater/).
+The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91).
+
+## {% linkable_title Configuration %}
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
@@ -22,9 +24,22 @@ To integrate this into Home Assistant, add the following section to your `config
updater:
```
-If you choose not to share any information when checking for updates, you can add `reporting: False`.
+{% configuration %}
+reporting:
+ description: Whether or not to share system information when checking for updates.
+ required: false
+ type: boolean
+ default: true
+include_used_components:
+ description: Whether or not to report the components that you are using in Home Assistant.
+ required: false
+ type: boolean
+ default: false
+{% endconfiguration %}
-It is possible to report the components that you are using to the Home Assistant developers. This will help them focus on improving the popular ones. To enable this option, you have to add `include_used_components: True`.
+For further information about the Updater's data, please check the [detailed overview](/docs/backend/updater/). If you choose not to share any information when checking for updates, you can set `reporting: false`.
+
+It is possible to report the components that you are using to the Home Assistant developers. This will help them focus on improving the popular ones. To enable this option, you have to add `include_used_components: true`.
```json
"components": [
@@ -41,7 +56,7 @@ It is possible to report the components that you are using to the Home Assistant
]
```
-### {% linkable_title Notification %}
+## {% linkable_title Notification %}
For an added bonus, an automation component can be created to send a message with a notifier when that state of this component's entity changes.
@@ -57,4 +72,3 @@ automation:
data:
message: 'Update for Home Assistant is available.'
```
-
diff --git a/source/_components/upnp.markdown b/source/_components/upnp.markdown
index b16888a93c2..a3c3cd4d366 100644
--- a/source/_components/upnp.markdown
+++ b/source/_components/upnp.markdown
@@ -33,20 +33,25 @@ upnp:
With the default settings only the sensors are added for statistics. If you wish to have port mapping done through IGD, add the option **port_mapping** and **ports**.
-{% configuration binary_sensor.template %}
- ports:
- description: Map of ports to map from internal to external. Pass 'hass' as internal port to use the port Home Assistant runs on. Note that you have to enable port_mapping if you wish to map ports.
- required: false
- type: map
- default: open same port on external router as that HASS runs locally and forwards it.
- port_mapping:
- description: If the component should try to map ports.
- required: false
- type: boolean
- default: false
- local_ip:
- description: The local IP address of the computer running Home Assistant.
- required: false
- type: string
- default: Try to auto-detect IP of host.
+{% configuration %}
+port_mapping:
+ description: If the component should try to map ports.
+ required: false
+ type: boolean
+ default: false
+sensors:
+ description: If the component should enable the UPNP sensors.
+ required: false
+ type: boolean
+ default: true
+local_ip:
+ description: The local IP address of the computer running Home Assistant.
+ required: false
+ type: string
+ default: Try to auto-detect IP of host.
+ports:
+ description: Map of ports to map from internal to external. Pass 'hass' as internal port to use the port Home Assistant runs on. Note that you have to enable port_mapping if you wish to map ports.
+ required: false
+ type: map
+ default: Open same port on external router as that HASS runs locally and forwards it.
{% endconfiguration %}
diff --git a/source/_components/usps.markdown b/source/_components/usps.markdown
index c63a385057a..487344d202b 100644
--- a/source/_components/usps.markdown
+++ b/source/_components/usps.markdown
@@ -16,7 +16,7 @@ ha_iot_class: "Cloud Polling"
The `usps` platform allows one to track deliveries and inbound mail from the [US Postal Service (USPS)](https://www.usps.com/).
In addition to having a USPS account, you will need to complete the "Opt-In" process for packages by clicking "Get Started Now" on [this page](https://my.usps.com/mobileWeb/pages/intro/start.action). You must also "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see inbound mail.
-## Prerequisites
+## {% linkable_title Prerequisites %}
This component requires that a headless-capable web browser is installed on your system - either PhantomJS or Google Chrome. Preferably use Chrome if your operating system supports it, since PhantomJS is deprecated.
@@ -25,10 +25,10 @@ This component requires that a headless-capable web browser is installed on your
- Hass.io containers are based on Alpine Linux. PhanthomJS is not available for Alpine Linux. Therefore it is currently not possible to use this component on Hass.io. + Hass.io containers are based on Alpine Linux. PhanthomJS is not available for Alpine Linux. Therefore it is currently not possible to use this component on Hass.io.
-### PhantomJS +### {% linkable_title PhantomJS %} Install the latest version of [PhantomJS]( http://phantomjs.org/download.html). Ensure the executable is on your `PATH`. `phantomjs --version` should work and report the correct version. This is the default option and requires no further configuration. @@ -38,18 +38,17 @@ Install the latest version of [PhantomJS]( http://phantomjs.org/download.html). If you use the PhantomJS option, specify `driver: phantomjs` in your `usps` configuration. - -### Chrome +### {% linkable_title Chrome %} Install Chrome 59 or greater (preferably the most recent). Install the latest [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads). Ensure both executables are on your `PATH`. `google-chrome --version` and `chromedriver --version` should work and report the correct version. OS-specific instructions: - [Ubuntu 16](https://gist.github.com/ziadoz/3e8ab7e944d02fe872c3454d17af31a5) (Selenium server portion *not* necessary) -- [RHEL/Centos 7](https://stackoverflow.com/a/46686621) +- [RHEL/Centos 7](https://stackoverflow.com/a/46686621) If you use the Chrome option, specify `driver: chrome` in your `usps` configuration. -## Configuration +## {% linkable_title Configuration %} To enable this component, add the following lines to your `configuration.yaml`: @@ -62,12 +61,26 @@ usps: You will see two new sensors, one for packages and one for mail and a camera to rotate through images of incoming mail for the current day. -Configuration options for the USPS component: - -- **username** (*Required*): The username to access the MyUSPS service. -- **password** (*Required*): The password for the given username. -- **driver** (*Required*): Specify if you're using `phantomjs` or `chrome`. -- **name** (*Optional*): Prefix for sensor names (defaults to "USPS") +{% configuration %} +username: + description: The username to access the MyUSPS service. + required: true + type: string +password: + description: The password for the given username. + required: true + type: string +driver: + description: Specify if you're using `phantomjs` or `chrome`. + required: false + type: string + default: phantomjs +name: + description: The prefix for sensor names. + required: false + type: string + default: usps +{% endconfiguration %}The USPS sensor logs into the MyUSPS website to scrape package data. It does not use an API. diff --git a/source/_components/vacuum.dyson.markdown b/source/_components/vacuum.dyson.markdown index b482899130c..50a09628d7c 100644 --- a/source/_components/vacuum.dyson.markdown +++ b/source/_components/vacuum.dyson.markdown @@ -15,7 +15,9 @@ ha_release: 0.51 The `dyson` vacuum platform allows you to control your Dyson 360 Eye robot vacuum. -You have first to setup the [Dyson component](/components/dyson/) +## {% linkable_title Configuration %} + +You have to set up the [Dyson component](/components/dyson/) first. ### {% linkable_title Component services %} diff --git a/source/_components/vacuum.ecovacs.markdown b/source/_components/vacuum.ecovacs.markdown index 144bc7afcd7..85ce3230aca 100644 --- a/source/_components/vacuum.ecovacs.markdown +++ b/source/_components/vacuum.ecovacs.markdown @@ -15,7 +15,9 @@ ha_release: 0.77 The `ecovacs` vacuum platform allows you to monitor and control your Ecovacs Deebot vacuums. -You have first to setup the [Ecovacs component](/components/ecovacs/) +## {% linkable_title Configuration %} + +You have to set up the [Ecovacs component](/components/ecovacs/) first. ### {% linkable_title Component Lifespans %} diff --git a/source/_components/vacuum.markdown b/source/_components/vacuum.markdown index a72a22e7ca5..f0b3bb760b5 100644 --- a/source/_components/vacuum.markdown +++ b/source/_components/vacuum.markdown @@ -11,6 +11,8 @@ footer: true The `vacuum` component enables the ability to control home cleaning robots within Home Assistant. +## {% linkable_title Configuration %} + To use this component in your installation, add a `vacuum` platform to your `configuration.yaml` file, like the [Xiaomi](/components/vacuum.xiaomi_miio/). ```yaml diff --git a/source/_components/vacuum.mqtt.markdown b/source/_components/vacuum.mqtt.markdown index 1777c7cd890..04fb17d504e 100644 --- a/source/_components/vacuum.mqtt.markdown +++ b/source/_components/vacuum.mqtt.markdown @@ -14,6 +14,8 @@ ha_release: 0.54 The `mqtt` vacuum component allows you to control your MQTT-enabled vacuum. +## {% linkable_title Configuration %} + To add your MQTT vacuum to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -229,6 +231,6 @@ MQTT payload: } ``` -### {% linkable_title Retrofitting a non-wifi Roomba with an ESP8266 %} - -- [This repo](https://github.com/johnboiles/esp-roomba-mqtt) has MQTT client firmware for retrofitting your old Roomba. +### {% linkable_title Retrofitting a non-wifi vacuums %} +- Retrofitting your old Roomba with an ESP8266. [This repo](https://github.com/johnboiles/esp-roomba-mqtt) provides MQTT client firmware. +- In you own a non-wifi Neato, you can refer to [this repo](https://github.com/jeroenterheerdt/neato-serial) that uses a Raspberry Pi to retrofit an old Neato. diff --git a/source/_components/vacuum.neato.markdown b/source/_components/vacuum.neato.markdown index bbdd37730b1..9ed678cfb61 100644 --- a/source/_components/vacuum.neato.markdown +++ b/source/_components/vacuum.neato.markdown @@ -18,9 +18,11 @@ The `neato` vacuum platform allows you to control your [Neato Botvac Connected]( The status will contain attributes on the robots last clean session.
-If you notice the robot stops responding to commands check the status attribute to see if the robot is offline. If you see "Robot Offline" check the Neato app and make sure your robot is connected and working. If it is not then follow the steps in the app to reset your robot and give it the same name as before then restart Home Assistant. +If you notice the robot stops responding to commands check the state to see if the robot is "unavailable". If you see "unavailable" first try to restart the vacuum and wait about 5 minutes to see if it is no longer "unavailable". If you are still having issues check the Neato app and make sure your robot is connected and working. If it is not then follow the steps in the app to reset your robot and give it the same name as before then restart Home Assistant.
+## {% linkable_title Configuration %} + To add `neato` vacuum to your installation, please follow instructions in [Neato component](/components/neato/). Currently supported services are: diff --git a/source/_components/vacuum.roomba.markdown b/source/_components/vacuum.roomba.markdown index 2186f1666aa..d7a242c9ce7 100644 --- a/source/_components/vacuum.roomba.markdown +++ b/source/_components/vacuum.roomba.markdown @@ -18,6 +18,8 @@ The `roomba` component allows you to control your [iRobot Roomba](http://www.iro This platform has only been tested with an iRobot Roomba 980 but should work find with any Wi-Fi enabled Roomba like the 690, 890 or the 960. +## {% linkable_title Configuration %} + To add your Roomba vacuum to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -31,7 +33,7 @@ vacuum: {% configuration %} host: - description: Hostname or IP address of the Roomba. + description: The hostname or IP address of the Roomba. required: true type: string username: @@ -45,18 +47,18 @@ password: name: description: The name of the vacuum. required: false - default: Roomba type: string + default: Roomba certificate: description: Path to your certificate store. required: false - default: /etc/ssl/certs/ca-certificates.crt type: string + default: /etc/ssl/certs/ca-certificates.crt continuous: description: Whether to operate in continuous mode. required: false - default: true type: boolean + default: true {% endconfiguration %}diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 34f5ea169a4..500e176081c 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -26,11 +26,11 @@ Currently supported services are: - `set_fan_speed` - remote control of your robot. +## {% linkable_title Configuration %} + Please follow [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to retrieve the API token used in `configuration.yaml`. -## {% linkable_title Configuring the Platform %} - To add a vacuum to your installation, add the following to `configuration.yaml`: ```yaml @@ -41,18 +41,19 @@ vacuum: ``` {% configuration %} - host: - description: The IP of your robot. - required: true - type: string - token: - description: The API token of your robot. - required: true - type: string - name: - description: The name of your robot. - required: false - type: string +host: + description: The IP address of your robot. + required: true + type: string +token: + description: The API token of your robot. + required: true + type: string +name: + description: The name of your robot. + required: false + type: string + default: Xiaomi Vacuum cleaner {% endconfiguration %} ## {% linkable_title Platform Services %} @@ -133,8 +134,8 @@ 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 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.
-
+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.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/) is confirmed as working for the following Android methods. Using older version than 5.0.30 is not recommended as it might lack support for some newer devices like the Roborock S50.
+
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
@@ -185,6 +186,7 @@ To fetch the token follow these instructions depending on your mobile phone plat
5. Click "Extract Token"
6. On the phone, you must confirm the backup. DO NOT enter any password and press the button to make the backup.
7. Once you have confirmed the backup the token extraction will begin, it should appear in the MiToolKit shortly.
+8. If you don't get a token, close MiToolKit completely, delete the folder MiToolkit\apps\com.xiaomi.smarthome and relaunch MiToolKit to force recreate a new backup (sometimes the files would not be overwritten before deleting the old ones)
#### {% linkable_title Linux and Android (not rooted) %}
@@ -258,3 +260,10 @@ To fetch the token follow these instructions depending on your mobile phone plat
12. Copy the returned 32-digit hexadecimal string to your clipboard.
13. Open `Terminal` and execute this command: `echo '0:
icon of the Developer Tools section. Look for entities that contain 'Vera Device Id' in their attributes, and you'll find the entity id on the left.
diff --git a/source/_components/verisure.markdown b/source/_components/verisure.markdown
index 49dd80958e1..5e14d2236d2 100644
--- a/source/_components/verisure.markdown
+++ b/source/_components/verisure.markdown
@@ -24,6 +24,8 @@ We support:
* [Locks](/components/lock.verisure/)
* [Door & Window](/components/binary_sensor.verisure/)
+ ## {% linkable_title Configuration %}
+
To integrate Verisure with Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
@@ -43,45 +45,45 @@ password:
required: true
type: string
alarm:
- description: Set to true to show alarm, false to disable.
+ description: Set to `true` to show alarm, `false` to disable.
required: false
- default: true
type: boolean
+ default: true
hygrometers:
- description: Set to true to show hygrometers, false to disable.
+ description: Set to `true` to show hygrometers, `false` to disable.
required: false
- default: true
type: boolean
+ default: true
smartplugs:
- description: Set to true to show smartplugs, false to disable.
+ description: Set to `true` to show smartplugs, `false` to disable.
required: false
- default: true
type: boolean
+ default: true
locks:
- description: Set to true to show locks, false to disable.
+ description: Set to `true` to show locks, `false` to disable.
required: false
- default: true
type: boolean
+ default: true
thermometers:
- description: Set to true to show thermometers, false to disable.
+ description: Set to `true` to show thermometers, `false` to disable.
required: false
- default: true
type: boolean
+ default: true
mouse:
- description: Set to true to show mouse detectors, false to disable.
+ description: Set to `true` to show mouse detectors, `false` to disable.
required: false
- default: true
type: boolean
+ default: true
door_window:
- description: Set to true to show mouse detectors, false to disable.
+ description: Set to `true` to show mouse detectors, `false` to disable.
required: false
- default: true
type: boolean
+ default: true
code_digits:
description: Number of digits in PIN code.
required: false
- default: 4
type: integer
+ default: 4
giid:
description: The GIID of your installation (If you have more then one alarm system). To find the GIID for your systems run 'python verisure.py EMAIL PASSWORD installations'.
required: false
diff --git a/source/_components/volvooncall.markdown b/source/_components/volvooncall.markdown
index d4028a46e4b..3ed8aa1e092 100644
--- a/source/_components/volvooncall.markdown
+++ b/source/_components/volvooncall.markdown
@@ -13,7 +13,6 @@ ha_release: 0.39
ha_iot_class: "Cloud Polling"
---
-
The `volvooncall` component offers integration with the [Volvo On Call](http://www.volvocars.com/intl/own/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level.
## {% linkable_title Configuration %}
@@ -90,6 +89,6 @@ resources:
scandinavian_miles:
description: If set to true, Scandinavian miles ("mil") are used for distances and fuel range.
required: false
- defaults: false
type: boolean
+ default: false
{% endconfiguration %}
diff --git a/source/_components/vultr.markdown b/source/_components/vultr.markdown
index 98051d2038c..f5313ff065e 100644
--- a/source/_components/vultr.markdown
+++ b/source/_components/vultr.markdown
@@ -14,9 +14,10 @@ logo: vultr.png
ha_iot_class: "Cloud Polling"
---
-
The `vultr` component allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant.
+## {% linkable_title Configuration %}
+
Obtain your API key from your [Vultr Account](https://my.vultr.com/settings/#settingsapi).
@@ -28,7 +29,7 @@ To integrate your Vultr subscriptions with Home Assistant, add the following sec ```yaml # Example configuration.yaml entry vultr: - api_key: ABCDEFG12345 + api_key: YOUR_API_KEY ``` {% configuration %} @@ -37,4 +38,3 @@ api_key: required: true type: string {% endconfiguration %} - diff --git a/source/_components/wake_on_lan.markdown b/source/_components/wake_on_lan.markdown index 87603ad2338..da7e5831afb 100644 --- a/source/_components/wake_on_lan.markdown +++ b/source/_components/wake_on_lan.markdown @@ -37,7 +37,6 @@ Send a _magic packet_ to wake up a device with 'Wake-On-LAN' capabilities. | `mac` | no | MAC address of the device to wake up. | | `broadcast_address` | yes | Optional broadcast IP where to send the magic packet. | - Sample service data: ```json @@ -45,4 +44,3 @@ Sample service data: "mac":"00:40:13:ed:f1:32" } ``` - diff --git a/source/_components/climate.econet.markdown b/source/_components/water_heater.econet.markdown similarity index 60% rename from source/_components/climate.econet.markdown rename to source/_components/water_heater.econet.markdown index 704c6ebf0ee..5ac129c4c38 100644 --- a/source/_components/climate.econet.markdown +++ b/source/_components/water_heater.econet.markdown @@ -8,20 +8,22 @@ comments: false sharing: true footer: true logo: econet.png -ha_category: Climate +ha_category: Water heater ha_release: 0.61.0 ha_iot_class: "Cloud Polling" +redirect_from: /components/climate.econet/ --- -The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](http://www.rheem.com/EcoNet/Home). This component allows you to set the temperature, the operation mode, and enable vaction mode. +The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](http://www.rheem.com/EcoNet/Home). This platform allows you to set the temperature, the operation mode, and enable vaction mode. -To enable the `econet` water heater platform add the following to your config. +## {% linkable_title Configuration %} +To enable the `econet` water heater platform, add the following information to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry -climate: +water_heater: - platform: econet username: YOUR_ECONET_EMAIL password: YOUR_ECONET_PASSWORD @@ -38,10 +40,9 @@ password: type: string {% endconfiguration %} +### {% linkable_title Service `econet.add_vacation` %} -### {% linkable_title Service `econet_add_vacation` %} - -You can use the service econet/add_vacation to create a new vacation for your EcoNet water heaters. +You can use the service `econet.add_vacation` to create a new vacation for your EcoNet water heaters. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | @@ -50,15 +51,17 @@ You can use the service econet/add_vacation to create a new vacation for your Ec | `end_date` | yes | this is a Unix timestamp for when the vaction should end.
-The Unix timestamps can be obtained from the input_datetime component. This will allow you to graphically set the start and end date. +The Unix timestamps can be obtained from the `input_datetime` component. This will allow you to graphically set the start and end date.
-### {% linkable_title Service `econet_delete_vacation` %} +### {% linkable_title Service `econet.delete_vacation` %} -You can use the service econet/delete_vacation to remove all vactions from an EcoNet water heater. +You can use the service `econet.delete_vacation` to remove all vactions from an EcoNet water heater. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | The entity id of the water heater to remove the vaction from. - ++Econet water heaters use to live under the `climate` platform prior to release 0.81. +
diff --git a/source/_components/water_heater.markdown b/source/_components/water_heater.markdown new file mode 100644 index 00000000000..56917dcc57b --- /dev/null +++ b/source/_components/water_heater.markdown @@ -0,0 +1,120 @@ +--- +layout: page +title: "Water Heater" +description: "Instructions on how to setup water heater devices within Home Assistant." +date: 2018-10-10 19:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + + +The `water_heater` component is built for the controlling and monitoring of hot water heaters. + +To enable this component, pick one of the platforms, and add it to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +water_heater: + platform: demo +``` + +## {% linkable_title Services %} + +### {% linkable_title Water heater control services %} +Available services: `water_heater.set_temperature`, `water_heater.turn_away_mode_on`, `water_heater.turn_away_mode_off`, `water_heater.set_operation_mode` + +
+Not all water heater services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking **Services**.
+
+Wink water heaters use to live under the `climate` platform prior to release 0.81. +
diff --git a/source/_components/waterfurnace.markdown b/source/_components/waterfurnace.markdown index 15a88eb8565..bc45420f464 100644 --- a/source/_components/waterfurnace.markdown +++ b/source/_components/waterfurnace.markdown @@ -53,10 +53,8 @@ unit: type: string {% endconfiguration %} - #### {% linkable_title Limitations %} The WebSocket interface used by this module requires active polling, otherwise the server side shuts down the connection. By default, this polling is happening every 10 seconds. All sensors are updated during every polling cycle. While this is communicating with a thermostat, geothermal systems operate most efficiently when setbacks are not used, and the home is kept at a constant temperature. It remains useful to collect the data from the system to understand its performance, but a full climate interface won't be implemented. - diff --git a/source/_components/watson_iot.markdown b/source/_components/watson_iot.markdown index b5c30202d49..0014d5e24da 100644 --- a/source/_components/watson_iot.markdown +++ b/source/_components/watson_iot.markdown @@ -83,7 +83,6 @@ include: type: list {% endconfiguration %} - ## {% linkable_title Examples %} ### {% linkable_title Full configuration %} diff --git a/source/_components/weather.bom.markdown b/source/_components/weather.bom.markdown index fe26c58337a..025dcd50dd1 100644 --- a/source/_components/weather.bom.markdown +++ b/source/_components/weather.bom.markdown @@ -33,8 +33,8 @@ name: station: description: "The station ID string. See the [`sensor.bom` docs](/components/sensor.bom/) for details on how to find the ID of a station." required: optional - default: The closest station type: string + default: The closest station {% endconfiguration %}diff --git a/source/_components/weather.buienradar.markdown b/source/_components/weather.buienradar.markdown index 8ec59346cc8..505c84bae90 100644 --- a/source/_components/weather.buienradar.markdown +++ b/source/_components/weather.buienradar.markdown @@ -41,12 +41,14 @@ longitude: required: false type: float forecast: - description: "'True' to add a temperature forecast, 'False' to suppress it." + description: "`true` to add a temperature forecast, `false` to suppress it." required: false - default: true type: boolean + default: true {% endconfiguration %} +### {% linkable_title Full configuration %} + A full configuration example: ```yaml diff --git a/source/_components/weather.ipma.markdown b/source/_components/weather.ipma.markdown index 02141227ead..68f4cf67a88 100644 --- a/source/_components/weather.ipma.markdown +++ b/source/_components/weather.ipma.markdown @@ -22,23 +22,23 @@ To add the IPMA weather platform to your installation, add the following to your ```yaml # Example configuration.yaml entry weather: - - platform: ipma + - platform: ipma ``` {% configuration %} name: description: The name you would like to give to the weather station. - required: false - default: The name of the used station + required: false type: string + default: The name of the used station latitude: description: Latitude of the location for which you want weather information. - required: false - default: Home Assistant global latitude configuration + required: false type: string + default: Home Assistant global latitude configuration longitude: description: Longitude of the location for which you want weather information. - required: false - default: Home Assistant global longitude configuration + required: false type: string + default: Home Assistant global longitude configuration {% endconfiguration %} diff --git a/source/_components/weather.markdown b/source/_components/weather.markdown index e558c1a29bc..fa199a2d666 100644 --- a/source/_components/weather.markdown +++ b/source/_components/weather.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -The `weather` platforms are gathering meteorological information from web services and display the conditions and other details about the weather at the given location. +The `weather` platforms are gathering meteorological information from web services and display the conditions and other details about the weather at the given location. Home Assistant currently supports free web services and such which require a registration. Please check the sidebar for a full list of supported `weather` platforms. @@ -32,4 +32,3 @@ The `weather` platform only knows the below listed conditions. The reason for th - 'windy' - 'windy-variant' - 'exceptional': - diff --git a/source/_components/weather.met.markdown b/source/_components/weather.met.markdown index 1c31f4a0357..3cdd8145b8c 100644 --- a/source/_components/weather.met.markdown +++ b/source/_components/weather.met.markdown @@ -24,7 +24,6 @@ weather: - platform: met ``` - {% configuration %} latitude: description: Manually specify latitude. By default the value will be taken from the Home Assistant configuration. diff --git a/source/_components/weather.metoffice.markdown b/source/_components/weather.metoffice.markdown index df624d2a9ca..37d41463dbd 100644 --- a/source/_components/weather.metoffice.markdown +++ b/source/_components/weather.metoffice.markdown @@ -26,12 +26,27 @@ weather: api_key: YOUR_API_KEY ``` -Configuration variables: - -- **api_key** (*Required*): Your personal API key from the [Datapoint website](http://www.metoffice.gov.uk/datapoint). +{% configuration %} +api_key: + description: "Your personal API key from the [Datapoint website](http://www.metoffice.gov.uk/datapoint)." + required: true + type: string +name: + description: Additional name for the weather component in Home Assistant. + required: false + type: string + default: Met Office +latitude: + description: "Latitude coordinate to monitor weather of (required if **longitude** is specified), defaults to coordinates defined in your `configuration.yaml`." + required: inclusive + type: float +longitude: + description: "Longitude coordinate to monitor weather of (required if **latitude** is specified), defaults to coordinates defined in your `configuration.yaml`." + required: inclusive + type: float +{% endconfiguration %}
This platform is an alternative to the [`metoffice`](/components/sensor.metoffice/) sensor. The weather platform is easier to configure but less customizable.
- diff --git a/source/_components/weather.openweathermap.markdown b/source/_components/weather.openweathermap.markdown index f0d9d1f93bb..1d83077ef80 100644 --- a/source/_components/weather.openweathermap.markdown +++ b/source/_components/weather.openweathermap.markdown @@ -30,29 +30,29 @@ weather: {% configuration %} api_key: - required: true description: Your API key for [OpenWeatherMap](http://openweathermap.org/). + required: true type: string name: - required: false description: Name to use in the frontend. + required: false + type: string default: OpenWeatherMap - type: string mode: - required: false description: "Can specify `hourly` or `daily`. Select `hourly` for a three-hour forecast or `daily` for daily forecast." - default: "`hourly`" + required: false type: string + default: "`hourly`" latitude: - required: false description: Latitude of the location to display the weather. - default: "The latitude in your `configuration.yaml` file." - type: float -longitude: required: false - description: Longitude of the location to display the weather. - default: "The longitude in your `configuration.yaml` file." type: float + default: "The latitude in your `configuration.yaml` file." +longitude: + description: Longitude of the location to display the weather. + required: false + type: float + default: "The longitude in your `configuration.yaml` file." {% endconfiguration %}diff --git a/source/_components/weather.smhi.markdown b/source/_components/weather.smhi.markdown new file mode 100644 index 00000000000..4eb17355a5b --- /dev/null +++ b/source/_components/weather.smhi.markdown @@ -0,0 +1,21 @@ +--- +layout: page +title: "SMHI Weather" +description: "Instructions on how to integrate SMHI forecasts within Homeassistant." +date: 2018-09-23 20:00 +sidebar: true +comments: false +sharing: true +footer: true +featured: true +logo: smhi.png +ha_category: Weather +ha_release: 0.81 +ha_iot_class: "Cloud Polling" +--- + +The `smhi` platform uses the [SMHI.se](https://www.smhi.se/) web service as a source for meteorological data for your location. + +## {% linkable_title Configuration %} + +Please see the [component](/components/smhi/) documentation for details and configuration. \ No newline at end of file diff --git a/source/_components/weather.yweather.markdown b/source/_components/weather.yweather.markdown index 055f9daa0ec..7f9744a3938 100644 --- a/source/_components/weather.yweather.markdown +++ b/source/_components/weather.yweather.markdown @@ -12,7 +12,6 @@ ha_category: Weather ha_release: 0.47 --- - The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/) as a source for current meteorological data. This component will show you the condition and temperatures for max. 10 days.
@@ -39,8 +38,8 @@ woeid: name: description: The name of the sensor. To easily recognize each sensor when adding more than one Yahoo weather sensor, it is recommended to use the name option. required: false - default: yweather type: string + default: yweather {% endconfiguration %}
diff --git a/source/_components/weather.zamg.markdown b/source/_components/weather.zamg.markdown index dd62ceec3dc..486f6d7fded 100644 --- a/source/_components/weather.zamg.markdown +++ b/source/_components/weather.zamg.markdown @@ -29,23 +29,23 @@ weather: {% configuration %} station_id: - required: false description: The ID number for a supported ZAMG station. + required: false type: string name: - required: false description: A name for the weather platform. + required: false type: string latitude: - required: false description: "Latitude coordinate to monitor weather of (required if **longitude** is specified)." - default: "Defaults to coordinates defined in your `configuration.yaml` file." - type: float -longitude: required: false - description: "Longitude coordinate to monitor weather of (required if **latitude** is specified)." - default: "Defaults to coordinates defined in your `configuration.yaml` file." type: float + default: "Defaults to coordinates defined in your `configuration.yaml` file." +longitude: + description: "Longitude coordinate to monitor weather of (required if **latitude** is specified)." + required: false + type: float + default: "Defaults to coordinates defined in your `configuration.yaml` file." {% endconfiguration %}
diff --git a/source/_components/weblink.markdown b/source/_components/weblink.markdown index e145d62e1be..4e05396cdf1 100644 --- a/source/_components/weblink.markdown +++ b/source/_components/weblink.markdown @@ -15,6 +15,8 @@ ha_qa_scale: internal The `weblink` component allows you to display links in the Home Assistant frontend. +## {% linkable_title Configuration %} + To use this component in your installation, add something like the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/websocket_api.markdown b/source/_components/websocket_api.markdown index 4457f2feeac..ca35aeb0678 100644 --- a/source/_components/websocket_api.markdown +++ b/source/_components/websocket_api.markdown @@ -18,6 +18,8 @@ The `websocket_api` component set up a WebSocket API and allows one to interact It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.
+## {% linkable_title Configuration %} + ```yaml # Example configuration.yaml entry websocket_api: diff --git a/source/_components/wemo.markdown b/source/_components/wemo.markdown index af752d9e99a..71f734402ab 100644 --- a/source/_components/wemo.markdown +++ b/source/_components/wemo.markdown @@ -15,6 +15,8 @@ ha_release: pre 0.7 The `wemo` component is the main component to integrate various [Belkin WeMo](http://www.belkin.com/us/Products/home-automation/c/wemo-home-automation/) devices with Home Assistant. +## {% linkable_title Configuration %} + Supported devices will be automatically discovered if the discovery component is enabled. Loading the `wemo` component will scan the local network for WeMo devices, even if you are not using the discovery component ```yaml diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown index ade545e1374..b26f93bf50c 100644 --- a/source/_components/wink.markdown +++ b/source/_components/wink.markdown @@ -78,8 +78,8 @@ client_secret: local_control: description: If set to `true` state changes for lights, locks and switches will be issued to the local hub. required: false - default: false type: boolean + default: false {% endconfiguration %} Local control: diff --git a/source/_components/wirelesstag.markdown b/source/_components/wirelesstag.markdown index d4e229d4a16..bd92d2ee6ce 100644 --- a/source/_components/wirelesstag.markdown +++ b/source/_components/wirelesstag.markdown @@ -15,6 +15,8 @@ ha_release: 0.68 The `wirelesstag` implementation allows you to integrate your [wirelesstag.net](http://wirelesstag.net) sensors tags in Home Assistant. +## {% linkable_title Configuration %} + To enable tags set up with your [wirelesstag.net](http://wirelesstag.net) account, add the following to your `configuration.yaml` file: ```yaml @@ -25,14 +27,14 @@ wirelesstag: ``` {% configuration %} - username: - description: Username for your [wirelesstag.net](http://wirelesstag.net) account. - required: true - type: string - password: - description: Password for your [wirelesstag.net](http://wirelesstag.net) account. - required: true - type: string +username: + description: Username for your wirelesstag.net account. + required: true + type: string +password: + description: Password for your wirelesstag.net account. + required: true + type: string {% endconfiguration %} Finish your configuration by visiting the [WirelessTag binary sensor](/components/binary_sensor.wirelesstag/), [WirelessTag sensor](/components/sensor.wirelesstag/), or [WirelessTag switch](/components/switch.wirelesstag/) documentation. @@ -44,4 +46,4 @@ Finish your configuration by visiting the [WirelessTag binary sensor](/componentTags Manager supports local push notifications for `http` schema only. So if your hass uses `https`, local push notifications are disabled and data is received via cloud polling. -
\ No newline at end of file + diff --git a/source/_components/xiaomi_aqara.markdown b/source/_components/xiaomi_aqara.markdown index 5c6fa1016ba..c01577030b0 100644 --- a/source/_components/xiaomi_aqara.markdown +++ b/source/_components/xiaomi_aqara.markdown @@ -92,38 +92,38 @@ xiaomi_aqara: ``` {% configuration %} - gateways: - description: A list of gateways to set up. - required: true - type: map - keys: - mac: - description: The MAC address of your gateway. *Optional if only using one gateway.* - required: false - type: string - key: - description: The key of your gateway. *Optional if only using sensors and/or binary sensors.* - required: false - type: string - host: - description: The host/IP address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped. - required: false - type: string - disable: - description: Disable the gateway. This is only useful if you don't want to integrate a specific gateway. - required: false - type: boolean - default: false - discovery_retry: - description: Number of times that Home Assistant should try to reconnect to the gateway. - required: false - type: integer - default: 3 - interface: - description: Which network interface to use. - required: false - type: string - default: any +gateways: + description: A list of gateways to set up. + required: true + type: map + keys: + mac: + description: The MAC address of your gateway. *Optional if only using one gateway.* + required: false + type: string + key: + description: The key of your gateway. *Optional if only using sensors and/or binary sensors.* + required: false + type: string + host: + description: The host/IP address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped. + required: false + type: string + disable: + description: Disable the gateway. This is only useful if you don't want to integrate a specific gateway. + required: false + type: boolean + default: false +discovery_retry: + description: Number of times that Home Assistant should try to reconnect to the gateway. + required: false + type: integer + default: 3 +interface: + description: Which network interface to use. + required: false + type: string + default: any {% endconfiguration %} ### {% linkable_title Services %} @@ -274,4 +274,3 @@ That means that Home Assistant is not getting any response from your Xiaomi gate - If you are using Home Assistant in [Docker](/docs/installation/docker/), make sure to use `--net=host`. - If you receive an `{"error":"Invalid key"}` in your log while trying to control the gateway light, you should generate the key again using an Android Phone or alternatively an emulator such as [bluestacks](https://www.bluestacks.com). In some instances there is an issue with keys being generated using the iOS application. - If the required library "PyXiaomiGateway" cannot be installed you will need to install some missing system dependencies `python3-dev`, `libssl-dev`, `libffi-dev` manually (e.g., `$ sudo apt-get install python3-dev libssl-dev libffi-dev`). - diff --git a/source/_components/zabbix.markdown b/source/_components/zabbix.markdown index 1056bef232c..fe317fce810 100644 --- a/source/_components/zabbix.markdown +++ b/source/_components/zabbix.markdown @@ -34,13 +34,13 @@ host: path: description: Path to your Zabbix install. required: false - default: "`/zabbix/`" type: string + default: "`/zabbix/`" ssl: description: Set to `True` if your Zabbix installation is using SSL. required: false - default: false type: boolean + default: false username: description: Your Zabbix username. required: false diff --git a/source/_components/zeroconf.markdown b/source/_components/zeroconf.markdown index d1459fdd1b1..d2e8908adea 100644 --- a/source/_components/zeroconf.markdown +++ b/source/_components/zeroconf.markdown @@ -14,6 +14,8 @@ ha_release: 0.18 The `zeroconf` component exposes your Home Assistant to the local network using [Zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking). Zeroconf is also sometimes known as Bonjour, Rendezvous, and Avahi. +## {% linkable_title Configuration %} + To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: ```yaml @@ -21,7 +23,7 @@ To integrate this into Home Assistant, add the following section to your `config zeroconf: ``` -The registration will include meta-data about the Home Assistant instance, including a base URL that can be used to access Home Assistant, the currently running Home Assistant version, and whether an API password is needed to access the instance. The examples below show two ways to retrieve the details for testing. +The registration will include meta-data about the Home Assistant instance, including a base URL that can be used to access Home Assistant, the currently running Home Assistant version, and whether an API password is needed to access the instance. The examples below show two ways to retrieve the details for testing. ```bash $ avahi-browse -alr @@ -39,6 +41,6 @@ Browsing domain 'local' on -1.-1 ... Browsing for services of type '_home-assistant._tcp' in domain 'local' on 4.0 ... Found service 'Home' of type '_home-assistant._tcp' in domain 'local' on 4.0. Service data for service 'Home' of type '_home-assistant._tcp' in domain 'local' on 4.0: - Host Home._home-assistant._tcp.local (192.168.0.70), port 8123, TXT data: + Host Home._home-assistant._tcp.local (192.168.0.70), port 8123, TXT data: ['requires_api_password=true', 'base_url=http://192.168.0.70:8123', 'version=0.41.0'] ``` diff --git a/source/_components/zha.markdown b/source/_components/zha.markdown index 477b89178c7..2bc206d73d5 100644 --- a/source/_components/zha.markdown +++ b/source/_components/zha.markdown @@ -13,8 +13,8 @@ ha_release: 0.44 ha_iot_class: "Local Polling" --- -[ZigBee Home Automation](http://www.zigbee.org/zigbee-for-developers/applicationstandards/zigbeehomeautomation/) -integration for Home Assistant allows you to connect many off-the-shelf ZigBee devices to Home Assistant, using a compatible ZigBee radio. +[Zigbee Home Automation](http://www.zigbee.org/zigbee-for-developers/applicationstandards/zigbeehomeautomation/) +integration for Home Assistant allows you to connect many off-the-shelf Zigbee devices to Home Assistant, using a compatible Zigbee radio. There is currently support for the following device types within Home Assistant: @@ -24,12 +24,14 @@ There is currently support for the following device types within Home Assistant: - [Switch](../switch.zha) - [Fan](../fan.zha) -Known working ZigBee radios: +Known working Zigbee radios: - Nortek/GoControl Z-Wave & Zigbee USB Adapter - Model HUSBZB-1 - XBee Series 2C -- [Elelabs ZigBee USB Adapter](https://elelabs.com/products/elelabs_usb_adapter.html) -- [Elelabs ZigBee Raspberry Pi Shield](https://elelabs.com/products/elelabs_zigbee_shield.html) +- [Elelabs Zigbee USB Adapter](https://elelabs.com/products/elelabs_usb_adapter.html) +- [Elelabs Zigbee Raspberry Pi Shield](https://elelabs.com/products/elelabs_zigbee_shield.html) + +## {% linkable_title Configuration %} To configure the component, a `zha` section must be present in the `configuration.yaml`, and the path to the serial device for the radio and path to the database which will persist your network data is required. @@ -45,8 +47,8 @@ zha: radio_type: description: One of `ezsp` or `xbee`. required: false - default: ezsp type: string + default: ezsp usb_path: description: Path to the serial device for the radio. required: true @@ -54,8 +56,8 @@ usb_path: baudrate: description: Baud rate of the serial device. required: false - default: 57600 type: integer + default: 57600 database_path: description: _Full_ path to the database which will keep persistent network data. required: true diff --git a/source/_components/zigbee.markdown b/source/_components/zigbee.markdown index e2b3b2429bd..d43c7051ff1 100644 --- a/source/_components/zigbee.markdown +++ b/source/_components/zigbee.markdown @@ -1,7 +1,7 @@ --- layout: page -title: "ZigBee" -description: "Instructions on how to integrate a ZigBee network with Home Assistant." +title: "Zigbee" +description: "Instructions on how to integrate a Zigbee network with Home Assistant." date: 2016-01-27 17:10 sidebar: true comments: false @@ -13,7 +13,7 @@ ha_release: 0.12 ha_iot_class: "Local Polling" --- -[ZigBee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local ZigBee device to be connected to a serial port. Through this it will send and receive commands to and from other devices on the ZigBee mesh network. +[Zigbee](http://www.zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](http://www.digi.com/lp/xbee) as wireless General Purpose Input/Output (GPIO) devices. The component requires a local Zigbee device to be connected to a serial port. Through this it will send and receive commands to and from other devices on the Zigbee mesh network. There is currently support for the following device types within Home Assistant: @@ -22,7 +22,9 @@ There is currently support for the following device types within Home Assistant: - [Light](../light.zigbee) (digital output pins) - [Switch](../switch.zigbee) (digital output pins) -The local ZigBee device (assuming XBee) must have an up to date Router or Coordinator API firmware installed. +## {% linkable_title Configuration %} + +The local Zigbee device (assuming XBee) must have an up to date Router or Coordinator API firmware installed. A `zigbee` section must be present in the `configuration.yaml` file and contain the following options as required: @@ -33,15 +35,15 @@ zigbee: {% configuration %} device: - description: The serial port to which the local ZigBee device is connected. + description: The serial port to which the local Zigbee device is connected. required: false - default: "/dev/ttyUSB0" type: string + default: "`/dev/ttyUSB0`" baud: - description: The baud rate at which to communicate with the local ZigBee device. + description: The baud rate at which to communicate with the local Zigbee device. required: false - default: 9600 type: integer + default: 9600 {% endconfiguration %} To find the possible serial port names of your device, run: @@ -51,7 +53,7 @@ $ ls /dev/ttyUSB* ```-The port may also appear as /dev/ttyACM* if you're communicating with the ZigBee device through an Arduino. +The port may also appear as /dev/ttyACM* if you're communicating with the Zigbee device through an Arduino.
### {% linkable_title Example %} diff --git a/source/_components/zone.markdown b/source/_components/zone.markdown index 1e5125b71c1..caeb22e761a 100644 --- a/source/_components/zone.markdown +++ b/source/_components/zone.markdown @@ -53,8 +53,8 @@ longitude: radius: description: The radius of the zone in meters. required: false - default: 100 type: integer + default: 100 icon: description: The icon to show instead of name. required: false @@ -62,8 +62,8 @@ icon: passive: description: To only use the zone for automation and hide it from the frontend and not use the zone for device tracker name. required: false - default: false type: boolean + default: false {% endconfiguration %} To find the latitude/longitude of a certain place you can use [Google Maps](https://www.google.com/maps/) or [Bing Maps](https://www.bing.com/maps). Just right click and copy the coordinates from there (Bing) or click on the "What is here?" (Google) diff --git a/source/_components/zoneminder.markdown b/source/_components/zoneminder.markdown index 520366e14e8..614a5ce022b 100644 --- a/source/_components/zoneminder.markdown +++ b/source/_components/zoneminder.markdown @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The ZoneMinder component sets up the integration with your [ZoneMinder](https://www.zoneminder.com) instance so that [cameras](/components/camera.zoneminder/), [sensors](/components/sensor.zoneminder/), and [switches](/components/switch.zoneminder) can use it. +## {% linkable_title Configuration %} + ```yaml # Example configuration.yaml entry zoneminder: @@ -30,23 +32,23 @@ host: path: description: Path to your ZoneMinder install. required: false - default: "`/zm/`" type: string + default: "`/zm/`" path_zms: description: Path to the CGI script for streaming. This should match `PATH_ZMS` in ZM's "Paths" settings. required: false - default: "`/zm/cgi-bin/nph-zms`" type: string + default: "`/zm/cgi-bin/nph-zms`" ssl: description: Set to `true` if your ZoneMinder installation is using SSL. required: false - default: false type: boolean + default: false verify_ssl: description: Verify the certification of the endpoint. required: false - default: true type: boolean + default: true username: description: Your ZoneMinder username. required: false @@ -70,3 +72,19 @@ zoneminder: username: YOUR_USERNAME password: YOUR_PASSWORD ``` + +### {% linkable_title Service %} + +Once loaded, the `zoneminder` platform will expose a service (`set_run_state`) that can be used to change the current run state of ZoneMinder. + +| Service data attribute | Optional | Description | +|:-----------------------|:---------|:----------------------------------| +| `name` | no | Name of the new run state to set. | + +For example, if your ZoneMinder instance was configured with a run state called "Home", you could write an [automation](/getting-started/automation/) that changes ZoneMinder to the "Home" run state by including the following [action](/getting-started/automation-action/): + ```yaml +action: + service: zoneminder.set_run_state + data: + name: Home +``` diff --git a/source/_components/zwave.markdown b/source/_components/zwave.markdown index 9dd4811b3e4..33c11eeccd3 100644 --- a/source/_components/zwave.markdown +++ b/source/_components/zwave.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Local Push" The [Z-Wave](http://www.z-wave.com/) integration for Home Assistant allows you to observe and control connected Z-Wave devices. Please see the [Z-Wave getting started section](/docs/z-wave/) for in-depth documentation on how to use and setup the Z-Wave component. +## {% linkable_title Configuration %} + If you have setup the requirements, then add the following entry `configuration.yaml` file: ```yaml diff --git a/source/_cookbook/configuration_yaml_by_klaasnicolaas.markdown b/source/_cookbook/configuration_yaml_by_klaasnicolaas.markdown new file mode 100644 index 00000000000..5329cff8c32 --- /dev/null +++ b/source/_cookbook/configuration_yaml_by_klaasnicolaas.markdown @@ -0,0 +1,12 @@ +--- +layout: page +title: "Configuration.yaml by klaasnicolaas" +description: "" +date: 2018-10-19 15:40 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Example configuration.yaml +ha_external_link: https://github.com/klaasnicolaas/Smarthome-homeassistant-config +--- diff --git a/source/_docs/authentication.markdown b/source/_docs/authentication.markdown index f2e984cf30a..8d711c416af 100644 --- a/source/_docs/authentication.markdown +++ b/source/_docs/authentication.markdown @@ -40,6 +40,10 @@ As a user, you can setup multi-factor authentication with time-based one-time pa ## {% linkable_title Troubleshooting %} +### {% linkable_title Authentication failures from `127.0.0.1` %} + +If you're seeting authentication failures from `127.0.0.1` and you're using the `nmap` device tracker, you should [exclude the Home Assistant IP](/components/device_tracker.nmap_tracker/#exclude) from being scanned. + ### {% linkable_title Bearer token warnings %} Under the new authentication system you'll see the following warning logged when the [legacy API password](/docs/authentication/providers/#legacy-api-password) is supplied, but not configured in Home Assistant: diff --git a/source/_docs/backend/database.markdown b/source/_docs/backend/database.markdown index 652ef13f05f..199466b4c43 100644 --- a/source/_docs/backend/database.markdown +++ b/source/_docs/backend/database.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Database" -description: "Details about the database which Home Assistant is using." +description: "Details about the database used by Home Assistant." date: 2016-10-10 10:00 sidebar: true comments: false @@ -10,14 +10,16 @@ footer: true redirect_from: /details/database/ --- -The default database that is used for Home Assistant is [SQLite](https://www.sqlite.org/) and is stored in your [configuration directory](/getting-started/configuration/) (e.g., `
template developer tools, create your template in the _Template editor_ and check the results on the right.
+
### {% linkable_title States %}
The next two statements result in same value if state exists. The second one will result in an error if state does not exist.
@@ -133,7 +147,7 @@ Print an attribute if state is defined. Both will return the same thing but the
{% raw %}
```text
{% if states.device_tracker.paulus %}
- {{ states.device_tracker.paulus.attributes.battery }}
+ {{ state_attr('device_tracker.paulus', 'battery') }}
{% else %}
??
{% endif %}
@@ -170,9 +184,9 @@ Print out a list of all the sensor states.
Paulus is at {{ states('device_tracker.paulus') }}.
{% endif %}
-{{ states.sensor.temperature | float + 1 }}
+{{ states('sensor.temperature') | float + 1 }}
-{{ (states.sensor.temperature | float * 10) | round(2) }}
+{{ (states('sensor.temperature') | float * 10) | round(2) }}
{% if states('sensor.temperature') | float > 20 %}
It is warm!
@@ -280,7 +294,7 @@ Just use the "Square bracket notation" to get the value.
{% raw %}
```yaml
-'{{ value_json["values"]["temp"] }}'
+'{{ value_json['values']['temp'] }}'
```
{% endraw %}
diff --git a/source/_docs/ecosystem/appdaemon/api.markdown b/source/_docs/ecosystem/appdaemon/api.markdown
index 4464e699717..09fcfd6781b 100755
--- a/source/_docs/ecosystem/appdaemon/api.markdown
+++ b/source/_docs/ecosystem/appdaemon/api.markdown
@@ -317,10 +317,10 @@ state = self.get_state("switch")
state = self.get_state("light.office_1")
# Return the brightness attribute for light.office_1
-state = self.get_state("light.office_1", "brightness")
+state = self.get_state("light.office_1", attribute = "brightness")
# Return the entire state for light.office_1
-state = self.get_state("light.office_1", "all")
+state = self.get_state("light.office_1", attribute = "all")
```
### {% linkable_title set_state() %}
diff --git a/source/_docs/ecosystem/backup/backup_github.markdown b/source/_docs/ecosystem/backup/backup_github.markdown
index cf526c7b502..82114cae475 100644
--- a/source/_docs/ecosystem/backup/backup_github.markdown
+++ b/source/_docs/ecosystem/backup/backup_github.markdown
@@ -57,10 +57,17 @@ Creating a `.gitignore` file in your repository will tell Git which files NOT to
Here is an example that will ignore everything but your YAML configuration.
```bash
-# Example .gitignore file for your config dir
+# Example .gitignore file for your config dir. Lines with ! will not be ignored.
*
!*.yaml
!.gitignore
+*.conf
+*.txt
+*.log
+.storage
+.cloud
+.google.token
+ip_bans.yaml
secrets.yaml
known_devices.yaml
```
diff --git a/source/_docs/ecosystem/ios/location.markdown b/source/_docs/ecosystem/ios/location.markdown
index 596a4b93a4b..694e26f4e7a 100644
--- a/source/_docs/ecosystem/ios/location.markdown
+++ b/source/_docs/ecosystem/ios/location.markdown
@@ -48,7 +48,7 @@ zone.home:
minor: 43814
```
-Restart Home Assistant and then the iOS app. It will begin then begin using iBeacons _instead of your location_ for enter and exit triggers around your zones. To add an iBeacon to `zone.home` add the above under your `customize`.
+Restart Home Assistant and then the iOS app. It will then begin using iBeacons _instead of your location_ for enter and exit triggers around your zones. To add an iBeacon to `zone.home` add the above under your `customize`.
[apple-energy-guide]: https://developer.apple.com/library/content/documentation/Performance/Conceptual/EnergyGuide-iOS/LocationBestPractices.html#//apple_ref/doc/uid/TP40015243-CH24-SW4
[apple-location-programming-guide]: https://developer.apple.com/library/content/documentation/UserExperience/Conceptual/LocationAwarenessPG/CoreLocation/CoreLocation.html#//apple_ref/doc/uid/TP40009497-CH2-SW9
diff --git a/source/_docs/installation/docker.markdown b/source/_docs/installation/docker.markdown
index 7b248911b78..e4c0a8125b3 100644
--- a/source/_docs/installation/docker.markdown
+++ b/source/_docs/installation/docker.markdown
@@ -185,7 +185,7 @@ $ docker-compose restart
### {% linkable_title Exposing Devices %}
-In order to use Z-Wave, ZigBee 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:
+In order to use Z-Wave, Zigbee 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:
```bash
$ docker run -d --name="home-assistant" -v /path/to/your/config:/config \
diff --git a/source/_docs/installation/macos.markdown b/source/_docs/installation/macos.markdown
index 51292c43ab2..c7b2c7c22c9 100644
--- a/source/_docs/installation/macos.markdown
+++ b/source/_docs/installation/macos.markdown
@@ -11,7 +11,7 @@ footer: true
[macOS](http://www.apple.com/macos/) is available by default on Apple computer. If you run a different operating system, please refer to the other section of the documentation.
-To run Home Assistant on macOS you need to install Python first. Download Python 3.5.3 or later from https://www.python.org/downloads/mac-osx/ and follow the instructions of the installer.
+To run Home Assistant on macOS you need to install Python first. Download Python 3.5.3 or later from [https://www.python.org/downloads/mac-osx/](https://www.python.org/downloads/mac-osx/) and follow the instructions of the installer.
Open a terminal and install Home Assistant.
diff --git a/source/_docs/installation/updating.markdown b/source/_docs/installation/updating.markdown
index a9884322b60..4bc5d375eb1 100644
--- a/source/_docs/installation/updating.markdown
+++ b/source/_docs/installation/updating.markdown
@@ -44,6 +44,14 @@ In the event that a Home Assistant version doesn't play well with your hardware
$ pip3 install homeassistant==0.XX.X
```
+#### {% linkable_title Run the beta version %}
+
+If you would like to test next release before anyone else, you can install the beta version released every two weeks:
+
+```bash
+$ pip3 install --pre --upgrade homeassistant
+```
+
#### {% linkable_title Run the development version %}
If you want to stay on the bleeding-edge Home Assistant development branch, you can upgrade to `dev`.
diff --git a/source/_docs/installation/vagrant.markdown b/source/_docs/installation/vagrant.markdown
index 66b48d09cb1..c48a9606b3f 100644
--- a/source/_docs/installation/vagrant.markdown
+++ b/source/_docs/installation/vagrant.markdown
@@ -10,7 +10,7 @@ footer: true
redirect_from: /getting-started/installation-vagrant/
---
-A `Vagrantfile` is available into `virtualization/vagrant` folder for quickly spinning up a Linux virtual machine running Home Assistant. This can be beneficial for those who want to experiment with Home Assistant and/or developers willing to easily test local changes and run test suite against them. In the same `virtualization/vagrant` folder there's also a `provision.sh` shell script which provides an easy way to interact with the Home Assistant instance running within the Vagrant VM.
+A `Vagrantfile` is available into `virtualization/vagrant` folder for quickly spinning up a Linux virtual machine running Home Assistant. This can be beneficial for those who want to experiment with Home Assistant and/or developers willing to easily test local changes and run test suite against them. In the same `virtualization/vagrant` folder there's also a `provision.sh` shell script which provides an easy way to interact with the Home Assistant instance running within the Vagrant VM. For Windows, use the batch script `provision.bat`.
Vagrant is intended for testing/development only. It is NOT recommended for permanent installations. @@ -20,6 +20,8 @@ Vagrant is intended for testing/development only. It is NOT recommended for perm You must have [Vagrant](https://www.vagrantup.com/downloads.html) and [Virtualbox](https://www.virtualbox.org/wiki/Downloads) installed on your workstation. Vagrant and Virtualbox support all the main platforms, including Windows, MacOS and Linux. +Limited support is available for Hyper-V on Windows, see below. + ## {% linkable_title Get Home Assistant source code %} Download the Home Assistant source code by either downloading the .zip file from [GitHub releases page](https://github.com/home-assistant/home-assistant/releases) or by using [Git](https://git-scm.com/) @@ -98,3 +100,15 @@ To completely remove the VM **and** setup a fresh new environment: ```bash $ ./provision.sh recreate ``` + +## {% linkable_title Windows %} + +On Windows, Vagrant is launched through an elevated `PowerShell`. Use the batch script `provision.bat` instead of the shell script `provision.sh`. + +## {% linkable_title Hyper-V %} + +It is possible to use Hyper-V instead of Virtualbox on Windows, with some limitations. + +Samba is used for the virtual machine to access files, for which the Windows credentials are needed when the machine is created. +As Hyper-V does not allow for port forwarding, NAT is used by default for the network. Through creating an external network switch in Hyper-V it is possible to access the machine on the network. +The IP address is visible on creation, and through the Hyper-V manager. diff --git a/source/_docs/mqtt/discovery.markdown b/source/_docs/mqtt/discovery.markdown index af0f99c2c1e..3c6a1d9cec4 100644 --- a/source/_docs/mqtt/discovery.markdown +++ b/source/_docs/mqtt/discovery.markdown @@ -38,6 +38,10 @@ Configuration variables: - **discovery** (*Optional*): If the MQTT discovery should be enabled or not. Defaults to `False`. - **discovery_prefix** (*Optional*): The prefix for the discovery topic. Defaults to `homeassistant`. +
+The [embedded MQTT broker](/docs/mqtt/broker#embedded-broker) does not save any messages between restarts. If you use the embedded MQTT broker you have to send the MQTT discovery messages after every Home Assistant restart for the devices to show up. +
+ The discovery topic need to follow a specific format: ```text @@ -55,6 +59,118 @@ An empty payload will cause a previously discovered device to be deleted. The `+As of Home Assistant 0.81, the Z-Wave `usb_path` and `network_key` options are configured through the Integrations page in Home Assistant. Specifying a `zwave:` section in configuration.yaml is no longer required unless you need to customize other settings, such as `device_config`, `polling_interval`, etc. +
+ + ### {% linkable_title Finding the controller path on Linux %}diff --git a/source/_includes/custom/footer.html b/source/_includes/custom/footer.html index 1a2e590320c..ad8df9a0553 100644 --- a/source/_includes/custom/footer.html +++ b/source/_includes/custom/footer.html @@ -1,13 +1,13 @@
Home Assistant
+ Home Assistant will track the state of all the devices in your home, so you don't have to.
diff --git a/source/_includes/custom/header.html b/source/_includes/custom/header.html index d0b387b1c1c..ce1ac699782 100644 --- a/source/_includes/custom/header.html +++ b/source/_includes/custom/header.html @@ -1,6 +1,6 @@ diff --git a/source/_lovelace/alarm-panel.markdown b/source/_lovelace/alarm-panel.markdown new file mode 100644 index 00000000000..7f94e3abf9a --- /dev/null +++ b/source/_lovelace/alarm-panel.markdown @@ -0,0 +1,81 @@ +--- +layout: page +title: "Alarm Panel Card" +sidebar_label: Alarm Panel +description: "The Alarm Panel allows you to Arm and Disarm your Alarm Control Panel Components" +date: 2018-10-15 10:28 +00:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +The Alarm Panel allows you to Arm and Disarm your Alarm Control Panel Components. + +
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
+
+Screenshot of the Alarm Panel card.
+
+
+Screenshot of the Alarm Panel card.
+
+
+Screenshot of the Entity Button card.
+
+
+Screenshot of the Entity Button card with Title and Script Service.
+
@@ -91,7 +91,7 @@ Define the severity map: - type: gauge title: With Severity unit_of_measurement: '%' - entity: sensor.cpu_usuage + entity: sensor.cpu_usage severity: green: 0 yellow: 45 diff --git a/source/_lovelace/glance.markdown b/source/_lovelace/glance.markdown index 9dda1cd3eac..32611e47f59 100644 --- a/source/_lovelace/glance.markdown +++ b/source/_lovelace/glance.markdown @@ -40,15 +40,14 @@ show_state: description: Show entity state-text. type: boolean default: "true" -column_width: +theme: required: false - description: "Column width as CSS length like `100px` or `calc(100% / 7)`. This controls how many entities appear in a row - at the default 20% you have 5 entities in a row. Use `calc(100% / 7)` for 7 entities in a row, and so on." + description: "Set to any theme within `themes.yaml`" type: string - default: 20% -theming: +columns: required: false - description: "Set to `primary` to style the card with the background and text color of the header bar." - type: string + description: Number of columns to show. If not specified the number will be set automatically. + type: integer {% endconfiguration %} ## {% linkable_title Options For Entities %} diff --git a/source/_lovelace/picture-elements.markdown b/source/_lovelace/picture-elements.markdown index 8dd83c9c005..54b60b92285 100644 --- a/source/_lovelace/picture-elements.markdown +++ b/source/_lovelace/picture-elements.markdown @@ -2,7 +2,7 @@ layout: page title: "Picture Elements Card" sidebar_label: Picture Elements -description: "Picture elements card is one of the most versatile type of cards" +description: "Picture elements card is one of the most versatile types of cards" date: 2018-07-01 10:28 +00:00 sidebar: true comments: false @@ -10,9 +10,9 @@ sharing: true footer: true --- -Picture elements card is one of the most versatile type of cards. +Picture elements card is one of the most versatile types of cards. -The cards allows you to position icons or text and even services! On an image based on coordinates. Imagine floor plan, imagine [picture-glance](/lovelace/picture-glance/) with no restrictions! +The cards allow you to position icons or text and even services! On an image based on coordinates. Imagine floor plan, imagine [picture-glance](/lovelace/picture-glance/) with no restrictions!
@@ -74,6 +74,11 @@ tap_action:
description: more-info, toggle, navigate, call-service
type: string
default: more-info
+hold_action:
+ required: false
+ description: Action to perform when clicked-and-held (e.g., `more-info`, `toggle`, `navigate`, `call-service`).
+ type: string
+ default: none
navigation_path:
required: false
description: Url path to navigate to (e.g., `/lovelace/1`)
@@ -86,6 +91,11 @@ service_data:
required: false
description: The service data to use.
type: object
+hold_time:
+ required: false
+ description: Time in ms for click-and-hold to register.
+ type: integer
+ default: 500
style:
required: true
description: Position and style the element using CSS.
@@ -117,6 +127,11 @@ tap_action:
description: more-info, toggle, navigate, call-service
type: string
default: more-info
+hold_action:
+ required: false
+ description: Action to perform when clicked-and-held (e.g., `more-info`, `toggle`, `navigate`, `call-service`).
+ type: string
+ default: none
navigation_path:
required: false
description: Url path to navigate to (e.g., `/lovelace/1`)
@@ -129,6 +144,11 @@ service_data:
required: false
description: The service data to use.
type: object
+hold_time:
+ required: false
+ description: Time in ms for click-and-hold to register.
+ type: integer
+ default: 500
style:
required: true
description: Position and style the element using CSS.
@@ -186,6 +206,11 @@ tap_action:
description: more-info, toggle, navigate, call-service
type: string
default: more-info
+hold_action:
+ required: false
+ description: Action to perform when clicked-and-held (e.g., `more-info`, `toggle`, `navigate`, `call-service`).
+ type: string
+ default: none
navigation_path:
required: false
description: Url path to navigate to (e.g., `/lovelace/1`)
@@ -198,6 +223,11 @@ service_data:
required: false
description: The service data to use.
type: object
+hold_time:
+ required: false
+ description: Time in ms for click-and-hold to register.
+ type: integer
+ default: 500
style:
required: true
description: Position and style the element using CSS.
@@ -221,6 +251,11 @@ tap_action:
description: none, more-info, toggle, navigate, call-service
type: string
default: more-info
+hold_action:
+ required: false
+ description: Action to perform when clicked-and-held (e.g., `more-info`, `toggle`, `navigate`, `call-service`).
+ type: string
+ default: none
navigation_path:
required: false
description: Url path to navigate to (e.g., `/lovelace/1`)
@@ -233,6 +268,11 @@ service_data:
required: false
description: The service data to use.
type: object
+hold_time:
+ required: false
+ description: Time in ms for click-and-hold to register.
+ type: integer
+ default: 500
image:
required: false
description: The image to display.
@@ -311,6 +351,20 @@ state_filter:
"off": brightness(50%) hue-rotate(45deg)
```
+## {% linkable_title How to use click-and-hold %}
+
+If the option `hold_action` is specified, that action will be performed when the entity is clicked and held for a certain time (default 0.5 seconds).
+Please note that the `tap_action` and `hold_action` share variables for `navigation_path`, `service` and `service_data`. It is therefore not possible to, e.g., call two different services when clicked and when held.
+
+```yaml
+tap_action: toggle
+hold_action: call-service
+service: light.turn_on
+service_data:
+ entity_id: light.bed_light
+ brightness_pct: 100
+```
+
## {% linkable_title Example %}
```yaml
diff --git a/source/_lovelace/thermostat.markdown b/source/_lovelace/thermostat.markdown
new file mode 100644
index 00000000000..3ae760f8d4c
--- /dev/null
+++ b/source/_lovelace/thermostat.markdown
@@ -0,0 +1,36 @@
+---
+layout: page
+title: "Thermostat Card"
+sidebar_label: Thermostat
+description: "The thermostat card allows you to control a climate entity."
+date: 2018-10-25 10:28 +00:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+---
+
+The thermostat card gives control of your climate entity.
+
+
+ 
+ Screenshot of the thermostat card.
+
- The non-interoperability between the newly launched IKEA smart lighting products and the Philips Hue bridge has been analyzed. One of the issues found is that the IKEA bulbs report their ProfileID as corresponding to the ZigBee Home Automation (ZHA) profile rather than the ZigBee Light Link (ZLL) profile. As the IKEA bulbs do not behave fully compliant with the ZLL standard, they are rejected by the Hue bridge. IKEA is aware of this and informed us their intent is to have the IKEA smart lighting bulbs to work with the Philips Hue bridge. + The non-interoperability between the newly launched IKEA smart lighting products and the Philips Hue bridge has been analyzed. One of the issues found is that the IKEA bulbs report their ProfileID as corresponding to the Zigbee Home Automation (ZHA) profile rather than the Zigbee Light Link (ZLL) profile. As the IKEA bulbs do not behave fully compliant with the ZLL standard, they are rejected by the Hue bridge. IKEA is aware of this and informed us their intent is to have the IKEA smart lighting bulbs to work with the Philips Hue bridge.## {% linkable_title Affordable %} diff --git a/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown b/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown index 4e87ac92fd4..c39ab07ef8b 100644 --- a/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown +++ b/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown @@ -1,6 +1,6 @@ --- layout: post -title: "Home Assistant 0.44: ZigBee, OpenCV and DLib" +title: "Home Assistant 0.44: Zigbee, OpenCV and DLib" description: "Speak natively with Zigbee network, detect faces with OpenCV: 0.44 is here." date: 2017-05-06 01:04:05 +0000 date_formatted: "May 6, 2017" @@ -13,7 +13,7 @@ og_image: /images/blog/2017-05-0.44/components.png
-This release brings some great new integrations. The biggest one is the [native ZigBee integration][zha docs] by [Russell Cloran][@rcloran]. This will allow Home Assistant to natively control Philips Hue lights without the need for a hub! (IKEA Tradfri lights not yet due to implementing a different profile)
+This release brings some great new integrations. The biggest one is the [native Zigbee integration][zha docs] by [Russell Cloran][@rcloran]. This will allow Home Assistant to natively control Philips Hue lights without the need for a hub! (IKEA Tradfri lights not yet due to implementing a different profile)
Another great new addition is [OpenCV][opencv docs] by [Teagan Glenn][@teagan42]. So now you'll be able to unlock all the cool stuff from OpenCV right in Home Assistant. And if OpenCV is not your style, you can try out the new [DLib integration][image_processing.dlib_face_identify docs] added by [Pascal Vizeli][@pvizeli] in this release.
diff --git a/source/_posts/2018-10-12-release-80.markdown b/source/_posts/2018-10-12-release-80.markdown
index 36537324d3e..1f413af08ed 100644
--- a/source/_posts/2018-10-12-release-80.markdown
+++ b/source/_posts/2018-10-12-release-80.markdown
@@ -42,6 +42,67 @@ On the devices side, we got basic support for the new IKEA TRÅDFRI switches, Ho
- Add new component fritzbox binary_sensor ([@hthiery] - [#17057]) ([fritzbox docs]) ([binary_sensor.fritzbox docs]) (new-platform)
- Add a webhook automation trigger ([@balloob] - [#17246]) ([automation.webhook docs]) (beta fix) (new-platform)
+## {% linkable_title Release 0.80.1 - October 15 %}
+
+- Fix automation editor ([@armills])
+- Fix arm/disarm calls. ([@mbrrg] - [#17381]) ([alarm_control_panel.spc docs])
+- Fix hangout.send_message requiring data key ([@quazzie] - [#17393]) ([hangouts docs])
+- Bugfix eventstream with EOF on end ([@pvizeli] - [#17465]) ([api docs])
+- Fix websocket API ([@balloob] - [#17471]) ([websocket_api docs])
+
+[#17381]: https://github.com/home-assistant/home-assistant/pull/17381
+[#17393]: https://github.com/home-assistant/home-assistant/pull/17393
+[#17465]: https://github.com/home-assistant/home-assistant/pull/17465
+[#17471]: https://github.com/home-assistant/home-assistant/pull/17471
+[@balloob]: https://github.com/balloob
+[@mbrrg]: https://github.com/mbrrg
+[@pvizeli]: https://github.com/pvizeli
+[@quazzie]: https://github.com/quazzie
+[alarm_control_panel.spc docs]: /components/alarm_control_panel.spc/
+[api docs]: /components/api/
+[hangouts docs]: /components/hangouts/
+[websocket_api docs]: /components/websocket_api/
+
+## {% linkable_title Release 0.80.2 - October 17 %}
+
+- Lovelace: Fix glance icon not updating
+- Fix: Connection pool of Request object is smaller than optimal value (8) ([@Anonym-tsk] - [#17483]) ([telegram_bot docs])
+- Blink update - fixes #17316 ([@fronzbot] - [#17538]) ([blink docs]) ([alarm_control_panel.blink docs]) ([binary_sensor.blink docs]) ([camera.blink docs]) ([sensor.blink docs])
+- Home Assistant Cloud: Add another 3 days leeway to give time for payment processing times ([@balloob] - [#17542]) ([cloud docs])
+
+[#17483]: https://github.com/home-assistant/home-assistant/pull/17483
+[#17538]: https://github.com/home-assistant/home-assistant/pull/17538
+[#17542]: https://github.com/home-assistant/home-assistant/pull/17542
+[@Anonym-tsk]: https://github.com/Anonym-tsk
+[@balloob]: https://github.com/balloob
+[@fronzbot]: https://github.com/fronzbot
+[alarm_control_panel.blink docs]: /components/alarm_control_panel.blink/
+[binary_sensor.blink docs]: /components/binary_sensor.blink/
+[blink docs]: /components/blink/
+[camera.blink docs]: /components/camera.blink/
+[cloud docs]: /components/cloud/
+[sensor.blink docs]: /components/sensor.blink/
+[telegram_bot docs]: /components/telegram_bot/
+
+## {% linkable_title Release 0.80.3 - October 18 %}
+
+- Update hangups to 0.4.6 and fix Issue #16593 hangouts reconnects. ([@hobbypunk90] - [#17518]) ([hangouts docs])
+- Update to async-upnp-client==0.12.5 ([@StevenLooman] - [#17401]) ([upnp docs]) ([media_player.dlna_dmr docs])
+- Upgrade async_upnp_client to 0.12.6 ([@StevenLooman] - [#17560]) ([upnp docs]) ([media_player.dlna_dmr docs])
+- Update snapcast to 2.0.9 ([@balloob] - [#17573]) ([media_player.snapcast docs])
+
+[#17401]: https://github.com/home-assistant/home-assistant/pull/17401
+[#17518]: https://github.com/home-assistant/home-assistant/pull/17518
+[#17560]: https://github.com/home-assistant/home-assistant/pull/17560
+[#17573]: https://github.com/home-assistant/home-assistant/pull/17573
+[@StevenLooman]: https://github.com/StevenLooman
+[@balloob]: https://github.com/balloob
+[@hobbypunk90]: https://github.com/hobbypunk90
+[hangouts docs]: https://www.home-assistant.io/components/hangouts/
+[media_player.dlna_dmr docs]: https://www.home-assistant.io/components/media_player.dlna_dmr/
+[media_player.snapcast docs]: https://www.home-assistant.io/components/media_player.snapcast/
+[upnp docs]: https://www.home-assistant.io/components/upnp/
+
## {% linkable_title New Features %}
- Add faucet, shower, sprinkler, valve to HomeKit ([@cdce8p] - [#17145]) ([homekit docs]) (new-feature)
diff --git a/source/_posts/2018-10-29-release-81.markdown b/source/_posts/2018-10-29-release-81.markdown
new file mode 100644
index 00000000000..1f40a74e6d7
--- /dev/null
+++ b/source/_posts/2018-10-29-release-81.markdown
@@ -0,0 +1,816 @@
+---
+layout: post
+title: "0.81: new Lovelace cards, LG soundbars, Dyson fans, Elk-M1"
+description: "Epic new release full of goodies build by over a hundred contributors."
+date: 2018-10-26 00:01:00
+date_formatted: "October 26, 2018"
+author: Tinkerer
+author_twitter: Dubh_Ad
+comments: true
+categories: Release-Notes
+og_image: /images/blog/2018-10-release-81/social.png
+---
+
+This release is a major milestone – 100 contributors have contributed over the last two weeks. A great bit thank you to everybody who contributed, both those returning and those who've been involved for their first time.
+
+To go with the configuration entry support, MQTT also now also integrates with the device registry. Not to be left out, LIFX, SimpliSafe, and Z-Wave have all gained both device registry support, and configuration entry support.
+
+Lovelace has another three new cards, the alarm panel, the button card, and the thermostat card:
+
+
+
+ Screenshot of the thermostat card.
+
diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown
index c06fac4ef3d..ce98c781af6 100644
--- a/source/hassio/installation.markdown
+++ b/source/hassio/installation.markdown
@@ -92,14 +92,14 @@ A detailed guide about running Hass.io as a virtual machine is available in the
[etcher]: https://etcher.io/
[Virtual Appliance]: https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/ova.md
[hassos-network]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md
-[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.11/hassos_rpi0-w-1.11.img.gz
-[pi1]: https://github.com/home-assistant/hassos/releases/download/1.11/hassos_rpi-1.11.img.gz
-[pi2]: https://github.com/home-assistant/hassos/releases/download/1.11/hassos_rpi2-1.11.img.gz
-[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.11/hassos_rpi3-1.11.img.gz
-[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.11/hassos_rpi3-64-1.11.img.gz
+[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi0-w-1.12.img.gz
+[pi1]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi-1.12.img.gz
+[pi2]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi2-1.12.img.gz
+[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi3-1.12.img.gz
+[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_rpi3-64-1.12.img.gz
[tinker]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_tinker-2.2.img.gz
[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_odroid-c2-2.2.img.gz
-[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.11/hassos_ova-1.11.vmdk
+[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.12/hassos_ova-1.12.vmdk
[linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio
[local]: http://hassio.local:8123
[samba]: /addons/samba/
diff --git a/source/help/index.markdown b/source/help/index.markdown
index d90660e84e1..fdc9cabb62f 100644
--- a/source/help/index.markdown
+++ b/source/help/index.markdown
@@ -53,6 +53,7 @@ Looking for [talking points](/help/talking-points/) or [trivia](/help/trivia)?
Don't miss the regular [Home Assistant podcasts](https://hasspodcast.io/).
+- [Build a wireless MQTT weather sensor for your Home Assistant](https://www.smartlab.at/build-a-wireless-mqtt-temperature-and-humidity-sensor-for-your-home-assistant/) - October 2018
- [Building a better thermostat with Home Assistant](https://opensource.com/article/18/8/build-thermostat-open-source-tools) - August 2018
- [Home Assistant lets you automate your smart home without giving up privacy](https://www.the-ambient.com/features/home-assistant-automation-privacy-582) - May 2018
- [HackSpace magazine #6](https://s3-eu-west-1.amazonaws.com/rpi-magazines/issues/full_pdfs/000/000/013/original/HS_6_Digital_Optimised.pdf?1524495009) - May 2018
diff --git a/source/images/blog/2018-10-release-81/social.png b/source/images/blog/2018-10-release-81/social.png
new file mode 100644
index 00000000000..adda79b370e
Binary files /dev/null and b/source/images/blog/2018-10-release-81/social.png differ
diff --git a/source/images/components/zestimate/zestimateexample.png b/source/images/components/zestimate/zestimateexample.png
new file mode 100644
index 00000000000..1ab53b1bb88
Binary files /dev/null and b/source/images/components/zestimate/zestimateexample.png differ
diff --git a/source/images/lovelace/lovelace_alarm_panel_card.gif b/source/images/lovelace/lovelace_alarm_panel_card.gif
new file mode 100644
index 00000000000..3a60ed0f1da
Binary files /dev/null and b/source/images/lovelace/lovelace_alarm_panel_card.gif differ
diff --git a/source/images/lovelace/lovelace_alarm_panel_title_card.gif b/source/images/lovelace/lovelace_alarm_panel_title_card.gif
new file mode 100644
index 00000000000..b9c76497f38
Binary files /dev/null and b/source/images/lovelace/lovelace_alarm_panel_title_card.gif differ
diff --git a/source/images/lovelace/lovelace_entity_button_card.png b/source/images/lovelace/lovelace_entity_button_card.png
new file mode 100644
index 00000000000..1cc38716644
Binary files /dev/null and b/source/images/lovelace/lovelace_entity_button_card.png differ
diff --git a/source/images/lovelace/lovelace_entity_button_complex_card.png b/source/images/lovelace/lovelace_entity_button_complex_card.png
new file mode 100644
index 00000000000..6512008bfec
Binary files /dev/null and b/source/images/lovelace/lovelace_entity_button_complex_card.png differ
diff --git a/source/images/lovelace/lovelace_thermostat_card.gif b/source/images/lovelace/lovelace_thermostat_card.gif
new file mode 100644
index 00000000000..c5425457808
Binary files /dev/null and b/source/images/lovelace/lovelace_thermostat_card.gif differ
diff --git a/source/images/screenshots/nsw-rural-fire-service-feed-entities.png b/source/images/screenshots/nsw-rural-fire-service-feed-entities.png
new file mode 100644
index 00000000000..463f5e5922f
Binary files /dev/null and b/source/images/screenshots/nsw-rural-fire-service-feed-entities.png differ
diff --git a/source/images/screenshots/nsw-rural-fire-service-feed-map.png b/source/images/screenshots/nsw-rural-fire-service-feed-map.png
new file mode 100644
index 00000000000..0b72035c5c4
Binary files /dev/null and b/source/images/screenshots/nsw-rural-fire-service-feed-map.png differ
diff --git a/source/images/supported_brands/ankuoo_recswitch.png b/source/images/supported_brands/ankuoo_recswitch.png
new file mode 100644
index 00000000000..5dc7012e545
Binary files /dev/null and b/source/images/supported_brands/ankuoo_recswitch.png differ
diff --git a/source/images/supported_brands/fios.svg b/source/images/supported_brands/fios.svg
new file mode 100644
index 00000000000..c2bc459e43b
--- /dev/null
+++ b/source/images/supported_brands/fios.svg
@@ -0,0 +1,130 @@
+
+
+
+
diff --git a/source/images/supported_brands/mill.png b/source/images/supported_brands/mill.png
new file mode 100644
index 00000000000..7b8187af5ac
Binary files /dev/null and b/source/images/supported_brands/mill.png differ
diff --git a/source/images/supported_brands/nsw-rural-fire-service.png b/source/images/supported_brands/nsw-rural-fire-service.png
new file mode 100644
index 00000000000..7192774bb7c
Binary files /dev/null and b/source/images/supported_brands/nsw-rural-fire-service.png differ
diff --git a/source/images/supported_brands/route53.png b/source/images/supported_brands/route53.png
new file mode 100644
index 00000000000..07f3e8018db
Binary files /dev/null and b/source/images/supported_brands/route53.png differ
diff --git a/source/images/supported_brands/rtorrent.png b/source/images/supported_brands/rtorrent.png
new file mode 100644
index 00000000000..f8887b07f66
Binary files /dev/null and b/source/images/supported_brands/rtorrent.png differ
diff --git a/source/images/supported_brands/smhi.png b/source/images/supported_brands/smhi.png
new file mode 100644
index 00000000000..4608ecd8b2a
Binary files /dev/null and b/source/images/supported_brands/smhi.png differ
diff --git a/source/images/supported_brands/thermoworks.png b/source/images/supported_brands/thermoworks.png
new file mode 100644
index 00000000000..fad4d2666f6
Binary files /dev/null and b/source/images/supported_brands/thermoworks.png differ
diff --git a/source/images/supported_brands/transport_nsw.png b/source/images/supported_brands/transport_nsw.png
new file mode 100644
index 00000000000..186ea62def0
Binary files /dev/null and b/source/images/supported_brands/transport_nsw.png differ
diff --git a/source/images/supported_brands/zigbee.png b/source/images/supported_brands/zigbee.png
index d91383457c4..8d6c3c04490 100644
Binary files a/source/images/supported_brands/zigbee.png and b/source/images/supported_brands/zigbee.png differ
diff --git a/source/lovelace/changelog.markdown b/source/lovelace/changelog.markdown
index 39bc13598b8..18573daa384 100644
--- a/source/lovelace/changelog.markdown
+++ b/source/lovelace/changelog.markdown
@@ -8,6 +8,20 @@ comments: false
sharing: true
footer: true
---
+## {% linkable_title Changes in 0.81.0 %}
+- 📣 New card type: `alarm-panel` ❤️
+- 📣 New card type: `thermostat` ❤️
+- 📣 New card type: `entity-button` ❤️
+- 📣 [glance card]: can be themed
+- 📣 [glance card]: define columns within
+- 📣 [entity button]: can be themed
+- Long press is now supported
+- Update to allow the use of Custom UI. If you run into issues please disable Custom UI and test before reporting them. If the issue goes away without Custom UI please report this to the Custom UI developer as this is not officially supported.
+
+## {% linkable_title Changes in 0.80.0 %}
+- 📣 New card type: `sensor` ❤️
+- 📣 New card type: `gauge` ❤️
+
## {% linkable_title Changes in 0.77.0 %}
- 📣 New notification drawer ❤️
diff --git a/source/lovelace/index.markdown b/source/lovelace/index.markdown
index 5bb15411593..551269287e7 100644
--- a/source/lovelace/index.markdown
+++ b/source/lovelace/index.markdown
@@ -28,7 +28,7 @@ The Lovelace UI is:
-If you're not using Chrome, please be sure to [read the FAQ](/lovelace/#faq) below. +If you're not using Firefox 63+ or Chrome, please be sure to [read the FAQ](/lovelace/#faq) below.
## {% linkable_title How it works %} @@ -133,7 +133,7 @@ This is the very very early version aimed at gathering feedback. Discussion and ### {% linkable_title I am running Firefox but, custom cards like gauge-card look bad or don't load at all. How do I fix this? %} -This is probably because your version of Firefox doesn't have custom components supported or enabled. Please set to `true` in your `about:config` the following settings: `dom.webcomponents.customelements.enabled` and `dom.webcomponents.shadowdom.enabled` +This is probably because your version of Firefox doesn't have custom components supported or enabled. Please upgrade to version 63 or higher, otherwise set `dom.webcomponents.customelements.enabled` and `dom.webcomponents.shadowdom.enabled` to `true` in `about:config`. ### {% linkable_title Custom cards don't load on my iOS device? %} diff --git a/source/lovelace/tips.markdown b/source/lovelace/tips.markdown index f4cf41ec3c2..2c8ef8cdfe8 100644 --- a/source/lovelace/tips.markdown +++ b/source/lovelace/tips.markdown @@ -36,9 +36,9 @@ you with the ability to split your Lovelace configuration into multiple files. The [Lovelace Jinja2 Script][lovelace-jinja] by [@skalavala] is a simple Jinja2 script that you run in the template editor to generate lovelace configuration based on the entities that are already setup.- Split configuration is currently possible directly in Lovelace, but it - is expected to be removed in the near future due to fact that Home Assistant - will be writing directly to the `ui-lovelace.yaml` file. + Split configuration is no longer possible directly in Lovelace, + due to fact that Home Assistant writes directly to the `ui-lovelace.yaml` file. + Use one of the above generators if you would like to contintue to have such functionality.
## {% linkable_title Tips and Tricks %}