-
-This Z-Wave integration is deprecated and replaced with a [new implementation based on Z-Wave JS](/integrations/zwave_js); it's currently in beta, and you can [try it now](/integrations/zwave_js/).
-
-
-
-## Devices, Nodes, Entities
-
-The *device* is the hardware, and also used when referring to the node and all its entities. There are 3 main types of devices:
-
-* [Controllers](/docs/z-wave/controllers) - all Z-Wave networks need to have one of these, though some may have two (a primary and a secondary)
-* Sensors - devices that tell you about the environment, these could be flood sensors, motion sensors, temperature sensors and so on
-* Actors or actuators - devices that change their environment, for example light switches, dimmers, thermostats (many of these will also have a sensor function)
-
-Many sensors and actors can directly control other devices through a capability called *association*, without the use of an automation, these are known as *routing slaves*. This will be a very simple control, such as turning a light on when a motion sensor is activated, and off when it stops detecting motion.
-
-The *node* is the presence of the device on the Z-Wave mesh. Once you've added a device to Home Assistant, the node is represented by an `entity_id` that starts with `zwave`.
-
-The *entity* is an individual integration of the node. It may be a sensor that you read from, or a control that you operate. For any node, there will be at least one entity (for the node itself) and if it exposes any controls or sensors there will be at least one entity per control or sensor. The [entities](/docs/z-wave/entities) that are created depend on the Command Class the device supports.
-
-## Z-Wave, Plus, Security 2
-
-There have been 2 extensions to the Z-Wave protocol. Using these requires that your controller supports these extensions, but devices are backward compatible.
-
-### Z-Wave Plus
-
-The key improvements are:
-
-* Improved battery life (50% increase)
-* Improved range (50% increase) if all your devices are Z-Wave Plus
-* Higher bandwidth and improved noise immunity if all your devices are Z-Wave Plus
-* Improved self-healing and fault tolerance
-
-### Z-Wave Security 2
-
-From 2 April 2017 all newly approved Z-Wave devices will have to support the Security 2 (S2) framework. At the time of writing this (October 2019) OpenZWave does not support the S2 framework.
-
-## Device Power
-
-Your Z-Wave mesh network is built with the devices that are mains powered (whether directly, or via a USB adapter), these relay traffic for other nodes, building the network. These devices are always awake and you can query them, or send configuration changes, at any time.
-
-Battery powered devices spend most of their time asleep, unable to relay traffic, to be queried, or receive changes. Changes sent while a device is asleep will be queued and sent the next time the device wakes. Details of the default wake interval, and how to manually wake the device (if supported) will be detailed in the device's manual. Some battery powered devices (primarily locks and thermostats) support beaming (the *Beam* command class) that allows them to be remotely woken. This does require that all devices in the network responsible for relaying the commands between the controller and the device also support beaming.
-
-
-
-The Z-Wave capability *routing* doesn't mean the device routes traffic, it actually means that it's able to control other devices. You'll see this capability on most remotes and switches.
-
-
-
-## Instant Status
-
-Older designs of Z-Wave devices may not support *Instant Status* (the *Hail* command class), because of a patent that was held by Lutron Electronics. Some manufacturers paid to use it, others didn't and so those devices may not report on changes. That patent expired in 2016, so new designs should support this.
-
-As long as your device lists Hail or Association in its Controlled Command Classes, then you'll get instant status updates. Devices that list Central Scene in their Controlled Command Classes in theory will also work this way, once OpenZWave supports the Central Scene class. You can check your device on the [Z-Wave alliance](https://products.z-wavealliance.org/) site, looking at the **Command Classes** link, then at the **Controlled Command Classes** section.
-
-## Polling
-
-Where a device doesn't send updates on status changes to the controller, you can work around this by using a thing called Polling. That causes the controller to ask the device to provide an update on all its sensors and states. This will cause a lot of traffic on the network, and if you poll too many devices too quickly, you can effectively break your Z-Wave network. Polling should only be used where there is no other choice, and you should use as large a polling interval as possible. Ideally you should replace the device.
-
-For example, with `polling_interval=60000` (which is the default) if you have 10 devices that are being polled at every interval, and each polling takes one second (request/response round trip), then it will take 10 seconds to complete the polling list. This only leaves 50 seconds left for normal traffic. The more devices you poll, and the shorter the interval, the less bandwidth that's available for normal traffic.
-
-Polling needs to be enabled per device, you can control this through the *polling intensity* (interval) of the device. See the [Node Management](/docs/z-wave/control-panel#z-wave-node-management) documentation for details.
-
-## Central Scene support
-
-The Central Scene command class isn't yet supported in OpenZWave (there is [work in progress](https://github.com/OpenZWave/open-zwave/pull/1125) to provide it it), though Home Assistant has introduced some support with [change 9178](https://github.com/home-assistant/home-assistant/pull/9178) which was part of 0.53 and [documented here](/docs/z-wave/device-specific/#homeseer-switches).
-
-## Supported Devices
-
-You can check to see if OpenZWave supports your particular device by looking at the [OpenZWave 1.4 GitHub](https://github.com/OpenZWave/open-zwave/tree/1.4/config). Be aware that being listed here doesn't mean that it will be supported in Home Assistant, since the version of OpenZWave used by Home Assistant will often lag the GitHub by a few months.
-
-Even if your device isn't listed there, it's likely that it will still work as expected as long as the device complies with the Z-Wave standards. The OpenZWave wiki describes how [you can add support](https://github.com/OpenZWave/open-zwave/wiki/Adding-Devices) for your device if it isn't listed.
diff --git a/source/_docs/z-wave/entities.markdown b/source/_docs/z-wave/entities.markdown
deleted file mode 100644
index 6b8fc943aca..00000000000
--- a/source/_docs/z-wave/entities.markdown
+++ /dev/null
@@ -1,206 +0,0 @@
----
-title: "Z-Wave Entity Naming"
-description: "A summary of common entity names."
----
-
-
-
-This Z-Wave integration is deprecated and replaced with a [new implementation based on Z-Wave JS](/integrations/zwave_js); it's currently in beta, and you can [try it now](/integrations/zwave_js/).
-
-
-
-## Binary Sensor
-
-Devices that support the Binary Sensor command class will create one (or more) entities starting with `binary_sensor`. For example, if the node is `door_sensor` then the binary sensor entity will be `binary_sensor.door_sensor`.
-
-These will normally be `on` when the sensor is active, otherwise they will be `off`. Some devices use `on` for closed, and some use `on` for open, and some devices allow you to change how they report.
-
-## Alarm
-
-This is for a single purpose sensor, multi sensors are explained under Multi Sensor.
-
-Devices (usually sensors) that support the Alarm command class will create entities starting with `sensor`, and with some generic suffixes, and a suffix that relates to the supported alarm class. For example, the smoke detector `lounge` will have an entity `sensor.lounge_smoke`, and possibly also `sensor.lounge_alarm_type` and `sensor.lounge_alarm_level`. If the device creates a `binary_sensor` entity, it is recommended to use that rather then the `sensor` entity.
-
-Note that the older Z-Wave alarm command class version 1 didn't have standardized types, and so each manufacturer specified their own version and type info. With Version 2 the alarm type was standardized to the below list. See the [openzwave alarm command class documents](https://github.com/OpenZWave/open-zwave/wiki/Alarm-Command-Class) for more info. You can see which version your sensor supports via the `zwcfg_0x*.xml` file. An example with version 2 support:
-
-```xml
-
-
-This Z-Wave integration is deprecated and replaced with a [new implementation based on Z-Wave JS](/integrations/zwave_js); it's currently in beta, and you can [try it now](/integrations/zwave_js/).
-
-
-
-## zwave.network_complete
-
-Home Assistant will trigger an event when the Z-Wave network is complete, meaning all of the nodes on the network have been queried. This can take quite some time, depending on wakeup intervals on the battery-powered devices on the network.
-
-```yaml
- - alias: "Z-Wave network is complete"
- trigger:
- platform: event
- event_type: zwave.network_complete
-```
-
-## zwave.network_complete_some_dead
-
-Home Assistant will trigger an event when the Z-Wave network is complete, but some nodes are marked dead, meaning all of the nodes on the network have been queried. This can take quite some time, depending on wakeup intervals on the battery-powered devices on the network.
-
-```yaml
- - alias: "Z-Wave network is complete some dead"
- trigger:
- platform: event
- event_type: zwave.network_complete_some_dead
-```
-
-## zwave.network_ready
-
-Home Assistant will trigger an event when the Z-Wave network is ready for use. Between `zwave.network_start` and `zwave.network_ready` Home Assistant will feel sluggish when trying to send commands to Z-Wave nodes. This is because the controller is requesting information from all of the nodes on the network. When this is triggered, all awake nodes have been queried and sleeping nodes will be queried when they awake.
-
-```yaml
- - alias: "Z-Wave network is ready"
- trigger:
- platform: event
- event_type: zwave.network_ready
-```
-
-## zwave.network_start
-
-Home Assistant will trigger an event when the Z-Wave network is set up to be started.
-
-```yaml
- - alias: "Z-Wave network is starting"
- trigger:
- platform: event
- event_type: zwave.network_start
-```
-
-## zwave.network_stop
-
-Home Assistant will trigger an event when the Z-Wave network is stopping.
-
-```yaml
- - alias: "Z-Wave network is stopping"
- trigger:
- platform: event
- event_type: zwave.network_stop
-```
-
-## zwave.node_event
-Home Assistant will trigger an event when command_class_basic changes value on a node. This can be virtually anything, so tests have to be made to determine what value equals what. You can use this for automations.
-
-Example:
-
-```yaml
- - alias: "Minimote Button Pressed"
- trigger:
- platform: event
- event_type: zwave.node_event
- event_data:
- entity_id: zwave.aeon_labs_minimote
- basic_level: 255
-```
-
-The *entity_id* and *basic_level* of all triggered events can be seen in the console output.
-
-## zwave.scene_activated
-
-Some devices can also trigger scene activation events, which can be used in automation scripts (for example, the press of a button on a wall switch):
-
-```yaml
-# Example configuration.yaml automation entry
-automation:
- - alias: "Turn on Desk light"
- trigger:
- platform: event
- event_type: zwave.scene_activated
- event_data:
- entity_id: zwave.zwaveme_zme_wallcs_secure_wall_controller
- scene_id: 11
-```
-
-Some devices (like the HomeSeer wall switches) allow you to do things like double, and triple click the up and down buttons and fire an event. These devices will also send `scene_data` to differentiate the events. This is an example of double clicking the on/up button:
-
-```yaml
-# Example configuration.yaml automation entry
-automation
- - alias: "Dining room dimmer - double tap up"
- trigger:
- - event_type: zwave.scene_activated
- platform: event
- event_data:
- entity_id: zwave.dining_room_cans
- scene_id: 1
- scene_data: 3
-```
-
-The *entity_id* and *scene_id* of all triggered events can be seen in the console output.
-
-For more information on HomeSeer devices and similar devices, please see the [device specific page](/docs/z-wave/device-specific/#homeseer-switches).
diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown
deleted file mode 100644
index 397a9057e51..00000000000
--- a/source/_docs/z-wave/installation.markdown
+++ /dev/null
@@ -1,299 +0,0 @@
----
-title: "Z-Wave"
-description: "Installation of the Z-Wave component."
----
-
-
-
-This Z-Wave integration is deprecated and replaced with a [new implementation based on Z-Wave JS](/integrations/zwave_js); it's currently in beta, and you can [try it now](/integrations/zwave_js/).
-
-
-
-
-Z-Wave can be configured using the Z-Wave *Integration* in the *Configuration* menu, or manually using an entry in `configuration.yaml`
-
-## Configuration
-
-```yaml
-# Example configuration.yaml entry
-zwave:
- usb_path: /dev/ttyACM0
- device_config: !include zwave_device_config.yaml
-```
-
-{% configuration Z-Wave %}
-usb_path:
- description: The port where your device is connected to your Home Assistant host. Z-Wave sticks will generally be `/dev/ttyACM0` and GPIO hats will generally be `/dev/ttyAMA0`.
- required: false
- type: string
- default: /zwaveusbstick
-network_key:
- description: The 16-byte network key in the form `"0x01, 0x02..."` used in order to connect securely to compatible devices. It is recommended that a network key is configured as security enabled devices may not function correctly if they are not added securely.
- required: false
- type: string
- default: None
-config_path:
- description: The path to the Python OpenZWave configuration files.
- required: false
- type: string
- default: the 'config' that is installed by python-openzwave
-polling_interval:
- description: The time period in milliseconds between polls of a nodes value. Be careful about using polling values below 30000 (30 seconds) as polling can flood the Z-Wave network and cause problems.
- required: false
- type: integer
- default: 60000
-debug:
- description: Print verbose Z-Wave info to log.
- required: false
- type: boolean
- default: false
-autoheal:
- description: Allows enabling auto Z-Wave heal at midnight. Warning, this is inefficient and [should not be used](https://github.com/home-assistant/architecture/issues/81#issuecomment-478444085).
- required: false
- type: boolean
- default: false
-device_config / device_config_domain / device_config_glob:
- description: "This attribute contains node-specific override values. NOTE: This needs to be specified if you are going to use any of the following options. See [Customizing devices and services](/docs/configuration/customizing-devices/) for the format."
- required: false
- type: [string, list]
- keys:
- ignored:
- description: Ignore this entity completely. It won't be shown in the Web Interface and no events are generated for it.
- required: false
- type: boolean
- default: false
- polling_intensity:
- description: Enables polling of a value and sets the frequency of polling (0=none, 1=every time through the list, 2=every other time, etc). If not specified then your device will not be polled.
- required: false
- type: integer
- default: 0
- refresh_value:
- description: Enable refreshing of the node value. Only the light integration uses this.
- required: false
- type: boolean
- default: false
- delay:
- description: Specify the delay for refreshing of node value. Only the light integration uses this.
- required: false
- type: integer
- default: 5
- invert_openclose_buttons:
- description: Inverts function of the open and close buttons for the cover domain. This will not invert the position and state reporting.
- required: false
- type: boolean
- default: false
- invert_percent:
- description: Inverts the percentage of the position for the cover domain. This will invert the position and state reporting.
- required: false
- type: boolean
- default: false
-{% endconfiguration %}
-
-### Network Key
-
-Security Z-Wave devices require a network key before being added to the network using the Add Secure Node button in the Z-Wave Network Management card. You must set the *network_key* configuration variable to use a network key before adding these devices.
-
-An easy script to generate a random key:
-
-```bash
-cat /dev/urandom | tr -dc '0-9A-F' | fold -w 32 | head -n 1 | sed -e 's/\(..\)/0x\1, /g' -e 's/, $//'
-```
-
-You can also use sites like [this one](https://www.random.org/cgi-bin/randbyte?nbytes=16&format=h) to generate the required data, just remember to put `0x` before each pair of characters and a `,` between them:
-
-```yaml
-# Example configuration.yaml entry for network_key
-zwave:
- network_key: "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
-
-On platforms other than Home Assistant and Docker, the compilation and installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspberry Pi. When you upgrade Home Assistant and python-openzwave is also upgraded, this will also result in a delay while the new version is compiled and installed.
-
-The first run after adding a device is when the `zwave` integration will take time to initialize the entities, some entities may appear with incomplete names. Running a network heal may speed up this process.
-
-## Platform specific instructions
-
-### Home Assistant
-
-You do not need to install any software to use Z-Wave.
-
-If the path of `/dev/ttyACM0` doesn't work, look in the *System* section of the *Supervisor* menu. There you'll find a *Hardware* button which will list all the hardware found.
-
-You can also check what hardware has been found using the [`ha` command](/hassio/commandline/#hardware):
-
-```bash
-ha hardware info
-```
-
-If you did an alternative install of Home Assistant on Linux (e.g., installing Ubuntu, then Docker, then Home Assistant Supervised) then the `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled in the host OS. Failure to do so will result in random failures of those components, e.g., dead or unreachable Z-Wave nodes, most notably right after Home Assistant restarts. Connect to your host OS via SSH, then you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` (commands are for Debian/Ubuntu).
-
-### Docker
-
-You do not need to install any software to use Z-Wave.
-
-To enable access to the Z-Wave stick, add `--device=/dev/ttyACM0` to the `docker` command that starts your container, for example:
-
-```bash
-docker run -d --name="home-assistant" -v /home/pi/homeassistant:/config -v /etc/localtime:/etc/localtime:ro --net=host --device=/dev/ttyACM0 homeassistant/raspberrypi3-homeassistant
-```
-
-If the path of `/dev/ttyACM0` doesn't work then you can find the path of the stick by disconnecting and then reconnecting it, and running the following in the Docker host:
-
-```bash
-ls -1tr /dev/tty*|tail -n 1
-```
-
-The `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled. Failure to do so will result in random failures of those components. For example you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager`
-
-### Community install methods
-
-#### Raspberry Pi specific
-
-On the Raspberry Pi you will need to enable the serial interface in the `raspi-config` tool before you can add Z-Wave to Home Assistant. Make sure to reboot the Raspberry Pi for the setting to take effect.
-
-#### Linux with Home Assistant Core
-
-On Debian Linux platforms there are dependencies you will need to have installed ahead of time (included in `systemd-devel` on Fedora/RHEL systems):
-
-```bash
-sudo apt-get install libudev-dev build-essential
-```
-
-You may also have to install the Python development libraries for your version of Python. For example `libpython3.6-dev`, and possibly `python3.6-dev` if you're using Python 3.6.
-
-##### Finding the controller path
-
-To find the path of your Z-Wave USB stick, disconnect it and then reconnect it to your system and run:
-
-```bash
-ls -ltr /dev/tty*|tail -n 1
-```
-
-That will give you a line that looks something like this:
-
-```bash
-crw-rw---- 1 root dialout 204, 64 Sep 21 10:25 /dev/ttyACM0
-```
-
-Where the date and time displayed is approximately the time you connected the USB stick or module (it may also be something like `/dev/ttyAMA0` or `/dev/ttyUSB0`). The number will be zero for the first device connected, and higher numbers for later devices.
-
-Or, if there is no result, try to find detailed USB connection info with:
-
-```bash
-dmesg | grep USB
-```
-
-If Home Assistant (`hass`) runs with another user (e.g., `homeassistant`) you need to give access to the stick with:
-
-```bash
-sudo usermod -aG dialout homeassistant
-```
-
-The output from `ls -ltr` above contains the following information:
-
-- The device type is `c` (character special).
-- The permissions are `rw-rw----`, meaning only the owner and group can read and write to it.
-- There is only `1` link to the file.
-- It is owned by `root` and can be accessed by members of the group `dialout`.
-- It has a major device number of `204`, and a minor device number of `64`.
-- The device was connected at `10:25` on `21 September`.
-- The device is `/dev/ttyUSB0`.
-
-#### macOS
-
-When installing on macOS you may have to also run the command below ahead of time, replace "x.x" with the version of Python (`$ python3 --version`) you have installed.
-
-```bash
-sudo /Applications/Python\ x.x/Install\ Certificates.command
-```
-
-On macOS you can find the USB stick with:
-
-```bash
-ls /dev/cu.usbmodem*
-```
-
-## Troubleshooting
-
-### Device path changes
-
-If your device path changes when you restart, see [this guide](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/) on fixing it.
-
-### Random unreachable Z-Wave nodes: ModemManager interference
-
-If this applies to your situation:
-
-- Some or all Z-Wave nodes are unreachable after restarting Home Assistant; not necessarily after every restart but seemingly random.
-- The Z-Wave stick stops responding, needs to be re-plugged or Home Assistant needs a restart to get Z-Wave back.
-- Your host OS is Debian-based/Ubuntu (for example: you installed Ubuntu, then Docker, then Hass.io).
-
-Then chances are high that the ModemManager in the host OS is causing the issue, claiming or interfering with the USB Z-Wave stick like the much used Aeotec ones. In this case you need to disable ModemManager.
-
-Connect to your host OS (e.g., Ubuntu) through SSH, then execute the following command on your host system to disable the ModemManager:
-
- ```bash
-systemctl disable ModemManager.service
-```
-
-### Component could not be set up
-
-Sometimes the device may not be accessible and you'll get an error message upon startup about not being able to set up Z-Wave. Run the following command for your device path (here we're using `/dev/ttyAMA0` for our Razberry board):
-
-```bash
-ls -l /dev/ttyAMA0
-```
-
-You should then see something like this:
-
-```txt
-crw-rw---- 1 root dialout 204, 64 Apr 1 12:34 /dev/ttyAMA0
-```
-
-The important pieces are the first piece `crw-rw----` and the group `dialout`. If those are different then, for your device path, run:
-
-```bash
-sudo chgrp dialout /dev/ttyAMA0
-sudo chmod g+rw /dev/ttyAMA0
-```
-
-Check too that the account you're running Home Assistant as is in the `dialout` group. For instance, if you're using `homeassistant`:
-
-```bash
-groups homeassistant
-```
-
-That should include `dialout`, if it doesn't then:
-
-```bash
-sudo usermod -aG dialout homeassistant
-```
-
-### Unable to install Python Openzwave
-
-If you're getting errors like:
-
-```txt
-openzwave-embed/open-zwave-master/libopenzwave.a: No such file or directory
-```
-
-Then the problem is that you're missing `libudev-dev` (or the equivalent for your distribution), please [install it](/docs/z-wave/installation/#linux).
-
-### Random failures
-
-If you're having random failures of the mesh, devices going missing, things randomly not working, check your `OZW_Log.txt` for the following messages:
-
-```txt
-WARNING: 500ms passed without reading the rest of the frame...aborting frame read
-WARNING: Out of frame flow! (0xfe). Sending NAK
-WARNING: Checksum incorrect - sending NAK
-```
-
-If you see any of these messages repeated in the log then _probably_ you've got something else running that's also using the Z-Wave controller. That might mean you've also got the OpenZ-Wave control panel (ozwcp) running, a second instance of Home Assistant or something else. You need to stop that other process to resolve this.
-
-### Changing device paths
-
-Configurations using `udev` can experience race conditions in creating device paths such that they change on reboot. This can cause a device to appear to change between `/dev/ttyACM0` and `/dev/ttyACM1` after reboot. In this case using the symlinks created for device IDs can ensure the correct device is used, for example: `/dev/serial/by-id/usb-0658_0200-if00` for Aeotec Z-Stick.
diff --git a/source/_docs/z-wave/query-stage.markdown b/source/_docs/z-wave/query-stage.markdown
deleted file mode 100644
index 2d07055f5cd..00000000000
--- a/source/_docs/z-wave/query-stage.markdown
+++ /dev/null
@@ -1,36 +0,0 @@
----
-title: "Z-Wave Query Stage"
-description: "What are the Query Stages."
----
-
-
-
-This Z-Wave integration is deprecated and replaced with a [new implementation based on Z-Wave JS](/integrations/zwave_js); it's currently in beta, and you can [try it now](/integrations/zwave_js/).
-
-
-
-When the Z-Wave mesh is first started, the controller will go through all the following stages for every device on the mesh. This is a slow process, and to complete requires that the devices be awake. While devices that are mains or USB powered are always awake, battery-powered devices spend most of their time asleep. Because of this, you can expect that after startup your battery powered devices will spend time in `Initializing (CacheLoad)` - how long depends on the device.
-
-Your devices will still function normally while marked as `Initializing`.
-
-| Stage | Description |
-| --------------------- | ---------------------------------------------------------------------- |
-| None | Query process hasn't started for this node |
-| ProtocolInfo | Retrieve protocol information |
-| Probe | Ping device to see if alive |
-| WakeUp | Start wake up process if a sleeping node |
-| ManufacturerSpecific1 | Retrieve manufacturer name and product ids if ProtocolInfo lets us |
-| NodeInfo | Retrieve info about supported, controlled command classes |
-| NodePlusInfo | Retrieve Z-Wave+ info and update device classes |
-| SecurityReport | Retrieve a list of Command Classes that require Security |
-| ManufacturerSpecific2 | Retrieve manufacturer name and product ids |
-| Versions | Retrieve version information |
-| Instances | Retrieve information about multiple command class instances |
-| Static | Retrieve static information (doesn't change) |
-| CacheLoad | Ping a device upon restarting with cached configuration for the device |
-| Associations | Retrieve information about associations |
-| Neighbors | Retrieve node neighbor list |
-| Session | Retrieve session information (changes infrequently) |
-| Dynamic | Retrieve dynamic information (changes frequently) |
-| Configuration | Retrieve configurable parameter information (only done on request) |
-| Complete | Query process is completed for this node |
diff --git a/source/_docs/z-wave/services.markdown b/source/_docs/z-wave/services.markdown
deleted file mode 100644
index 43d4bebcdbb..00000000000
--- a/source/_docs/z-wave/services.markdown
+++ /dev/null
@@ -1,54 +0,0 @@
----
-title: "Z-Wave Services"
-description: "Services exposed by the Z-Wave component."
----
-
-
-
-This Z-Wave integration is deprecated and replaced with a [new implementation based on Z-Wave JS](/integrations/zwave_js); it's currently in beta, and you can [try it now](/integrations/zwave_js/).
-
-
-
-The `zwave` integration exposes multiple services to help maintain the network. All of these are available through the Z-Wave control panel.
-
-| Service | Description |
-| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| add_node | Put the Z-Wave controller in inclusion mode. Allows you to add a new device to the Z-Wave network. |
-| add_node_secure | Put the Z-Wave controller in secure inclusion mode. Allows you to add a new device with secure communications to the Z-Wave network. |
-| cancel_command | Cancels a running Z-Wave command. If you have started an add_node or remove_node command, and decide you are not going to do it, then this must be used to stop the inclusion/exclusion command. |
-| change_association | Add or remove an association in the Z-Wave network |
-| heal_network | Tells the controller to "heal" the Z-Wave network. Basically asks the nodes to tell the controller all of their neighbors so the controller can re-figure out optimal routing. |
-| heal_node | Tells the controller to "heal" a specific node on the network. Requires `node_id` field. You can also force return route update with `return_routes` field. |
-| print_config_parameter | Prints Z-Wave node's configuration parameter value to the (console) log. |
-| print_node | Print all states of Z-Wave node. |
-| refresh_entity | Refresh the Z-Wave entity by refreshing dependent values. |
-| refresh_node | Refresh the Z-Wave node. |
-| refresh_node_value | Refresh the specified value of a Z-Wave node. |
-| remove_node | Put the Z-Wave controller in exclusion mode. Allows you to remove a device from the Z-Wave network. |
-| rename_node | Sets a node's name. Requires a `node_id` and `name` field. |
-| rename_value | Sets a value's name. Requires a `node_id`, `value_id`, and `name` field. |
-| remove_failed_node | Remove a failed node from the network. The Node should be on the controller's Failed Node List, otherwise this command will fail. |
-| replace_failed_node | Replace a failed device with another. If the node is not in the controller's Failed Node List, or the node responds, this command will fail. |
-| reset_node_meters | Reset a node's meter values. Only works if the node supports this. |
-| set_config_parameter | Lets the user set a configuration parameter to a node. NOTE: Use the parameter option's `label` string as the `value` for list parameters (e.g., `"value": "Off"`). For all other parameters use the relevant integer `value` (e.g., `"value": 1`). |
-| set_node_value | Set the specified value of a Z-Wave node. |
-| soft_reset | Tells the controller to do a "soft reset." This is not supposed to lose any data, but different controllers can behave differently to a "soft reset" command. |
-| start_network | Starts the Z-Wave network. |
-| stop_network | Stops the Z-Wave network. |
-| test_network | Tells the controller to send no-op commands to each node and measure the time for a response. In theory, this can also bring back nodes which have been marked "presumed dead." |
-| test_node | Tells the controller to send no-op command(s) to a specific node. Requires `node_id` field. You can specify amount of test_messages to send by specifying it with `messages` field. In theory, this could bring back nodes marked as "presumed dead" |
-
-The `soft_reset` and `heal_network` commands can be used to help keep a Z-Wave network running reliably. This is a configuration option for the `zwave` component. The option defaults to `false` but can be enabled by setting `autoheal` to true. This, however, is bad practice since it introduces overhead that can be avoided since you only need to do a `heal_network` whenever one of the following actions are done:
-
-- Adding/Removing a new node
-- Moving a node around
-- Moving the Controller
-- Removing a Dead Node
-
-
-
-Using the `soft_reset` function with some Z-Wave controllers can cause the Z-Wave network to hang.
-
-
-
-To trigger a `heal_network`, one can always use *Settings -> Z-Wave Network Management -> Heal Network* from the GUI whenever one of the above actions took place.
diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html
index e1fad6d7ce6..044ffacd5d6 100644
--- a/source/_includes/asides/docs_navigation.html
+++ b/source/_includes/asides/docs_navigation.html
@@ -157,41 +157,6 @@
-
-
- - {% active_link /docs/z-wave/installation/ Configuring the Z-Wave - component %} - -
- {% active_link /docs/z-wave/adding/ Adding devices %} -
- - {% active_link /docs/z-wave/control-panel/ The Z-Wave control panel - %} - -
- {% active_link /docs/z-wave/controllers/ Controllers %} -
- - {% active_link /docs/z-wave/devices/ Devices %} - and - {% active_link - /docs/z-wave/entities/ Entities %} - -
- - {% active_link /docs/z-wave/query-stage/ Query Stages %} - for devices - -
- - {% active_link /docs/z-wave/device-specific/ Device Specific %} - configuration - -
- - {% active_link /docs/z-wave/events/ Events %} - and - {% active_link - /docs/z-wave/services/ Services %} - -
-
diff --git a/source/_includes/installation/container/alternative.md b/source/_includes/installation/container/alternative.md
index f62d55ec85b..d98458b45b2 100644
--- a/source/_includes/installation/container/alternative.md
+++ b/source/_includes/installation/container/alternative.md
@@ -39,13 +39,13 @@ Adjust the following Terminal command as follows :
- Replace `/PATH_TO_YOUR_USB_STICK` matches the path for your USB stick (e.g., `/dev/ttyACM0` for most Synology users)
- Replace "Australia/Melbourne" with [your timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
-Run it in Terminal.
+Run it in Terminal.
```bash
sudo docker run --restart always -d --name homeassistant -v /PATH_TO_YOUR_CONFIG:/config --device=/PATH_TO_YOUR_USB_STICK -e TZ=Australia/Melbourne --net=host {{ site.installation.container.base }}:stable
```
-Complete the remainder of the Z-Wave configuration by [following the instructions here.](/docs/z-wave/installation)
+Complete the remainder of the Z-Wave configuration by [following the instructions here.](/integrations/zwave_js)
Remark: to update your Home Assistant on your Docker within Synology NAS, you just have to do the following:
@@ -100,16 +100,16 @@ If you want to use a USB Bluetooth adapter or Z-Wave USB stick with Home Assista
- Find USB devices attached. Type command:
`ls /dev/tty*`
The above command should show you any USB devices plugged into your NAS. If you have more than one, you may get multiple items returned. Like : `ttyACM0`
-
+
- Run Docker command:
```bash
docker run --init --name homeassistant --net=host --privileged -itd -v /share/CACHEDEV1_DATA/Public/homeassistant/config:/config -e TZ=Europe/London --device /dev/ttyACM0 {{ site.installation.container.base }}:stable
```
-
+
`-v` is your configuration path
`-e` is set timezone
-
+
- Edit `configuration.yaml`
```yaml
@@ -127,10 +127,10 @@ That will tell Home Assistant where to look for our Z-Wave radio.
```bash
docker run --init --name homeassistant --net=host --privileged -itd -v /share/CACHEDEV1_DATA/Public/homeassistant/config:/config -e TZ=Europe/London -v /dev/bus/usb:/dev/bus/usb -v /var/run/dbus:/var/run/dbus {{ site.installation.container.base }}:stable
```
-
+
First `-v` is your configuration path
`-e` is set timezone
-
+
- Edit the `configuration.yaml` file
```yaml
diff --git a/source/_integrations/broadlink.markdown b/source/_integrations/broadlink.markdown
index 7cbfe6f0e78..089482ebd1e 100644
--- a/source/_integrations/broadlink.markdown
+++ b/source/_integrations/broadlink.markdown
@@ -29,7 +29,7 @@ The Broadlink integration allows you to control and monitor Broadlink universal
{% include integrations/config_flow.md %}
-### Entities and subdomains
+## Entities and subdomains
There is no more need to set up platforms, except for custom IR/RF switches. Once the device is configured, all entities will be created automatically.
@@ -49,7 +49,6 @@ The `remote` entities allow you to learn and send codes with universal remotes.
Use `remote.learn_command` to learn IR and RF codes. These codes are grouped by device and stored as commands in the [storage folder](#Learned%20codes%20storage%20location). They can be sent with the `remote.send_command` service later.
-
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------- |
| `entity_id` | no | ID of the remote. |
diff --git a/source/_integrations/brottsplatskartan.markdown b/source/_integrations/brottsplatskartan.markdown
index 4432823668a..a3a15aeb764 100644
--- a/source/_integrations/brottsplatskartan.markdown
+++ b/source/_integrations/brottsplatskartan.markdown
@@ -43,7 +43,6 @@ longitude:
default: Your home zone longitude defined in your configuration.
{% endconfiguration %}
-
## Notes
### Area
diff --git a/source/_integrations/browser.markdown b/source/_integrations/browser.markdown
index ed7a1d7ed90..28c525f5b44 100644
--- a/source/_integrations/browser.markdown
+++ b/source/_integrations/browser.markdown
@@ -20,13 +20,16 @@ To load this component, add the following lines to your `configuration.yaml`:
browser:
```
-#### Service `browser/browse_url`
+### Services
+
+Once loaded, the `browser` platform will expose services that can be called to perform various actions.
+
+Available services: `browser/browse_url`.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `url` | no | The URL to open.
-
### Usage
To use this service, choose **Call Service** from the **Developer Tools**. Choose the service *browser/browse_url* from the list of **Available services:** and enter the URL into the **Service Data** field and hit **CALL SERVICE**.
diff --git a/source/_integrations/buienradar.markdown b/source/_integrations/buienradar.markdown
index f3b37f55e40..e320f57ac7e 100644
--- a/source/_integrations/buienradar.markdown
+++ b/source/_integrations/buienradar.markdown
@@ -44,47 +44,47 @@ The Buienradar integration will set up separate sensor entities with more detail
The following entities will be created:
-- **Station name**: The name of the selected meteo-station.
-- **Barometer forecast**: A numeric barametric forecast (1 to 7)
-- **Barometer forecast name**: "A textual representation of the barometer forecast (eg: Thunderstorms, Stable, etc.)."
-- **Condition code**: "A symbol and a unique code identifying the current weather condition ([a..z])."
-- **Condition**: A symbol and the current weather condition (`clear`, `cloudy`, `fog`, `rainy`, `snowy` or `lightning`).
-- **Condition detailed**: A symbol and detailed current weather condition (`clear`, `partlycloudy`, `cloudy`, `partlycloudy-fog`, `partlycloudy-light-rain`, `partlycloudy-rain`, `light-rain`, `rainy`, `snowy-rainy`, `partlycloudy-light-snow`, `partlycloudy-snow`, `light-snow`, `snowy`, `partlycloudy-lightning` or `lightning`).
-- **Condition exact**: A symbol with the full current weather condition (in English).
-- **Symbol**: A symbol for the current weather with the full current condition (in Dutch).
-- **Feel temperature**: "The current feel temperature (in [C](https://en.wikipedia.org/wiki/Celsius))."
-- **Humidity**: The relative humidity (%).
-- **Temperature**: "The current temperature (in [C](https://en.wikipedia.org/wiki/Celsius))."
-- **Ground temperature**: "The current ground temperature (in [C](https://en.wikipedia.org/wiki/Celsius))."
-- **Wind speed**: "The wind speed in [km/h](https://en.wikipedia.org/wiki/Kilometres_per_hour)."
-- **Wind force**: "The wind speed/force in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale)."
-- **Wind direction**: "Where the wind is coming from: N (North), Z (south), NO (North-East), etc."
-- **Wind azimuth**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise.
-- **Pressure**: "The sea-level air pressure in [hPa](https://en.wikipedia.org/wiki/Hectopascal)."
-- **Visibility**: "Visibility in meters ([m](https://en.wikipedia.org/wiki/Metre))."
-- **Wind gust**: "The wind speed of wind gusts ([km/h](https://en.wikipedia.org/wiki/Kilometres_per_hour))."
-- **Precipation**: The amount of precipitation/rain in mm/h.
-- **Precipation forecast average**: The average expected precipitation/rain in mm/h within the given time-frame.
-- **Precipation forecast total**: The total expected precipitation/rain in mm within the given time-frame. The total expected rain in the configured time-frame will be equal to _precipitation_forecast_total_/_timeframe_ mm/min. So, with time-frame configured to 30 minutes and a value of 5, the expected rain is 5 mm in 30 minutes, which is the same as 10 mm/h. If time-frame is set to 90 minutes and a value of 5, the expected rain is 5 mm in 90 minutes, which is equal to 3.3 mm/h.
-- **Irradiance**: "Sun intensity in Watt per square meter ([W/m2](https://en.wikipedia.org/wiki/W/m2))."
-- **Rain last 24h**: The rain over the last 24 hours (in mm).
-- **Rain last hour**: The rain over the last hour (in mm).
-- **Temperature n days ahead**: "The forecasted temperature n days ahead (in [C](https://en.wikipedia.org/wiki/Celsius))."
-- **Minimum temperature n days ahead**: "The forecasted minimum temperature n days ahead (in [C](https://en.wikipedia.org/wiki/Celsius))."
-- **Rain chance n days ahead**: The forecasted chance for rain n days ahead (%).
-- **Sun chance n days ahead**: The forecasted chance for sun n days ahead (%).
-- **Rain n days ahead**: "The forecasted amount of rain in [mm](https://en.wikipedia.org/wiki/Millimeter) n days ahead; the average of minrain_1d and maxrain_1d."
-- **Minimum rain n days ahead**: "The minimum forecasted amount of rain in [mm](https://en.wikipedia.org/wiki/Millimeter) n days ahead."
-- **Maximum rain n days ahead**: "The maximum forecasted amount of rain in [mm](https://en.wikipedia.org/wiki/Millimeter) n days ahead."
-- **Wind azimuth n days ahead**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise for n days ahead. (derived from winddirection_1d)
-- **Wind direction n days ahead**: "Where the wind will be coming from n days ahead: N (North), Z (south), NO (North-East), etc."
-- **Wind force n days ahead**: "The expected windforce in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale) n days ahead."
-- **Wind speed n days ahead**: "The expected windspeed in [m/s](https://en.wikipedia.org/wiki/M/s) n days ahead (derived from windforce_1d)."
-- **Condition code n days ahead**: Symbol and condition code of the expected condition n days ahead.
-- **Condition n days ahead**: Symbol and expected condition n days ahead.
-- **Detailed condition n days ahead**: Symbol and detailed expected condition n days ahead.
-- **Full condition (english) n days ahead**: Symbol and full expected condition n days ahead (in English).
-- **Full condition (dutch) n days ahead**: Symbol and full expected condition n days ahead (in Dutch).
+- **Station name**: The name of the selected meteo-station
+- **Barometer forecast**: A numeric barometric forecast (1 to 7)
+- **Barometer forecast name**: A textual representation of the barometer forecast (eg: Thunderstorms, Stable, etc.)
+- **Condition code**: A symbol and a unique code identifying the current weather condition (`[a..z]`)
+- **Condition**: A symbol and the current weather condition (`clear`, `cloudy`, `fog`, `rainy`, `snowy` or `lightning`)
+- **Condition detailed**: A symbol and detailed current weather condition (`clear`, `partlycloudy`, `cloudy`, `partlycloudy-fog`, `partlycloudy-light-rain`, `partlycloudy-rain`, `light-rain`, `rainy`, `snowy-rainy`, `partlycloudy-light-snow`, `partlycloudy-snow`, `light-snow`, `snowy`, `partlycloudy-lightning` or `lightning`)
+- **Condition exact**: A symbol with the full current weather condition (in English)
+- **Symbol**: A symbol for the current weather with the full current condition (in Dutch)
+- **Feel temperature**: The current wind chill factor (in [°C](https://en.wikipedia.org/wiki/Celsius))
+- **Humidity**: The relative humidity (in %)
+- **Temperature**: The current temperature (in [°C](https://en.wikipedia.org/wiki/Celsius))
+- **Ground temperature**: The current ground temperature (in [°C](https://en.wikipedia.org/wiki/Celsius))
+- **Wind speed**: The wind speed (in [km/h](https://en.wikipedia.org/wiki/Kilometres_per_hour))
+- **Wind force**: The wind speed/force (in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale))
+- **Wind direction**: Where the wind is coming from: N (North), Z (south), NO (North-East), etc.
+- **Wind azimuth**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise
+- **Pressure**: The sea-level air pressure (in [hPa](https://en.wikipedia.org/wiki/Hectopascal))
+- **Visibility**: Visibility (in [m](https://en.wikipedia.org/wiki/Metre))
+- **Wind gust**: The wind speed of wind gusts ([km/h](https://en.wikipedia.org/wiki/Kilometres_per_hour))
+- **Precipitation**: The amount of precipitation/rain (in mm/h)
+- **Precipitation forecast average**: The average expected precipitation/rain within the given time-frame (in mm/h)
+- **Precipitation forecast total**: The total expected precipitation/rain in mm within the given time-frame. The total expected rain in the configured time-frame will be equal to _precipitation_forecast_total_/_timeframe_ mm/min. So, with time-frame configured to 30 minutes and a value of 5, the expected rain is 5 mm in 30 minutes, which is the same as 10 mm/h. If time-frame is set to 90 minutes and a value of 5, the expected rain is 5 mm in 90 minutes, which is equal to 3.3 mm/h.
+- **Irradiance**: Sun intensity in Watt per square meter ([W/m2](https://en.wikipedia.org/wiki/W/m2))
+- **Rain last 24h**: The rain over the last 24 hours (in [mm](https://en.wikipedia.org/wiki/Millimeter))
+- **Rain last hour**: The rain over the last hour (in [mm](https://en.wikipedia.org/wiki/Millimeter))
+- **Temperature n days ahead**: The forecasted temperature n days ahead (in [°C](https://en.wikipedia.org/wiki/Celsius))
+- **Minimum temperature n days ahead**: The forecasted minimum temperature n days ahead (in [°C](https://en.wikipedia.org/wiki/Celsius))
+- **Rain chance n days ahead**: The forecasted chance for rain n days ahead (in %)
+- **Sun chance n days ahead**: The forecasted chance for sun n days ahead (in %)
+- **Rain n days ahead**: The forecasted amount of rain (in [mm](https://en.wikipedia.org/wiki/Millimeter)) n days ahead; the average of `Minimum rain n days ahead` and `Maximum rain n days ahead`
+- **Minimum rain n days ahead**: The minimum forecasted amount of rain (in [mm](https://en.wikipedia.org/wiki/Millimeter)) n days ahead
+- **Maximum rain n days ahead**: The maximum forecasted amount of rain (in [mm](https://en.wikipedia.org/wiki/Millimeter)) n days ahead
+- **Wind azimuth n days ahead**: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise for n days ahead (derived from `Wind direction n days ahead`)
+- **Wind direction n days ahead**: Where the wind will be coming from n days ahead: N (North), Z (south), NO (North-East), etc.
+- **Wind force n days ahead**: The expected wind force (in [Bft](https://en.wikipedia.org/wiki/Beaufort_scale)) n days ahead
+- **Wind speed n days ahead**: The expected wind speed (in [m/s](https://en.wikipedia.org/wiki/M/s)) n days ahead (derived from `Wind force n days ahead`)
+- **Condition code n days ahead**: Symbol and condition code of the expected condition n days ahead
+- **Condition n days ahead**: Symbol and expected condition n days ahead
+- **Detailed condition n days ahead**: Symbol and detailed expected condition n days ahead
+- **Full condition (english) n days ahead**: Symbol and full expected condition n days ahead (in English)
+- **Full condition (dutch) n days ahead**: Symbol and full expected condition n days ahead (in Dutch)
{% include integrations/option_flow.md %}
@@ -98,5 +98,9 @@ timeframe:
description: Minutes to look ahead for precipitation forecast sensors (minimum 5, maximum 120).
{% endconfiguration_basic %}
-_[Usage statement:](https://www.buienradar.nl/overbuienradar/gratis-weerdata)
-Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for **non-commercial purposes**. Please refer to the full usage statement linked above to confirm your use or to request permission._
+
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
+
+**Usage statement**
+Buienradar makes free weather data available for use by individuals and businesses (website/intranet). The use of the weather data is allowed for **non-commercial purposes**. Please refer to the [full usage statement](https://www.buienradar.nl/overbuienradar/gratis-weerdata) to confirm your use or to request permission.
+
+
diff --git a/source/_integrations/camera.markdown b/source/_integrations/camera.markdown
index d1beb3acfb3..6a5e5d1185f 100644
--- a/source/_integrations/camera.markdown
+++ b/source/_integrations/camera.markdown
@@ -21,7 +21,6 @@ The `Preload stream` option will start the camera feed on Home Assistant startup
Example showing the Preload Stream option in the camera dialog.
-
### Services
Once loaded, the `camera` platform will expose services that can be called to perform various actions.
diff --git a/source/_integrations/cast.markdown b/source/_integrations/cast.markdown
index d9179ee1e37..a393f487d6e 100644
--- a/source/_integrations/cast.markdown
+++ b/source/_integrations/cast.markdown
@@ -44,6 +44,7 @@ cast_downstairs_on_kitchen:
view_path: downstairs
service: cast.show_lovelace_view
```
+
Home Assistant Cast requires your Home Assistant installation to be accessible via `https://`. If you're using Home Assistant Cloud, you don't need to do anything. Otherwise you must make sure that you have configured the `external_url` in your [configuration](/docs/configuration/basic).
@@ -145,7 +146,7 @@ Optional:
- `media_type`: Media type, e.g. `video/mp4`, `audio/mp3`, `image/jpeg`, defaults to `video/mp4`.
-#### Example:
+#### Example
```yaml
'cast_bubbleupnp_to_my_chromecast':
@@ -178,7 +179,7 @@ Optional:
- `enqueue`: Enqueue only
- `playlist_id`: Play video with `media_id` from this playlist
-#### Example:
+#### Example
```yaml
'cast_youtube_to_my_chromecast':
@@ -201,16 +202,18 @@ Optional:
#### Media parameters
Mandatory:
+
- `app_name`: `supla`
- `media_id`: Supla item ID
-
Optional:
+
- `is_live`: Item is a livestream
-#### Example:
+#### Example
Example values to cast the item at
+
```yaml
'cast_supla_to_my_chromecast':
alias: "Cast supla to My Chromecast"
@@ -258,7 +261,7 @@ Optional:
- `is_live`: Item is a live stream
-#### Example:
+#### Example
Example values to cast [BBC Radio 1](https://www.bbc.co.uk/sounds/play/live:bbc_radio_one)
@@ -290,8 +293,10 @@ This app doesn't retrieve its own metadata, so if you want the cast interface or
Note: Media ID is NOT the 8 digit alphanumeric in the URL, it can be found by right-clicking the playing video. E.g., [this episode](https://www.bbc.co.uk/iplayer/episode/b09w7fd9/bitz-bob-series-1-1-castle-makeover) shows:
- 2908kbps | dash (mf_cloudfront_dash_https)
- b09w70r2 | 960x540
+| | |
+| --- | --- |
+| 2908kbps | dash (mf_cloudfront_dash_https) |
+| b09w70r2 | 960x540 |
With b09w70r2 being the `media_id`
@@ -306,7 +311,7 @@ Optional:
- `is_live`: Item is a live stream
-#### Example:
+#### Example
Example values to cast [this episode](https://www.bbc.co.uk/iplayer/episode/b09w7fd9/bitz-bob-series-1-1-castle-makeover)
diff --git a/source/_integrations/channels.markdown b/source/_integrations/channels.markdown
index 026fd6dcfec..40265c4065b 100644
--- a/source/_integrations/channels.markdown
+++ b/source/_integrations/channels.markdown
@@ -14,6 +14,8 @@ The Channels platform allows you to control [Channels](https://getchannels.com/)
Your favorite channels will appear as sources in the Source List in Home Assistant.
+## Configuration
+
To add Channels to your installation, add the following to your `configuration.yaml` file:
```yaml
@@ -49,7 +51,6 @@ Seek forward by the number of seconds currently set in settings on the instance
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String that points at `entity_id` of Channels app.
-
### Service `seek_backward`
Seek backward by the number of seconds currently set in settings on the instance of Channels.
diff --git a/source/_integrations/cisco_webex_teams.markdown b/source/_integrations/cisco_webex_teams.markdown
index 672e2f47381..28273076057 100644
--- a/source/_integrations/cisco_webex_teams.markdown
+++ b/source/_integrations/cisco_webex_teams.markdown
@@ -14,17 +14,22 @@ ha_platforms:
The `cisco_webex_teams` notification platform allows you to deliver rich notifications from Home Assistant to [Cisco Webex Teams](https://www.webex.com/team-collaboration.html) (formerly known as Cisco Spark).
-To use this notification platform you will need an app (bot) token. To obtain a token visit [Cisco Webex for Developers](https://developer.webex.com/).
+To use this notification platform you will need an app (bot) token. To obtain a token visit [Cisco Webex for Developers](https://developer.webex.com/).
+
* Detailed instructions can be found in the section titled **Creating a Webex Teams Bot** on the [Webex Teams bot documentation](https://developer.webex.com/docs/bots).
You also need to specify the `room_id` that you wish to post messages into. The `room_id` can be found in one of two ways:
-1. Logging in at [Cisco Webex for Developers](https://developer.webex.com/) and navigate to `Documentation`>`API Reference`>`Messages` and select List Messages, or
-2. Log into the web client at [teams.webex.com](https://teams.webex.com/),
- * select the room (or create a new room),
- * then copying the room ID from the URL.
-
-**Note:** you must add the bot email (in the format `mybot@webex.bot`) as a participant to the room specified above.
+1. Logging in at [Cisco Webex for Developers](https://developer.webex.com/) and navigate to `Documentation`>`API Reference`>`Messages` and select List Messages, or
+2. Log into the web client at [teams.webex.com](https://teams.webex.com/),
+ * select the room (or create a new room),
+ * then copying the room ID from the URL.
+
+
-The [Z-Wave](https://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.
+The [Z-Wave](https://www.z-wave.com/) integration for Home Assistant allows you to observe and control connected Z-Wave devices.
+
+## Quick start
+
+To add Z-Wave to your installation, plug the Z-Wave stick into the device that runs Home Assistant. Then Go to Configuration >> Integrations in the UI. Click the "Add integration" button in the bottom right and from the list of integrations, select "Z-Wave" and follow the instructions shown.
+
+For more information, please see the [detailed installation instructions](#detailed-installation-instructions).
+
+## Device support
There is currently support for the following device types within Home Assistant:
-- Binary Sensor
+- [Binary Sensor](#binary-sensor)
- [Climate](#climate)
- [Cover](#cover)
- Fan
@@ -50,18 +58,14 @@ There is currently support for the following device types within Home Assistant:
- Sensor
- Switch
-## Configuration
+### Binary Sensor
-If you have setup the requirements, then add the following entry `configuration.yaml` file:
+In order for Home Assistant to recognize motion or alarm sensors properly, you will need to change the sensor configuration from `Basic Set (default)` to `Binary Sensor report` or `Alarm report`.
+These devices will either show as a binary sensor or a sensor called `Alarm xxxx` and will report a numeric value. Test to see what value is what. Sometimes this is noted in the device manual.
-```yaml
-# Example configuration.yaml entry
-zwave:
-```
+You can set the settings of the Z-Wave device through the Z-Wave control panel.
-## Climate
-
-To get your Z-Wave thermostat or HVAC unit working with Home Assistant, follow the instructions for the general [Z-Wave component](/getting-started/z-wave/).
+### Climate
+
+You must add the bot email (in the format `mybot@webex.bot`) as a participant to the room specified above.
+
+
To enable this platform in your installation, add the following to your `configuration.yaml` file:
@@ -39,7 +44,7 @@ notify:
## Rich Text Formatting
-Webex Teams clients can render rich text via a whitelisted set of html tags.
+Webex Teams clients can render rich text via a whitelisted set of html tags.
For example, you could configure automations to display details in an easy to read fashion like so:
@@ -113,8 +118,8 @@ Here are the automations for the above screenshot:
The following is a list of the allowed html tags and attributes:
Tag | More Info
---- | ---
-`<@personEmail:email@examplecompany.com>` | Used to tag another Webex Team user by email address.
+--- | ---
+`<@personEmail:email@examplecompany.com>` | Used to tag another Webex Team user by email address.
`` | Defines a hyperlink. Allows attribute `href`.
`` | Defines a section that is quoted from another source. Allows attribute `class` with allowed values `danger`, `warning`, `info`, `primary`, `secondary`. `` | Defines bold text. diff --git a/source/_integrations/citybikes.markdown b/source/_integrations/citybikes.markdown index c26b4f413a1..01f22a3de4f 100644 --- a/source/_integrations/citybikes.markdown +++ b/source/_integrations/citybikes.markdown @@ -52,7 +52,6 @@ stations: type: list {% endconfiguration %} - ## Example Additional configuration samples: diff --git a/source/_integrations/climate.mqtt.markdown b/source/_integrations/climate.mqtt.markdown index 24975ebeeb0..d30809f571c 100644 --- a/source/_integrations/climate.mqtt.markdown +++ b/source/_integrations/climate.mqtt.markdown @@ -366,11 +366,11 @@ value_template: required: false {% endconfiguration %} -#### Optimistic mode +## Optimistic mode If a property works in *optimistic mode* (when the corresponding state topic is not set), Home Assistant will assume that any state changes published to the command topics did work and change the internal state of the entity immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the entity is only updated when the requested update is confirmed by the device through the state topic. -#### Using Templates +## Using Templates For all `*_state_topic`s, a template can be specified that will be used to render the incoming payloads on these topics. Also, a default template that applies to all state topics can be specified as `value_template`. This can be useful if you received payloads are e.g., in JSON format. Since in JSON, a quoted string (e.g., `"foo"`) is just a string, this can also be used for unquoting. @@ -395,9 +395,9 @@ climate: This will parse the incoming `"auto"` as JSON, resulting in `auto`. Obviously, in this case you could also just set `value_template: {% raw %}"{{ value_json }}"{% endraw %}`. -Similarly for `*_command_topic`s, a template can be specified to render the outgoing payloads on these topics. +Similarly for `*_command_topic`s, a template can be specified to render the outgoing payloads on these topics. -### Example +## Example A full configuration example looks like the one below. diff --git a/source/_integrations/cloudflare.markdown b/source/_integrations/cloudflare.markdown index d3901f617fd..0530a80146c 100644 --- a/source/_integrations/cloudflare.markdown +++ b/source/_integrations/cloudflare.markdown @@ -55,6 +55,7 @@ This platform uses the API from [ipify.org](https://www.ipify.org/) to set the p ### Home Assistant Companion App If you would like to use [iOS App](https://companion.home-assistant.io/) via Cloudflare set **Minimum TLS version as 1.2**, in order to do that, do the following: + 1. Login to your [Cloudflare](https://dash.cloudflare.com/) account. 2. Choose your domain. 3. Click on the `SSL/TLS` icon. diff --git a/source/_integrations/command_line.markdown b/source/_integrations/command_line.markdown index 233d9a26c07..97e73861dc5 100644 --- a/source/_integrations/command_line.markdown +++ b/source/_integrations/command_line.markdown @@ -119,7 +119,7 @@ binary_sensor: payload_off: "fail" ``` -Consider to use the [`ping` sensor ](/integrations/ping#binary-sensor) as an alternative to the samples above. +Consider to use the [ping sensor](/integrations/ping#binary-sensor) as an alternative to the samples above. ### Check if a system service is running diff --git a/source/_integrations/control4.markdown b/source/_integrations/control4.markdown index 07a469d9b7b..a919eb2ebb4 100644 --- a/source/_integrations/control4.markdown +++ b/source/_integrations/control4.markdown @@ -20,6 +20,7 @@ The Control4 integration allows you to control and monitor lights from your loca Before setting up, you should assign a static IP address/DHCP reservation on your router to your Control4 controller. Home Assistant must be able to communicate with the controller over the local network; 4Sight remote access is not supported. {% include integrations/config_flow.md %} + ## Options The Control4 integration offers additional options in **Configuration** -> **Integrations** -> **Control4** -> **Options**: diff --git a/source/_integrations/conversation.markdown b/source/_integrations/conversation.markdown index 0c94100e1dc..ed7d8354ef4 100644 --- a/source/_integrations/conversation.markdown +++ b/source/_integrations/conversation.markdown @@ -94,7 +94,7 @@ intent_script: {% endraw %} -#### Service `conversation.process` +## Service `conversation.process` | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------| diff --git a/source/_integrations/dsmr.markdown b/source/_integrations/dsmr.markdown index 36db24aa81e..0a8d32bd63a 100644 --- a/source/_integrations/dsmr.markdown +++ b/source/_integrations/dsmr.markdown @@ -57,6 +57,7 @@ This integration is known to work for: - Kaifa E0026 - Kamstrup 382JxC (DSMR 2.2) - Sagemcom XS210 ESMR5 +- Sagemcom T211 - Ziv E0058 ESMR5 ### Connecting to the meter diff --git a/source/_integrations/ecobee.markdown b/source/_integrations/ecobee.markdown index b2e1b705356..f65f11165c8 100644 --- a/source/_integrations/ecobee.markdown +++ b/source/_integrations/ecobee.markdown @@ -98,6 +98,11 @@ name: required: false default: "`notify`" type: string +index: + description: If you have multiple thermostats, you can specify which one to send the notification to by setting an `index`. The index values assigned to the thermostats are consecutive integers, starting at 0. + required: false + default: 0 + type: integer {% endconfiguration %} To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_integrations/garadget.markdown b/source/_integrations/garadget.markdown index 43c90b52824..79c061fa67f 100644 --- a/source/_integrations/garadget.markdown +++ b/source/_integrations/garadget.markdown @@ -81,19 +81,15 @@ cover: access_token: !secret garadget_access_token name: Garage door -sensor: - - platform: template - sensors: - garage_door_status: - friendly_name: "State of the door" - value_template: "{{ states('cover.garage_door') }}" - garage_door_time_in_state: - friendly_name: "Since" - value_template: "{{ state_attr('cover.garage_door', 'time_in_state') }}" - garage_door_wifi_signal_strength: - friendly_name: "WiFi strength" - value_template: "{{ state_attr('cover.garage_door', 'wifi_signal_strength') }}" - unit_of_measurement: "dB" +template: + - sensor: + - name: Garage door state + state: "{{ states('cover.garage_door') }}" + - name: Garage door state since + state: "{{ state_attr('cover.garage_door', 'time_in_state') }}" + - name: Garage door WiFi signal strength + state: "{{ state_attr('cover.garage_door', 'wifi_signal_strength') }}" + unit_of_measurement: "dB" group: garage_door: diff --git a/source/_integrations/calendar.google.markdown b/source/_integrations/google.markdown similarity index 93% rename from source/_integrations/calendar.google.markdown rename to source/_integrations/google.markdown index c77ae6ff944..9318be436bd 100644 --- a/source/_integrations/calendar.google.markdown +++ b/source/_integrations/google.markdown @@ -34,10 +34,9 @@ Generate a Client ID and Client Secret on 1. You will then be automatically taken to the OAuth consent screen, you do not need to add any scopes here so click `SAVE AND CONTINUE` to move to the `Test users` page. You will need to add the Gmail address you will be using with this integration as a test user before you will be allowed to use the API. Once you have added your email address under `Test users` click `SAVE AND CONTINUE` which will take to the 'Summary' page (you do not need to do anything here). 1. Click Credentials in the menu on the left hand side of the screen, then click `+ Create credentials` (at the top of the screen), then select `OAuth client ID`. 1. Set the Application type to `TV and Limited Input` and give this credential set a name (like "Home Assistant Credentials") then click 'Create'. -1. You will then be presented with a pop-up saying 'OAuth client created' showing `Your Client ID` and `Your Client Secret`. Make a note of these (for example, copy and paste them into a text editor) as you will need to put these in your `configuration.yaml` file shortly. Once you have noted these strings, click `OK`. If you need to find these credentials again at any point then simply nagivate to `APIs & Services` > `Credentials` and you will see `Home Assistant Credentials` (or whatever you named them in the previous step) under `OAuth 2.0 Clident IDs`. To view both the `Client ID` and `Client secret`, click on the pencil icon, this will take you to the settings page for these credentials and the information will be on the right hand side of the page. +1. You will then be presented with a pop-up saying 'OAuth client created' showing `Your Client ID` and `Your Client Secret`. Make a note of these (for example, copy and paste them into a text editor) as you will need to put these in your `configuration.yaml` file shortly. Once you have noted these strings, click `OK`. If you need to find these credentials again at any point then simply navigate to `APIs & Services` > `Credentials` and you will see `Home Assistant Credentials` (or whatever you named them in the previous step) under `OAuth 2.0 Clident IDs`. To view both the `Client ID` and `Client secret`, click on the pencil icon, this will take you to the settings page for these credentials and the information will be on the right hand side of the page. 1. We need to double check that the "Google Calendar API" has been automatically enabled. To do this, select `Library` from the menu, then search for "Google Calendar API". If it is enabled you will see `API Enabled` with a green tick next to it. If it is not enabled, then enable it. - If you will later be adding more scopes than just the "Google Calendar API" to the OAuth for this application, you will need to delete your token file under your Home Assistant Profile. You will lose your refresh token due to the re-authenticating to add more API access. It's recommended to use different authorizations for different pieces of Google. ## Troubleshooting @@ -173,17 +172,15 @@ entities: default: true {% endconfiguration %} - - ### Sensor attributes - - **offset_reached**: If set in the event title and parsed out will be `on`/`off` once the offset in the title in minutes is reached. So the title `Very important meeting #Important !!-10` would trigger this attribute to be `on` 10 minutes before the event starts. - - **all_day**: `true`/`false` if this is an all day event. Will be `false` if there is no event found. - - **message**: The event title with the `search` and `offset` values extracted. So in the above example for **offset_reached** the **message** would be set to `Very important meeting` - - **description**: The event description. - - **location**: The event Location. - - **start_time**: Start time of event. - - **end_time**: End time of event. +- **offset_reached**: If set in the event title and parsed out will be `on`/`off` once the offset in the title in minutes is reached. So the title `Very important meeting #Important !!-10` would trigger this attribute to be `on` 10 minutes before the event starts. +- **all_day**: `true`/`false` if this is an all day event. Will be `false` if there is no event found. +- **message**: The event title with the `search` and `offset` values extracted. So in the above example for **offset_reached** the **message** would be set to `Very important meeting` +- **description**: The event description. +- **location**: The event Location. +- **start_time**: Start time of event. +- **end_time**: End time of event. ### Service `google.add_event` diff --git a/source/_integrations/hassio.markdown b/source/_integrations/hassio.markdown new file mode 100644 index 00000000000..c8beaf282c4 --- /dev/null +++ b/source/_integrations/hassio.markdown @@ -0,0 +1,137 @@ +--- +title: Supervisor +description: Control Supervisor Add-ons and OS from Home Assistant +ha_category: + - Binary Sensor + - Sensor +ha_iot_class: Local Polling +ha_release: 2021.4 +ha_domain: hassio +ha_platforms: + - binary_sensor + - sensor +--- + +Supervisor integration allows you to monitor and control Supervisor add-ons and operating system from Home Assistant. +This integration is installed automatically if you run Home Assistant OS or Supervised. + +## Sensors + +For each installed add-on Supervisor provides following sensors: + +| Sensor | Enabled by default | Description | +| ------- | ------------------ | ----------- | +| Version | no | Current version of the add-on +| Newest Version | no | Latest version of the add-on currently available + +For Home Assistant OS Supervisor provides following sensors: + +| Sensor | Enabled by default | Description | +| ------- | ------------------ | ----------- | +| Version | no | Current version of the Home Assistant OS +| Newest Version | no | Latest version of the Home Assistant OS currently available + +## Binary Sensors + +For each installed add-on Supervisor provides following binary sensors: + +| Sensor | Enabled by default | Description | +| ------- | ------------------ | ----------- | +| Update Available | no | Whether there is an update available for this add-on + +For Home Assistant OS Supervisor provides following binary sensors: + +| Sensor | Enabled by default | Description | +| ------- | ------------------ | ----------- | +| Update Available | no | Whether there is an update available for OS + +## Services + +### Service hassio.addon_start + +Start an add-on. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `addon` | no | Add-on slug + +### Service hassio.addon_stop + +Stop an add-on. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `addon` | no | Add-on slug + +### Service hassio.addon_restart + +Restart an add-on. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `addon` | no | Add-on slug + +### Service hassio.addon_stdin + +Write data to add-on stdin. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `addon` | no | Add-on slug + +### Service hassio.addon_update + +Update add-on. This service should be used with caution since add-on updates can contain breaking changes. It is highly recommended that you review release notes/change logs before updating an add-on. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `addon` | no | Add-on slug + +### Service hassio.host_reboot + +Reboot the host system. + +### Service hassio.host_shutdown + +Shutdown the host system. + +### Service hassio.backup_full + +Create a full backup. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `name` | yes | Name of the backup file. Default is current date and time +| `password` | yes | Optional password for backup + +### Service hassio.backup_partial + +Create a partial backup. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `addons` | yes | List of add-on slugs to backup +| `folders` | yes | List of directories to backup +| `name` | yes | Name of the backup file. Default is current date and time +| `password` | yes | Optional password for backup + +### Service hassio.restore_full + +Restore from full backup. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `slug` | no | Slug of backup to restore from +| `password` | yes | Optional password for backup + +### Service hassio.restore_partial + +Restore from partial backup. + +| Service Data Attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `slug` | no | Slug of backup to restore from +| `homeassistant` | yes | Whether to restore Home Assistant, `true` or `false` +| `addons` | yes | List of add-on slugs to restore +| `folders` | yes | List of directories to restore +| `password` | yes | Optional password for backup diff --git a/source/_integrations/hikvision.markdown b/source/_integrations/hikvision.markdown index cfb480fb517..76c1376a723 100644 --- a/source/_integrations/hikvision.markdown +++ b/source/_integrations/hikvision.markdown @@ -62,6 +62,7 @@ and has been confirmed to work with the following models: - DS-2CD2385G1 - IPC-D140H(-M) - DS-7616NI-K2 (NVR) +- ERI-K104-PR (NVR) This platform also was confirmed to work with the following Hikvison-based NVRS @@ -154,6 +155,12 @@ Supported sensor/event types are: - PIR Alarm - Face Detection - Scene Change Detection +- I/O +- Unattended Baggage +- Attended Baggage +- Recording Failure +- Exiting Region +- Entering Region ## Examples diff --git a/source/_integrations/hive.markdown b/source/_integrations/hive.markdown index 1cf937258f3..9cdf832362a 100644 --- a/source/_integrations/hive.markdown +++ b/source/_integrations/hive.markdown @@ -28,6 +28,13 @@ ha_config_flow: true The Hive integration for Home Assistant allows you to interact with supported devices and services offered by [hivehome.com](https://www.hivehome.com) ++ +Please note that Hive shut down its North American Servers on November 30th, 2021. +Read more about this in their [shutdown notice](https://www.hivehome.com/us/support). + ++ This Hive integration uses the same username and password you use on the [Hive website](https://sso.hivehome.com) to configure it within Home Assistant, 2FA authentication is also supported. Once configured Home Assistant will detect and add all Hive devices, including support for multi-zone heating. {% include integrations/config_flow.md %} diff --git a/source/_integrations/iammeter.markdown b/source/_integrations/iammeter.markdown index 13ad92c7eef..ee17703183e 100644 --- a/source/_integrations/iammeter.markdown +++ b/source/_integrations/iammeter.markdown @@ -72,21 +72,21 @@ Sensors available in the library: | wem3080t_power_a | W | A phase active power | | wem3080t_importenergy_a | kWh | A phase import energy | | wem3080t_exportgrid_a | kWh | A phase export energy | -| wem3080t_frequency_a | kWh | A phase frequency | -| wem3080t_pf_a | kWh | A phase power factor | +| wem3080t_frequency_a | hz | A phase frequency | +| wem3080t_pf_a | | A phase power factor | | | | | | wem3080t_voltage_b | V | B phase voltage | | wem3080t_current_b | A | B phase current | | wem3080t_power_b | W | B phase active power | | wem3080t_importenergy_b | kWh | B phase import energy | | wem3080t_exportgrid_b | kWh | B phase export energy | -| wem3080t_frequency_b | kWh | B phase frequency | -| wem3080t_pf_b | kWh | B phase power factor | +| wem3080t_frequency_b | hz | B phase frequency | +| wem3080t_pf_b | | B phase power factor | | | | | | wem3080t_voltage_c | V | C phase voltage | | wem3080t_current_c | A | C phase current | | wem3080t_power_c | W | C phase active power | | wem3080t_importenergy_c | kWh | C phase import energy | | wem3080t_exportgrid_c | kWh | C phase export energy | -| wem3080t_frequency_c | kWh | C phase frequency | -| wem3080t_pf_c | kWh | C phase power factor | +| wem3080t_frequency_c | hz | C phase frequency | +| wem3080t_pf_c | | C phase power factor | diff --git a/source/_integrations/mqtt.markdown b/source/_integrations/mqtt.markdown index 007bccc1948..13aa74193d4 100644 --- a/source/_integrations/mqtt.markdown +++ b/source/_integrations/mqtt.markdown @@ -64,3 +64,9 @@ mqtt: - [Birth and last will messages](/docs/mqtt/birth_will/) - [Testing your setup](/docs/mqtt/testing/) - [Logging](/docs/mqtt/logging/) + +## Event `event_mqtt_reloaded` + +Event `event_mqtt_reloaded` is fired when Manually configured MQTT entities have been reloaded and entities thus might have changed. + +This event has no additional data. diff --git a/source/_integrations/pvoutput.markdown b/source/_integrations/pvoutput.markdown index 9629d471fbf..62c1c00f6f4 100644 --- a/source/_integrations/pvoutput.markdown +++ b/source/_integrations/pvoutput.markdown @@ -49,24 +49,20 @@ sensor: - platform: pvoutput system_id: YOUR_SYSTEM_ID api_key: YOUR_API_KEY - - platform: template - sensors: - power_consumption: - value_template: "{% if is_state_attr('sensor.pvoutput', 'power_consumption', 'NaN') %}0{% else %}{{ state_attr('sensor.pvoutput', 'power_consumption') }}{% endif %}" - friendly_name: "Using" - unit_of_measurement: "Watt" - energy_consumption: - value_template: '{{ "%0.1f"|format(state_attr("sensor.pvoutput", "energy_consumption")|float/1000) }}' - friendly_name: "Used" - unit_of_measurement: "kWh" - power_generation: - value_template: '{% if is_state_attr("sensor.pvoutput", "power_generation", "NaN") %}0{% else %}{{ state_attr("sensor.pvoutput", "power_generation") }}{% endif %}' - friendly_name: "Generating" - unit_of_measurement: "Watt" - energy_generation: - value_template: '{% if is_state_attr("sensor.pvoutput", "energy_generation", "NaN") %}0{% else %}{{ "%0.2f"|format(state_attr("sensor.pvoutput", "energy_generation")|float/1000) }}{% endif %}' - friendly_name: "Generated" - unit_of_measurement: "kWh" +template: + - sensor: + - name: Power Consumption + state: "{{ state_attr('sensor.pvoutput', 'power_consumption') | float(default=0) }}" + unit_of_measurement: "W" + - name: Energy Consumption + state: "{{ '%0.1f' | format(state_attr('sensor.pvoutput', 'energy_consumption') | float(default=0) / 1000) }}" + unit_of_measurement: "kWh" + - name: Power Generation + state: "{{ state_attr('sensor.pvoutput', 'power_generation') | float(default=0) }}" + unit_of_measurement: "W" + - name: Energy Generation + state: "{{ '%0.2f' | format(state_attr('sensor.pvoutput', 'energy_generation') | float(default=0) / 1000) }}" + unit_of_measurement: "kWh" ``` {% endraw %} diff --git a/source/_integrations/serial.markdown b/source/_integrations/serial.markdown index 8deca5a02ad..1a2f3461ed2 100644 --- a/source/_integrations/serial.markdown +++ b/source/_integrations/serial.markdown @@ -139,20 +139,17 @@ sensor: serial_port: /dev/ttyUSB0 baudrate: 9600 - - platform: template - sensors: - my_temperature_sensor: - friendly_name: Temperature - unit_of_measurement: "°C" - value_template: "{{ states('sensor.serial_sensor').split(',')[1] | float }}" - my_humidity_sensor: - friendly_name: Humidity - unit_of_measurement: "%" - value_template: "{{ states('sensor.serial_sensor').split(',')[2] | float }}" - my_barometer: - friendly_name: Barometer - unit_of_measurement: "mbar" - value_template: "{{ states('sensor.serial_sensor').split(',')[4] | float }}" +template: + sensor: + - name: Temperature + unit_of_measurement: "°C" + state: "{{ states('sensor.serial_sensor').split(',')[1] | float(default=0) }}" + - name: Humidity + unit_of_measurement: "%" + state: "{{ states('sensor.serial_sensor').split(',')[2] | float(default=0) }}" + - name: Barometer + unit_of_measurement: "mbar" + state: "{{ states('sensor.serial_sensor').split(',')[4] | float(default=0) }}" ``` {% endraw %} diff --git a/source/_integrations/solax.markdown b/source/_integrations/solax.markdown index 7a416e4a34f..33ec8d6fa78 100644 --- a/source/_integrations/solax.markdown +++ b/source/_integrations/solax.markdown @@ -46,17 +46,14 @@ If you would like to convert the values from multiple panels or view the total p ```yaml # Example configuration.yaml entry for template platform -sensors: -- platform: template - sensors: - total_pv_power: - friendly_name: "Total PV Power" - unit_of_measurement: "W" - value_template: "{{ (states('sensor.pv1_power') | float) + (states('sensor.pv2_power') | float) }}" - load_power: - friendly_name: "Load Power" - unit_of_measurement: "W" - value_template: "{{ (states('sensor.power_now') | float) - (states('sensor.exported_power') | float) }}" +template: +- sensor + - name: Total PV power + unit_of_measurement: "W" + state: "{{ (states('sensor.pv1_power') | float(default=0)) + (states('sensor.pv2_power') | float(default=0)) }}" + - name: Load power + unit_of_measurement: "W" + state: "{{ (states('sensor.power_now') | float(default=0)) - (states('sensor.exported_power') | float(default=0)) }}" ``` {% endraw %} diff --git a/source/_integrations/sql.markdown b/source/_integrations/sql.markdown index 4b66572a94f..e9902d41c41 100644 --- a/source/_integrations/sql.markdown +++ b/source/_integrations/sql.markdown @@ -106,10 +106,19 @@ Note that the SQL sensor state corresponds to the last row of the SQL result set ### Previous state of an entity -This example only works with *binary_sensors*: - +Based on previous example with temperature, the query to get the former state is : ```sql -SELECT * FROM states WHERE entity_id = 'binary_sensor.xyz789' GROUP BY state ORDER BY last_changed DESC LIMIT 1; +SELECT * FROM (SELECT * FROM states WHERE entity_id = 'sensor.temperature_in' ORDER BY state_id DESC LIMIT 2) two_entity ORDER BY state_id ASC LIMIT 1; +``` +Thus in yaml +```yaml +# Example configuration.yaml +sensor: + - platform: sql + queries: + - name: Former_Temperature_In + query: "SELECT * FROM (SELECT state FROM states WHERE entity_id = 'sensor.temperature_in' ORDER BY state_id DESC LIMIT 2) two_entity ORDER BY state_id ASC LIMIT 1;" + column: "state" ``` ### Database size diff --git a/source/_integrations/template.markdown b/source/_integrations/template.markdown index 40e1c2f53a3..58cb885decd 100644 --- a/source/_integrations/template.markdown +++ b/source/_integrations/template.markdown @@ -709,3 +709,9 @@ sensor: type: device_class default: None {% endconfiguration %} + +## Event `event_template_reloaded` + +Event `event_template_reloaded` is fired when Template entities have been reloaded and entities thus might have changed. + +This event has no additional data. diff --git a/source/_integrations/tuya.markdown b/source/_integrations/tuya.markdown index 7363406aad5..9a3432e1811 100644 --- a/source/_integrations/tuya.markdown +++ b/source/_integrations/tuya.markdown @@ -15,6 +15,7 @@ ha_codeowners: - '@Tuya' - '@zlinoliver' - '@METISU' + - '@tsutsuku' ha_platforms: - climate - fan @@ -44,9 +45,9 @@ This is a separate account to the one you made for the app. You cannot log in wi ### Create a project 1. Log in to the [Tuya IoT Platform](https://iot.tuya.com/). -2. In the left navigation bar, click `Cloud` > `Development`. If this is your first time setting up an account you will be asked to subscribe to a Cloud Development Plan. You can select and "purchase" the Trial Edition (it's free). +2. In the left navigation bar, click `Cloud` > `Development`. 3. On the page that appears, click `Create Cloud Project`. -4. In the `Create Project` dialog box, configure `Project Name`, `Description`, `Industry`, and `Data Center`. For the `Development Method` field, select `Smart Home` from the dropdown list. For the `Data Center` field, select the zone you are located in. +4. In the `Create Cloud Project` dialog box, configure `Project Name`, `Description`, `Industry`, and `Data Center`. For the `Development Method` field, select `Smart Home` from the dropdown list. For the `Data Center` field, select the zone you are located in.  5. Click `Create` to continue with project configuration. 6. In Configuration Wizard, make sure you add `Device Status Notification` API. The list of API should look like this: @@ -99,7 +100,7 @@ Click the created project to enter the `Project Overview` page and get the `Auth description: Incorrect Access ID or Access Secret. Please refer to [Tuya credential table](https://github.com/tuya/tuya-home-assistant/wiki/Install-Tuya-v2?_source=d10de34623e3daca5b02e3c31528a0c4#3-enter-your-tuya-credential). "1106: permission deny": - description: >- + description: > - App account not linked with cloud project: On the [Tuya IoT Platform](https://iot.tuya.com/cloud/), you have linked devices by using Tuya Smart or Smart Life app in your cloud project. For more information, see [Link devices by app account](https://developer.tuya.com/en/docs/iot/Platform_Configuration_smarthome?id=Kamcgamwoevrx&_source=7a356dd493196a01bb9021b7680a2a45#title-3-Link%20devices%20by%20app%20account). - Incorrect username or password: Enter the correct account and password of the Tuya Smart or Smart Life app in the **Account** and **Password** fields. Note that the app account depends on which app (Tuya Smart or Smart Life) you used to link devices on the [Tuya IoT Platform](https://iot.tuya.com/cloud/). @@ -110,28 +111,31 @@ Click the created project to enter the `Project Overview` page and get the `Auth description: Empty parameter of username or app. Fill the parameters refer to [Tuya credential table](https://github.com/tuya/tuya-home-assistant/wiki/Install-Tuya-v2?_source=d10de34623e3daca5b02e3c31528a0c4#3-enter-your-tuya-credential). "2406: skill id invalid": - description: Make sure that your cloud project on the [Tuya IoT Platform](https://iot.tuya.com/cloud/) should be created after May 25, 2021. Otherwise, you need to create a new project or migrate data to a new project. For more information, see [Operation on the Tuya IoT Platform](https://developer.tuya.com/en/docs/iot/migrate-from-an-older-version?id=Kamee9wtbd00b#title-3-Operation%20on%20the%20Tuya%20IoT%20Platform). + description: > + - Make sure you use the **Tuya Smart** or **SmartLife** app account to log in. Also, choose the right data center endpoint related to your country region. For more details, please check [Country Regions and Data Center](https://github.com/tuya/tuya-home-assistant/blob/master/docs/regions_dataCenters.md). + + - Your cloud project on the [Tuya IoT Development Platform](https://iot.tuya.com) should be created after May 25, 2021. Otherwise, you need to create a new project. "28841105: No permissions. This project is not authorized to call this API": description: > Some APIs are not authorized, please [Subscribe](https://developer.tuya.com/en/docs/iot/applying-for-api-group-permissions?id=Ka6vf012u6q76#title-2-Subscribe%20to%20cloud%20products) then [Authorize](https://developer.tuya.com/en/docs/iot/applying-for-api-group-permissions?id=Ka6vf012u6q76#title-3-Authorize%20projects%20to%20call%20the%20cloud%20product). The following APIs must be subscribed for this tutorial: + - Device Status Notification + - Authorization - - Smart Home Devices Management - - - Smart Home Family Management + - IoT Core - Smart Home Scene Linkage - - Smart Home Data Service - - - Device status notification + - IoT Data Analytics {% endconfiguration_basic %} ## Related Documents -- [Supported Device Category](https://github.com/tuya/tuya-home-assistant/wiki/Supported-Device-Category?_source=f5f782752be3c4a9157ec47514d6091b) -- [How to Develop a New Driver](https://github.com/tuya/tuya-home-assistant/wiki/How-to-Develop-a-New-Driver?_source=dbf3bf17966af48325e4328b2535eefe) -- [FAQs](https://github.com/tuya/tuya-home-assistant/wiki/FAQs) +- [Tuya Integration Documentation Page](https://github.com/tuya/tuya-home-assistant) +- [Supported Tuya Device Category](https://github.com/tuya/tuya-home-assistant/blob/master/docs/supported_devices.md) +- [Error Code and Troubleshooting](https://github.com/tuya/tuya-home-assistant/blob/master/docs/error_code.md) +- [Countries/Regions and Tuya Data Center](https://github.com/tuya/tuya-home-assistant/blob/master/docs/regions_dataCenters.md) +- [FAQs](https://github.com/tuya/tuya-home-assistant/blob/master/docs/faq.md) diff --git a/source/_integrations/uk_transport.markdown b/source/_integrations/uk_transport.markdown index d1381452e71..84a115617f4 100644 --- a/source/_integrations/uk_transport.markdown +++ b/source/_integrations/uk_transport.markdown @@ -84,27 +84,22 @@ Attributes can be accessed using the [template sensor](/integrations/template) a ```yaml # Example configuration.yaml entry for a template sensor to access the attributes of the next departing train. -- platform: template - sensors: - next_train_status: - friendly_name: "Next train status" - value_template: >- +template: + - sensor: + - name: Next train status + state: >- {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].status}} - next_trains_origin: - friendly_name: "Next train origin" - value_template: >- + - name: Next train origin + state: >- {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].origin_name}} - next_trains_estimated: - friendly_name: "Next train estimated" - value_template: >- + - name: Next train estimated + state: >- {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].estimated}} - next_trains_scheduled: - friendly_name: "Next train scheduled" - value_template: >- + - name: Next train scheduled + state: >- {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].scheduled}} - next_trains_platform: - friendly_name: "Next train platform" - value_template: >- + - name: Next train platform + state: >- {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].platform}} ``` @@ -141,20 +136,16 @@ And the template sensor for viewing the next bus attributes. ```yaml # Example configuration.yaml entry for a template sensor to access the attributes of the next departing bus. -- platform: template - sensors: - next_bus_route: - friendly_name: "Next bus route" - value_template: "{{state_attr('sensor.next_bus_to_wantage', 'next_buses')[0].route}}" - next_bus_direction: - friendly_name: "Next bus direction" - value_template: "{{state_attr('sensor.next_bus_to_wantage', 'next_buses')[0].direction}}" - next_bus_scheduled: - friendly_name: "Next bus scheduled" - value_template: "{{state_attr('sensor.next_bus_to_wantage', 'next_buses')[0].scheduled}}" - next_bus_estimated: - friendly_name: "Next bus estimated" - value_template: "{{state_attr('sensor.next_bus_to_wantage', 'next_buses')[0].estimated}}" +template: + - sensor: + - name: Next bus route + state: "{{state_attr('sensor.next_bus_to_wantage', 'next_buses')[0].route}}" + - name: Next bus direction + state: "{{state_attr('sensor.next_bus_to_wantage', 'next_buses')[0].direction}}" + - name: Next bus scheduled + state: "{{state_attr('sensor.next_bus_to_wantage', 'next_buses')[0].scheduled}}" + - name: Next bus estimated + state: "{{state_attr('sensor.next_bus_to_wantage', 'next_buses')[0].estimated}}" ``` {% endraw %} diff --git a/source/_integrations/utility_meter.markdown b/source/_integrations/utility_meter.markdown index 42c250e3e51..817aaba49b1 100644 --- a/source/_integrations/utility_meter.markdown +++ b/source/_integrations/utility_meter.markdown @@ -55,8 +55,8 @@ offset: type: time type: integer cron: - description: This option is *mutually exclusive* of `cycle` and `offset`. It provides an advanced method of defining when should the counter be reset. It follows common [crontab syntax](https://crontab.guru). - required: false + description: This option is *mutually exclusive* of `cycle` and `offset`. It provides an advanced method of defining when should the counter be reset. It follows common [crontab syntax](https://crontab.guru) but extended to support more advanced scheduling. See the [croniter](https://github.com/taichino/croniter) library. + required: true type: string net_consumption: description: Set this to True if you would like to treat the source as a net meter. This will allow your counter to go both positive and negative. @@ -172,6 +172,20 @@ automation: entity_id: utility_meter.monthly_energy ``` +Assuming your utility provider cycle is offset from the last day of the month + +- cycles at 17h00 on the last day of the month + +a cron(extended syntax used for last day of month) based utility meter can be used: + +```yaml +utility_meter: + monthly_energy: + source: sensor.energy + name: Monthly Energy + cron: "0 17 L * *" +``` + ## Advanced Configuration for DSMR users When using the [DSMR component](/integrations/dsmr) to get data from the utility meter, each tariff (peak and off-peak) has a separate sensor. Additionally, there is a separate sensor for gas consumption. The meter switches automatically between tariffs, so an automation is not necessary in this case. But, you do have to setup a few more instances of the `utility_meter` component. @@ -212,22 +226,34 @@ utility_meter: cycle: monthly ``` -Additionally, you can add template sensors to compute daily and monthly total usage. +Additionally, you can add template sensors to compute daily and monthly total usage. Important note, in these examples, +we use the `is_number()` [function](/docs/configuration/templating/#numeric-functions-and-filters) to verify the values +returned from the sensors are numeric. If this evalutes to false, `None` is returned. {% raw %} ```yaml -sensor: - - platform: template - sensors: - daily_energy: - friendly_name: Daily Energy - unit_of_measurement: kWh - value_template: "{{ states('sensor.daily_energy_offpeak')|float + states('sensor.daily_energy_peak')|float }}" - monthly_energy: - friendly_name: Monthly Energy - unit_of_measurement: kWh - value_template: "{{ states('sensor.monthly_energy_offpeak')|float + states('sensor.monthly_energy_peak')|float }}" +template: + - sensor: + - name: 'Daily Energy Total' + device_class: energy + unit_of_measurement: kWh + state: > + {% if is_number(states('sensor.daily_energy_offpeak')) and is_number(states('sensor.daily_energy_peak')) %} + {{ (states('sensor.daily_energy_offpeak') + states('sensor.daily_energy_peak')) | float }} + {% else %} + None + {% endif %} + + - name: 'Monthly Energy Total' + device_class: energy + unit_of_measurement: kWh + state: > + {% if is_number(states('sensor.monthly_energy_offpeak')) and is_number(states('sensor.monthly_energy_peak')) %} + {{ (states('sensor.monthly_energy_offpeak') + states('sensor.monthly_energy_peak')) | float }} + {% else %} + None + {% endif %} ``` {% endraw %} diff --git a/source/_integrations/withings.markdown b/source/_integrations/withings.markdown index b79f0f27346..1553272687c 100644 --- a/source/_integrations/withings.markdown +++ b/source/_integrations/withings.markdown @@ -127,46 +127,52 @@ In a text editor, replace ```USER_PROFILE_NAME``` in the template sensors below ```yaml # Example configuration.yaml entry -sensor: - - platform: template - sensors: - withings_weight_lbs_USER_PROFILE_NAME: - friendly_name: "withings weight_lbs_USER_PROFILE_NAME" - unit_of_measurement: "lbs" - value_template: "{{ (states('sensor.withings_weight_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185) | round(2, default=0) }}" - icon_template: mdi:weight-pound +template: + - sensor: + - name: Withings weight lbs USER_PROFILE_NAME + unit_of_measurement: "lbs" + state: >- + {{ + (states('sensor.withings_weight_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185) + | round(2, default=0) + }} + icon: "mdi:weight-pound" - - platform: template - sensors: - withings_bone_mass_lbs_USER_PROFILE_NAME: - friendly_name: "withings bone_mass_lbs_USER_PROFILE_NAME" - unit_of_measurement: "lbs" - value_template: "{{ (states('sensor.withings_bone_mass_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185) | round(2, default=0) }}" - icon_template: mdi:weight-pound - - - platform: template - sensors: - withings_fat_free_mass_lbs_USER_PROFILE_NAME: - friendly_name: "withings fat_free_mass_lbs_USER_PROFILE_NAME" - unit_of_measurement: "lbs" - value_template: "{{ (states('sensor.withings_fat_free_mass_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185) | round(2, default=0) }}" - icon_template: mdi:weight-pound - - - platform: template - sensors: - withings_fat_mass_lbs_USER_PROFILE_NAME: - friendly_name: "withings fat_mass_lbs_USER_PROFILE_NAME" - unit_of_measurement: "lbs" - value_template: "{{ (states('sensor.withings_fat_mass_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185) | round(2, default=0) }}" - icon_template: mdi:weight-pound - - - platform: template - sensors: - withings_muscle_mass_lbs_USER_PROFILE_NAME: - friendly_name: "withings muscle_mass_lbs_USER_PROFILE_NAME" - unit_of_measurement: "lbs" - value_template: "{{ (states('sensor.withings_muscle_mass_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185) | round(2, default=0) }}" - icon_template: mdi:weight-pound + - name: Withings bone mass lbs USER_PROFILE_NAME + unit_of_measurement: "lbs" + state: >- + {{ + (states('sensor.withings_bone_mass_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185) + | round(2, default=0) + }} + icon: "mdi:weight-pound" + + - name: Withings fat free mass lbs USER_PROFILE_NAME + unit_of_measurement: "lbs" + state: >- + {{ + (states('sensor.withings_fat_free_mass_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185) + | round(2, default=0) + }} + icon: "mdi:weight-pound" + + - name: Withings fat mass lbs USER_PROFILE_NAME + unit_of_measurement: "lbs" + state: >- + {{ + (states('sensor.withings_fat_mass_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185) + | round(2, default=0) + }} + icon: "mdi:weight-pound" + + - name: Withings muscle mass lbs USER_PROFILE_NAME + unit_of_measurement: "lbs" + state: >- + {{ + (states('sensor.withings_muscle_mass_kg_USER_PROFILE_NAME') | float(0) * 2.20462262185) + | round(2, default=0) + }} + icon: "mdi:weight-pound" ``` {% endraw %} diff --git a/source/_integrations/zwave.markdown b/source/_integrations/zwave.markdown index 7ffd523b611..aa5f1f89deb 100644 --- a/source/_integrations/zwave.markdown +++ b/source/_integrations/zwave.markdown @@ -37,11 +37,19 @@ The Z-Wave integration will no longer receive any updates. The technical depende
@@ -76,7 +80,7 @@ Once enabled, any Z-Wave climate devices will be available to Home Assistant. Mu
- `climate.remotec_zxt120_heating_1_id`: Allows you to control the connected device. See below for examples.
- `sensor.remotec_zxt120_temperature_38`: A sensor which returns the current temperature set on the attached device.
-### Automating Z-Wave Climate Devices
+#### Automating Z-Wave Climate Devices
The following examples will instruct a Remotec ZXT-120 to turn the attached device mode to Heating, and set the temperature at 24 degrees after 8pm. Add it to `automation.yaml`.
@@ -117,7 +121,7 @@ automation:
**Note:** In the example above, the word `Off` is encased in single quotes to be valid YAML.
-### Test if it works
+#### Test if it works
A simple way to test if your Z-Wave climate device is working is to use **Developer Tools** -> **Services**. Choose the applicable Climate service from the list of **Available services:** and enter something like the sample below into the **Service Data** field and then press **CALL SERVICE**.
@@ -126,13 +130,11 @@ entity_id: climate.remotec_zxt120_heating_1_id
hvac_mode: Heat
```
-## Cover
+### Cover
Z-Wave garage doors, blinds, and roller shutters are supported as cover in Home Assistant.
-To get your Z-Wave covers working with Home Assistant, follow the instructions for the general [Z-Wave component](#configuration).
-
-If you discover that you need to [invert the operation](/docs/z-wave/installation/#invert_openclose_buttons) of open/close for a particular device, you may change this behavior in your Z-Wave section of your `configuration.yaml` file as follows, in addition you can also [invert percent position](/docs/z-wave/installation/#invert_percent):
+If you discover that you need to [invert the operation](#invert_openclose_buttons) of open/close for a particular device, you may change this behavior in your Z-Wave section of your `configuration.yaml` file as follows, in addition you can also [invert percent position](#invert_percent):
```yaml
zwave:
@@ -142,9 +144,9 @@ zwave:
invert_percent: true
```
-## Lock
+### Lock
-To get your Z-Wave locks working with Home Assistant, follow the instructions for the general [Z-Wave component](#configuration).
+These devices require a network key to be set for the Z-Wave network before they are paired, using the **Add Node Secure** option.
Z-Wave locks will expose three services under the lock domain to manage usercodes if the lock supports it:
@@ -153,3 +155,2400 @@ Z-Wave locks will expose three services under the lock domain to manage usercode
| clear_usercode | Clears a usercode at code_slot X. Valid code_slots are 1-254, but max is defined by the lock. |
| get_usercode | Get a usercode from the lock at code_slot. Valid code_slots are 1-254, but max is defined by the lock. |
| set_usercode | Sets usercode to X at code_slot Y. Valid usercodes are at least 4 digits, and max defined by the lock. |
+
+Home Assistant stores logs from Z-Wave in `OZW_log.txt` in the Home Assistant configuration directory, when you pair a secure device you should see communication from the node with lines starting with `info: NONCES` in `OZW_log.txt` when the device is paired successfully with a secure connection.
+
+## Services
+
+The `zwave` integration exposes multiple services to help maintain the network. All of these are available through the Z-Wave control panel.
+
+| Service | Description |
+| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| add_node | Put the Z-Wave controller in inclusion mode. Allows you to add a new device to the Z-Wave network. |
+| add_node_secure | Put the Z-Wave controller in secure inclusion mode. Allows you to add a new device with secure communications to the Z-Wave network. |
+| cancel_command | Cancels a running Z-Wave command. If you have started an add_node or remove_node command, and decide you are not going to do it, then this must be used to stop the inclusion/exclusion command. |
+| change_association | Add or remove an association in the Z-Wave network |
+| heal_network | Tells the controller to "heal" the Z-Wave network. Basically asks the nodes to tell the controller all of their neighbors so the controller can re-figure out optimal routing. |
+| heal_node | Tells the controller to "heal" a specific node on the network. Requires `node_id` field. You can also force return route update with `return_routes` field. |
+| print_config_parameter | Prints Z-Wave node's configuration parameter value to the (console) log. |
+| print_node | Print all states of Z-Wave node. |
+| refresh_entity | Refresh the Z-Wave entity by refreshing dependent values. |
+| refresh_node | Refresh the Z-Wave node. |
+| refresh_node_value | Refresh the specified value of a Z-Wave node. |
+| remove_node | Put the Z-Wave controller in exclusion mode. Allows you to remove a device from the Z-Wave network. |
+| rename_node | Sets a node's name. Requires a `node_id` and `name` field. |
+| rename_value | Sets a value's name. Requires a `node_id`, `value_id`, and `name` field. |
+| remove_failed_node | Remove a failed node from the network. The Node should be on the controller's Failed Node List, otherwise this command will fail. |
+| replace_failed_node | Replace a failed device with another. If the node is not in the controller's Failed Node List, or the node responds, this command will fail. |
+| reset_node_meters | Reset a node's meter values. Only works if the node supports this. |
+| set_config_parameter | Lets the user set a configuration parameter to a node. NOTE: Use the parameter option's `label` string as the `value` for list parameters (e.g., `"value": "Off"`). For all other parameters use the relevant integer `value` (e.g., `"value": 1`). |
+| set_node_value | Set the specified value of a Z-Wave node. |
+| soft_reset | Tells the controller to do a "soft reset." This is not supposed to lose any data, but different controllers can behave differently to a "soft reset" command. |
+| start_network | Starts the Z-Wave network. |
+| stop_network | Stops the Z-Wave network. |
+| test_network | Tells the controller to send no-op commands to each node and measure the time for a response. In theory, this can also bring back nodes which have been marked "presumed dead." |
+| test_node | Tells the controller to send no-op command(s) to a specific node. Requires `node_id` field. You can specify amount of test_messages to send by specifying it with `messages` field. In theory, this could bring back nodes marked as "presumed dead" |
+
+The `soft_reset` and `heal_network` commands can be used to help keep a Z-Wave network running reliably. This is a configuration option for the `zwave` component. The option defaults to `false` but can be enabled by setting `autoheal` to true. This, however, is bad practice since it introduces overhead that can be avoided since you only need to do a `heal_network` whenever one of the following actions are done:
+
+- Adding/Removing a new node
+- Moving a node around
+- Moving the Controller
+- Removing a Dead Node
+
+
+
+```
+
+## Central Scene configuration
+
+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
+
+For Inovelli switches, you'll need to update (or possibly add) the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg_*.xml` file with the following:
+
+```xml
+
+
+```
+
+For Inovelli LZW30-SN and LZW31-SN switches with a third button for configuration, you'll need to add a third scene for that under the COMMAND_CLASS_CENTRAL_SCENE CommandClass:
+
+```xml
+
+
+ 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.
+
+
+ LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on.
+
+
+
+
+ Time, in minutes, for auto-off timer delay.
+
+
+
+
+ Set the time (in minutes) after which you want the switch to automatically turn on once it has been turned off.
+
+
+ Choose which physical and Z-Wave triggers should prompt the switch to send a status change report to associated devices.
+
+
+ Status after power failure. Off: always turn light off. On: always turn light on. Restore: remember the latest state and restore that state.
+
+
+ Enable or Disable scene control functionality for quick double tap triggers (Available for select hubs only).
+
+
+ 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.
+
+
+ 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.
+
+
+ Set reporting behavior for disabled physical control.
+
+
+```
+
+Zen22v2 (Dimmer):
+
+```xml
+
+
+ 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.
+
+
+ LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on.
+
+
+
+
+ Time, in minutes, for auto-off timer delay.
+
+
+
+
+ Set the time (in minutes) after which you want the switch to automatically turn on once it has been turned off.
+
+
+ Choose which physical and Z-Wave triggers should prompt the switch to send a status change report to associated devices.
+
+
+ Status after power failure. Off: always turn light off. On: always turn light on. Restore: remember the latest state and restore that state.
+
+
+ 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
+
+
+ Set the minimum brightness level (in %) for your dimmer. You won’t be able to dim the light below the set value. Default: 1
+
+
+ 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
+
+
+ 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.
+
+
+ Enable or Disable scene control functionality for quick double tap triggers.
+
+
+ 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
+
+
+ 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.
+
+
+ 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
+
+
+ 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.
+
+
+ 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
+
+
+ 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.
+
+
+ Choose how you'd like the dimmer to report when paddles are tapped and held and physical / Z-Wave control is enabled or disabled.
+
+
+ Set reporting behavior for disabled physical control.
+
+
+ Set the brightness level the dimmer will turn on to when off and when lower paddle is held DOWN for a second. Default: 20
+
+
+```
+
+Zen26 (On/Off Switch):
+
+```xml
+
+
+ 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.
+
+
+ LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on.
+
+
+
+
+ Time, in minutes, for auto-off timer delay.
+
+
+
+
+ Set the time (in minutes) after which you want the switch to automatically turn on once it has been turned off.
+
+
+ Choose which physical and Z-Wave triggers should prompt the switch to send a status change report to associated devices.
+
+
+ Status after power failure. Off: always turn light off. On: always turn light on. Restore: remember the latest state and restore that state.
+
+
+ Enable or Disable scene control functionality for quick double tap triggers (Available for select hubs only).
+
+
+ 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.
+
+
+ Set reporting behavior for disabled physical control.
+
+
+```
+
+Zen27 (Dimmer):
+
+```xml
+
+
+ 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.
+
+
+ LED Indication light function. Normal has the LED Indication on when the switch is off, off when the switch is on.
+
+
+
+
+ Time, in minutes, for auto-off timer delay.
+
+
+
+
+ Set the time (in minutes) after which you want the switch to automatically turn on once it has been turned off.
+
+
+ Choose which physical and Z-Wave triggers should prompt the switch to send a status change report to associated devices.
+
+
+ Status after power failure. Off: always turn light off. On: always turn light on. Restore: remember the latest state and restore that state.
+
+
+ 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
+
+
+ Set the minimum brightness level (in %) for your dimmer. You won't be able to dim the light below the set value.
+
+
+ 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 "Full", Parameter 11 is automatically disabled.
+
+
+ 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.
+
+
+ Enable or Disable scene control functionality for quick double tap triggers.
+
+
+ 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
+
+
+ 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.
+
+
+ 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
+
+
+ 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.
+
+
+ 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
+
+
+ Choose how you'd like the dimmer to report when paddles are tapped and held and physical / Z-Wave control is enabled or disabled.
+
+
+ Set reporting behavior for disabled physical control.
+
+
+ Set the brightness level the dimmer will turn on to when off and when lower paddle is held DOWN for a second. Default: 20
+
+
+```
+
+Zen30 (Double Switch):
+
+```xml
+
+
+ LED Indicator Mode for Dimmer. Normal has the dimmer (top) LED indication on when the switch is off, off when the switch is on. Default: Normal
+
+
+ LED Indicator Mode for Relay. Normal has the relay (bottom) LED indication on when the switch is off, off when the switch is on. Default: Normal
+
+
+ LED Indicater color for Dimmer. White, Blue, Green or Red. Default: White
+
+
+ LED Indicater color for Relay. White, Blue, Green or Red. Default: White
+
+
+ LED Indicater Brightness for Dimmer. Bright (100%), Medium (60%) or Low (30%). Default: Medium
+
+
+ LED Indicater Brightness for Relay. Bright (100%), Medium (60%) or Low (30%). Default: Medium
+
+
+ LED Indicator Mode for Scene Control. Enable/Disable LED indicators next to the dimmer lighting up when a scene is selected. Default: disabled
+
+
+ Auto Turn-Off Timer for Dimmer. Sets the time (in minutes) after which you want the dimmer to automatically turn off once it has been turned on. Range: 1-65535. Default: 0 (disabled)
+
+
+ Auto Turn-On Timer for Dimmer. Sets the time (in minutes) after which you want the dimmer to automatically turn on once it has been turned off. Range: 1-65535. Default: 0 (disabled)
+
+
+ Auto Turn-Off Timer for Relay. Sets the time (in minutes) after which you want the relay to automatically turn off once it has been turned on. Range: 1-65535. Default: 0 (disabled)
+
+
+ Auto Turn-On Timer for Relay. Sets the time (in minutes) after which you want the relay to automatically turn on once it has been turned off. Range: 1-65535. Default: 0 (disabled)
+
+
+ On Off Status After Power Failure. Default: Restore both to prior state
+
+
+ Ramp Rate Control for Dimmer. 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. Note that 0 is instant. Default: 1
+
+
+ Minimum Brightness. Set the minimum brightness level (in %) for your dimmer. You won't be able to dim the light below the set value. Default: 1
+
+
+ Maximum Brightness. Set the maximum brightness level (in %) for your dimmer. You won't be able to add brightness to the light beyond the set value. Default: 99
+
+
+ Double Tap Function for Dimmer. When set to full, turns light on to 100%. If set to maximum level, turns light on to % set in Parameter 15. Default: full
+
+
+ Enable/Disable Double-tap for Dimmer. Enables/Disables the double-tap function and assign brightness to single tap. enabled: single tap turns on to maximum brightness level. disabled (last level): single tap returns to last brightness level. disabled (full/max level): single tap returns to full brightmess. Default: enabled
+
+
+ Enable/Disable Load Control for Dimmer (Smart Bulb Setting). Enable or disable direct manual and Z-Wave control of the connected light (works great for smart bulb control). If disabled, the dimmer will no longer control the connected bulb directly but will still send on/off and brightness reports to the hub so you cn use them to create automations for your smart bulbs or other switches. Scenes and other functionality will still be available through the paddles. Default: manual disabled
+
+
+ Enable/Disable Load Control for Relay (Smart Bulb Setting). Enable or disable direct manual and Z-Wave control of the connected light (works great for smart bulb control). If disabled, the relay will no longer control the connected bulb directly but will still send on/off and brightness reports to the hub so you cn use them to create automations for your smart bulbs or other switches. Scenes and other functionality will still be available through the paddles. Default: manual disabled
+
+
+ Choose how many seconds it takes for the dimmer to go from 0% to 100% brightness when pressing and holding the paddle. Default: 4.
+
+
+ Default Brightness Level On for Dimmer. Set custom brightness level (in %) for the dimmer to come on to at single tap. Choose 0 for last brightness level. Default: 0.
+
+
+ Sets behavior of the dimmer when physical control is disabled
+
+
+ Sets behavior of the relay when physical control is disabled
+
+
+ Set the brightness level the dimmer will turn on to when off and when lower paddle is held DOWN for a second. Default: 20
+
+
+ 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.
+
+
+```
+
+Zen32 Scene Controller:
+
+```xml
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set the time (in minutes) after which you want the switch to automatically turn off once it has been turned on.
+
+
+ Set the time (in minutes) after which you want the switch to automatically turn on once it has been turned off.
+
+
+
+
+
+
+
+
+ Choose the type of 3-way switch you want to use with this switch in a 3-way set-up.
+
+
+```
+
+Zen34 Remote Switch:
+
+```xml
+
+
+ Choose the LED indicator mode for your Remote Switch
+
+
+ Choose the LED indicator color for the upper paddle remote controlled triggers
+
+
+ Choose the LED indicator color for the lower paddle remote control triggers
+
+
+```
+
+For Zooz switches, you'll need to update (or possibly add) the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
+
+```xml
+
+
+```
+
+For the Zooz Zen30 Double Switch, you'll need to add the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
+
+```xml
+
+
+```
+
+For the Zooz Zen32 Scene Controller, you'll need to add the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
+
+```xml
+
+
+
+```
+
+Go to the Z-Wave Network Management section in the Home Assistant Configuration, select the node which has just been updated and enable the scene support configuration parameter.
+
+Once this is complete, you should see the following `zwave.scene_activated` events:
+
+| **Action** | **scene\_id** | **scene\_data** |
+| :------------: | :-----------: | :-------------: |
+| Single tap off | 1 | 7680 |
+| Single tap on | 2 | 7680 |
+| Double tap off | 1 | 7860 |
+| Double tap on | 2 | 7860 |
+| Triple tap off | 1 | 7920 |
+| Triple tap on | 2 | 7920 |
+| 4x tap off | 1 | 7980 |
+| 4x tap on | 2 | 7980 |
+| 5x tap off | 1 | 8040 |
+| 5x tap on | 2 | 8040 |
+| Held off | 1 | 7800 |
+| Held on | 2 | 7800 |
+| Released off | 1 | 7740 |
+| Released on | 2 | 7740 |
+
+The Zooz ZEN34 Remote Switch has shown inverted `scene_id` values compared to other Zooz switches as well as different `scene_data` values depending on production run:
+
+Recent production runs have appeared with:
+
+| **Action** | **scene\_id** | **scene\_data** |
+| :----------: | :-----------: | :-------------: |
+| 1x tap on | 1 | 7680 |
+| 1x tap off | 2 | 7680 |
+| 2x tap on | 1 | 7860 |
+| 2x tap off | 2 | 7860 |
+| 3x tap on | 1 | 7920 |
+| 3x tap off | 2 | 7920 |
+| 4x tap on | 1 | 7980 |
+| 4x tap off | 2 | 7980 |
+| 5x tap on | 1 | 8040 |
+| 5x tap off | 2 | 8040 |
+| Held on | 1 | 7800 |
+| Held off | 2 | 7800 |
+| Released on | 1 | 7740 |
+| Released off | 2 | 7740 |
+
+Early production runs have appeared with:
+
+| **Action** | **scene\_id** | **scene\_data** |
+| :----------: | :-----------: | :-------------: |
+| 1x tap on | 1 | 0 |
+| 1x tap off | 2 | 0 |
+| 2x tap on | 1 | 3 |
+| 2x tap off | 2 | 3 |
+| 3x tap on | 1 | 4 |
+| 3x tap off | 2 | 4 |
+| 4x tap on | 1 | 5 |
+| 4x tap off | 2 | 5 |
+| 5x tap on | 1 | 6 |
+| 5x tap off | 2 | 6 |
+| Held on | 1 | 2 |
+| Held off | 2 | 2 |
+| Released on | 1 | 1 |
+| Released off | 2 | 1 |
+
+### HomeSeer Switches
+
+For the HomeSeer devices specifically, you may need to update the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
+
+```xml
+
+
+```
+
+Below is a table of the action/scenes for the HomeSeer devices (as a reference for other similar devices):
+
+| **Action** | **scene\_id** | **scene\_data** |
+| :--------------: | :-----------: | :-------------: |
+| Single tap on | 1 | 0 |
+| Single tap off | 2 | 0 |
+| Double tap on | 1 | 3 |
+| Double tap off | 2 | 3 |
+| Triple tap on | 1 | 4 |
+| Triple tap off | 2 | 4 |
+| Tap and hold on | 1 | 2 |
+| Tap and hold off | 2 | 2 |
+
+Some installations will see those details:
+
+Top button ID: 1, Bottom ID: 2
+
+| **Action** | **scene\_data** |
+| :----------: | :-------------: |
+| Single Press | 7800 |
+| Hold Button | 7740 |
+| 2x Tap | 7860 |
+| 3x Tap | 7920 |
+| 4x Tap | 7980 |
+| 5x Tap | 8040 |
+
+### Fibaro Button FGPB-101-6 v3.2
+
+
+
+For the Button, you may need to update the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
+
+```xml
+
+
+```
+
+Below is a table of the action/scenes for the Button (as a reference for other similar devices):
+
+| **Action** | **scene\_id** | **scene\_data** |
+| :-----------: | :-----------: | :-------------: |
+| Single tap on | 1 | 0 |
+| Double tap on | 1 | 3 |
+| Triple tap on | 1 | 4 |
+
+Tap and hold wakes up the Button.
+
+### Fibaro Keyfob FGKF-601
+
+For the Fibaro Keyfob, you may need to update the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
+
+```xml
+
+
+```
+
+Below is a table of the action/scenes for the Keyfob (as a reference for other similar devices):
+
+| **Action** | **scene\_id** | **scene\_data** |
+| :-------------------------------: | :-----------: | :-------------: |
+| Button one (Square) single tap | 1 | 7680 |
+| Button one (Square) hold | 1 | 7800 |
+| Button one (Square) release | 1 | 7740 |
+| Button two (Circle) single tap | 2 | 7680 |
+| Button two (Circle) hold | 2 | 7800 |
+| Button two (Circle) release | 2 | 7740 |
+| Button three (X) single tap | 3 | 7680 |
+| Button three (X) hold | 3 | 7800 |
+| Button three (X) release | 3 | 7740 |
+| Button four (Triangle) single tap | 4 | 7680 |
+| Button four (Triangle) hold | 4 | 7800 |
+| Button four (Triangle) release | 4 | 7740 |
+| Button five (Minus) single tap | 5 | 7680 |
+| Button five (Minus) hold | 5 | 7800 |
+| Button five (Minus) release | 5 | 7740 |
+| Button six (Plus) single tap | 6 | 7680 |
+| Button six (Plus) hold | 6 | 7800 |
+| Button six (Plus) release | 6 | 7740 |
+
+Press circle and plus simultaneously to wake up the device.
+
+### Aeotec NanoMote Quad
+
+
+
+Once you've added the NanoMote to your Z-Wave network, you'll need to update your `zwcfg_*.xml` file with the below XML data. Stop Home Assistant and open your `zwcfg_*.xml` file (located in your configuration folder). Find the NanoMote device section and then its corresponding `CommandClass` section with id="91". Replace the entire CommandClass section with the below XML data. Save the file and restart Home Assistant.
+
+```xml
+
+
+```
+
+Below is a table of the action/scenes for the NanoMote Quad:
+
+| **Action** | **scene\_id** | **scene\_data** |
+| :---------------------: | :-----------: | :-------------: |
+| Button one single tap | 1 | 7680 |
+| Button one hold | 1 | 7800 |
+| Button one release | 1 | 7740 |
+| Button two single tap | 2 | 7680 |
+| Button two hold | 2 | 7800 |
+| Button two release | 2 | 7740 |
+| Button three single tap | 3 | 7680 |
+| Button three hold | 3 | 7800 |
+| Button three release | 3 | 7740 |
+| Button four single tap | 4 | 7680 |
+| Button four hold | 4 | 7800 |
+| Button four release | 4 | 7740 |
+
+Example Event:
+
+```yaml
+ "event_type": "zwave.scene_activated",
+ "data": {
+ "entity_id": "zwave.nanomote",
+ "scene_id": 2,
+ "scene_data": 7680
+ }
+```
+
+### Aeotec Wallmote
+
+
+
+For the Aeotec Wallmote, you may need to update the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
+
+```xml
+
+
+```
+
+Below is a table of the action/scenes for the Wallmote (as a reference for other similar devices):
+
+| **Action** | **scene\_id** | **scene\_data** |
+| :---------------------: | :-----------: | :-------------: |
+| Button one single tap | 1 | 0 |
+| Button one hold | 1 | 2 |
+| Button one release | 1 | 1 |
+| Button two single tap | 2 | 0 |
+| Button two hold | 2 | 2 |
+| Button two release | 2 | 1 |
+| Button three single tap | 3 | 0 |
+| Button three hold | 3 | 2 |
+| Button three release | 3 | 1 |
+| Button four single tap | 4 | 0 |
+| Button four hold | 4 | 2 |
+| Button four release | 4 | 1 |
+
+### WallC-S Switch
+
+Use the same configuration as for the Aeotec Wallmote.
+
+### HANK One-key Scene Controller HKZN-SCN01/HKZW-SCN01
+
+For the HANK One-key Scene Controller, you may need to update the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
+
+```xml
+
+
+```
+
+Below is a table of the action/scenes for the Button (as a reference for other similar devices):
+
+| **Action** | **scene\_id** | **scene\_data** |
+| :---------------: | :-----------: | :-------------: |
+| Button single tap | 1 | 0 |
+| Button hold | 1 | 2 |
+| Button release | 1 | 1 |
+
+### HANK Four-key Scene Controller HKZN-SCN04
+
+For the HANK Four-key Scene Controller, you may need to update the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
+
+```xml
+
+
+```
+
+Below is a table of the action/scenes for the Buttons and associated Pictogram:
+
+| **Action** | **Pictogram** | **scene\_id** | **scene\_data** |
+| :------------------: | :--------------: | :-----------: | :-------------: |
+| Button one tap | Moon and Star | 1 | 0 |
+| Button one hold | Moon and Star | 1 | 2 |
+| Button one release | Moon and Star | 1 | 1 |
+| Button two tap | People | 2 | 0 |
+| Button two hold | People | 2 | 2 |
+| Button two release | People | 2 | 1 |
+| Button three tap | Circle | 3 | 0 |
+| Button three hold | Circle | 3 | 2 |
+| Button three release | Circle | 3 | 1 |
+| Button four tap | Circle with Line | 4 | 0 |
+| Button four hold | Circle with Line | 4 | 2 |
+| Button four release | Circle with Line | 4 | 1 |
+
+### Remotec ZRC-90 Scene Master
+
+To get the ZRC-90 Scene Master working in Home Assistant, you must first edit the `COMMAND_CLASS_CENTRAL_SCENE` in your `zwcfg` file.
+
+1. Go the Z-Wave control panel in Home Assistant and make a note of the node number your ZRC-90 has been assigned.
+2. *Stop* Home Assistant.
+3. Make a backup of your `zwfcg` file, just in case.
+4. In the `zwcfg` file, find the `Node id` that corresponds to the number you noted in the first step.
+5. Within the `Node id` you identified, highlight everything between `` (inclusive) and paste in the following:
+
+ ```xml
+
+
+ ```
+
+6. Save the changes you made the `zwcfg` file and start Home Assistant back up.
+
+Button presses will trigger `zwave.scene_activated` with the following:
+
+- `node_id`: the node of your Scene Master (useful if you have more than one)
+- `scene_id`: the number button you press (1-8)
+- `scene_data`: the type of press registered (see below)
+
+The Scene Master has eight buttons which can send four actions.
+The type of action is reflected in the `scene_data` parameter:
+
+| **Action** | **scene\_data** |
+| :---------------: | :-------------: |
+| Single press | 0 |
+| Long press (2s) | 1 |
+| Release from hold | 2 |
+| Double-press | 3 |
+
+Let's see how this works in an automation for a Scene Master that's assigned as Node 7:
+
+```yaml
+- id: "1234567890"
+ alias: "Double-press Button 2 to toggle all lights"
+ trigger:
+ - platform: event
+ event_type: zwave.scene_activated
+ event_data:
+ node_id: 7
+ scene_id: 2
+ scene_data: 3
+ condition: []
+ action:
+ - data:
+ service: light.toggle
+ target:
+ entity_id: group.all_lights
+```
+
+### RFWDC Cooper 5-button Scene Control Keypad
+
+For the RFWDC Cooper 5-button Scene Control Keypad, you may need to update the `COMMAND_CLASS_CENTRAL_SCENE` for each node in your `zwcfg` file with the following:
+
+```xml
+
+
+```
+
+Below is a table of the action/scenes for the Buttons:
+
+| **Action** | **scene\_id** |
+| :--------------: | :-----------: |
+| Button one tap | 1 |
+| Button two tap | 2 |
+| Button three tap | 3 |
+| Button four tap | 4 |
+| Button five tap | 5 |
+
+When a button turns off, the controller sends `basic_set` in a generic `node_event` and does not specify which button was pressed. The status of the buttons is encoded into the `indicator` value, so in order to determine the status of each button, you need to refresh the indicator value. You can also control the LEDs for each button by setting the indicator value. For responsiveness, automations should be triggered with `zwave.scene_activated` events rather than the switch status.
+
+Here is an example configuration needed for the scene controller:
+
+{% raw %}
+
+```yaml
+automation:
+ - alias: "Sync the indicator value on button events"
+ trigger:
+ - platform: event
+ event_type: zwave.scene_activated
+ event_data:
+ entity_id: zwave.scene_contrl
+ - platform: event
+ event_type: zwave.node_event
+ event_data:
+ entity_id: zwave.scene_contrl
+ action:
+ - service: zwave.refresh_node_value
+ data:
+ node_id: 3
+ value_id: "{{ state_attr('sensor.scene_contrl_indicator','value_id') }}"
+switch:
+ - platform: template
+ switches:
+ button_1_led:
+ value_template: "{{ states('sensor.scene_contrl_indicator')|int|bitwise_and(1) > 0 }}"
+ turn_on:
+ service: zwave.set_node_value
+ data:
+ node_id: 3
+ value_id: "{{ state_attr('sensor.scene_contrl_indicator','value_id') }}"
+ value: "{{ states('sensor.scene_contrl_indicator')|int + 1 }}"
+ turn_off:
+ service: zwave.set_node_value
+ data:
+ node_id: 3
+ value_id: "{{ state_attr('sensor.scene_contrl_indicator','value_id') }}"
+ value: "{{ states('sensor.scene_contrl_indicator')|int - 1 }}"
+ button_2_led:
+ value_template: "{{ states('sensor.scene_contrl_indicator')|int|bitwise_and(2) > 0 }}"
+ turn_on:
+ service: zwave.set_node_value
+ data:
+ node_id: 3
+ value_id: "{{ state_attr('sensor.scene_contrl_indicator','value_id') }}"
+ value: "{{ states('sensor.scene_contrl_indicator')|int + 2 }}"
+ turn_off:
+ service: zwave.set_node_value
+ data:
+ node_id: 3
+ value_id: "{{ state_attr('sensor.scene_contrl_indicator','value_id') }}"
+ value: "{{ states('sensor.scene_contrl_indicator')|int - 2 }}"
+ button_3_led:
+ value_template: "{{ states('sensor.scene_contrl_indicator')|int|bitwise_and(4) > 0 }}"
+ turn_on:
+ service: zwave.set_node_value
+ data:
+ node_id: 3
+ value_id: "{{ state_attr('sensor.scene_contrl_indicator','value_id') }}"
+ value: "{{ states('sensor.scene_contrl_indicator')|int + 4 }}"
+ turn_off:
+ service: zwave.set_node_value
+ data:
+ node_id: 3
+ value_id: "{{ state_attr('sensor.scene_contrl_indicator','value_id') }}"
+ value: "{{ states('sensor.scene_contrl_indicator')|int - 4 }}"
+ button_4_led:
+ value_template: "{{ states('sensor.scene_contrl_indicator')|int|bitwise_and(8) > 0 }}"
+ turn_on:
+ service: zwave.set_node_value
+ data:
+ node_id: 3
+ value_id: "{{ state_attr('sensor.scene_contrl_indicator','value_id') }}"
+ value: "{{ states('sensor.scene_contrl_indicator')|int + 8 }}"
+ turn_off:
+ service: zwave.set_node_value
+ data:
+ node_id: 3
+ value_id: "{{ state_attr('sensor.scene_contrl_indicator','value_id') }}"
+ value: "{{ states('sensor.scene_contrl_indicator')|int - 8 }}"
+ button_5_led:
+ value_template: "{{ states('sensor.scene_contrl_indicator')|int|bitwise_and(16) > 0 }}"
+ turn_on:
+ service: zwave.set_node_value
+ data:
+ node_id: 3
+ value_id: "{{ state_attr('sensor.scene_contrl_indicator','value_id') }}"
+ value: "{{ states('sensor.scene_contrl_indicator')|int + 16 }}"
+ turn_off:
+ service: zwave.set_node_value
+ data:
+ node_id: 3
+ value_id: "{{ state_attr('sensor.scene_contrl_indicator','value_id') }}"
+ value: "{{ states('sensor.scene_contrl_indicator')|int - 16 }}"
+```
+
+### HeatIt/ThermoFloor Z-Push Button 2/8 Wall Switch
+
+To get the Z-Push Button 2 or the Z-Push Button 8 working in Home Assistant, you must first edit the `COMMAND_CLASS_CENTRAL_SCENE` in your `zwcfg` file.
+
+1. Go the Z-Wave control panel in Home Assistant and make a note of the node number your wall switch has been assigned.
+2. *Stop* Home Assistant.
+3. Make a backup of your `zwfcg` file, just in case.
+4. In the `zwcfg` file, find the `Node id` that corresponds to the number you noted in the first step.
+5. Within the `Node id` you identified, highlight everything between `` (inclusive) and paste in the following:
+ - 5.1 For the Z-Push Button 2:
+
+ ```xml
+
+
+ ```
+
+ - 5.2 For the Z-Push Button 4:
+
+ ```xml
+
+
+ ```
+
+ - 5.3 For the Z-Push Button 8:
+
+ ```xml
+
+
+ ```
+
+6. Save the changes you made the `zwcfg` file and start Home Assistant back up.
+
+Button presses will trigger `zwave.scene_activated` with the following:
+
+- `scene_id`: the number of the button you press from top left (1) to bottom right (8)
+
+{% endraw %}
+
+### Logicgroup ZDB5100 Matrix
+
+
+
+Once you've added the ZDB5100 to your Z-Wave network, you'll need to update your `zwcfg_*.xml` file with the below XML data. Stop Home Assistant and open your `zwcfg_*.xml` file (located in your configuration folder). Find the ZDB5100 device section and then its corresponding `CommandClass` section with id="91". Replace the entire CommandClass section with the below XML data. Save the file and restart Home Assistant.
+
+```xml
+
+
+```
+
+Below is a table of the action/scenes for the ZDB5100 Matrix:
+
+| **Action** | **scene\_id** | **scene\_data** |
+| :---------------------: | :-----------: | :-------------: |
+| Button one single tap | 1 | 7680 |
+| Button one double tap | 1 | 7860 |
+| Button one triple tap | 1 | 7920 |
+| Button one hold | 1 | 7800 |
+| Button one release | 1 | 7740 |
+| Button two single tap | 2 | 7680 |
+| Button two double tap | 2 | 7860 |
+| Button two triple tap | 2 | 7920 |
+| Button two hold | 2 | 7800 |
+| Button two release | 2 | 7740 |
+| Button three single tap | 3 | 7680 |
+| Button three double tap | 3 | 7860 |
+| Button three triple tap | 3 | 7920 |
+| Button three hold | 3 | 7800 |
+| Button three release | 3 | 7740 |
+| Button four single tap | 4 | 7680 |
+| Button four double tap | 4 | 7860 |
+| Button four triple tap | 4 | 7920 |
+| Button four hold | 4 | 7800 |
+| Button four release | 4 | 7740 |
+
+Example Event:
+
+```yaml
+- alias: "MatrixButton2"
+ trigger:
+ - event_type: zwave.scene_activated
+ platform: event
+ event_data:
+ node_id: 2
+ scene_id: 2
+ scene_data: 7680
+ action:
+ - service: switch.toggle
+ target:
+ entity_id: switch.office_fan
+```
+
+### Zooz S2 MultiRelay (Zen16)
+
+Contact Zooz to obtain the over the air firmware update instructions and new user manual for the MultiRelay.
+
+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:
+
+```xml
+
+
+ On Off Status After Power Failure. Default: all relays restore to previous state
+
+
+ Switch Type for Relay 1 (Sw1). Choose the wall switch type you want to connect to the Sw1 terminal. Default: toggle switch (state changes whenever the switch is toggled)
+
+
+ Switch Type for Relay 2 (Sw2). Choose the wall switch type you want to connect to the Sw2 terminal. Default: toggle switch (state changes whenever the switch is toggled)
+
+
+ Switch Type for Relay 3 (Sw3). Choose the wall switch type you want to connect to the Sw3 terminal. Default: toggle switch (state changes whenever the switch is toggled)
+
+
+ LED Indicator Control. Choose if you want the LED indicator to turn on when any of the relays are on or if all of them are off, or if you want it to remain on or off at all times. Default: On when all relays are off
+
+
+ Auto Turn-Off Timer for Relay 1. Sets the time (in minutes) after which you want relay 1 to automatically turn off once it has been turned on. Range: 1-65535. Default: 0 (disabled)
+
+
+ Auto Turn-On Timer for Relay 1. Sets the time (in minutes) after which you want relay 1 to automatically turn on once it has been turned off. Range: 1-65535. Default: 0 (disabled)
+
+
+ Auto Turn-Off Timer for Relay 2. Sets the time (in minutes) after which you want relay 2 to automatically turn off once it has been turned on. Range: 1-65535. Default: 0 (disabled)
+
+
+ Auto Turn-On Timer for Relay 2. Sets the time (in minutes) after which you want relay 2 to automatically turn on once it has been turned off. Range: 1-65535. Default: 0 (disabled)
+
+
+ Auto Turn-Off Timer for Relay 3. Sets the time (in minutes) after which you want relay 3 to automatically turn off once it has been turned on. Range: 1-65535. Default: 0 (disabled)
+
+
+ Auto Turn-On Timer for Relay 3. Sets the time (in minutes) after which you want relay 3 to automatically turn on once it has been turned off. Range: 1-65535. Default: 0 (disabled)
+
+
+ Enable/Disable Manual Control for SW1. Default: enabled
+
+
+ Enable/Disable Manual Control for SW2. Default: enabled
+
+
+ Enable/Disable Manual Control for SW3. Default: enabled
+
+
+ Choose between second, minutes, and hours as the unit for Auto Turn-Off time for Relay 1. Default: minutes
+
+
+ Choose between second, minutes, and hours as the unit for Auto Turn-On time for Relay 1. Default: minutes
+
+
+ Choose between second, minutes, and hours as the unit for Auto Turn-Off time for Relay 2. Default: minutes
+
+
+ Choose between second, minutes, and hours as the unit for Auto Turn-On time for Relay 2. Default: minutes
+
+
+ Choose between second, minutes, and hours as the unit for Auto Turn-Off time for Relay 3. Default: minutes
+
+
+ Choose between second, minutes, and hours as the unit for Auto Turn-On time for Relay 3. Default: minutes
+
+
+```
+
+### Zooz S2 Outdoor Motion Sensor v2.0 (ZSE29)
+
+The configuration parameters will have to be added to the `zwcfg` file. Replace the existing `COMMAND_CLASS_CONFIGURATION` with the one of the following options:
+
+```xml
+
+
+ Set the value of basic set report sent to the light associated with the sensor in Group 2 (so the light turns on to the selected brightness level). 99 is the equivalent of full brightness in Z-Wave terms.
+ default: 99
+
+
+
+ Enable or disable motion reports completely. If motion sensor is disabled, the device will not report motion at all to your hub.
+
+
+ Adjust motion sensitivity where 10 is the most sensitive setting.
+ default: 10
+
+
+
+ Set lux level trigger with 10 being the lowest reported value. The sensor will report motion to the hub and associated devices only if lux level is below the set value.
+ 0 - set manually by lux knob; (default)
+ 1 - ignore lux and always report motion;
+
+
+
+ Set motion re-trigger time for the delay before the sensor reports no motion to the hub and associated devices after detecting the last motion activity.
+ 0 - set manually by timer knob; (default)
+ 5-720 (seconds) - set customer re-trigger time;
+
+
+
+ Set lux reporting frequency to decide how often the snesor will measure and send brightness level data to the hub and associated devices.
+ default: 30 (minutes)
+
+
+
+```
+
+### Jasco 2 Button Remote (37792/ZW5307)
+
+
+
+Once you've added the remote to your Z-Wave network, you'll need to update your `zwcfg_*.xml` file with the below XML data. Stop Home Assistant and open your `zwcfg_*.xml` file (located in your configuration folder). Find the remote's device section and then its corresponding `CommandClass` section with id="91". Replace the entire CommandClass section with the below XML data. Save the file and restart Home Assistant.
+
+```xml
+
+
+```
+
+Below is a table of the action/scenes for the Jasco remote:
+
+| **Action** | **scene\_id** | **scene\_data** |
+| :-------------------: | :-----------: | :-------------: |
+| Button one single tap | 1 | 0 |
+| Button one double tap | 1 | 3 |
+| Button one triple tap | 1 | 4 |
+| Button two single tap | 2 | 0 |
+| Button two double tap | 2 | 3 |
+| Button two triple tap | 2 | 4 |
+
+Example Event:
+
+```yaml
+- alias: "JascoButton1"
+ trigger:
+ - event_type: zwave.scene_activated
+ platform: event
+ event_data:
+ node_id: 2
+ scene_id: 1
+ scene_data: 0
+ action:
+ - service: switch.toggle
+ target:
+ entity_id: switch.office_fan
+```
+
+### EATON On/Off & Dimmer (RF9501/RF9540-N/RF9640-N/RF9601-N)
+
+Once you've added the remote to your Z-Wave network, you'll need to update your `zwcfg_*.xml` file with the below XML data. Stop Home Assistant and open your `zwcfg_*.xml` file (located in your configuration folder). Find the remote's device section and then its corresponding `CommandClass` section with id="112". Insert the snippet below into the CommandClass section with the below XML data. Save the file and restart Home Assistant.
+
+```xml
+
+ Ensures that changes to the master node automatically notify accessory switches
+
+```
diff --git a/source/_posts/2017-10-21-release-56.markdown b/source/_posts/2017-10-21-release-56.markdown
index 3bc53bcbb3c..6948285677b 100644
--- a/source/_posts/2017-10-21-release-56.markdown
+++ b/source/_posts/2017-10-21-release-56.markdown
@@ -16,7 +16,7 @@ og_image: /images/blog/2017-10-0.56/components.png
We reached another milestone aka number: 10000. GitHub is assigning numbers to pull requests and issues and the "10000" is a [PR](https://github.com/home-assistant/home-assistant/pull/10000). Our ratio is around 1/3 issues and 2/3 pull requests. To be more precise: 64% pull requests and 36% issues.
-If you haven't noticed, there is now a [glossary](/docs/glossary/) that collects some Home Assistant relevant terms. Talking about the documentation: [@DubhAd](https://github.com/DubhAd) rewrote large parts of the [Z-Wave section](/docs/z-wave/). More structure to get started and to find details during the setup and the configuration.
+If you haven't noticed, there is now a [glossary](/docs/glossary/) that collects some Home Assistant relevant terms. Talking about the documentation: [@DubhAd](https://github.com/DubhAd) rewrote large parts of the Z-Wave section. More structure to get started and to find details during the setup and the configuration.
## Google Assistant / Google Home integration
This release includes a new component to integrate Home Assistant with Google Assistant by [Phil Kates][@philk]. We integrate via the Smart Home API, this means that you will be able to control your devices in Home Assistant via any device that has Google Assistant. Learn more in [the documentation][google_assistant docs].
diff --git a/source/_redirects b/source/_redirects
index 96270e7e0a2..96dcc0b6317 100644
--- a/source/_redirects
+++ b/source/_redirects
@@ -1065,7 +1065,6 @@
/integrations/climate.modbus /integrations/modbus
/integrations/cover.modbus /integrations/modbus
/integrations/fan.xiaomi_miio /integrations/xiaomi_miio
-/integrations/google /integrations/calendar.google
/integrations/light.xiaomi_miio /integrations/xiaomi_miio
/integrations/lovelace /lovelace
/integrations/remote.xiaomi_miio /integrations/xiaomi_miio
@@ -2021,6 +2020,27 @@
/docs/ecosystem/notebooks/stats https://data.home-assistant.io
/docs/frontend/mobile https://companion.home-assistant.io
/docs/script/editor /docs/scripts/editor
+/docs/z-wave /integrations/zwave_js
+/docs/z-wave/adding /integrations/zwave/#adding-and-removing-devices
+/docs/z-wave/control-panel /integrations/zwave/#control-panel
+/docs/z-wave/controllers/#aeotec-stick /docs/z-wave/controllers/#aeotec-z-stick
+/docs/z-wave/devices /integrations/zwave/#device-support
+/docs/z-wave/devices/#instant-status /integrations/zwave/#instant-status
+/docs/z-wave/devices/#polling /integrations/zwave/#polling
+/docs/z-wave/device-specific /integrations/zwave/#device-specific-information
+/docs/z-wave/device-specific/#device-categories /integrations/zwave/#device-support
+/docs/z-wave/device-specific/#motion-or-alarm-sensors /integrations/zwave/#binary-sensor
+/docs/z-wave/device-specific/#locks-and-other-secure-devices /integrations/zwave/#lock
+/docs/z-wave/device-specific/#specific-devices /integrations/zwave/#device-specific-information
+/docs/z-wave/device-specific/#aeotec-z-stick /docs/z-wave/controllers/#aeotec-z-stick
+/docs/z-wave/device-specific/#razberry-board /docs/z-wave/controllers/#razberry-board
+/docs/z-wave/device-specific/#raspberry-pi-3-procedure /docs/z-wave/controllers/#raspberry-pi-3-procedure
+/docs/z-wave/device-specific/#raspberry-pi-4-procedure /docs/z-wave/controllers/#raspberry-pi-4-procedure
+/docs/z-wave/entities /integrations/zwave/#device-support
+/docs/z-wave/events /integrations/zwave/#events
+/docs/z-wave/installation /integrations/zwave/#detailed-installation-instructions
+/docs/z-wave/query-stage /integrations/zwave/#query-stage
+/docs/z-wave/services /integrations/zwave/#services
/ecosystem/ios/notifications https://companion.home-assistant.io/docs/notifications/notifications-basic
/ecosystem/notebooks https://data.home-assistant.io
/ecosystem/notebooks/api https://data.home-assistant.io
@@ -2045,6 +2065,7 @@
/integrations/trace /docs/automation/troubleshooting
/integrations/weather.knx /integrations/knx#weather
/integrations/zigbee /integrations/xbee
+/integrations/calendar.google /integrations/google
/integrations/hassio /hassio
/integrations/cloud.alexa /cloud/alexa
/getting-started/automation-create-first /getting-started/automation
@@ -2071,12 +2092,12 @@
/getting-started/troubleshooting-configuration /docs/troubleshooting
/getting-started/updating /common-tasks/os
/getting-started/yaml /docs/configuration/yaml
-/getting-started/z-wave /docs/z-wave
-/getting-started/z-wave-devices /docs/z-wave/devices
-/getting-started/z-wave-installation /docs/z-wave/installation
-/getting-started/z-wave-panel /docs/z-wave/control-panel
-/getting-started/z-wave-device-specific /docs/z-wave/device-specific
-/hassio/zwave /docs/z-wave
+/getting-started/z-wave /integrations/zwave_js
+/getting-started/z-wave-devices /integrations/zwave_js
+/getting-started/z-wave-installation /integrations/zwave_js
+/getting-started/z-wave-panel /integrations/zwave_js
+/getting-started/z-wave-device-specific /integrations/zwave_js
+/hassio/zwave /integrations/zwave_js
/topics/events /docs/configuration/events
/topics/packages /docs/configuration/packages
/topics/platform_options /docs/configuration/platform_options
diff --git a/source/docs/index.markdown b/source/docs/index.markdown
index 8c385a46f11..8ccc3fbfa86 100644
--- a/source/docs/index.markdown
+++ b/source/docs/index.markdown
@@ -19,12 +19,6 @@ The documentation covers beginner to advanced topics around the installation, se
+
+Using the `soft_reset` function with some Z-Wave controllers can cause the Z-Wave network to hang.
+
+
+
+To trigger a `heal_network`, one can always use *Settings -> Z-Wave Network Management -> Heal Network* from the GUI whenever one of the above actions took place.
+
+## Events
+
+### zwave.network_complete
+
+Home Assistant will trigger an event when the Z-Wave network is complete, meaning all of the nodes on the network have been queried. This can take quite some time, depending on wakeup intervals on the battery-powered devices on the network.
+
+```yaml
+ - alias: "Z-Wave network is complete"
+ trigger:
+ platform: event
+ event_type: zwave.network_complete
+```
+
+### zwave.network_complete_some_dead
+
+Home Assistant will trigger an event when the Z-Wave network is complete, but some nodes are marked dead, meaning all of the nodes on the network have been queried. This can take quite some time, depending on wakeup intervals on the battery-powered devices on the network.
+
+```yaml
+ - alias: "Z-Wave network is complete some dead"
+ trigger:
+ platform: event
+ event_type: zwave.network_complete_some_dead
+```
+
+### zwave.network_ready
+
+Home Assistant will trigger an event when the Z-Wave network is ready for use. Between `zwave.network_start` and `zwave.network_ready` Home Assistant will feel sluggish when trying to send commands to Z-Wave nodes. This is because the controller is requesting information from all of the nodes on the network. When this is triggered, all awake nodes have been queried and sleeping nodes will be queried when they awake.
+
+```yaml
+ - alias: "Z-Wave network is ready"
+ trigger:
+ platform: event
+ event_type: zwave.network_ready
+```
+
+### zwave.network_start
+
+Home Assistant will trigger an event when the Z-Wave network is set up to be started.
+
+```yaml
+ - alias: "Z-Wave network is starting"
+ trigger:
+ platform: event
+ event_type: zwave.network_start
+```
+
+### zwave.network_stop
+
+Home Assistant will trigger an event when the Z-Wave network is stopping.
+
+```yaml
+ - alias: "Z-Wave network is stopping"
+ trigger:
+ platform: event
+ event_type: zwave.network_stop
+```
+
+### zwave.node_event
+
+Home Assistant will trigger an event when command_class_basic changes value on a node. This can be virtually anything, so tests have to be made to determine what value equals what. You can use this for automations.
+
+Example:
+
+```yaml
+ - alias: "Minimote Button Pressed"
+ trigger:
+ platform: event
+ event_type: zwave.node_event
+ event_data:
+ entity_id: zwave.aeon_labs_minimote
+ basic_level: 255
+```
+
+The *entity_id* and *basic_level* of all triggered events can be seen in the console output.
+
+### zwave.scene_activated
+
+Some devices can also trigger scene activation events, which can be used in automation scripts (for example, the press of a button on a wall switch):
+
+```yaml
+# Example configuration.yaml automation entry
+automation:
+ - alias: "Turn on Desk light"
+ trigger:
+ platform: event
+ event_type: zwave.scene_activated
+ event_data:
+ entity_id: zwave.zwaveme_zme_wallcs_secure_wall_controller
+ scene_id: 11
+```
+
+Some devices (like the HomeSeer wall switches) allow you to do things like double, and triple click the up and down buttons and fire an event. These devices will also send `scene_data` to differentiate the events. This is an example of double clicking the on/up button:
+
+```yaml
+# Example configuration.yaml automation entry
+automation
+ - alias: "Dining room dimmer - double tap up"
+ trigger:
+ - event_type: zwave.scene_activated
+ platform: event
+ event_data:
+ entity_id: zwave.dining_room_cans
+ scene_id: 1
+ scene_data: 3
+```
+
+The *entity_id* and *scene_id* of all triggered events can be seen in the console output.
+
+For more information on HomeSeer devices and similar devices, please see the [device specific page](/integrations/zwave/#homeseer-switches).
+
+## Detailed installation instructions
+
+Z-Wave can be configured using the Z-Wave *Integration* in the *Configuration* menu, or manually using an entry in `configuration.yaml`
+
+### Configuration
+
+```yaml
+# Example configuration.yaml entry
+zwave:
+ usb_path: /dev/ttyACM0
+ device_config: !include zwave_device_config.yaml
+```
+
+{% configuration Z-Wave %}
+usb_path:
+ description: The port where your device is connected to your Home Assistant host. Z-Wave sticks will generally be `/dev/ttyACM0` and GPIO hats will generally be `/dev/ttyAMA0`.
+ required: false
+ type: string
+ default: /zwaveusbstick
+network_key:
+ description: The 16-byte network key in the form `"0x01, 0x02..."` used in order to connect securely to compatible devices. It is recommended that a network key is configured as security enabled devices may not function correctly if they are not added securely.
+ required: false
+ type: string
+ default: None
+config_path:
+ description: The path to the Python OpenZWave configuration files.
+ required: false
+ type: string
+ default: the 'config' that is installed by python-openzwave
+polling_interval:
+ description: The time period in milliseconds between polls of a nodes value. Be careful about using polling values below 30000 (30 seconds) as polling can flood the Z-Wave network and cause problems.
+ required: false
+ type: integer
+ default: 60000
+debug:
+ description: Print verbose Z-Wave info to log.
+ required: false
+ type: boolean
+ default: false
+autoheal:
+ description: Allows enabling auto Z-Wave heal at midnight. Warning, this is inefficient and [should not be used](https://github.com/home-assistant/architecture/issues/81#issuecomment-478444085).
+ required: false
+ type: boolean
+ default: false
+device_config / device_config_domain / device_config_glob:
+ description: "This attribute contains node-specific override values. NOTE: This needs to be specified if you are going to use any of the following options. See [Customizing devices and services](/docs/configuration/customizing-devices/) for the format."
+ required: false
+ type: [string, list]
+ keys:
+ ignored:
+ description: Ignore this entity completely. It won't be shown in the Web Interface and no events are generated for it.
+ required: false
+ type: boolean
+ default: false
+ polling_intensity:
+ description: Enables polling of a value and sets the frequency of polling (0=none, 1=every time through the list, 2=every other time, etc). If not specified then your device will not be polled.
+ required: false
+ type: integer
+ default: 0
+ refresh_value:
+ description: Enable refreshing of the node value. Only the light integration uses this.
+ required: false
+ type: boolean
+ default: false
+ delay:
+ description: Specify the delay for refreshing of node value. Only the light integration uses this.
+ required: false
+ type: integer
+ default: 5
+ invert_openclose_buttons:
+ description: Inverts function of the open and close buttons for the cover domain. This will not invert the position and state reporting.
+ required: false
+ type: boolean
+ default: false
+ invert_percent:
+ description: Inverts the percentage of the position for the cover domain. This will invert the position and state reporting.
+ required: false
+ type: boolean
+ default: false
+{% endconfiguration %}
+
+#### Network Key
+
+Security Z-Wave devices require a network key before being added to the network using the Add Secure Node button in the Z-Wave Network Management card. You must set the *network_key* configuration variable to use a network key before adding these devices.
+
+An easy script to generate a random key:
+
+```bash
+cat /dev/urandom | tr -dc '0-9A-F' | fold -w 32 | head -n 1 | sed -e 's/\(..\)/0x\1, /g' -e 's/, $//'
+```
+
+You can also use sites like [this one](https://www.random.org/cgi-bin/randbyte?nbytes=16&format=h) to generate the required data, just remember to put `0x` before each pair of characters and a `,` between them:
+
+```yaml
+# Example configuration.yaml entry for network_key
+zwave:
+ network_key: "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
+
+On platforms other than Home Assistant and Docker, the compilation and installation of python-openzwave happens when you first enable the Z-Wave component, and can take half an hour or more on a Raspberry Pi. When you upgrade Home Assistant and python-openzwave is also upgraded, this will also result in a delay while the new version is compiled and installed.
+
+The first run after adding a device is when the `zwave` integration will take time to initialize the entities, some entities may appear with incomplete names. Running a network heal may speed up this process.
+
+### Platform specific instructions
+
+#### Home Assistant
+
+You do not need to install any software to use Z-Wave.
+
+If the path of `/dev/ttyACM0` doesn't work, look in the *System* section of the *Supervisor* menu. There you'll find a *Hardware* button which will list all the hardware found.
+
+You can also check what hardware has been found using the [`ha` command](/hassio/commandline/#hardware):
+
+```bash
+ha hardware info
+```
+
+If you did an alternative install of Home Assistant on Linux (e.g., installing Ubuntu, then Docker, then Home Assistant Supervised) then the `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled in the host OS. Failure to do so will result in random failures of those components, e.g., dead or unreachable Z-Wave nodes, most notably right after Home Assistant restarts. Connect to your host OS via SSH, then you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` (commands are for Debian/Ubuntu).
+
+#### Docker
+
+You do not need to install any software to use Z-Wave.
+
+To enable access to the Z-Wave stick, add `--device=/dev/ttyACM0` to the `docker` command that starts your container, for example:
+
+```bash
+docker run -d --name="home-assistant" -v /home/pi/homeassistant:/config -v /etc/localtime:/etc/localtime:ro --net=host --device=/dev/ttyACM0 homeassistant/raspberrypi3-homeassistant
+```
+
+If the path of `/dev/ttyACM0` doesn't work then you can find the path of the stick by disconnecting and then reconnecting it, and running the following in the Docker host:
+
+```bash
+ls -1tr /dev/tty*|tail -n 1
+```
+
+The `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled. Failure to do so will result in random failures of those components. For example you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager`
+
+#### Community install methods
+
+##### Raspberry Pi specific
+
+On the Raspberry Pi you will need to enable the serial interface in the `raspi-config` tool before you can add Z-Wave to Home Assistant. Make sure to reboot the Raspberry Pi for the setting to take effect.
+
+##### Linux with Home Assistant Core
+
+On Debian Linux platforms there are dependencies you will need to have installed ahead of time (included in `systemd-devel` on Fedora/RHEL systems):
+
+```bash
+sudo apt-get install libudev-dev build-essential
+```
+
+You may also have to install the Python development libraries for your version of Python. For example `libpython3.6-dev`, and possibly `python3.6-dev` if you're using Python 3.6.
+
+###### Finding the controller path
+
+To find the path of your Z-Wave USB stick, disconnect it and then reconnect it to your system and run:
+
+```bash
+ls -ltr /dev/tty*|tail -n 1
+```
+
+That will give you a line that looks something like this:
+
+```bash
+crw-rw---- 1 root dialout 204, 64 Sep 21 10:25 /dev/ttyACM0
+```
+
+Where the date and time displayed is approximately the time you connected the USB stick or module (it may also be something like `/dev/ttyAMA0` or `/dev/ttyUSB0`). The number will be zero for the first device connected, and higher numbers for later devices.
+
+Or, if there is no result, try to find detailed USB connection info with:
+
+```bash
+dmesg | grep USB
+```
+
+If Home Assistant (`hass`) runs with another user (e.g., `homeassistant`) you need to give access to the stick with:
+
+```bash
+sudo usermod -aG dialout homeassistant
+```
+
+The output from `ls -ltr` above contains the following information:
+
+- The device type is `c` (character special).
+- The permissions are `rw-rw----`, meaning only the owner and group can read and write to it.
+- There is only `1` link to the file.
+- It is owned by `root` and can be accessed by members of the group `dialout`.
+- It has a major device number of `204`, and a minor device number of `64`.
+- The device was connected at `10:25` on `21 September`.
+- The device is `/dev/ttyUSB0`.
+
+##### macOS
+
+When installing on macOS you may have to also run the command below ahead of time, replace "x.x" with the version of Python (`$ python3 --version`) you have installed.
+
+```bash
+sudo /Applications/Python\ x.x/Install\ Certificates.command
+```
+
+On macOS you can find the USB stick with:
+
+```bash
+ls /dev/cu.usbmodem*
+```
+
+### Troubleshooting
+
+#### Device path changes
+
+If your device path changes when you restart, see [this guide](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/) on fixing it.
+
+#### Random unreachable Z-Wave nodes: ModemManager interference
+
+If this applies to your situation:
+
+- Some or all Z-Wave nodes are unreachable after restarting Home Assistant; not necessarily after every restart but seemingly random.
+- The Z-Wave stick stops responding, needs to be re-plugged or Home Assistant needs a restart to get Z-Wave back.
+- Your host OS is Debian-based/Ubuntu (for example: you installed Ubuntu, then Docker, then Supervisor).
+
+Then chances are high that the ModemManager in the host OS is causing the issue, claiming or interfering with the USB Z-Wave stick like the much used Aeotec ones. In this case you need to disable ModemManager.
+
+Connect to your host OS (e.g., Ubuntu) through SSH, then execute the following command on your host system to disable the ModemManager:
+
+ ```bash
+systemctl disable ModemManager.service
+```
+
+#### Component could not be set up
+
+Sometimes the device may not be accessible and you'll get an error message upon startup about not being able to set up Z-Wave. Run the following command for your device path (here we're using `/dev/ttyAMA0` for our Razberry board):
+
+```bash
+ls -l /dev/ttyAMA0
+```
+
+You should then see something like this:
+
+```txt
+crw-rw---- 1 root dialout 204, 64 Apr 1 12:34 /dev/ttyAMA0
+```
+
+The important pieces are the first piece `crw-rw----` and the group `dialout`. If those are different then, for your device path, run:
+
+```bash
+sudo chgrp dialout /dev/ttyAMA0
+sudo chmod g+rw /dev/ttyAMA0
+```
+
+Check too that the account you're running Home Assistant as is in the `dialout` group. For instance, if you're using `homeassistant`:
+
+```bash
+groups homeassistant
+```
+
+That should include `dialout`, if it doesn't then:
+
+```bash
+sudo usermod -aG dialout homeassistant
+```
+
+#### Unable to install Python Openzwave
+
+If you're getting errors like:
+
+```txt
+openzwave-embed/open-zwave-master/libopenzwave.a: No such file or directory
+```
+
+Then the problem is that you're missing `libudev-dev` (or the equivalent for your distribution), please [install it](#linux-with-home-assistant-core).
+
+#### Random failures
+
+If you're having random failures of the mesh, devices going missing, things randomly not working, check your `OZW_Log.txt` for the following messages:
+
+```txt
+WARNING: 500ms passed without reading the rest of the frame...aborting frame read
+WARNING: Out of frame flow! (0xfe). Sending NAK
+WARNING: Checksum incorrect - sending NAK
+```
+
+If you see any of these messages repeated in the log then _probably_ you've got something else running that's also using the Z-Wave controller. That might mean you've also got the OpenZ-Wave control panel (ozwcp) running, a second instance of Home Assistant or something else. You need to stop that other process to resolve this.
+
+#### Changing device paths
+
+Configurations using `udev` can experience race conditions in creating device paths such that they change on reboot. This can cause a device to appear to change between `/dev/ttyACM0` and `/dev/ttyACM1` after reboot. In this case using the symlinks created for device IDs can ensure the correct device is used, for example: `/dev/serial/by-id/usb-0658_0200-if00` for Aeotec Z-Stick.
+
+## Adding and removing devices
+
+### Adding Devices
+
+To add a [Z-Wave device](/integrations/zwave/#device-support):
+
+1. Go to the [Z-Wave control panel](/integrations/zwave/#control-panel).
+2. Click **Add Node** in the *Z-Wave Network Management* card, or **Add Node Secure** for secure devices like locks. This puts your [Z-Wave controller](/docs/z-wave/controllers/) in "inclusion" mode.
+3. Activate your device by following the instructions provided with it. Usually, this involves pressing a button.
+4. Make sure the device is in its final location, then click **Heal Network**. This is optional but helps optimize network speed.
+
+When you add a device, it may initially appear without a specific entity ID (e.g., `zwave.__`) or other identifying information. *Heal Network* should speed the process of populating this information. You *might* need to restart Home Assistant for the entity ID to appear.
+
+
+
+Some Z-Wave USB sticks have a physical "inclusion" button to add devices; **don't use it**. Likewise, don't add devices directly through other tools like [OpenZWave control panel](https://github.com/OpenZWave/open-zwave-control-panel). Many devices only send capabilities information at the time you add them, so if you add them outside of Home Assistant this information will be missing.
+
+
+
+
+Secure devices require additional bandwidth; too many secure devices can slow down your Z-Wave network. We recommend only using secure inclusion for devices that require it, like locks or garage door openers.
+
+
+### Removing Devices
+
+To remove a [Z-Wave device](/integrations/zwave/#device-support):
+
+1. Go to the [Z-Wave control panel](/integrations/zwave/#control-panel).
+2. Click **Remove Node** in the *Z-Wave Network Management* card. This puts your [Z-Wave controller](/docs/z-wave/controllers/) in "exclusion" mode.
+3. Activate your device by following the instructions provided with it. Usually, this involves pressing a button.
+4. The device should now be removed, but that won't show until you restart Home Assistant. Look for a confirmation signal on the device if available, or confirm in the Home Assistant logs.
+5. Click **Heal Network**. This is optional but helps optimize network speed.
+
+If your device isn't responding to this process, possibly because you've factory reset it or it has failed, you can remove it using **Remove Failed Node**.
+
+### Already Added
+
+If your device was previously added to another controller but not removed from it, **you must remove it before adding it to Home Assistant**.
+
+1. **Remove the device from the old controller**, if possible. If your device was added to a different system (SmartThings, Wink, etc.) follow that system's instructions to remove the device. Then try adding the device to Home Assistant again.
+2. If you can't remove it from the old controller, **try removing the device using Home Assistant**. Follow the instructions in [Removing Devices](#removing-devices); even though it hasn't been added to Home Assistant yet, most Z-Wave devices will respond to exclusion mode from *any* controller. Then try adding the device to Home Assistant again. (Secure devices with a theft protection feature may not allow this.)
+3. If removing the device doesn't help, **try a factory reset** as a last resort. Check your device's manual for instructions.
+
+### Range Issues
+
+Normally you can add and remove devices as long as they are within range of any Z-Wave Plus device in your network, using a feature called [network-wide inclusion](https://z-wavealliance.org/z-wave_plus_certification/).
+
+If you are using older non-Z-Wave Plus devices, your device may need to be within the range of your [controller](/docs/z-wave/controllers/) to be added or removed. If you cannot move the device (e.g., wall switches), you can try temporarily relocating your controller to be near your device. See the [Z-Wave Alliance documentation on Z-Wave Plus](https://z-wavealliance.org/z-wave_plus_certification/) for more information on how to determine if your devices support Z-Wave Plus.
+
+### Forcibly Removing Devices
+
+You can use the **Remove Failed Node** button to remove a failed device (e.g., because it is broken). In rare cases, you may want to remove a device that has *not* failed. This is not recommended but can help when a device has not been recognized as failed.
+
+1. Go to the *States* menu under *Developer tools* in the Home Assistant frontend
+2. Click on the name of the `zwave.` entity you want to remove
+3. Make note of the entity's "node_id" value as you will need to re-add the "node_id" attribute and value in step 4.
+4. At the top, edit the JSON attributes to replace `false` with `true` for `"is_failed": false,` so that it reads `"is_failed": true.` Also add the "node_id" value to the number listed in the entity's attribute. The YAML attributes should look something like below:
+
+ ```yaml
+ node_id: 6
+ is_failed: true
+ ```
+
+5. Click **Set State**
+6. Go to the [Z-Wave control panel](/integrations/zwave/#control-panel)
+7. Click **Remove Failed Node** in the *Z-Wave Node Management* card
+8. The device will now be removed, but that won't show until you restart Home Assistant
+
+## Control panel
+
+The Z-Wave control panel is available via **Configuration** → **Integrations** → **Z-Wave** → **Configure**.
+
+- **No Z-Wave integration?** Follow the [set up instructions](/integrations/zwave/#detailed-installation-instructions) to enable it.
+- **Missing the *Configuration* button?** See the [configuration documentation](/integrations/config/) for instructions on enabling it.
+
+### Z-Wave Network Management
+
+Here is where you [include and exclude](/integrations/zwave/#adding-removing-devices) Z-Wave devices from your network.
+
+- **Add Node** puts the controller into inclusion mode, so you can include (add) a device to your Z-Wave network
+- **Add Node Secure** puts the controller into secure inclusion mode (this requires that you've created a [security key](/integrations/zwave/#network-key))
+- **Remove Node** puts the controller into exclusion mode, so you can exclude (remove) a device. Note that you can exclude a non-secure device that's been added to another network
+- **Cancel Command** cancels any of the above
+
+- **Heal Network** tells the controller to "heal" the Z-Wave network. Basically asks the nodes to tell the controller all of their neighbors so the controller can recompute optimal routing.
+- **Start Network** starts the Z-Wave network
+- **Stop Network** stops the Z-Wave network
+- **Soft Reset** tells the controller to do a "soft reset." This is not supposed to lose any data, but different controllers can behave differently to a "soft reset" command, and may cause the Z-Wave network to hang.
+- **Test Network** tells the controller to send no-op commands to each node and measure the time for a response. In theory, this can also bring back nodes which have been marked "presumed dead".
+- **Save Configuration** Saves the current cache of the network to `zwcfg_[home_id].xml`.
+
+#### Query Stage
+
+When the Z-Wave mesh is first started, the controller will go through all the following stages for every device on the mesh. This is a slow process, and to complete requires that the devices be awake. While devices that are mains or USB powered are always awake, battery-powered devices spend most of their time asleep. Because of this, you can expect that after startup your battery powered devices will spend time in `Initializing (CacheLoad)` - how long depends on the device.
+
+Your devices will still function normally while marked as `Initializing`.
+
+| Stage | Description |
+| --------------------- | ---------------------------------------------------------------------- |
+| None | Query process hasn't started for this node |
+| ProtocolInfo | Retrieve protocol information |
+| Probe | Ping device to see if alive |
+| WakeUp | Start wake up process if a sleeping node |
+| ManufacturerSpecific1 | Retrieve manufacturer name and product ids if ProtocolInfo lets us |
+| NodeInfo | Retrieve info about supported, controlled command classes |
+| NodePlusInfo | Retrieve Z-Wave+ info and update device classes |
+| SecurityReport | Retrieve a list of Command Classes that require Security |
+| ManufacturerSpecific2 | Retrieve manufacturer name and product ids |
+| Versions | Retrieve version information |
+| Instances | Retrieve information about multiple command class instances |
+| Static | Retrieve static information (doesn't change) |
+| CacheLoad | Ping a device upon restarting with cached configuration for the device |
+| Associations | Retrieve information about associations |
+| Neighbors | Retrieve node neighbor list |
+| Session | Retrieve session information (changes infrequently) |
+| Dynamic | Retrieve dynamic information (changes frequently) |
+| Configuration | Retrieve configurable parameter information (only done on request) |
+| Complete | Query process is completed for this node |
+
+### Z-Wave Node Management
+
+- **Refresh Node** refreshes the information on the node and its entities. If used on a battery powered device, the device will first need to wake for this to work.
+- **Remove Failed Node** will remove a failed node from the network. The node needs to be on the controller's Failed Node List (marked as `is_failed: true`), otherwise this command will fail. You can trick OpenZWave into thinking the node is failed by selecting the `zwave` entity in the *States* menu, under *Developer tools*, and changing `"is_failed": false,` to `"is_failed": true,` then selecting *Set State*.
+- **Replace Failed Node** will replace a failed device with another. If the node is not in the controller's Failed Node List, or the node responds, this command will fail.
+- **Print Node** prints all state of Z-Wave node to the console log
+
+- **Heal Node** starts healing of the node.(Update neighbor list and update return routes)
+
+- **Test Node** sends no_op test messages to the node. This could in theory bring back a dead node.
+
+- **Node Information** this will display the Z-Wave entity card with information about the node:
+
+- **averageRequestRTT** The average Round Trip Time (RTT) of requests sent to the node, in milliseconds. A value of 250, for example, is a quarter of a second.
+- **averageResponseRTT** The average Round Trip Time of responses to requests
+- **battery_level** *Battery powered devices only* - the battery level, which may be rounded to the nearest 10
+- **capabilities** A comma separated list of the capabilities of the device
+- **friendly_name** The name you specified to be displayed
+- **is_awake** Whether the device is awake or not
+- **is_failed** Whether the device has been marked as failed. The controller won't try to contact failed devices.
+- **is_info_received** True once the controller has received the node information from the node.
+- **is_ready** When you start the network (or Home Assistant) it will take a short while before all devices are ready, this shows which aren't yet ready.
+- **is_zwave_plus** True for any Z-Wave Plus devices (note that controllers always report *false*, regardless of whether they are Plus devices or not)
+- **lastRequestRTT** The Round Trip Time of the last request
+- **lastResponseRTT** The Round Trip Time of the response to the last request
+- **manufacturer_name** The name of the manufacturer, as supplied by OpenZWave
+- **max_baud_rate** The maximum bandwidth the device supports, most modern devices will support 40,000 or higher
+- **node_id** The unique node ID of this node
+- **node_name** The base name of this node, this is used to build the entity ID of all entities of this node
+- **product_name** The product name of the device, as supplied by OpenZWave
+- **query_stage** The query stage for this device (see [here](/integrations/zwave/#query-stage) for details)
+- **receivedCnt** The number of messages received from the device
+- **receivedDups** The number of duplicate messages received from the device
+- **receivedTS** The date and time the last message was received from the devices
+- **receivedUnsolicited** How many unsolicited messages were received
+- **retries** How many retries have been made to send messages to this node
+- **sentCnt** How many messages have been sent to the node
+- **sentFailed** How many messages that were sent weren't acknowledged
+- **sentTS** The date and time the last message was sent to the node
+- **wake_up_interval** *Battery powered devices only* - the wakeup interval of the device, in seconds
+
+
+Battery powered devices need to be awake before you can use the Z-Wave control panel to update their settings. How to wake your device is device specific, and some devices will stay awake for only a couple of seconds. Please refer to the manual of your device for more details.
+
+
+#### Entities of this node
+
+This is a dropdown where you can select all the entities of this node. Once selected you can then use:
+
+- **Refresh Entity** to refresh just that entity's values
+- **Entity Information** to display the attributes of that entity (e.g., its friendly name, the ID of the node, etc)
+
+Here you can mark a device as requiring polling so the controller is aware of changes because the device doesn't send updates itself. Do see the information on [polling here](/integrations/zwave/#polling), since excessive polling can break your Z-Wave network.
+
+The **Polling intensity** says how many poll intervals this device is polled on. For example, if you set 2 then it's polled on every second interval.
+
+You can also exclude a Z-Wave devices from Home Assistant. You can do that if you have a device that you need to have on the Z-Wave network, but you don't want it to appear in Home Assistant, or if you've got a device that's failed and you're unable to exclude it.
+
+Renaming Z-Wave entities is done with the same [customization options](/docs/configuration/customizing-devices/) as any other entity in Home Assistant.
+
+#### Node Values
+
+Contains a list of available values of the selected node, and it's instances.
+
+#### Node group associations
+
+Where the device supports the *Association* command class, this will allow you to associate the device with another. OpenZWave will automatically associate the device with the controller, to provide instant updates when the device doesn't support the *Hail* command class.
+
+You can use this to enable one device to directly control another. This is primarily useful for remote controls that operate lights or switches, or where you want to have multiple devices operate as one.
+
+There may be multiple groups, that are used for different purposes. The manual of your device will explain what each group is for.
+
+##### Broadcast group
+
+Some Z-Wave devices may associate themselves with the broadcast node (node 255). You'll be able to tell if this has happened if opening a door (or triggering a motion sensor) causes lights to come on, and closing the door (or the motion sensor going clear) causes lights to run off. You can get rid of this by selecting any target node. If the group has node 255 in it, a *Remove broadcast* button will appear. You can also use the `zwave.change_association` service:
+
+```json
+{"association": "remove", "node_id": 3, "group": 1, "target_node_id": 255}
+```
+
+That would remove the broadcast group from association group 1 of the device with node_id 3.
+
+#### Node configuration options
+
+You can set the *wakeup* interval (in seconds) of the device, this is shown for all devices that can be battery powered, even if they are currently mains powered. The wakeup interval only applies when those devices are battery powered.
+
+
+The wakeup interval has no impact on the device's ability to report sensor changes. This is purely for how often the Z-Wave chip will check in with the controller. That activity consumes a lot of battery power compared to reporting sensor changes and if you reduce it you'll be reducing the battery life of your device.
+
+
+Underneath that you can select any supported configuration parameter to see the current setting. You can then change this and select **Set Configuration Parameter** to updated it. Battery powered devices will be updated the next time they wake.
+
+#### Node protection
+
+If your node has the protection commandclass, you can change the protection level of the node.
+Check your device manual on how to use this setting, as it is different between manufacturers.
+Set the new selection by pressing the **Set Protection** button.
+
+### Node user codes
+
+If your node has user codes, you can set and delete them. The format is raw hex ASCII code. Below the input you will see your actual code. For normal nodes this is as follows:
+
+```yaml
+\x30 = 0
+\x31 = 1
+\x32 = 2
+\x33 = 3
+\x34 = 4
+\x35 = 5
+\x36 = 6
+\x37 = 7
+\x38 = 8
+\x39 = 9
+```
+
+Some non compliant device like tag readers, have implemented to use raw hex code.
+Please refer to a [hex ASCII table](https://www.asciitable.com/) to set your code.
+
+Here is a small Python program than will take numbers on the command line and print the correct sequence for compliant devices:
+
+```python
+#! /usr/bin/python3
+import sys
+
+translations = {}
+
+for x in range(0, 10):
+ translations["%s" % x] = "\\x3%s" % x
+
+for c in sys.argv[1]:
+ print(translations[c], end="")
+```
+
+### OZW Log
+
+If you want to only retrieve some lines at the end of the log, you can specify that with the selection field. Max is the last 1000 lines and minimum is 0 which equals the whole log. If this is not specified, you will retrieve the whole log.
+Select **Load** to open a new window with the static log.
+Select **Tail** to open a new window with a tailing log with the last specified lines of the log. This is a self updating window.
+
+## Instant Status
+
+Older designs of Z-Wave devices may not support *Instant Status* (the *Hail* command class), because of a patent that was held by Lutron Electronics. Some manufacturers paid to use it, others didn't and so those devices may not report on changes. That patent expired in 2016, so new designs should support this.
+
+As long as your device lists Hail or Association in its Controlled Command Classes, then you'll get instant status updates. Devices that list Central Scene in their Controlled Command Classes in theory will also work this way, once OpenZWave supports the Central Scene class. You can check your device on the [Z-Wave alliance](https://products.z-wavealliance.org/) site, looking at the **Command Classes** link, then at the **Controlled Command Classes** section.
+
+## Polling
+
+Where a device doesn't send updates on status changes to the controller, you can work around this by using a thing called Polling. That causes the controller to ask the device to provide an update on all its sensors and states. This will cause a lot of traffic on the network, and if you poll too many devices too quickly, you can effectively break your Z-Wave network. Polling should only be used where there is no other choice, and you should use as large a polling interval as possible. Ideally you should replace the device.
+
+For example, with `polling_interval=60000` (which is the default) if you have 10 devices that are being polled at every interval, and each polling takes one second (request/response round trip), then it will take 10 seconds to complete the polling list. This only leaves 50 seconds left for normal traffic. The more devices you poll, and the shorter the interval, the less bandwidth that's available for normal traffic.
+
+Polling needs to be enabled per device, you can control this through the *polling intensity* (interval) of the device. See the [Node Management](/integrations/zwave/#z-wave-node-management) documentation for details.
+
+## Device specific information
+
+### Aeon Minimote
+
+Here's a handy configuration for the Aeon Labs Minimote that defines all possible button presses. Put it into `automation.yaml`.
+
+```yaml
+ - id: mini_1_pressed
+ alias: "Minimote Button 1 Pressed"
+ trigger:
+ - platform: event
+ event_type: zwave.scene_activated
+ event_data:
+ entity_id: zwave.aeon_labs_minimote_1
+ scene_id: 1
+ - id: mini_1_held
+ alias: "Minimote Button 1 Held"
+ trigger:
+ - platform: event
+ event_type: zwave.scene_activated
+ event_data:
+ entity_id: zwave.aeon_labs_minimote_1
+ scene_id: 2
+ - id: mini_2_pressed
+ alias: "Minimote Button 2 Pressed"
+ trigger:
+ - platform: event
+ event_type: zwave.scene_activated
+ event_data:
+ entity_id: zwave.aeon_labs_minimote_1
+ scene_id: 3
+ - id: mini_2_held
+ alias: "Minimote Button 2 Held"
+ trigger:
+ - platform: event
+ event_type: zwave.scene_activated
+ event_data:
+ entity_id: zwave.aeon_labs_minimote_1
+ scene_id: 4
+ - id: mini_3_pressed
+ alias: "Minimote Button 3 Pressed"
+ trigger:
+ - platform: event
+ event_type: zwave.scene_activated
+ event_data:
+ entity_id: zwave.aeon_labs_minimote_1
+ scene_id: 5
+ - id: mini_3_held
+ alias: "Minimote Button 3 Held"
+ trigger:
+ - platform: event
+ event_type: zwave.scene_activated
+ event_data:
+ entity_id: zwave.aeon_labs_minimote_1
+ scene_id: 6
+ - id: mini_4_pressed
+ alias: "Minimote Button 4 Pressed"
+ trigger:
+ - platform: event
+ event_type: zwave.scene_activated
+ event_data:
+ entity_id: zwave.aeon_labs_minimote_1
+ scene_id: 7
+ - id: mini_4_held
+ alias: "Minimote Button 4 Held"
+ trigger:
+ - platform: event
+ event_type: zwave.scene_activated
+ event_data:
+ entity_id: zwave.aeon_labs_minimote_1
+ scene_id: 8
+```
+
+### Zooz Toggle Switches
+
+Some models of the Zooz Toggle switches ship with an instruction manual with incorrect instruction for Z-Wave inclusion/exclusion. The instructions say that the switch should be quickly switched on-off-on for inclusion and off-on-off for exclusion. However, the correct method is on-on-on for inclusion and off-off-off for exclusion.
+
+### Inovelli Light/Fan Combo (LZW36)
+
+Follow the [instructions](https://support.inovelli.com/portal/kb/articles/installation-setup-lzw36-fan-light-red-series-gen-2-home-assistant-hass-io) provided by Inovelli. You will need to uncomment command class 38 in the imported configuration file.
+
+```xml
+ Configuration
-
-
- 
-
-
- Z-Wave
-
diff --git a/source/images/integrations/tuya/image_002.png b/source/images/integrations/tuya/image_002.png
index f6fd0385ddb..447490b75d9 100644
Binary files a/source/images/integrations/tuya/image_002.png and b/source/images/integrations/tuya/image_002.png differ