jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Franck Nijhof 2020-04-20 12:47:50 +02:00
commit 7fae8fcee8
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
122 changed files with 871 additions and 294 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Gemfile.lock
View File

@ -86,7 +86,7 @@ GEM
rb-fsevent (0.10.3)
rb-inotify (0.10.1)
ffi (~> 1.0)
rouge (3.17.0)
rouge (3.18.0)
ruby-enum (0.8.0)
i18n
ruby2_keywords (0.0.2)
@ -94,9 +94,7 @@ GEM
sass (3.4.25)
sass-globbing (1.1.5)
sass (>= 3.1)
sassc (2.2.1)
ffi (~> 1.9)
sassc (2.2.1-x64-mingw32)
sassc (2.3.0)
ffi (~> 1.9)
sinatra (2.0.8.1)
mustermann (~> 1.0)

4
_config.yml
View File

@ -101,8 +101,8 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 108
current_patch_version: 3
date_released: 2020-04-10
current_patch_version: 6
date_released: 2020-04-16
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

9
source/_docs/autostart/macos.markdown
View File

@ -8,7 +8,6 @@ Setting up Home Assistant to run as a background service is simple; macOS will s
To get Home Assistant installed as a background service, run:
```bash
$ hass --script macos install
@ -26,3 +25,11 @@ $ hass --script macos uninstall
Home Assistant has been uninstalled.
```
Note:
`automake` is required for `hass` to start. If you are missing this on your system, you can install this by running:
```bash
$ brew install autoconf
```

6
source/_docs/configuration/basic.markdown
View File

@ -35,7 +35,11 @@ elevation:
required: false
type: integer
unit_system:
description: "`metric` for Metric, `imperial` for Imperial."
description: "`metric` for Metric, `imperial` for Imperial. This also sets temperature_unit, Celsius for Metric and Fahrenheit for Imperial"
required: false
type: string
temperature_unit:
description: "Override temperature unit set by unit_system. `C` for Celsius, `F` for Fahrenheit."
required: false
type: string
time_zone:

10
source/_docs/configuration/yaml.markdown
View File

@ -111,3 +111,13 @@ This means that you've mistakenly entered a tab character, instead of spaces.
Home Assistant is case sensitive, a state of `'on'` is not the same as `'On'` or `'ON'`. Similarly an entity of `group.Doors` is not the same as `group.doors`.
If you're having trouble, check the case that Home Assistant is reporting in the dev-state menu, under *Developer tools*.
### Booleans
YAML treats `Y`, `true`, `Yes`, `ON` all as `true` and `n`, `FALSE`, `No`, `off` as `false`. This means that if you want to set the state of an entity to `on` you *must* quote it as `'on'` otherwise it will be translated as setting the state to true. The same applies to `off`.
Not quoting the value may generate an error such as:
```txt
not a valid value for dictionary value @ data
```

496
source/_docs/z-wave/device-specific.markdown
View File

@ -163,7 +163,7 @@ Some models of the Zooz Toggle switches ship with an instruction manual with inc
## Central Scene configuration
To provide Central Scene support you need to **shutdown Home Assistant** and modify your `zwcfg_*.xml` file according to the following guides.
To provide Central Scene support you need to **stop your Z-Wave network** and modify your `zwcfg_*.xml` file according to the following guides. Start your Z-Wave network again after editing `zwcfg_*.xml`.
### Inovelli Scene Capable On/Off and Dimmer Wall Switches
@ -191,131 +191,399 @@ Triple tap on|2|4
5x tap off|1|6
5x tap on|2|6
### Zooz Scene Capable On/Off and Dimmer Wall Switches (Zen26 & Zen27 - Firmware 2.0+)
### Zooz Scene Capable On/Off and Dimmer Wall Switches (Zen21v2 & Zen22v2 - Firmware 3.0+ and Zen26 & Zen27 - Firmware 2.0+)
Many Zooz Zen26/27 switches that have been sold do not have firmware 2.0+. Contact Zooz to obtain the over the air firmware update instructions and new user manual for the switches.
Once the firmware is updated, the the new configuration parameters will have to be added to the `zwcfg` file. Replace the existing `COMMAND_CLASS_CONFIGURATION` with the one of the following options (depending on your model of switch):
Zen21v2 (On/Off Switch):
```xml
<CommandClass id="112" name="COMMAND_CLASS_CONFIGURATION" version="1">
<Instance index="1" />
<Value type="list" genre="config" instance="1" index="1" label="Paddle Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Normal mode: Upper paddle turns the light on, lower paddle turns the light off. Reverse mode: Upper paddle turns the light off, lower paddle turns the light on. Toggle mode: Either paddle toggles the light.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Toggle" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="2" label="LED Indication Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="3" vindex="1" size="1">
<Help>LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Always Off" value="2" />
<Item label="Always On" value="3" />
</Value>
<Value type="list" genre="config" instance="1" index="3" label="Enable Auto Turn-Off Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="4" label="Auto Turn-Off Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="60">
<Help>Time, in minutes, for auto-off timer delay.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="5" label="Enable Auto Turn-On Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="6" label="Auto Turn-On Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="60">
<Help>Set the time (in minutes) after which you want the switch to automatically turn on once it has been turned off.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="7" label="Association Reports" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="15" vindex="15" size="1">
<Help>Choose which physical and Z-Wave triggers should prompt the switch to send a status change report to associated devices.</Help>
<Item label="none" value="0" />
<Item label="physical tap on ZEN21 only" value="1" />
<Item label="physical tap on connected 3-way switch only" value="2" />
<Item label="physical tap on ZEN21 or connected 3-way switch" value="3" />
<Item label="Z-Wave command from hub" value="4" />
<Item label="physical tap on ZEN21 or Z-Wave command from hub" value="5" />
<Item label="physical tap on connected 3-way switch or Z-Wave command from hub" value="6" />
<Item label="physical tap on ZEN21 / connected 3-way switch or Z-Wave command from hub" value="7" />
<Item label="timer only" value="8" />
<Item label="physical tap on ZEN21 or timer" value="9" />
<Item label="physical tap on connected 3-way switch or timer" value="10" />
<Item label="physical tap on ZEN21 / connected 3-way switch or timer" value="11" />
<Item label="Z-Wave command from hub or timer" value="12" />
<Item label="physical tap on ZEN21, Z-Wave command from hub, or timer" value="13" />
<Item label="physical tap on ZEN21 / connected 3-way switch, Z-Wave command from hub, or timer" value="14" />
<Item label="all of the above. (default)" value="15" />
</Value>
<Value type="list" genre="config" instance="1" index="8" label="On Off Status After Power Failure" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="1" size="1">
<Help>Status after power failure. Off: always turn light off. On: always turn light on. Restore: remember the latest state and restore that state.</Help>
<Item label="Off" value="0" />
<Item label="On" value="1" />
<Item label="Restore" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="9" label="Enable/Disable Scene Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Enable or Disable scene control functionality for quick double tap triggers (Available for select hubs only).</Help>
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="11" label="Smart Bulb Mode: Enable/Disable Paddle / Z-Wave Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Enable or disable local on/off control. If enabled, you’ll only be able to control the connected light via Z-Wave. Scenes and other functionality will still be available through paddles.</Help>
<Item label="physical paddle control disabled" value="0" />
<Item label="physical paddle control enabled (default)" value="1" />
<Item label="physical paddle and Z-Wave control disabled" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="12" label="3-Way Switch Type" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Choose the type of 3-way switch you want to use with this dimmer in a 3-way set-up. Changing this setting can allow you to control brightness and dim the light from both 3-way locations. Use a regular momentary switch (like the Zooz ZAC99 accessory switch) if value is set to 2.</Help>
<Item label="regular mechanical 3-way on/off switch(default)" value="0" />
<Item label="momentary switch, click once to change status (light on or off)" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="13" label="Reporting behavior with disabled physical control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Set reporting behavior for disabled physical control.</Help>
<Item label="switch reports on/off status and changes LED indicator state even if physical and Z-Wave control is disabled (default)" value="0" />
<Item label="switch doesn&apos;t report on/off status or change LED indicator state when physical (and Z-Wave) control is disabled" value="1" />
</Value>
</CommandClass>
```
Zen22v2 (Dimmer):
```xml
<CommandClass id="112" name="COMMAND_CLASS_CONFIGURATION" version="1">
<Instance index="1" />
<Value type="list" genre="config" instance="1" index="1" label="Paddle Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Normal mode: Upper paddle turns the light on, lower paddle turns the light off. Reverse mode: Upper paddle turns the light off, lower paddle turns the light on. Toggle mode: Either paddle toggles the light.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Toggle" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="2" label="LED Indication Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="3" vindex="1" size="1">
<Help>LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Always Off" value="2" />
<Item label="Always On" value="3" />
</Value>
<Value type="list" genre="config" instance="1" index="3" label="Enable Auto Turn-Off Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="4" label="Auto Turn-Off Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="60">
<Help>Time, in minutes, for auto-off timer delay.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="5" label="Enable Auto Turn-On Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="6" label="Auto Turn-On Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="60">
<Help>Set the time (in minutes) after which you want the switch to automatically turn on once it has been turned off.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="7" label="Association Reports" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="15" vindex="15" size="1">
<Help>Choose which physical and Z-Wave triggers should prompt the switch to send a status change report to associated devices.</Help>
<Item label="none" value="0" />
<Item label="physical tap on ZEN22 only" value="1" />
<Item label="physical tap on connected 3-way switch only" value="2" />
<Item label="physical tap on ZEN22 or connected 3-way switch" value="3" />
<Item label="Z-Wave command from hub" value="4" />
<Item label="physical tap on ZEN22 or Z-Wave command from hub" value="5" />
<Item label="physical tap on connected 3-way switch or Z-Wave command from hub" value="6" />
<Item label="physical tap on ZEN22 / connected 3-way switch or Z-Wave command from hub" value="7" />
<Item label="timer only" value="8" />
<Item label="physical tap on ZEN22 or timer" value="9" />
<Item label="physical tap on connected 3-way switch or timer" value="10" />
<Item label="physical tap on ZEN22 / connected 3-way switch or timer" value="11" />
<Item label="Z-Wave command from hub or timer" value="12" />
<Item label="physical tap on ZEN22, Z-Wave command from hub, or timer" value="13" />
<Item label="physical tap on ZEN22 / connected 3-way switch, Z-Wave command from hub, or timer" value="14" />
<Item label="all of the above. (default)" value="15" />
</Value>
<Value type="list" genre="config" instance="1" index="8" label="On Off Status After Power Failure" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="1" size="1">
<Help>Status after power failure. Off: always turn light off. On: always turn light on. Restore: remember the latest state and restore that state.</Help>
<Item label="Off" value="0" />
<Item label="On" value="1" />
<Item label="Restore" value="2" />
</Value>
<Value type="byte" genre="config" instance="1" index="9" label="Ramp Rate Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="99" value="0">
<Help>Adjust the physical ramp rate for your dimmer (fade-in / fade-out effect for on / off operation). Values correspond to the number of seconds it take for the dimmer to reach full brightness or turn off when operated manually. This setting is for physical taps only, see parameter 17 to adjust Z-Wave ramp rate. Values: 1 – 99 (seconds). 0 – instant on/off. Default: 1</Help>
</Value>
<Value type="byte" genre="config" instance="1" index="10" label="Minimum Brightness" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="1">
<Help>Set the minimum brightness level (in %) for your dimmer. You won’t be able to dim the light below the set value. Default: 1</Help>
</Value>
<Value type="byte" genre="config" instance="1" index="11" label="Maximum Brightness" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="99">
<Help>Set the maximum brightness level (in %) for your dimmer. You won’t be able to add brightness to the light beyond the set value. Note: if Parameter 12 is set to value 0, Parameter 11 is automatically disabled. Default: 99</Help>
</Value>
<Value type="list" genre="config" instance="1" index="12" label="Double Tap Function" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Double Tap action. When set to Full, turns light on to 100%. If set to Maximum Level, turns light on to % set in Parameter 11.</Help>
<Item label="Full" value="0" />
<Item label="Maximum Level" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="13" label="Enable/Disable Scene Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Enable or Disable scene control functionality for quick double tap triggers.</Help>
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="14" label="Enable/Disable Double-tap" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="2" size="1">
<Help>Enables/Disables the double-tap fucntion and assign brightness to single tap. Last level: single tap returns to last brightness level. Full/Max level: single tap returns to full/max level</Help>
<Item label="Enabled" value="0" />
<Item label="Disabled (last level)" value="1" />
<Item label="Disabled (full/max level)" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="15" label="Smart Bulb Mode: Enable/Disable Paddle / Z-Wave Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="1" size="1">
<Help>Enable or disable local on/off control. If enabled, you’ll only be able to control the connected light via Z-Wave. Scenes and other functionality will still be available through paddles.</Help>
<Item label="physical paddle control disabled" value="0" />
<Item label="physical paddle control enabled (default)" value="1" />
<Item label="physical paddle and Z-Wave control disabled" value="2" />
</Value>
<Value type="byte" genre="config" instance="1" index="16" label="Physical Dimming Speed" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="4">
<Help>Set the time it takes to get from 0% to 100% brightness when pressing and holding the paddle (physical dimming). The number entered as value corresponds to the number of seconds. Default: 4</Help>
</Value>
<Value type="list" genre="config" instance="1" index="17" label="Zwave Ramp Rate Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Choose if you want to set the Z-Wave ramp rate independently of the physical ramp rate (using an appropriate command in your hub) or if you want them to match.</Help>
<Item label="Z-Wave ramp rate matches the physical ramp rate set in parameter 9" value="0" />
<Item label="Z-Wave ramp rate is set independently using appropriate Z-Wave commands (default)" value="1" />
</Value>
<Value type="byte" genre="config" instance="1" index="18" label="Custom Brightness Level On" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="99" value="0">
<Help>Set the custom brightness level (instead of the last set brightness level) you want the dimmer to come on to when you single tap the upper paddle. Default: 0 - last brightness level</Help>
</Value>
<Value type="list" genre="config" instance="1" index="19" label="3-Way Switch Type" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="3" vindex="0" size="1">
<Help>Choose the type of 3-way switch you want to use with this dimmer in a 3-way set-up. Changing this setting can allow you to control brightness and dim the light from both 3-way locations. Use a regular momentary switch (like the Zooz ZAC99 accessory switch) if value is set to 2.</Help>
<Item label="regular mechanical 3-way on/off switch, use the connected 3-way switch to turn the light off or on to the last brightness level, dimming only available from the Zooz Z-Wave dimmer and from the hub (or through voice control if smart speaker is integrated with your Z-Wave hub) (default)" value="0" />
<Item label="regular mechanical 3-way on/off switch, tap the paddles once to change state (light on or off), tap the paddles twice quickly to turn light on to full brightness, tap the paddles quickly 3 times to enable a dimming sequence (the light will start dimming up and down in a loop) and tap the switch again to set the selected brightness level" value="1" />
<Item label="momentary switch, click once to change status (light on or off), click twice quickly to turn light on to full brightness, press and hold to adjust brightness (dim up / dim down in sequence)" value="2" />
<Item label="momentary switch, click once to change status (light on or off), click twice quickly to turn light on to full brightness, press and hold to adjust brightness (dim up / dim down in sequence but always reduce brightness after double click)" value="3" />
</Value>
<Value type="list" genre="config" instance="1" index="20" label="Zwave tap and hold Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Choose how you&apos;d like the dimmer to report when paddles are tapped and held and physical / Z-Wave control is enabled or disabled.</Help>
<Item label="report each brightness level to hub when physical / Z-Wave control is disabled for physical dimming (final level only reported if physical / Z-Wave control is enabled)" value="0" />
<Item label="report final brightness level only for physical dimming, regardless of the physical / Z-Wave control mode" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="21" label="Reporting behavior with disabled physical control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Set reporting behavior for disabled physical control.</Help>
<Item label="switch reports on/off status and changes LED indicator state even if physical and Z-Wave control is disabled (default)" value="0" />
<Item label="switch doesn&apos;t report on/off status or change LED indicator state when physical (and Z-Wave) control is disabled" value="1" />
</Value>
<Value type="byte" genre="config" instance="1" index="22" label="Night Light Mode" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="99" value="0">
<Help>Set the brightness level the dimmer will turn on to when off and when lower paddle is held DOWN for a second. Default: 20</Help>
</Value>
</CommandClass>
```
Zen26 (On/Off Switch):
```xml
<CommandClass id="112" name="COMMAND_CLASS_CONFIGURATION" version="1" request_flags="4" innif="true">
<Instance index="1" />
<Value type="list" genre="config" instance="1" index="1" label="Paddle Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Normal mode: Upper paddle turns the light on, lower paddle turns the light off. Reverse will reverse those functions. Any will toggle the light regardless of which button is pushed.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Any" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="2" label="LED Indication Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="3" vindex="0" size="1">
<Help>LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Always Off" value="2" />
<Item label="Always On" value="3" />
</Value>
<Value type="list" genre="config" instance="1" index="3" label="Enable Turn-Off Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Enable or disable the auto turn-off timer function.</Help>
<Item label="Disabled (Default)" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="4" label="Turn-Off Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="1">
<Help>Time, in seconds, for auto-off timer delay. 60 (default).</Help>
</Value>
<Value type="list" genre="config" instance="1" index="5" label="Enable Turn-On Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Enable or disable the auto turn-on timer function.</Help>
<Item label="Disabled (Default)" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="6" label="Turn-On Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="55">
<Help>Time, in minutes, for auto-on timer delay. 60 (default).</Help>
</Value>
<Value type="list" genre="config" instance="1" index="8" label="On Off Status After Power Failure" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="2" size="1">
<Help>Status after power on after power failure. OFF will always turn light off. ON will always turn light on. Restore will remember the latest state and restore that state.</Help>
<Item label="OFF" value="0" />
<Item label="ON" value="1" />
<Item label="Restore" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="10" label="Scene Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Enable or disable scene control functionality for quick double tap triggers.</Help>
<Item label="Disabled (Default)" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="11" label="Enable/Disable Paddle Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Enable or disable local on/off control. If enabled, you&apos;ll only be able to control the connected light via Z-Wave.</Help>
<Item label="Disabled" value="0" />
<Item label="Enabled (Default)" value="1" />
</Value>
<CommandClass id="112" name="COMMAND_CLASS_CONFIGURATION" version="1">
<Instance index="1" />
<Value type="list" genre="config" instance="1" index="1" label="Paddle Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Normal mode: Upper paddle turns the light on, lower paddle turns the light off. Reverse mode: Upper paddle turns the light off, lower paddle turns the light on. Toggle mode: Either paddle toggles the light.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Toggle" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="2" label="LED Indication Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="3" vindex="1" size="1">
<Help>LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Always Off" value="2" />
<Item label="Always On" value="3" />
</Value>
<Value type="list" genre="config" instance="1" index="3" label="Enable Auto Turn-Off Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="4" label="Auto Turn-Off Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="60">
<Help>Time, in minutes, for auto-off timer delay.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="5" label="Enable Auto Turn-On Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="6" label="Auto Turn-On Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="60">
<Help>Set the time (in minutes) after which you want the switch to automatically turn on once it has been turned off.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="7" label="Association Reports" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="15" vindex="15" size="1">
<Help>Choose which physical and Z-Wave triggers should prompt the switch to send a status change report to associated devices.</Help>
<Item label="none" value="0" />
<Item label="physical tap on ZEN26 only" value="1" />
<Item label="physical tap on connected 3-way switch only" value="2" />
<Item label="physical tap on ZEN26 or connected 3-way switch" value="3" />
<Item label="Z-Wave command from hub" value="4" />
<Item label="physical tap on ZEN26 or Z-Wave command from hub" value="5" />
<Item label="physical tap on connected 3-way switch or Z-Wave command from hub" value="6" />
<Item label="physical tap on ZEN26 / connected 3-way switch or Z-Wave command from hub" value="7" />
<Item label="timer only" value="8" />
<Item label="physical tap on ZEN26 or timer" value="9" />
<Item label="physical tap on connected 3-way switch or timer" value="10" />
<Item label="physical tap on ZEN26 / connected 3-way switch or timer" value="11" />
<Item label="Z-Wave command from hub or timer" value="12" />
<Item label="physical tap on ZEN26, Z-Wave command from hub, or timer" value="13" />
<Item label="physical tap on ZEN26 / connected 3-way switch, Z-Wave command from hub, or timer" value="14" />
<Item label="all of the above. (default)" value="15" />
</Value>
<Value type="list" genre="config" instance="1" index="8" label="On Off Status After Power Failure" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="1" size="1">
<Help>Status after power failure. Off: always turn light off. On: always turn light on. Restore: remember the latest state and restore that state.</Help>
<Item label="Off" value="0" />
<Item label="On" value="1" />
<Item label="Restore" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="10" label="Enable/Disable Scene Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Enable or Disable scene control functionality for quick double tap triggers (Available for select hubs only).</Help>
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="11" label="Smart Bulb Mode: Enable/Disable Paddle / Z-Wave Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Enable or disable local on/off control. If enabled, you’ll only be able to control the connected light via Z-Wave. Scenes and other functionality will still be available through paddles.</Help>
<Item label="physical paddle control disabled" value="0" />
<Item label="physical paddle control enabled (default)" value="1" />
<Item label="physical paddle and Z-Wave control disabled" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="13" label="Reporting behavior with disabled physical control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Set reporting behavior for disabled physical control.</Help>
<Item label="switch reports on/off status and changes LED indicator state even if physical and Z-Wave control is disabled (default)" value="0" />
<Item label="switch doesn&apos;t report on/off status or change LED indicator state when physical (and Z-Wave) control is disabled" value="1" />
</Value>
</CommandClass>
```
Zen27 (Dimmer):
```xml
<CommandClass id="112" name="COMMAND_CLASS_CONFIGURATION" version="1" request_flags="4" innif="true">
<Instance index="1" />
<Value type="list" genre="config" instance="1" index="1" label="Paddle Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Normal mode: Upper paddle turns the light on, lower paddle turns the light off. Reverse will reverse those functions. Any will toggle the light regardless of which button is pushed.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Any" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="2" label="LED Indication Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="3" vindex="0" size="1">
<Help>LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Always Off" value="2" />
<Item label="Always On" value="3" />
</Value>
<Value type="list" genre="config" instance="1" index="3" label="Enable Auto Turn-Off Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="4" label="Auto Turn-Off Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="60">
<Help>Time, in minutes, for auto-off timer delay.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="5" label="Enable Auto Turn-On Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="6" label="Auto Turn-On Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="60">
<Help>Time, in minutes, for auto-off timer delay.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="8" label="On Off Status After Power Failure" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="2" size="1">
<Help>Status after power on after power failure. OFF will always turn light off. ON will always turn light on. Restore will remember the latest state and restore that state.</Help>
<Item label="OFF" value="0" />
<Item label="ON" value="1" />
<Item label="Restore" value="2" />
</Value>
<Value type="byte" genre="config" instance="1" index="9" label="Ramp Rate Control" units="seconds" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="3">
<Help>Adjust the ramp rate for your dimmer (fade-in / fade-out effect for on / off operation). Values correspond to the number of seconds it take for the dimmer to reach full brightness or turn off when operated manually.</Help>
</Value>
<Value type="byte" genre="config" instance="1" index="10" label="Minimum Brightness" units="%" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="99">
<Help>Set the minimum brightness level for your dimmer. You won&apos;t be able to dim the light below the set value.</Help>
</Value>
<Value type="byte" genre="config" instance="1" index="11" label="Maximum Brightness" units="%" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="99">
<Help>Set the maximum brightness level for your dimmer. You won&apos;t be able to add brightness to the light beyond the set value. Note: if Parameter 12 is set to value &quot;Full&quot;, Parameter 11 is automatically disabled.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="12" label="Double Tap Function Brightness" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Double Tap action. When set to Full, turns light on to 100%. If set to Maximum Level, turns light on to % set in Parameter 11.</Help>
<Item label="Full" value="0" />
<Item label="Maximum Level" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="13" label="Scene Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Enable or disable scene control functionality for quick double tap triggers.</Help>
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="14" label="Enable Double Tap Function" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Enable the double tap or disable the double tap function and assign brightness level to single tap.</Help>
<Item label="Enabled" value="0" />
<Item label="Disabled - Single Tap To Last Brightness" value="1" />
<Item label="Disabled - Single Tap To Max Brightness" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="15" label="Enable/Disable Paddle Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Enable or disable local on/off control. If enabled, light will only be able to be controlled via Z-Wave.</Help>
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<CommandClass id="112" name="COMMAND_CLASS_CONFIGURATION" version="1">
<Instance index="1" />
<Value type="list" genre="config" instance="1" index="1" label="Paddle Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Normal mode: Upper paddle turns the light on, lower paddle turns the light off. Reverse mode: Upper paddle turns the light off, lower paddle turns the light on. Toggle mode: Either paddle toggles the light.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Toggle" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="2" label="LED Indication Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="3" vindex="1" size="1">
<Help>LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on.</Help>
<Item label="Normal" value="0" />
<Item label="Reverse" value="1" />
<Item label="Always Off" value="2" />
<Item label="Always On" value="3" />
</Value>
<Value type="list" genre="config" instance="1" index="3" label="Enable Auto Turn-Off Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="4" label="Auto Turn-Off Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="60">
<Help>Time, in minutes, for auto-off timer delay.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="5" label="Enable Auto Turn-On Timer" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="int" genre="config" instance="1" index="6" label="Auto Turn-On Timer Duration" units="minutes" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="65535" value="60">
<Help>Set the time (in minutes) after which you want the switch to automatically turn on once it has been turned off.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="7" label="Association Reports" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="15" vindex="15" size="1">
<Help>Choose which physical and Z-Wave triggers should prompt the switch to send a status change report to associated devices.</Help>
<Item label="none" value="0" />
<Item label="physical tap on ZEN27 only" value="1" />
<Item label="physical tap on connected 3-way switch only" value="2" />
<Item label="physical tap on ZEN27 or connected 3-way switch" value="3" />
<Item label="Z-Wave command from hub" value="4" />
<Item label="physical tap on ZEN27 or Z-Wave command from hub" value="5" />
<Item label="physical tap on connected 3-way switch or Z-Wave command from hub" value="6" />
<Item label="physical tap on ZEN27 / connected 3-way switch or Z-Wave command from hub" value="7" />
<Item label="timer only" value="8" />
<Item label="physical tap on ZEN27 or timer" value="9" />
<Item label="physical tap on connected 3-way switch or timer" value="10" />
<Item label="physical tap on ZEN27 / connected 3-way switch or timer" value="11" />
<Item label="Z-Wave command from hub or timer" value="12" />
<Item label="physical tap on ZEN27, Z-Wave command from hub, or timer" value="13" />
<Item label="physical tap on ZEN27 / connected 3-way switch, Z-Wave command from hub, or timer" value="14" />
<Item label="all of the above. (default)" value="15" />
</Value>
<Value type="list" genre="config" instance="1" index="8" label="On Off Status After Power Failure" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="2" size="1">
<Help>Status after power failure. Off: always turn light off. On: always turn light on. Restore: remember the latest state and restore that state.</Help>
<Item label="Off" value="0" />
<Item label="On" value="1" />
<Item label="Restore" value="2" />
</Value>
<Value type="byte" genre="config" instance="1" index="9" label="Ramp Rate Control" units="seconds" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="1">
<Help>Adjust the physical ramp rate for your dimmer (fade-in / fade-out effect for on / off operation). Values correspond to the number of seconds it take for the dimmer to reach full brightness or turn off when operated manually. This setting is for physical taps only, see parameter 17 to adjust Z-Wave ramp rate.</Help>
</Value>
<Value type="byte" genre="config" instance="1" index="10" label="Minimum Brightness" units="%" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="1">
<Help>Set the minimum brightness level (in %) for your dimmer. You won&apos;t be able to dim the light below the set value.</Help>
</Value>
<Value type="byte" genre="config" instance="1" index="11" label="Maximum Brightness" units="%" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="99">
<Help>Set the maximum brightness level (in %) for your dimmer. You won&apos;t be able to add brightness to the light beyond the set value. Note: if Parameter 12 is set to value &quot;Full&quot;, Parameter 11 is automatically disabled.</Help>
</Value>
<Value type="list" genre="config" instance="1" index="12" label="Double Tap Function" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Double Tap action. When set to Full, turns light on to 100%. If set to Maximum Level, turns light on to % set in Parameter 11.</Help>
<Item label="Full" value="0" />
<Item label="Maximum Level" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="13" label="Enable/Disable Scene Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Enable or Disable scene control functionality for quick double tap triggers.</Help>
<Item label="Disabled" value="0" />
<Item label="Enabled" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="14" label="Enable/Disable Double-tap" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="0" size="1">
<Help>Enables/Disables the double-tap function and assign brightness to single tap. Last level: single tap returns to last brightness level. Full/Max level: single tap returns to full/max level</Help>
<Item label="Enabled" value="0" />
<Item label="Disabled (last level)" value="1" />
<Item label="Disabled (full/max level)" value="2" />
</Value>
<Value type="list" genre="config" instance="1" index="15" label="Smart Bulb Mode: Enable/Disable Paddle / Z-Wave Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="2" vindex="1" size="1">
<Help>Enable or disable local on/off control. If enabled, you’ll only be able to control the connected light via Z-Wave. Scenes and other functionality will still be available through paddles.</Help>
<Item label="physical paddle control disabled" value="0" />
<Item label="physical paddle control enabled (default)" value="1" />
<Item label="physical paddle and Z-Wave control disabled" value="2" />
</Value>
<Value type="byte" genre="config" instance="1" index="16" label="Physical Dimming Speed" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="1" max="99" value="4">
<Help>Set the time it takes to get from 0% to 100% brightness when pressing and holding the paddle (physical dimming). The number entered as value corresponds to the number of seconds. Default: 4</Help>
</Value>
<Value type="list" genre="config" instance="1" index="17" label="Zwave Ramp Rate Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="1" size="1">
<Help>Choose if you want to set the Z-Wave ramp rate independently of the physical ramp rate (using an appropriate command in your hub) or if you want them to match.</Help>
<Item label="Z-Wave ramp rate matches the physical ramp rate set in parameter 9" value="0" />
<Item label="Z-Wave ramp rate is set independently using appropriate Z-Wave commands (default)" value="1" />
</Value>
<Value type="byte" genre="config" instance="1" index="18" label="Custom Brightness Level On" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="99" value="0">
<Help>Set the custom brightness level (instead of the last set brightness level) you want the dimmer to come on to when you single tap the upper paddle. Default: 0 - last brightness level</Help>
</Value>
<Value type="list" genre="config" instance="1" index="20" label="Zwave tap and hold Control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Choose how you&apos;d like the dimmer to report when paddles are tapped and held and physical / Z-Wave control is enabled or disabled.</Help>
<Item label="report each brightness level to hub when physical / Z-Wave control is disabled for physical dimming (final level only reported if physical / Z-Wave control is enabled)" value="0" />
<Item label="report final brightness level only for physical dimming, regardless of the physical / Z-Wave control mode" value="1" />
</Value>
<Value type="list" genre="config" instance="1" index="21" label="Reporting behavior with disabled physical control" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="1" vindex="0" size="1">
<Help>Set reporting behavior for disabled physical control.</Help>
<Item label="switch reports on/off status and changes LED indicator state even if physical and Z-Wave control is disabled (default)" value="0" />
<Item label="switch doesn&apos;t report on/off status or change LED indicator state when physical (and Z-Wave) control is disabled" value="1" />
</Value>
<Value type="byte" genre="config" instance="1" index="22" label="Night Light Mode" units="" read_only="false" write_only="false" verify_changes="false" poll_intensity="0" min="0" max="99" value="0">
<Help>Set the brightness level the dimmer will turn on to when off and when lower paddle is held DOWN for a second. Default: 20</Help>
</Value>
</CommandClass>
```

7
source/_docs/z-wave/installation.markdown
View File

@ -101,6 +101,13 @@ zwave:
network_key: "0x2e, 0xcc, 0xab, 0x1c, 0xa3, 0x7f, 0x0e, 0xb5, 0x70, 0x71, 0x2d, 0x98, 0x25, 0x43, 0xee, 0x0c"
```
In addition to modifying the `configuration.yaml` file, the `options.xml` file network key must be set as well:
```xml
<!-- Example options.xml entry for network_key -->
<Option name="NetworkKey" value="0x2e, 0xcc, 0xab, 0x1c, 0xa3, 0x7f, 0x0e, 0xb5, 0x70, 0x71, 0x2d, 0x98, 0x25, 0x43, 0xee, 0x0c" />
```
Ensure you keep a backup of this key. If you have to rebuild your system and don't have a backup of this key, you won't be able to reconnect to any security devices. This may mean you have to do a factory reset on those devices, and your controller, before rebuilding your Z-Wave network.
## First Run

1
source/_integrations/anthemav.markdown
View File

@ -1,7 +1,6 @@
---
title: Anthem A/V Receivers
description: Instructions on how to integrate Anthem A/V Receivers into Home Assistant.
logo: anthemav.png
ha_category:
- Media Player
ha_iot_class: Local Push

4
source/_integrations/apache_kafka.markdown
View File

@ -20,13 +20,13 @@ To use the `apache_kafka` integration in your installation, add the following to
```yaml
apache_kafka:
host: localhost
ip_address: localhost
port: 9092
topic: home_assistant_1
```
{% configuration %}
host:
ip_address:
description: The IP address or hostname of an Apache Kafka cluster.
required: true
type: string

1
source/_integrations/aurora_abb_powerone.markdown
View File

@ -1,7 +1,6 @@
---
title: Aurora ABB Solar PV
description: Instructions on how to integrate an Aurora ABB Powerone solar inverter within Home Assistant.
logo: powerone.png
ha_category:
- Sensor
- Energy

1
source/_integrations/automatic.markdown
View File

@ -1,7 +1,6 @@
---
title: Automatic
description: Instructions for how to integrate Automatic ODB readers into Home Assistant.
logo: automatic.png
ha_category:
- Car
ha_release: 0.28

1
source/_integrations/avion.markdown
View File

@ -4,7 +4,6 @@ description: Instructions on how to setup GE Avi-on Bluetooth dimmers within Hom
ha_category:
- Light
ha_iot_class: Assumed State
logo: avi-on.png
ha_release: 0.37
ha_domain: avion
---

1
source/_integrations/bbox.markdown
View File

@ -1,7 +1,6 @@
---
title: Bbox
description: Instructions on how to integrate Bouygues Bbox routers into Home Assistant.
logo: bbox.png
ha_category:
- Network
- Sensor

1
source/_integrations/bizkaibus.markdown
View File

@ -1,7 +1,6 @@
---
title: Bizkaibus
description: Instructions on how to integrate timetable data for traveling on Bizkaibus within Home Assistant.
logo: bizkaibus.png
ha_category:
- Transport
- Sensor

1
source/_integrations/blinksticklight.markdown
View File

@ -1,7 +1,6 @@
---
title: BlinkStick
description: Instructions on how to setup Blinkstick lights within Home Assistant.
logo: blinkstick.png
ha_category:
- DIY
ha_release: 0.7.5

1
source/_integrations/broadlink.markdown
View File

@ -1,7 +1,6 @@
---
title: Broadlink
description: Instructions on how to integrate Broadlink within Home Assistant.
logo: broadlink.png
ha_category:
- Remote
- Switch

1
source/_integrations/brottsplatskartan.markdown
View File

@ -3,7 +3,6 @@ title: Brottsplatskartan
description: Instructions on how to integrate brottsplatskartan.se into Home Assistant.
ha_category:
- Social
logo: brottsplatskartan.png
ha_release: 0.85
ha_iot_class: Cloud Polling
ha_domain: brottsplatskartan

1
source/_integrations/bt_home_hub_5.markdown
View File

@ -1,7 +1,6 @@
---
title: BT Home Hub 5
description: Instructions on how to integrate BT Home Hub 5 router into Home Assistant.
logo: bt.png
ha_category:
- Presence Detection
ha_release: 0.22

1
source/_integrations/bt_smarthub.markdown
View File

@ -1,7 +1,6 @@
---
title: BT Smart Hub
description: Instructions on how to integrate BT Smart Hub router into Home Assistant.
logo: bt.png
ha_category:
- Presence Detection
ha_release: 0.82

1
source/_integrations/canary.markdown
View File

@ -1,7 +1,6 @@
---
title: Canary
description: Instructions on how to integrate your Canary devices into Home Assistant.
logo: canary.png
ha_category:
- Alarm
- Camera

1
source/_integrations/channels.markdown
View File

@ -1,7 +1,6 @@
---
title: Channels
description: Instructions on how to integrate Channels into Home Assistant.
logo: channels.png
ha_category:
- Media Player
ha_release: 0.65

1
source/_integrations/clickatell.markdown
View File

@ -1,7 +1,6 @@
---
title: Clickatell
description: Instructions on how to add Clickatell notifications to Home Assistant.
logo: clickatell.png
ha_category:
- Notifications
ha_release: 0.56

1
source/_integrations/co2signal.markdown
View File

@ -1,7 +1,6 @@
---
title: CO2 Signal
description: Instructions on how to use CO2Signal data within Home Assistant
logo: co2signal.png
ha_category:
- Environment
ha_release: 0.87

1
source/_integrations/comed_hourly_pricing.markdown
View File

@ -1,7 +1,6 @@
---
title: ComEd Hourly Pricing
description: Instructions on how to set up the ComEd Hourly Pricing sensor in Home Assistant.
logo: comed.png
ha_category:
- Energy
ha_release: '0.40'

1
source/_integrations/ddwrt.markdown
View File

@ -1,7 +1,6 @@
---
title: DD-WRT
description: Instructions on how to integrate DD-WRT based routers into Home Assistant.
logo: ddwrt.png
ha_category:
- Presence Detection
ha_release: pre 0.7

1
source/_integrations/decora.markdown
View File

@ -4,7 +4,6 @@ description: Instructions on how to setup Leviton Decora Bluetooth dimmers withi
ha_category:
- Light
ha_iot_class: Local Polling
logo: leviton.png
ha_release: 0.37
ha_domain: decora
---

1
source/_integrations/decora_wifi.markdown
View File

@ -4,7 +4,6 @@ description: Instructions on how to setup Leviton Decora Smart Wi-Fi switches/di
ha_category:
- Light
ha_iot_class: Cloud Polling
logo: leviton.png
ha_release: 0.51
ha_domain: decora_wifi
---

1
source/_integrations/denonavr.markdown
View File

@ -1,7 +1,6 @@
---
title: Denon AVR Network Receivers
description: Instructions on how to integrate Denon AVR Network Receivers into Home Assistant.
logo: denon.png
ha_category:
- Media Player
ha_iot_class: Local Polling

1
source/_integrations/dlna_dmr.markdown
View File

@ -1,7 +1,6 @@
---
title: DLNA Digital Media Renderer
description: Instructions on how to integrate a DLNA DMR device into Home Assistant.
logo: dlna.png
ha_category:
- Media Player
ha_release: 0.76

1
source/_integrations/dominos.markdown
View File

@ -1,7 +1,6 @@
---
title: Dominos Pizza
description: Instructions on how to setup Dominos Pizza ordering within Home Assistant.
logo: dominos.png
ha_category:
- Other
ha_iot_class: Cloud Polling

1
source/_integrations/dovado.markdown
View File

@ -5,7 +5,6 @@ ha_category:
- System Monitor
- Notifications
- Sensor
logo: dovado.png
ha_release: 0.87
ha_iot_class: Local Polling
ha_domain: dovado

1
source/_integrations/dte_energy_bridge.markdown
View File

@ -1,7 +1,6 @@
---
title: DTE Energy Bridge
description: Instructions on how to setup DTE Energy Bridge with Home Assistant.
logo: dte_energy.png
ha_category:
- Energy
ha_release: 0.21

1
source/_integrations/dweet.markdown
View File

@ -1,7 +1,6 @@
---
title: dweet.io
description: Transfer events to Dweet.io.
logo: dweet.png
ha_category:
- History
- Sensor

1
source/_integrations/dyson.markdown
View File

@ -1,7 +1,6 @@
---
title: Dyson
description: Instructions on how to integrate Dyson into Home Assistant.
logo: dyson.png
ha_category:
- Hub
- Climate

1
source/_integrations/ebox.markdown
View File

@ -1,7 +1,6 @@
---
title: EBox
description: Instructions on how to integrate EBox data usage within Home Assistant.
logo: ebox.png
ha_category:
- Network
ha_release: 0.39

1
source/_integrations/eddystone_temperature.markdown
View File

@ -1,7 +1,6 @@
---
title: Eddystone
description: Instructions on how to integrate Eddystone beacons with Home Assistant in order to receive temperature data.
logo: eddystone.png
ha_category:
- DIY
ha_release: 0.42

1
source/_integrations/edimax.markdown
View File

@ -1,7 +1,6 @@
---
title: Edimax
description: Instructions on how to integrate Edimax switches into Home Assistant.
logo: edimax.png
ha_category:
- Switch
ha_release: pre 0.7

1
source/_integrations/egardia.markdown
View File

@ -1,7 +1,6 @@
---
title: Egardia
description: Instructions on how to setup Egardia / Woonveilig within Home Assistant.
logo: egardia.png
ha_category:
- Hub
- Alarm

1
source/_integrations/emby.markdown
View File

@ -1,7 +1,6 @@
---
title: Emby
description: Instructions on how to integrate Emby into Home Assistant.
logo: emby.png
ha_category:
- Media Player
ha_release: 0.32

1
source/_integrations/ephember.markdown
View File

@ -1,7 +1,6 @@
---
title: EPH Controls
description: Instructions on how to integrate EPH Controls EMBER thermostats within Home Assistant.
logo: ephcontrolsember.png
ha_category:
- Climate
ha_release: 0.57

1
source/_integrations/essent.markdown
View File

@ -1,7 +1,6 @@
---
title: Essent
description: Instructions on how to integrate Essent within Home Assistant.
logo: essent.png
ha_category:
- Energy
- Sensor

1
source/_integrations/eufy.markdown
View File

@ -1,7 +1,6 @@
---
title: eufy
description: Instructions on how to integrate Eufy devices into Home Assistant.
logo: eufy.png
ha_category:
- Hub
- Light

6
source/_integrations/fan.xiaomi_miio.markdown
View File

@ -534,3 +534,9 @@ Turn the dry mode off.
| Service data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------|
| `entity_id` | no | Only act on a specific Xiaomi miIO fan entity. |
## Troubleshooting `Unable to find device` error messages
Check if the device is in the same subnet as the Home Assistant instance. Otherwise, you should configure your router/firewall to put this device in the same VLAN as the Home Assistant instance.
If it's not possible to use VLANs for some reason, your last resort may be using NAT translation, between the IPs.

4
source/_integrations/fronius.markdown
View File

@ -27,7 +27,7 @@ sensor:
{% configuration %}
resource:
description: "The IP address of the Fronius device"
description: "The URL of the Fronius device (e.g., `http://192.0.2.0` or `http://fronius.local`)"
required: true
type: string
monitored_conditions:
@ -96,7 +96,7 @@ a list of sensors that are to be integrated can be given like below.
```yaml
sensor:
- platform: fronius
resource: FRONIUS_IP_ADDRESS
resource: FRONIUS_URL
monitored_conditions:
- sensor_type: inverter
device: 1

1
source/_integrations/garadget.markdown
View File

@ -1,7 +1,6 @@
---
title: Garadget
description: Instructions on how to integrate Garadget covers within Home Assistant.
logo: garadget.png
ha_category:
- Cover
ha_release: 0.32

1
source/_integrations/geniushub.markdown
View File

@ -1,7 +1,6 @@
---
title: Genius Hub
description: Instructions on how to integrate a Genius Hub with Home Assistant.
logo: geniushub.png
ha_category:
- Climate
- Water Heater

4
source/_integrations/google_assistant.markdown
View File

@ -177,6 +177,7 @@ entity_config:
Currently, the following domains are available to be used with Google Assistant, listed with their default types:
- alarm_control_panel (arm/disarm)
- camera (streaming, requires compatible camera)
- group (on/off)
- input_boolean (on/off)
@ -191,11 +192,10 @@ Currently, the following domains are available to be used with Google Assistant,
- climate (temperature setting, hvac_mode)
- vacuum (dock/start/stop/pause)
- sensor (temperature setting for temperature sensors and humidity setting for humidity sensors)
- Alarm Control Panel (arm/disarm)
### Secure Devices
Certain devices are considered secure, including anything in the `lock` domain, `alarm_control_panel` domain and `covers` with device types `garage` and `door`.
Certain devices are considered secure, including anything in the `lock` domain, `alarm_control_panel` domain and `covers` with device types `door`, `garage` or `gate`.
By default these cannot be opened by Google Assistant unless a `secure_devices_pin` is set up. To allow opening, set the `secure_devices_pin` to something and you will be prompted to speak the pin when opening the device. Closing or locking these devices does not require a pin.

1
source/_integrations/harman_kardon_avr.markdown
View File

@ -1,7 +1,6 @@
---
title: Harman Kardon AVR
description: Instructions on how to integrate Harman Kardon AVR Network Receivers into Home Assistant.
logo: harman_kardon.png
ha_category:
- Media Player
ha_iot_class: Local Polling

1
source/_integrations/hdmi_cec.markdown
View File

@ -3,7 +3,6 @@ title: HDMI-CEC
description: Instructions on how to interact with HDMI-CEC via Home Assistant.
ha_category:
- Automation
logo: hdmi.png
ha_release: 0.23
ha_iot_class: Local Push
ha_domain: hdmi_cec

1
source/_integrations/heatmiser.markdown
View File

@ -1,7 +1,6 @@
---
title: Heatmiser
description: Instructions on how to integrate Heatmiser thermostats within Home Assistant.
logo: heatmiser.png
ha_category:
- Climate
ha_release: '0.10'

1
source/_integrations/hitron_coda.markdown
View File

@ -1,7 +1,6 @@
---
title: Rogers Hitron CODA
description: Instructions on how to integrate Hitron CODA Routers into Home Assistant.
logo: hitron.png
ha_category:
- Presence Detection
ha_release: 0.58

10
source/_integrations/homekit.markdown
View File

@ -17,8 +17,12 @@ The `homekit` integration allows you to forward entities from Home Assistant to
<div class="note warning">
It might be necessary to install an additional package:
`sudo apt-get install libavahi-compat-libdnssd-dev`
If you are using the official Home Assistant images or running Home Assistant Core on Docker, HomeKit is ready to go out of the box. If you are running Home Assistant in a manual virtual environment or on a NAS without Docker, you may need to install or upgrade dependencies for HomeKit to function.
HomeKit requires openssl 1.1.0 or later as the HomeKit Accessory Protocol (HAP) uses the `ChaCha20` stream cipher and the `Poly1305` authenticator.
It might be necessary to install an additional package:
`sudo apt-get install libavahi-compat-libdnssd-dev`
</div>
@ -359,7 +363,7 @@ The following integrations are currently supported:
| automation / input_boolean / remote / scene / script | Switch | All represented as switches. |
| binary_sensor | Sensor | Support for `co2`, `door`, `garage_door`, `gas`, `moisture`, `motion`, `occupancy`, `opening`, `smoke` and `window` device classes. Defaults to the `occupancy` device class for everything else. |
| climate | Thermostat | All climate devices. |
| cover | GarageDoorOpener | All covers that support `open` and `close` and have `garage` as their `device_class`. |
| cover | GarageDoorOpener | All covers that support `open` and `close` and have `garage` or `gate` as their `device_class`. |
| cover | WindowCovering | All covers that support `set_cover_position`. |
| cover | WindowCovering | All covers that support `open_cover` and `close_cover` through value mapping. (`open` -> `>=50`; `close` -> `<50`) |
| cover | WindowCovering | All covers that support `open_cover`, `stop_cover` and `close_cover` through value mapping. (`open` -> `>70`; `close` -> `<30`; `stop` -> every value in between) |

8
source/_integrations/homekit_controller.markdown
View File

@ -57,6 +57,14 @@ Home Assistant does not currently support HomeKit BLE.
</div>
<div class="note warning">
If you are using the official Home Assistant images or running Home Assistant Core on Docker, HomeKit controller is ready to go out of the box. If you are running Home Assistant in a manual virtual environment or on a NAS without Docker, you may need to install or upgrade dependencies for HomeKit controller to function.
HomeKit controller requires openssl 1.1.0 or later as the HomeKit Accessory Protocol (HAP) uses the `ChaCha20` stream cipher and the `Poly1305` authenticator.
</div>
## Troubleshooting
### I don't have a HomeKit PIN

1
source/_integrations/homeworks.markdown
View File

@ -1,7 +1,6 @@
---
title: Lutron Homeworks
description: How to use Lutron Homeworks Series 4 & 8 with Home Assistant.
logo: lutron.png
ha_category:
- Hub
- Light

2
source/_integrations/http.markdown
View File

@ -164,7 +164,7 @@ If you want to use Home Assistant to host or serve static files then create a di
<div class='note warning'>
Files served from the `www`/`local` folder, aren't protected by the Home Assistant authentication. Files stored in this folder, if the URL is known, can be accessed by anybody without authentication.
Files served from the `www` folder (`/local/` url), aren't protected by the Home Assistant authentication. Files stored in this folder, if the URL is known, can be accessed by anybody without authentication.
</div>

1
source/_integrations/iammeter.markdown
View File

@ -1,7 +1,6 @@
---
title: IamMeter
description: Instructions on how to integrate IAMMETER sensor within Home Assistant.
logo: iammeter-logo.png
ha_category:
- Energy
- Sensor

1
source/_integrations/insteon.markdown
View File

@ -1,7 +1,6 @@
---
title: Insteon
description: Instructions on how to set up an Insteon Modem (PLM or Hub) locally within Home Assistant.
logo: insteon.png
ha_category:
- Hub
- Binary Sensor

1
source/_integrations/iota.markdown
View File

@ -1,7 +1,6 @@
---
title: IOTA
description: Instructions on how to integrate IOTA wallets with Home Assistant.
logo: iota.png
ha_category:
- Finance
- Sensor

1
source/_integrations/irish_rail_transport.markdown
View File

@ -1,7 +1,6 @@
---
title: Irish Rail Transport
description: Instructions on how to integrate timetable data for traveling on Irish Rail within Home Assistant.
logo: irishrail.png
ha_category:
- Transport
ha_iot_class: Cloud Polling

1
source/_integrations/kodi.markdown
View File

@ -1,7 +1,6 @@
---
title: Kodi
description: Instructions on how to integrate Kodi into Home Assistant.
logo: kodi.png
ha_category:
- Notifications
- Media Player

1
source/_integrations/lockitron.markdown
View File

@ -1,7 +1,6 @@
---
title: Lockitron
description: Instructions on how to integrate Lockitron locks into Home Assistant.
logo: lockitron.png
ha_category:
- Lock
ha_iot_class: Cloud Polling

1
source/_integrations/lutron_caseta.markdown
View File

@ -1,7 +1,6 @@
---
title: Lutron Caseta
description: Instructions on how to use Lutron Caseta devices with Home Assistant.
logo: lutron.png
ha_category:
- Hub
- Cover

1
source/_integrations/magicseaweed.markdown
View File

@ -1,7 +1,6 @@
---
title: Magicseaweed
description: How to integrate Magicseaweed within Home Assistant.
logo: magicseaweed.png
ha_category:
- Sensor
ha_release: 0.75

1
source/_integrations/marytts.markdown
View File

@ -1,7 +1,6 @@
---
title: MaryTTS
description: Instructions on how to setup MaryTTS with Home Assistant.
logo: marytts.png
ha_category:
- Text-to-speech
ha_release: 0.43

1
source/_integrations/melissa.markdown
View File

@ -1,7 +1,6 @@
---
title: Melissa
description: Instructions on how to integrate Melissa Climate into Home Assistant.
logo: mclimate.png
ha_category:
- Hub
- Climate

3
source/_integrations/mvglive.markdown
View File

@ -1,7 +1,6 @@
---
title: MVG
description: Instructions on how to integrate Munich public transport departure times into Home Assistant.
logo: mvg.png
ha_category:
- Transport
ha_release: 0.42
@ -33,7 +32,7 @@ destinations:
required: false
type: list
directions:
description: "Filter by direction of the departure. For Tram, Bus, SEV, and S-Bahn, direction = direction. For U-Bahn trains, directions are more general. For U1, U2, U3 and U6, direction='1' indicates south-bound trains, direction='2' indicates northbound trains. For U4 and U5, direction='1' indicates east-bound trains, direction='2' indicates west-bound trains. For example, setting directions: '1' can be used to get all south-bound trains at Scheidplatz."
description: "Filter by direction of the departure. For Tram, Bus, SEV, and S-Bahn, direction = destination. For U-Bahn trains, directions are more general. For U1, U2, U3 and U6, direction='1' indicates south-bound trains, direction='2' indicates northbound trains. For U4 and U5, direction='1' indicates east-bound trains, direction='2' indicates west-bound trains. For example, setting directions: '1' can be used to get all south-bound trains at Scheidplatz."
required: false
type: list
lines:

1
source/_integrations/mychevy.markdown
View File

@ -1,7 +1,6 @@
---
title: myChevrolet
description: Instructions on how to integrate Chevy Bolt car into Home Assistant.
logo: chevy.png
ha_category:
- Car
ha_release: 0.62

1
source/_integrations/nello.markdown
View File

@ -1,7 +1,6 @@
---
title: Nello
description: Instructions on how to integrate Nello intercom devices.
logo: nello.png
ha_category:
- Lock
ha_release: 0.52

8
source/_integrations/nest.markdown
View File

@ -26,9 +26,11 @@ There is currently support for the following device types within Home Assistant:
### Setting up developer account
<p class='note warning'>
New users are not currently able to set up a Works With Nest Developer account due to the change announced by Google. We will reach out to Nest to see if we can become a partner so that users joining Home Assistant after August can still use Nest. In the future we will add documentation on how to setup a Works With Google account and configure your Nest integration.
</p>
<div class='note warning'>
New users are not currently able to set up a Works With Nest Developer account due to the change announced by Google. We will reach out to Nest to see if we can become a partner so that users joining Home Assistant after [August 2019](/blog/2019/05/08/nest-data-bye-bye/) can still use Nest. In the future we will add documentation on how to setup a Works With Google account and configure your Nest integration.
</div>
1. Visit [Nest Developers](https://developers.nest.com/), and sign in. Create an account if you don't have one already.
2. Fill in account details:

1
source/_integrations/netio.markdown
View File

@ -1,7 +1,6 @@
---
title: Netio
description: Instructions on how to integrate Netio switches into Home Assistant.
logo: netio.png
ha_category:
- Switch
ha_iot_class: Local Polling

8
source/_integrations/nextcloud.markdown
View File

@ -16,11 +16,13 @@ The `nextcloud` integration pulls summary [Nextcloud](https://nextcloud.com/) in
## Configuration
This integration requires access to the monitor API of a Nextcloud instance (This is generally an admin user).
This integration has the following Nextcloud Server prerequisites:
You should also generate an App password from the Nextcloud web UI: **Settings** > **Security** > **Devices & sessions** > **Create new app password**.
- The user must be in the Nextcloud `admin` group (__*Nextcloud*__ > __*Users*__)
- The Nextcloud 'Monitoring' app must be installed (__*Nextcloud*__ > __*Apps*__ > 🔍(Search Icon) > __*Monitoring*__ > __*Enable*__)
- (Recommended) A Nextcloud App password should be generated for use in Home Assistant (__*Nextcloud*__ > __*Settings*__ > __*Personal*__ > __*Security*__ > __*Devices & sessions*__ > __*Create new app password*__)
Once you have generated the App password, add the following to your `configuration.yaml` file:
To enable the Nextcloud integration, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry

1
source/_integrations/no_ip.markdown
View File

@ -1,7 +1,6 @@
---
title: No-IP.com
description: Keep your computer registered with the NO-IP.com dynamic DNS.
logo: noip.png
ha_category:
- Network
ha_release: 0.57

1
source/_integrations/nuki.markdown
View File

@ -1,7 +1,6 @@
---
title: Nuki
description: Instructions on how to integrate a Nuki Smart Lock devices.
logo: nuki.png
ha_category:
- Lock
ha_release: 0.38

1
source/_integrations/openevse.markdown
View File

@ -1,7 +1,6 @@
---
title: OpenEVSE
description: Instructions on how to integrate a WiFi-equipped OpenEVSE Charging station with Home Assistant
logo: openevse.png
ha_category:
- Car
ha_release: 0.38

1
source/_integrations/opengarage.markdown
View File

@ -1,7 +1,6 @@
---
title: OpenGarage
description: Instructions on how to integrate OpenGarage.io covers within Home Assistant.
logo: opengarage.png
ha_category:
- DIY
ha_release: 0.44

3
source/_integrations/openuv.markdown
View File

@ -112,7 +112,7 @@ automation:
```
Update the UV index data every 20 minutes while the sun is at least 10 degrees above the horizon:
{% raw %}
```yaml
automation:
- alias: Update OpenUV every 20 minutes while the sun is at least 10 degrees above the horizon
@ -127,6 +127,7 @@ automation:
action:
service: openuv.update_uv_index_data
```
{% endraw %}
Update the protection window once a day:
```yaml

26
source/_integrations/openweathermap.markdown
View File

@ -18,7 +18,7 @@ There is currently support for the following device types within Home Assistant:
- [Sensor](#sensor)
- [Weather](#weather)
You need an API key which is free but requires a [registration](https://home.openweathermap.org/users/sign_up).
You need an API key, which is free, but requires a [registration](https://home.openweathermap.org/users/sign_up).
## Weather
@ -42,7 +42,7 @@ name:
type: string
default: OpenWeatherMap
mode:
description: "Can specify `hourly`, `daily` of `freedaily`. Select `hourly` for a three-hour forecast, `daily` for daily forecast or `freedaily` for a five days forecast with the free tier."
description: "Can specify `hourly`, `daily`, or `freedaily`. Select `hourly` for a three-hour forecast, `daily` for daily forecast, or `freedaily` for a five-day forecast with the free tier."
required: false
type: string
default: "`hourly`"
@ -68,7 +68,7 @@ This platform is an alternative to the [`openweathermap`](/integrations/openweat
The `openweathermap` platform uses [OpenWeatherMap](https://openweathermap.org/) as a source for current meteorological data for your location. The `forecast` will show you the condition in 3h.
To add OpenWeatherMap sensor to your installation, add the following to your `configuration.yaml` file:
To include OpenWeatherMap sensor to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -95,7 +95,7 @@ forecast:
default: false
type: boolean
language:
description: The language in which you want text results to be returned. It's a two-characters string, e.g., `en`, `es`, `ru`, `it`, etc.
description: The language in which you want text results to be returned. It's a two-characters string (e.g., `en`, `es`, `ru`, `it`, etc.).
required: false
default: en
type: string
@ -107,23 +107,23 @@ monitored_conditions:
weather:
description: A human-readable text summary.
temperature:
description: The current temperature.
description: Current temperature.
wind_speed:
description: The wind speed.
description: Wind speed.
wind_bearing:
description: The wind bearing.
description: Wind bearing.
humidity:
description: The relative humidity.
description: Relative humidity.
pressure:
description: The sea-level air pressure in millibars.
description: Sea-level air pressure in millibars.
clouds:
description: Description about cloud coverage.
description: Description of cloud coverage.
rain:
description: The rain volume.
description: Rain volume.
snow:
description: The snow volume.
description: Snow volume.
weather_code:
description: The current weather condition code.
description: Current weather condition code.
{% endconfiguration %}
Details about the API are available in the [OpenWeatherMap documentation](https://openweathermap.org/api).

2
source/_integrations/orangepi_gpio.markdown
View File

@ -17,7 +17,7 @@ This integration provides the following platforms:
- Binary sensor: The `orangepi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your Orange Pi or NanoPi.
### Configuration
## Configuration
To use your Orange Pi's GPIO in your installation, add the following to your `configuration.yaml` file:

1
source/_integrations/radiotherm.markdown
View File

@ -1,7 +1,6 @@
---
title: Radio Thermostat
description: Instructions on how to integrate Radio Thermostat (3M Filtrete) thermostats within Home Assistant.
logo: radiotherm.png
ha_category:
- Climate
ha_iot_class: Local Polling

1
source/_integrations/recollect_waste.markdown
View File

@ -1,7 +1,6 @@
---
title: ReCollect Waste
description: Instructions on how to set up Recollect Waste sensor within Home Assistant.
logo: recollect-waste.png
ha_category:
- Sensor
ha_release: 0.87

27
source/_integrations/recorder.markdown
View File

@ -155,18 +155,19 @@ Note that purging will not immediately decrease disk space usage but it will sig
## Custom database engines
| Database engine | `db_url` |
| :--------------------- | :------------------------------------------------------------------------------------------- |
| SQLite | `sqlite:////PATH/TO/DB_NAME` |
| MariaDB | `mysql+pymysql://SERVER_IP/DB_NAME?charset=utf8` |
| MariaDB | `mysql+pymysql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
| MariaDB (omit pymysql) | `mysql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
| MySQL | `mysql://SERVER_IP/DB_NAME?charset=utf8` |
| MySQL | `mysql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
| PostgreSQL | `postgresql://SERVER_IP/DB_NAME` |
| PostgreSQL | `postgresql://user:password@SERVER_IP/DB_NAME` |
| PostgreSQL (Socket) | `postgresql://@/DB_NAME` |
| MS SQL Server | `mssql+pyodbc://username:password@SERVER_IP/DB_NAME?charset=utf8;DRIVER={DRIVER};Port=1433;` |
| Database engine | `db_url` |
| :----------------------------- | :------------------------------------------------------------------------------------------- |
| SQLite | `sqlite:////PATH/TO/DB_NAME` |
| MariaDB | `mysql+pymysql://SERVER_IP/DB_NAME?charset=utf8` |
| MariaDB | `mysql+pymysql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
| MariaDB (omit pymysql) | `mysql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
| MySQL | `mysql://SERVER_IP/DB_NAME?charset=utf8` |
| MySQL | `mysql://user:password@SERVER_IP/DB_NAME?charset=utf8` |
| PostgreSQL | `postgresql://SERVER_IP/DB_NAME` |
| PostgreSQL | `postgresql://user:password@SERVER_IP/DB_NAME` |
| PostgreSQL (Socket) | `postgresql://@/DB_NAME` |
| PostgreSQL (Custom socket dir) | `postgresql://@/DB_NAME?host=/path/to/dir` |
| MS SQL Server | `mssql+pyodbc://username:password@SERVER_IP/DB_NAME?charset=utf8;DRIVER={DRIVER};Port=1433;` |
<div class='note'>
@ -297,7 +298,7 @@ source /srv/homeassistant/bin/activate
pip3 install pyodbc
```
You will also need to install an ODBC Driver. Microsoft ODBC drivers are recommended, however FreeTDS is available for systems that are not supported by Microsoft. Instrucitons for installing the Microsoft ODBC drivers can be found [here](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server).
You will also need to install an ODBC Driver. Microsoft ODBC drivers are recommended, however FreeTDS is available for systems that are not supported by Microsoft. Instructions for installing the Microsoft ODBC drivers can be found [here](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server).
<div class='note'>

1
source/_integrations/recswitch.markdown
View File

@ -1,7 +1,6 @@
---
title: Ankuoo REC Switch
description: Instructions on how to integrate Ankuoo REC Switch into Home Assistant.
logo: ankuoo_recswitch.png
ha_release: 0.81
ha_category:
- Switch

1
source/_integrations/sendgrid.markdown
View File

@ -1,7 +1,6 @@
---
title: SendGrid
description: Instructions on how to add email notifications via SendGrid to Home Assistant.
logo: sendgrid.png
ha_category:
- Notifications
ha_release: 0.14

1
source/_integrations/sesame.markdown
View File

@ -1,7 +1,6 @@
---
title: Sesame Smart Lock
description: Instructions on how to integrate Sesame by CANDY HOUSE into Home Assistant.
logo: sesame.png
ha_category:
- Lock
ha_iot_class: Cloud Polling

1
source/_integrations/shodan.markdown
View File

@ -4,7 +4,6 @@ description: Instructions on how to integrate Shodan sensors into Home Assistant
ha_category:
- Sensor
ha_iot_class: Cloud Polling
logo: shodan.png
ha_release: 0.51
ha_codeowners:
- '@fabaff'

1
source/_integrations/sigfox.markdown
View File

@ -1,7 +1,6 @@
---
title: Sigfox
description: Display messages from Sigfox devices in Home Assistant.
logo: sigfox.png
ha_category:
- Sensor
ha_iot_class: Cloud Polling

1
source/_integrations/slide.markdown
View File

@ -1,7 +1,6 @@
---
title: Slide
description: Instructions on how to integrate the Innovation in Motion Slide covers with Home Assistant.
logo: slide.png
ha_category:
- Hub
- Cover

1
source/_integrations/sma.markdown
View File

@ -3,7 +3,6 @@ title: SMA Solar
description: Instructions on how to connect your SMA Solar Inverter to Home Assistant.
ha_category:
- Energy
logo: sma.png
ha_iot_class: Local Polling
ha_release: 0.36
ha_codeowners:

1
source/_integrations/snapcast.markdown
View File

@ -1,7 +1,6 @@
---
title: Snapcast
description: Instructions on how to integrate Snapcast into Home Assistant.
logo: snapcast.png
ha_category:
- Media Player
ha_release: 0.13

1
source/_integrations/snips.markdown
View File

@ -1,7 +1,6 @@
---
title: Snips
description: Instructions on how to integrate Snips within Home Assistant.
logo: snips.png
ha_category:
- Voice
ha_release: 0.48

1
source/_integrations/socialblade.markdown
View File

@ -1,7 +1,6 @@
---
title: Social Blade
description: Instructions on how to set up Social Blade Sensor within Home Assistant.
logo: socialblade.png
ha_category:
- Multimedia
ha_release: 0.69

1
source/_integrations/somfy_mylink.markdown
View File

@ -1,7 +1,6 @@
---
title: Somfy MyLink
description: Instructions on how to integrate Somfy MyLink devices with Home Assistant.
logo: tahoma.png
ha_category:
- Hub
- Cover

1
source/_integrations/sony_projector.markdown
View File

@ -1,7 +1,6 @@
---
title: Sony Projector
description: Instructions on how to integrate Sony Projector switches into Home Assistant.
logo: sony.png
ha_category:
- Multimedia
ha_iot_class: Local Polling

1
source/_integrations/spc.markdown
View File

@ -6,7 +6,6 @@ ha_category:
- Alarm
- Binary Sensor
ha_release: 0.47
logo: vanderbilt_spc.png
ha_iot_class: Local Push
ha_domain: spc
---

2
source/_integrations/speedtestdotnet.markdown
View File

@ -21,7 +21,7 @@ Most Speedtest.net servers require TCP port 8080 outbound to function. Without t
## Configuration
For the `server_id` check the list of [available servers](http://www.speedtestserver.com).
For the `server_id` check the list of [available servers](https://speedtest.net/speedtest-servers.php).
To add Speedtest.net sensors to your installation, add the following to your `configuration.yaml` file:

4
source/_integrations/spotify.markdown
View File

@ -31,8 +31,8 @@ To create the required Spotify application:
- Select **Create An App**. Enter any name and description.
- Once your application is created, view it and copy your **Client ID** and **Client Secret**, which are used in the Home Assistant configuration file.
- Add a **Redirect URI** in one of the following forms:
- If you are not using SSL: `http://<your_home_assistant_url_or_local_ip>/auth/external/callback`
- If you are using SSL: `https://<your_home_assistant_url_or_local_ip>/auth/external/callback`
- If you are not using SSL: `http://<your_home_assistant_url_or_local_ip>:<port>/auth/external/callback`
- If you are using SSL: `https://<your_home_assistant_url_or_local_ip>:<port>/auth/external/callback`
- Click **Save** after adding the URI.
If you are using an externally accessible address, you will likely also need to set the `base_url` attribute of the [HTTP Integration](/integrations/http/). This should be set using the same base URL as the redirect URI, e.g., if you used a domain name (not local IP) in the redirect, then use the same domain name in your `base_url`.

1
source/_integrations/ssdp.markdown
View File

@ -28,4 +28,5 @@ The following integrations are automatically discovered by the SSDP integration:
- [DirecTV](/integrations/directv/)
- [Huawei LTE](../huawei_lte/)
- [Philips Hue](../hue/)
- [Roku](/integrations/roku/)
- [Samsung TV](../samsungtv/)

1
source/_integrations/startca.markdown
View File

@ -1,7 +1,6 @@
---
title: Start.ca
description: Instructions on how to integrate Start.ca data usage within Home Assistant.
logo: startca.png
ha_category:
- Network
ha_release: 0.64

1
source/_integrations/supervisord.markdown
View File

@ -1,7 +1,6 @@
---
title: Supervisord
description: Instructions on how to integrate Supervisord within Home Assistant.
logo: supervisord.png
ha_category:
- System Monitor
ha_release: '0.20'

1
source/_integrations/swisscom.markdown
View File

@ -1,7 +1,6 @@
---
title: Swisscom Internet-Box
description: Instructions on how to integrate Swisscom Internet-Box into Home Assistant.
logo: swisscom.png
ha_category:
- Presence Detection
ha_release: 0.32

Some files were not shown because too many files have changed in this diff Show More