Skip to content

Commit

Permalink
Update ZWave documentation (openhab#695)
Browse files Browse the repository at this point in the history
Signed-off-by: Chris Jackson <[email protected]>
  • Loading branch information
cdjackson authored and kaikreuzer committed Jun 3, 2018
1 parent 76a8550 commit 33824ac
Show file tree
Hide file tree
Showing 744 changed files with 11,088 additions and 7,057 deletions.
7 changes: 3 additions & 4 deletions _addons_bindings/zwave/doc/act/45602_0_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ title: 45602 - ZWave
# 45602 Lamp Module with Dimmer Control
This describes the Z-Wave device *45602*, manufactured by *ACT - Advanced Control Technologies* with the thing type UID of ```act_45602_00_000```.

The 45602 does not permanently listening for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour. The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.
The 45602 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.

## Overview

No device information is provided in the database. Consider [updating the database](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/338) to improve the documentation.

## Channels

The following table summarises the channels available for the 45602
The following table summarises the channels available for the 45602 -:

| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
Expand All @@ -26,7 +26,6 @@ The following table summarises the channels available for the 45602

The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.


The ```switch_dimmer``` channel supports the ```Dimmer``` item and is in the ```DimmableLight``` category.

Expand Down Expand Up @@ -188,7 +187,7 @@ The device does not support associations.

### Documentation Links

* [GE 45602 Lamp Dimmer](https://www.cd-jackson.com/zwave_device_uploads/338/45602-UsersGuide.pdf)
* [User Manual](https://www.cd-jackson.com/zwave_device_uploads/338/45602-UsersGuide.pdf)

---

Expand Down
5 changes: 2 additions & 3 deletions _addons_bindings/zwave/doc/act/zdm230_0_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ title: ZDM230 - ZWave
# ZDM230 HomePro Wall Dimmer ZDM230
This describes the Z-Wave device *ZDM230*, manufactured by *ACT - Advanced Control Technologies* with the thing type UID of ```act_zdm230_00_000```.

The ZDM230 does not permanently listening for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour. The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.
The ZDM230 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.

## Overview

Radio Frequency (RF) Controlled, 500W, 230 VAC, European Wall Mounted, 3-Way Dimmer Receiver, Dual Switch, Release 1.1

## Channels

The following table summarises the channels available for the ZDM230
The following table summarises the channels available for the ZDM230 -:

| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
Expand All @@ -26,7 +26,6 @@ The following table summarises the channels available for the ZDM230

The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.


The ```switch_dimmer``` channel supports the ```Dimmer``` item and is in the ```DimmableLight``` category.

Expand Down
5 changes: 2 additions & 3 deletions _addons_bindings/zwave/doc/act/zdp200_0_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: ZDP200 - ZWave
# ZDP200 HomePro ZDP200 Wall Dimmer
This describes the Z-Wave device *ZDP200*, manufactured by *ACT - Advanced Control Technologies* with the thing type UID of ```act_zdp200_00_000```.

The ZDP200 does not permanently listening for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour. The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.
The ZDP200 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.

## Overview

Expand All @@ -22,7 +22,7 @@ Use Habmin or another zwave tool to exclude the device from the zwave mesh.

## Channels

The following table summarises the channels available for the ZDP200
The following table summarises the channels available for the ZDP200 -:

| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
Expand All @@ -32,7 +32,6 @@ The following table summarises the channels available for the ZDP200

The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.


The ```switch_dimmer``` channel supports the ```Dimmer``` item and is in the ```DimmableLight``` category.

Expand Down
7 changes: 3 additions & 4 deletions _addons_bindings/zwave/doc/act/zdw103_0_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ This describes the Z-Wave device *ZDW103*, manufactured by *ACT - Advanced Contr
![ZDW103 product image](https://www.cd-jackson.com/zwave_device_uploads/463/463_default.jpg)


The ZDW103 does not permanently listening for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour. The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.
The ZDW103 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.

## Overview

No device information is provided in the database. Consider [updating the database](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/463) to improve the documentation.

## Channels

The following table summarises the channels available for the ZDW103
The following table summarises the channels available for the ZDW103 -:

| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
Expand All @@ -29,7 +29,6 @@ The following table summarises the channels available for the ZDW103

The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.


The ```switch_dimmer``` channel supports the ```Dimmer``` item and is in the ```DimmableLight``` category.

Expand Down Expand Up @@ -349,7 +348,7 @@ This group supports 5 nodes.
### Documentation Links

* [Specifications](https://www.cd-jackson.com/zwave_device_uploads/463/ZDW103-spec.pdf)
* [Manual](https://www.cd-jackson.com/zwave_device_uploads/463/ZDW103-instr.pdf)
* [User Manual](https://www.cd-jackson.com/zwave_device_uploads/463/ZDW103-instr.pdf)

---

Expand Down
7 changes: 3 additions & 4 deletions _addons_bindings/zwave/doc/act/zdw120_0_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ This describes the Z-Wave device *ZDW120*, manufactured by *ACT - Advanced Contr
![ZDW120 product image](https://www.cd-jackson.com/zwave_device_uploads/460/460_default.jpg)


The ZDW120 does not permanently listening for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour. The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.
The ZDW120 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.

## Overview

No device information is provided in the database. Consider [updating the database](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/460) to improve the documentation.

## Channels

The following table summarises the channels available for the ZDW120
The following table summarises the channels available for the ZDW120 -:

| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
Expand All @@ -29,7 +29,6 @@ The following table summarises the channels available for the ZDW120

The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.


The ```switch_dimmer``` channel supports the ```Dimmer``` item and is in the ```DimmableLight``` category.

Expand Down Expand Up @@ -315,7 +314,7 @@ This group supports 5 nodes.
### Documentation Links

* [Specifications](https://www.cd-jackson.com/zwave_device_uploads/460/ZDW120-spec.pdf)
* [Manual](https://www.cd-jackson.com/zwave_device_uploads/460/ZDW120-instr.pdf)
* [User Manual](https://www.cd-jackson.com/zwave_device_uploads/460/ZDW120-instr.pdf)

---

Expand Down
20 changes: 11 additions & 9 deletions _addons_bindings/zwave/doc/act/zir010_0_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,27 @@ title: ZIR010 - ZWave
# ZIR010 PIR Motion Sensor
This describes the Z-Wave device *ZIR010*, manufactured by *ACT - Advanced Control Technologies* with the thing type UID of ```act_zir010_00_000```.

The ZIR010 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is unable to participate in the routing of data from other devices.

The ZIR010 does not permanently listen for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour. The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.

## Overview

No device information is provided in the database. Consider [updating the database](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/189) to improve the documentation.

## Channels

The following table summarises the channels available for the ZIR010
The following table summarises the channels available for the ZIR010 -:

| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
| Binary Sensor | sensor_binary | Door | Switch |
| Alarm | alarm_general | Door | Switch |
| battery-level | system.battery-level | Battery | Number |
| Battery Level | battery-level | Battery | Number |

### Binary Sensor

Indicates if a sensor has triggered

Indicates if a sensor has triggered.

The ```sensor_binary``` channel supports the ```Switch``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device.

Expand All @@ -38,8 +41,7 @@ The following state translation is provided for this channel to the ```Switch```

### Alarm

Indicates if an alarm is triggered

Indicates if an alarm is triggered.

The ```alarm_general``` channel supports the ```Switch``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device.

Expand All @@ -54,7 +56,7 @@ The following state translation is provided for this channel to the ```Switch```

Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (e.g. 4 levels) should convert to a percentage to provide a consistent battery level reading.

The ```system.battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category.
The ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category.



Expand Down Expand Up @@ -149,14 +151,14 @@ This setting is defined in *seconds*. It is advisable not to set this interval t

Note that this setting does not affect the devices ability to send sensor data, or notification events.

This parameter has the configuration ID ```wakeup_node``` and is of type ```INTEGER```.
This parameter has the configuration ID ```wakeup_interval``` and is of type ```INTEGER```.

### Wakeup Node

When sleeping devices wake up, they send a notification to a listening device. Normally, this device is the network controller, and normally the controller will set this automatically to its own address.
In the event that the network contains multiple controllers, it may be necessary to configure this to a node that is not the main controller. This is an advanced setting and should not be changed without a full understanding of the impact.

This parameter has the configuration ID ```wakeup_interval``` and is of type ```INTEGER```.
This parameter has the configuration ID ```wakeup_node``` and is of type ```INTEGER```.


## Association Groups
Expand Down
9 changes: 4 additions & 5 deletions _addons_bindings/zwave/doc/act/zrm230_0_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This describes the Z-Wave device *ZRM230*, manufactured by *ACT - Advanced Contr
![ZRM230 product image](https://www.cd-jackson.com/zwave_device_uploads/188/188_default.gif)


The ZRM230 does not permanently listening for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour. The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.
The ZRM230 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.

## Overview

Expand All @@ -32,7 +32,7 @@ Including to the Network (Must be installed in permanent location, not on test b

## Channels

The following table summarises the channels available for the ZRM230
The following table summarises the channels available for the ZRM230 -:

| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
Expand All @@ -41,15 +41,14 @@ The following table summarises the channels available for the ZRM230

### Switch

Switch the power on and off
Switch the power on and off.

The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category.

### Dimmer

The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.


The ```switch_dimmer``` channel supports the ```Dimmer``` item and is in the ```DimmableLight``` category.

Expand Down Expand Up @@ -242,7 +241,7 @@ This group supports 5 nodes.

### Documentation Links

* [Instruction](https://www.cd-jackson.com/zwave_device_uploads/188/ZRM230-instr.pdf)
* [User Manual](https://www.cd-jackson.com/zwave_device_uploads/188/ZRM230-instr.pdf)
* [Specification Sheet](https://www.cd-jackson.com/zwave_device_uploads/188/ZRM230-spec.pdf)

---
Expand Down
8 changes: 4 additions & 4 deletions _addons_bindings/zwave/doc/act/zrp200_0_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: ZRP200 - ZWave
# ZRP200 HomePro Applicance Module ZRP200
This describes the Z-Wave device *ZRP200*, manufactured by *ACT - Advanced Control Technologies* with the thing type UID of ```act_zrp200_00_000```.

The ZRP200 does not permanently listening for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour. The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.
The ZRP200 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data from other devices.

## Overview

Expand All @@ -24,15 +24,15 @@ Use Habmin or another zwave tool to exclude the device from the zwave mesh.

## Channels

The following table summarises the channels available for the ZRP200
The following table summarises the channels available for the ZRP200 -:

| Channel | Channel Id | Category | Item Type |
|---------|------------|----------|-----------|
| Switch | switch_binary | Switch | Switch |

### Switch

Switch the power on and off
Switch the power on and off.

The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category.

Expand Down Expand Up @@ -64,7 +64,7 @@ The device does not support associations.
### Documentation Links

* [Installation instructions](https://www.cd-jackson.com/zwave_device_uploads/360/ZRP200-instr.pdf)
* [Device specificatinos](https://www.cd-jackson.com/zwave_device_uploads/360/ZRP200-spec.pdf)
* [Device Specifications](https://www.cd-jackson.com/zwave_device_uploads/360/ZRP200-spec.pdf)

---

Expand Down
Loading

0 comments on commit 33824ac

Please sign in to comment.