diff --git a/_addons_bindings/amazonechocontrol/readme.md b/_addons_bindings/amazonechocontrol/readme.md index ae33a136d..801988a22 100644 --- a/_addons_bindings/amazonechocontrol/readme.md +++ b/_addons_bindings/amazonechocontrol/readme.md @@ -145,6 +145,7 @@ It will be configured at runtime by using the save channel to store the current | musicProviderId | String | R/W | echo, echoshow, echospot | Current Music provider | playMusicVoiceCommand | String | W | echo, echoshow, echospot | Write Only! Voice command as text. E.g. 'Yesterday from the Beatles' | startCommand | String | W | echo, echoshow, echospot | Write Only! Used to start anything. Available options: Weather, Traffic, GoodMorning, SingASong, TellStory, FlashBriefing and FlashBriefing. (Note: The options are case sensitive) +| announcement | String | W | echo, echoshow, echospot | Write Only! Display the announcement message on the display. See in the tutorial section to learn how it’s possible to set the title and turn off the sound. | textToSpeech | String | W | echo, echoshow, echospot | Write Only! Write some text to this channel and alexa will speak it. It is possible to use plain text or SSML: e.g. `I want to tell you a secret.I am not a real human.` | textToSpeechVolume | Dimmer | R/W | echo, echoshow, echospot | Volume of the textToSpeech channel, if 0 the current volume will be used | lastVoiceCommand | String | R/W | echo, echoshow, echospot | Last voice command spoken to the device. Writing to the channel starts voice output. @@ -232,6 +233,7 @@ Switch Echo_Living_Room_Bluetooth "Bluetooth" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:bluetoothDeviceName"} // Commands +String Echo_Living_Room_Announcement "Announcement" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:announcement"} String Echo_Living_Room_TTS "Text to Speech" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:textToSpeech"} Dimmer Echo_Living_Room_TTS_Volume "Text to Speech Volume" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:textToSpeechVolume"} String Echo_Living_Room_Remind "Remind" (Alexa_Living_Room) {channel="amazonechocontrol:echo:account1:echo1:remind"} @@ -356,6 +358,41 @@ then end ``` +### Show an announcement on the echo show or echo spot: + +1) Create a rule with a trigger of your choice + +Simple: + +```php +rule "Say welcome if the door opens" +when + Item Door_Contact changed to OPEN +then + Echo_Living_Room_Announcement.sendCommand('Door opened') +end +``` + +Expert: +You can use a json formatted string to control the title and the sound: + +```php +{ "sound": true, "speak":"" "title": "", "body": "<Body Text>"} +``` + +The combination of sound=true and speak in SSML syntax is not allowed + +Note: If you turn off the sound and alexa is playing music, it will anyway turn down the volume for a moment. This behavior can not be changed. + +```php +rule "Say welcome if the door opens" +when + Item Door_Contact changed to OPEN +then + Echo_Living_Room_Announcement.sendCommand('{ "sound": false, "title": "Doorstep", "body": "Door opened"}') +end +``` + ## Playing an alarm sound for 15 seconds with an openHAB rule if an door contact was opened: 1) Do get the ID of your sound, follow the steps in "How To Get IDs" diff --git a/_addons_bindings/bluetooth.ruuvitag/readme.md b/_addons_bindings/bluetooth.ruuvitag/readme.md index 898127cf2..04929b457 100644 --- a/_addons_bindings/bluetooth.ruuvitag/readme.md +++ b/_addons_bindings/bluetooth.ruuvitag/readme.md @@ -24,6 +24,11 @@ Only a single thing type is added by this extension: | --------------- | ------------------------- | | ruuvitag_beacon | A Ruuvi Tag Sensor Beacon | + +Under normal conditions the ruuvitag should submit data every 10 seconds. +However, if no data has been retrieved after 1 minute the ruuvitag is set to OFFLINE and the state of channels is set to UNDEF. +When new data is retrieved when OFFLINE the ruuvtag is set ONLINE again. + ## Discovery As any other Bluetooth device, Ruuvi Tag Beacons are discovered automatically by the corresponding bridge. diff --git a/_addons_bindings/daikin/readme.md b/_addons_bindings/daikin/readme.md index f3395223a..63e97b36c 100644 --- a/_addons_bindings/daikin/readme.md +++ b/_addons_bindings/daikin/readme.md @@ -34,6 +34,7 @@ This addon will broadcast messages on your local network looking for Daikin air The temperature channels have a precision of one half degree Celsius. For the BRP072A42: + | Channel Name | Description | |--------------|---------------------------------------------------------------------------------------------| | power | Turns the power on/off for the air conditioning unit. | @@ -45,6 +46,7 @@ For the BRP072A42: | fanspeed | The fan speed set for the unit (AUTO, SILENCE, LEVEL_1, LEVEL_2, LEVEL_3, LEVEL_4, LEVEL_5) | For the BRP15B61: + | Channel Name | Description | |-----------------|---------------------------------------------------------------------------------------------| | power | Turns the power on/off for the air conditioning unit. | diff --git a/_addons_bindings/denon1/readme.md b/_addons_bindings/denon1/readme.md index d1ab06033..25cfd8793 100644 --- a/_addons_bindings/denon1/readme.md +++ b/_addons_bindings/denon1/readme.md @@ -7,7 +7,7 @@ description: "The openHAB Denon Binding allows interaction with Denon AV receive source: https://github.com/openhab/openhab1-addons/blob/master/bundles/binding/org.openhab.binding.denon/README.md since: 1x logo: images/addons/denon.png -install: auto +install: legacy --- <!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository --> diff --git a/_addons_bindings/denonmarantz/readme.md b/_addons_bindings/denonmarantz/readme.md index d8de25c1d..b2b394787 100644 --- a/_addons_bindings/denonmarantz/readme.md +++ b/_addons_bindings/denonmarantz/readme.md @@ -17,15 +17,10 @@ install: auto This binding integrates Denon & Marantz AV receivers by using either Telnet or a (undocumented) HTTP API. -## Introduction - -This binding is an adaptation of the existing Denon 1.x binding. -It can be fully configured without any configuration files. -In most cases the AVRs can be discovered and will be added to the Inbox of the Paper UI. - ## Supported Things This binding supports Denon and Marantz receivers having a Telnet interface or a web based controller at `http://<AVR IP address>/`. +The thing type for all of them is `avr`. Tested models: Marantz SR5008, Denon AVR-X2000 / X3000 / X1200W / X2100W / X2200W / X3100W / X3300W @@ -37,13 +32,8 @@ During Discovery this is auto-detected and configured. This binding can discover Denon and Marantz receivers using mDNS. The serial number (which is the MAC address of the network interface) is used as unique identifier. -It tries to detect the number of zones (when the AVR responds to HTTP). It defaults to 2 zones. - -## Binding Configuration - -The AVR should be auto-discovered correctly. -In case it does not work you can add the AVR manually. -There are no configuration files for this binding. +It tries to detect the number of zones (when the AVR responds to HTTP). +It defaults to 2 zones. ## Thing Configuration @@ -59,14 +49,6 @@ There are more parameters which all have defaults set. | httpPort | port number, e.g. 80 | 80 | | httpPollingInterval | polling interval in seconds (minimal 5) | 5 | -### Static definition in a .things file - -Example `.things` file entry: - -``` -Thing denonmarantz:avr:0005cd123456 "Receiver" @ "Living room" [host="192.168.1.100"] -``` - ## Channels The DenonMarantz AVR supports the following channels (some channels are model specific): @@ -103,24 +85,28 @@ The DenonMarantz AVR supports the following channels (some channels are model sp (RW) = read-write (W) = write-only (no feedback) -## Item Configuration +## Full Example -Example of usage in `.items` files. +`.things` file: ``` -Switch marantz_power "Receiver" <switch> {channel="denonmarantz:avr:0006781d58b1:general#power"} -Dimmer marantz_volume "Volume" <soundvolume> {channel="denonmarantz:avr:0006781d58b1:mainZone#volume"} -Number marantz_volumeDB "Volume [%.1f dB]" {channel="denonmarantz:avr:0006781d58b1:mainzone#volume"} -Switch marantz_mute "Mute" <mute> {channel="denonmarantz:avr:0006781d58b1:mainZone#mute"} -Switch marantz_z2power "Zone 2" {channel="denonmarantz:avr:0006781d58b1:zone2#power"} -String marantz_input "Input [%s]" {channel="denonmarantz:avr:0006781d58b1:mainZone#input" } -String marantz_surround "Surround: [%s]" {channel="denonmarantz:avr:0006781d58b1:general#surroundProgram"} -String marantz_command {channel="denonmarantz:avr:0006781d58b1:general#command"} +Thing denonmarantz:avr:1 "Receiver" @ "Living room" [host="192.168.1.100"] ``` -## Sitemap Configuration +`.items` file: -Example of displaying the items in a `.sitemap` file. +``` +Switch marantz_power "Receiver" <switch> {channel="denonmarantz:avr:1:general#power"} +Dimmer marantz_volume "Volume" <soundvolume> {channel="denonmarantz:avr:1:mainZone#volume"} +Number marantz_volumeDB "Volume [%.1f dB]" {channel="denonmarantz:avr:1:mainzone#volume"} +Switch marantz_mute "Mute" <mute> {channel="denonmarantz:avr:1:mainZone#mute"} +Switch marantz_z2power "Zone 2" {channel="denonmarantz:avr:1:zone2#power"} +String marantz_input "Input [%s]" {channel="denonmarantz:avr:1:mainZone#input" } +String marantz_surround "Surround: [%s]" {channel="denonmarantz:avr:1:general#surroundProgram"} +String marantz_command {channel="denonmarantz:avr:1:general#command"} +``` + +`.sitemap` file: ``` ... @@ -135,15 +121,7 @@ Group item=marantz_input label="Receiver" icon="receiver" { ... ``` -## Using the command channel - -In a `.rules` file you can use the sendCommand function to send a command to the AVR. - -``` -marantz_command.sendCommand("MSMCH STEREO") -``` - -## Control protocol documentation +## Control Protocol Reference These resources can be useful to learn what to send using the `command`channel: @@ -152,4 +130,3 @@ These resources can be useful to learn what to send using the `command`channel: - [AVR-3311CI/AVR-3311/AVR-991](http://www.awe-europe.com/documents/Control%20Docs/Denon/Archive/AVR3311CI_AVR3311_991_PROTOCOL_V7.1.0.pdf) - [CEOL Piccolo DRA-N5/RCD-N8](http://www.audioproducts.com.au/downloadcenter/products/Denon/CEOLPICCOLOBK/Manuals/DRAN5_RCDN8_PROTOCOL_V.1.0.0.pdf) - [Marantz Control Protocol (2014+)](http://m.us.marantz.com/DocumentMaster/US/Marantz%202014%20NR%20Series%20-%20SR%20Series%20RS232%20IP%20Protocol.xls) - diff --git a/_addons_bindings/enturno/readme.md b/_addons_bindings/enturno/readme.md new file mode 100644 index 000000000..e249b47a4 --- /dev/null +++ b/_addons_bindings/enturno/readme.md @@ -0,0 +1,111 @@ +--- +id: enturno +label: EnturNo +title: EnturNo - Bindings +type: binding +description: "This binding gets Norwegian public transport real-time (estimated) data from the [Entur.no API](https://developer.entur.org/content/journey-planner-0)." +since: 2x +install: auto +--- + +<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository --> + +{% include base.html %} + +# EnturNo Binding + +This binding gets Norwegian public transport real-time (estimated) data from the [Entur.no API](https://developer.entur.org/content/journey-planner-0). + +## Supported Things + +As for now, binding supports only one thing `linestop`. +It can change in the future as entur.no exposes API for access of different type public transport data, for example: journey planing, stop information etc. + +### Entur Timetable + +Entur timetable provides information about departures for chosen line/service of public transport in Norway and chosen stop place. +It contains informationabout stop place (id, name, transport mode) and real-time departures from that place. +**It is worth noting that binding is thought to be primarily used for busdepartures (can work for other supported by entur.no transport types). +Two Direction channel groups are consequence of that assumption. +That will say that usually for stop place of a given name there are two bus stops for same line going in opposite directions.** +Each **Direction** channel group contains information about direction,line code, 5 coming departures, and whether given departure time is real-time (estimated) or not. + +## Discovery + +Since thing needs to be explicitly configured for stop id and line, no auto discovery is available. + +## Thing Configuration + +### Entur Timetable + +| Parameter | Description | +|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| stopPlaceId (Stop code) | Unique id of stop place that can be get from [en-tur.no](https://en-tur.no) after selecting bus stop. Information will be displayed in link. Example: <https://en-tur.no/nearby-stop-place-detail?id=NSR:StopPlace:30848> stopPlaceId is **NSR:StopPlace:30848** in this case| +| lineCode (Line code) | Code (name or numeber) of line used by public transport provider. Examples: 3, 3E, 4, 21 | + +## Channels + +### Stop Place + +| Channel Group ID | Channel ID | Item Type | Description | +|------------------|-----------------|-----------|-------------------------------------------------------------| +| stopPlace | id | String | Id of the stop place. | +| stopPlace | name | String | Name of the stop place. | +| stopPlace | transportMode | String | Type of transport served from bus stop bus/train/plane etc. | + +### Line Direction + +| Channel Group ID | Channel ID | Item Type | Description | +|-------------------|---------------------------------------------------------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| direction | lineCode | String | Code (usually number) of the public transport line. | +| direction | frontDisplayText | String | Text of front display of the public transport line (usually direction) | +| direction | departure01, departure02, departure03, departure04, departure05 | DateTime | Times of next five departures. | +| direction | estimatedFlag01, estimatedFlag02, estimatedFlag03, estimatedFlag04, estimatedFlag05 | String | Values (true/false) saying that corresponding departure is real-time (estimated - true) or departure from timetable. Values (true/false) can be parsed to boolean. | + +## Full Example + +### Things + +demo.things + +```java +Thing enturno:linestop:1 "Småstrandgaten line nr 2" [stopPlaceId="NSR:StopPlace:30848", lineCode="2"] +``` + +### Items + +demo.items + +```java +// Stop place +String StopId "StopId" {channel="enturno:linestop:1:stopPlace#id"} +String StopPlaceName "Stop Place [%s]" {channel="enturno:linestop:1:stopPlace#name"} +String LineCode "Line [%s]" {channel="enturno:linestop:1:Direction01#lineCode"} +String TransportMode "TransportMode [%s]" {channel="enturno:linestop:1:stopPlace#transportMode"} + +// Direction01 +String Direction01_FrontDisplay "Direction01 front display [%s]" {channel="enturno:linestop:1:Direction01#frontDisplayText"} +DateTime RealTime_Departure01_Time1 "Departure01 time" {channel="enturno:linestop:1:Direction01#departure01"} +DateTime RealTime_Departure02_Time2 "Departure02 time" {channel="enturno:linestop:1:Direction01#departure02"} +DateTime RealTime_Departure03_Time3 "Departure03 time" {channel="enturno:linestop:1:Direction01#departure03"} +DateTime RealTime_Departure04_Time4 "Departure04 time" {channel="enturno:linestop:1:Direction01#departure04"} +DateTime RealTime_Departure05_Time5 "Departure05 time" {channel="enturno:linestop:1:Direction01#departure05"} +String RealTime_Departure01_IsReal1 "Departure01 is real-time" {channel="enturno:linestop:1:Direction01#estimatedFlag01"} +String RealTime_Departure02_IsReal2 "Departure02 is real-time" {channel="enturno:linestop:1:Direction01#estimatedFlag02"} +String RealTime_Departure03_IsReal3 "Departure03 is real-time" {channel="enturno:linestop:1:Direction01#estimatedFlag03"} +String RealTime_Departure04_IsReal4 "Departure04 is real-time" {channel="enturno:linestop:1:Direction01#estimatedFlag04"} +String RealTime_Departure05_IsReal5 "Departure05 is real-time" {channel="enturno:linestop:1:Direction01#estimatedFlag05"} + +//Direction02 +String Direction02_FrontDisplay "Direction02 front display [%s]" {channel="enturno:linestop:1:Direction02#frontDisplayText"} +DateTime RealTime_Departure01_Time1 "Departure01 time" {channel="enturno:linestop:1:Direction02#departure01"} +DateTime RealTime_Departure02_Time2 "Departure02 time" {channel="enturno:linestop:1:Direction02#departure02"} +DateTime RealTime_Departure03_Time3 "Departure03 time" {channel="enturno:linestop:1:Direction02#departure03"} +DateTime RealTime_Departure04_Time4 "Departure04 time" {channel="enturno:linestop:1:Direction02#departure04"} +DateTime RealTime_Departure05_Time5 "Departure05 time" {channel="enturno:linestop:1:Direction02#departure05"} +String RealTime_Departure01_IsReal1 "Departure01 is real-time" {channel="enturno:linestop:1:Direction02#estimatedFlag01"} +String RealTime_Departure02_IsReal2 "Departure02 is real-time" {channel="enturno:linestop:1:Direction02#estimatedFlag02"} +String RealTime_Departure03_IsReal3 "Departure03 is real-time" {channel="enturno:linestop:1:Direction02#estimatedFlag03"} +String RealTime_Departure04_IsReal4 "Departure04 is real-time" {channel="enturno:linestop:1:Direction02#estimatedFlag04"} +String RealTime_Departure05_IsReal5 "Departure05 is real-time" {channel="enturno:linestop:1:Direction02#estimatedFlag05"} +``` diff --git a/_addons_bindings/heos/readme.md b/_addons_bindings/heos/readme.md new file mode 100644 index 000000000..6574c1455 --- /dev/null +++ b/_addons_bindings/heos/readme.md @@ -0,0 +1,420 @@ +--- +id: heos +label: Denon HEOS +title: Denon HEOS - Bindings +type: binding +description: "This binding support the HEOS-System from Denon." +since: 2x +install: auto +--- + +<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository --> + +{% include base.html %} + +# Denon HEOS Binding + +This binding support the HEOS-System from Denon. +The binding provides control of the players and groups within the network. +It also supports selecting favorites and play them on players or groups within the HEOS-Network. +The binding first establishes a connection to one of the players of the HEOS-Network and use them as a bridge. +After a connection is established, the binding searches for all available players and groups via the bridge. +To keep the network traffic low it is recommended to establish only one connection via one bridge. +Connection to the bridge is done via a Telnet connection. + +## Supported Things + +Bridge: +The binding supports a bridge to connect to the HEOS-Network. +A bridge uses the thing ID "bridge". + + +Player: +A generic player is supported via this binding. +Currently no differences are made between the players. +A player uses the thing ID "player" + +Groups: +The binding supports HEOS groups. +A group uses the thing ID "group" + + +## Discovery + +This binding supports full automatic discovery of available players to be used as a bridge, players and groups (both after establishing a connection via a bridge). +Please note that only one bridge is required to establish a connection. +Adding a second bridge can cause trouble with the connection. +It is recommended to use the Paper UI or other GUI to setup the system and add all players and groups. +The bridge is discovered through UPnP in the local network. +Once it is added the players and groups are discovered via the bridge and placed within the inbox. + +## Binding Configuration + +This binding does not require any configuration. + +## Thing Configuration + +### Bridge Configuration + +The bridge has the following configuration parameter + +| Parameter | Description | Required | +|----------------- |------------------------------------------------------------ | --------- | +| ipAddress | The network address of the bridge | yes | +| username | The user name to login to the HEOS account | no | +| password | The password for the HEOS account | no | +| heartbeat | The time in seconds for the HEOS Heartbeat (default = 60 s) | no | + +The password and the user name are used to login to the HEOS account. +This is required to load the favorites, playlists and so on from personal settings. +If no login information is provided these features can't be used. + +```` +Bridge heos:bridge:main "name" [ipAddress="192.168.0.1", unsername="xxx", password="123456"] +```` + +### Player Configuration + +Player have the following configuration parameter + +| Parameter | Description | Required | +|----------------- |----------------------------------------------------------- | --------- | +| pid | The internal player ID | yes | + +For manual configuration a player can be defined as followed: + +```` +Thing heos:player:player1 "name" [pid="123456789"] +```` + +PID behind the heos:player:--- should be changed as required. +It is recommended to use the player PID. +If the PID isn't known it can be discovered by establishing a Telnet connection (port 1255) to one player and search for available players (Command: heos://player/get_players) within the network. +Another way is to use Paper UI to discover the player via the bridge and get the PID. +For further details refer to the [HEOS CLI](https://rn.dmglobal.com/euheos/HEOS_CLI_ProtocolSpecification.pdf) specification. + +### Group Configuration + +Player have the following configuration parameter + +| Parameter | Description | Required | +|----------------- |------------------------------------------------------------------------------------- | --------- | +| members | The members of the groups. These are the player IDs. IDs have to be separated by ";" | yes | + + +``` +Thing heos:group:group1 "name" [members="45345634;35534567"] +``` + +### Defining Bridge and Players together + +Defining Player and Bridge together. +To ensure that the players and groups are attached to the bridge the definition can be like: + +``` +Bridge heos:bridge:main "Bridge" [ipAddress="192.168.0.1", username="userName", password="123456"] { + player Kitchen "Kitchen"[pid="434523813"] + player LivingRoom "Living Room"[pid="918797451"] + group 813793755 "Ground Level"[members="434523813;918797451"] +} +``` + +## Channels + +### Channels of Thing type 'player' + +| Channel ID | Item Type | Description | +|----------------- |----------- |--------------------------------------------------------------------- | +| Control | Player | Play (also ON) / Pause (also OFF) / Next / Previous | +| Volume | Dimmer | Volume control / also accepts "DECREASE" & "INCREASE" | +| Mute | Switch | Mute the Player | +| Title | String | Song Title | +| Artist | String | Song Artist | +| Album | String | Album Title | +| Cover | Image | The cover of the actual song | +| Inputs | String | The input to be switched to. Input values from HEOS protocol | +| CurrentPosition | Number:Time | Shows the current track position in seconds | +| Duration | Number:Time | The overall track duration in seconds | +| Type | String | The type of the played media. Station or song for example | +| Station | String | The station name if it is a station (Spotify shows track name....) | +| PlayUrl | String | Plays a media file located at the URL | +| Shuffle | Switch | Switches shuffle ON or OFF | +| RepeatMode | String | Defines the repeat mode: Inputs are: "One" , "All" or "Off" | +| Playlists | String | Plays a playlist. Playlists are identified by numbers (starting at 0!). List can be found in the HEOS App | + + +#### Example + +``` +Player LivingRoom_Control "Control" {channel="heos:player:main:LivingRoom:Control"} +``` + +### Channels of Thing type 'group' + +| Channel ID | Item Type | Description | +|----------------- |----------- |-------------------------------------------------------------------- | +| Control | Player | Play (also ON) / Pause (also OFF) / Next / Previous | +| Volume | Dimmer | Volume control / also accepts "DECREASE" & "INCREASE" | +| Mute | Switch | Mute the Group | +| Title | String | Song Title | +| Artist | String | Song Artist | +| Album | String | Album Title | +| Ungroup | Switch | Deletes the group (OFF) or generate the group again (ON) | +| Cover | Image | The cover of the actual song | +| CurrentPosition | Number:Time | Shows the current track position in seconds | +| Duration | Number:Time | The overall track duration in seconds | +| Type | String | The type of the played media. Station or song for example | +| Station | String | The station name if it is a station (Spotify shows track name....) | +| Inputs | String | The input to be switched to. Input values from HEOS protocol | +| PlayUrl | String | Plays a media file located at the URL | +| Shuffle | Switch | Switches shuffle ON or OFF | +| RepeatMode | String | Defines the repeat mode: Inputs are: "One" ; "All" or "Off" | +| Playlists | String | Plays a playlist. Playlists are identified by numbers (starting at 0!). List can be found in the HEOS App | + +| Input names | +|-------------- | +| aux_in_1 | +| aux_in_2 | +| aux_in_3 | +| aux_in_4 | +| aux1 | +| aux2 | +| aux3 | +| aux4 | +| aux5 | +| aux6 | +| aux7 | +| line_in_1 | +| line_in_2 | +| line_in_3 | +| line_in_4 | +| coax_in_1 | +| coax_in_2 | +| optical_in_1 | +| optical_in_2 | +| hdmi_in_1 | +| hdmi_arc_1 | +| cable_sat | +| dvd | +| bluray | +| game | +| mediaplayer | +| cd | +| tuner | +| hdradio | +| tvaudio | +| phono | + +An current list can be found within the HEOS CLI protocol which can be found [here](https://rn.dmglobal.com/euheos/HEOS_CLI_ProtocolSpecification.pdf). + +### Channels of Thing type 'bridge' + +| Channel ID | Item Type | Description | +|---------------------- |----------- |-------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Reboot | Switch | Reboot the whole HEOS System. Can be used if you get in trouble with the system | +| BuildGroup | Switch | Is used to define a group. The player which shall be grouped has to be selected first. If Switch is then activated the group is build. | + + + +For a list of the commands please refer to the [HEOS CLI protocol](https://rn.dmglobal.com/euheos/HEOS_CLI_ProtocolSpecification.pdf). + + +## *Dynamic Channels* + +Also the bridge, players and groups supports dynamic channels which represent the players of the network and the favorites. +They are added dynamically if a player is found and if favorites are defined within the HEOS Account. +To activate Favorites the system has to be signed in to the HEOS Account. +The player and group channels are only shown on the bridge. + + +### Favorite Channels + +| Channel ID | Item Type | Description | +|------------ |----------- |------------------------------------------------------------------------------------------------------- | +| {mid} | Switch | A channel which represents the favorite. Please check via UI how the correct Channel Type looks like. | + + Example + + ``` + Switch Favorite_1 "Fav 1 [%s]" {channel="heos:bridge:main:s17492"} + ``` + +### Player Channels + +| Channel ID | Item Type | Description | +|------------ |----------- |----------------------------------------------------------------------------------------------------- | +| {playerID} | Switch | A channel which represents the player. Please check via UI how the correct Channel Type looks like. | + +Example + + ``` + Switch Player_1 "Player [%s]" {channel="heos:bridge:main:P123456789"} + ``` + + The {playerUID} has either a P in front of the number which indicates that this is a player or a G to indicate this is a group. + +## Full Example + +###demo.things: + +``` +Bridge heos:bridge:main "Bridge" [ipAddress="192.168.0.1", username="userName", password="123456"] { + player Kitchen "Kitchen"[pid="434523813"] + player LivingRoom "Living Room"[pid="918797451"] + group 813793755 "Ground Level"[members="434523813;918797451"] +} +``` + +###demo.items: + +``` +Player LivingRoom_Control "Control" {channel="heos:player:main:LivingRoom:Control"} +Switch LivingRoom_Mute "Mute"{channel="heos:player:main:LivingRoom:Mute"} +Dimmer LivingRoom_Volume "Volume" {channel="heos:player:main:LivingRoom:Volume"} +String LivingRoom_Title "Title [%s]" {channel="heos:player:main:LivingRoom:Title"} +String LivingRoom_Interpret "Interpret [%s]" {channel="heos:player:main:LivingRoom:Artist"} +String LivingRoom_Album "Album [%s]" {channel="heos:player:main:LivingRoom:Album"} +``` + +###demo.sitemap + +``` + Frame label="LivingRoom" { + Default item=LivingRoom_Control + Default item=LivingRoom_Mute + Default item=LivingRoom_Volume + Default item=LivingRoom_Title + Default item=LivingRoom_Interpret + Default item=LivingRoom_Album + } +``` + +## Detailed Explanation + +This section gives some detailed explanations how to use the binding. + +### Grouping Players + +Players can be grouped via the binding. +To do so, select the player channels of the players you want to group at the bridge and then use the "Made Group" channel to create the group. +The first player which is selected will be the group leader. +The group GID then is the same as the PID of the group leader. +Therefore changing play pause and some other things at the leading player will also change that at the whole group. +Muting and Volume on the other hand can be changed individually for each player also for the group leader. +If you want to change that for the whole group you have to do it via the group thing. + +### Inputs + +To play inputs like the Aux_In it can be played at each player or group. +It is also possible to play an input from another player at the selected player. +To do so, first select the player channel of the player where the input is located (source) at the bridge. +Then use the input channel of the player where the source shall be played (destination) to activate the input. + +#### Example + +Player A = Kitchen (destination) +Player B = Living Room (source) + +Items: + +``` +Switch HeosBridge_Play_Living "Living Room" (gHeos) {channel="heos:bridge:ed0ac1ff-0193-65c6-c1b8-506137456a50:P918797451"} +String HeosKitchen_Input (gHeos) {channel="heos:player:918797451:Inputs"} +String HeosKitchen_InputSelect "Input" (gHeos) +``` + +Rule for kitchen: + +``` +rule "Play AuxIn from Living Room" + when + Item HeosKitchen_InputSelect received command + then + if (receivedCommand.toString == "aux_in_1") { + sendCommand(HeosKitchen_Input, "aux_in_1") + + } if (receivedCommand.toString == "LivingRoom") { + sendCommand(HeosBridge_Play_Living, ON) + sendCommand(HeosKitchen_Input, "aux_in_1") + sendCommand(HeosBridge_Play_Living, OFF) //Switch player channel off again to be sure that it is OFF + } +``` + +Sitemap: + +``` +Switch item=HeosKitchen_InputSelect mappings=[aux_in_1 = "Aux In" , LivingRoom = "Living Room"] +``` + +### The Online status of Groups and Players + +The online state of a Thing can be helpful for groups to control the visibility of group items within sitemap. +So if the group is removed the visibility of those items is also changed. + +#### Example + +First you have to define a new Item within the Item section which is used later within the Sitemap: + +Items: + +``` +String HeosGroup_Status + +``` + +Then we need a rule which triggers the state if an Item goes Online or Offline. + +Rules: + +``` +rule "Online State Heos Group" + +when + Thing "heos:group:1747557118" changed +then + var thingStatus = getThingStatusInfo("heos:group:1747557118") + sendCommand(HeosGroup_Status, thingStatus.getStatus.toString) +end + +``` + +Sitemap: + +``` +Frame label="Heos Group" visibility=[HeosGroup_Status==ONLINE] { + + Default item=HeosGroup1_Player + Default item=HeosGroup1_Volume + Default item=HeosGroup1_Mute + Default item=HeosGroup1_Favorites + Default item=HeosGroup1_Playlist + + Text item=HeosGroup1_Song { + Default item=HeosGroup1_Song + Default item=HeosGroup1_Artist + Default item=HeosGroup1_Album + Image item=HeosGroup1_Cover url="" + } + +} +``` + +### Playlists + +Playlists can be played by sending the number (starts at 0!) to the binding via the playlists channel at the corresponding player or group. +To find the correct number for the playlist, please have a look to the HEOS App and see at which position the playlist you want to play is located. + +#### Example + +Items: + +``` +String HeosKitchen_Playlist "Playlists" (gHeos) {channel="heos:player:918797451:Playlists"} + +``` + +Sitemap: + +``` +Switch item=HeosKitchen_Playlists mappings=[0="San Glaser", 1="Classic", 2="Beasty Boys"] +``` diff --git a/_addons_bindings/iaqualink/readme.md b/_addons_bindings/iaqualink/readme.md new file mode 100644 index 000000000..54ed53963 --- /dev/null +++ b/_addons_bindings/iaqualink/readme.md @@ -0,0 +1,133 @@ +--- +id: iaqualink +label: iAquaLink +title: iAquaLink - Bindings +type: binding +description: "This binding supports:" +since: 2x +install: auto +--- + +<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository --> + +{% include base.html %} + +# iAquaLink Binding + +This binding supports: + +* Any iAquaLink based pool system +* Reading auxiliary, temperature, pump, chemistry and system values +* Controlling system, auxiliary, lighting, and temperature settings + +## Binding Configuration + +The binding requires the iAquaLink user name and password. +If you have more then one pool system registered to an account, you may optionally specify the pool serial ID/Number to use, otherwise the first pool controller will be used. + + +## Manual Thing Configuration + +``` +Thing iaqualink:controller:pool [ userName="user@domain.com", password="somepassword"] +``` + +## Channels + + +The following is a list of supported channels. +Auxiliary and OneTouch channels will be dynamically added depending on what a system reports as being supported. + +Auxiliary channels that are of a number type represent lighting modes (typically 0-15), Auxiliary channels that are dimmer types can set the light value in increments of 25 (0,25,50,750,100). The Auxiliary channel type will be dynamically assigned based on the controller configuration. + +Heater status can be OFF (0), Enabled/ON (3), or Heating (1). + +| Channel Type ID | Item Type | +|---------------------|----------------------------| +| status | String | +| system_type | Number | +| temp_scale | String | +| spa_temp | Number:Temperature | +| pool_temp | Number:Temperature | +| air_temp | Number:Temperature | +| spa_set_point | Number:Temperature | +| pool_set_point | Number:Temperature | +| cover_pool | Switch | +| freeze_protection | Switch | +| spa_pump | Switch | +| pool_pump | Switch | +| spa_heater | Switch | +| pool_heater | Switch | +| solar_heater | Switch | +| spa_heater_status | Number | +| pool_heater_status | Number | +| solar_heater_status | Number | +| spa_salinity | Number | +| pool_salinity | Number | +| orp | Number | +| ph | Number | +| onetouch_1 | Switch | +| onetouch_n+1 | Switch | +| aux_1 | Switch or String or Dimmer | +| aux_n+1 | Switch or String or Dimmer | + +### Color/Mood Auxiliary Channels + +String auxiliary channels can control a variety of lighting moods/colors depending on what type of lighting system is installed. +The following is a table of aux_n channel values (String) to lighting set descriptions values. +The binding will automatically detect which color system is enabled and add the appropriate channel type with the following option labels. +Colors can be set, but only On or Off is reported back as the current state of the channel. + +| String Value | jandy Color | Jandy Led Water Colors | Pentair SAm/SAL | Hayward Universal | Pentair intelliBrite | +|--------------|----------------|------------------------|-----------------|-------------------|----------------------| +| "off" | Off | Off | Off | Off | Off | +| "on" | On | On | On | On | On | +| "1" | Alpine White | Alpine White | White | Voodoo Lounge | SAM | +| "2" | Sky Blue | Sky Blue | Light Green | Deep Blue Sea | Party | +| "3" | Cobalt Blue | Cobalt Blue | Green | Afternoon Skies | Romance | +| "4" | Caribbean Blue | Caribbean Blue | Cyan | Emerald | Caribbean | +| "5" | Spring Green | Spring Green | Blue | Sangria | American | +| "6" | Emerald Green | Emerald Green | Lavender | Cloud White | Cal Sunset | +| "7" | Emerald Rose | Emerald Rose | Magenta | Twilight | Royal | +| "8" | Magenta | Magenta | Light Magenta | Tranquility | Blue | +| "9" | Garnet Red | Violet | Color Splash | Gemstone | Green | +| "10" | Violet | Slow Splash | | USA! | Red | +| "11" | Color Splash | Fast Splash | | Mardi Gras | White | +| "12" | | USA!!! | | Cool Caberet | Magenta | +| "13" | | Fat Tuesday | | | Hold | +| "14" | | Disco Tech | | | Recall | + + + + +## Sample Items + +``` +Group Group_AquaLink +String AquaLinkStatus "Status [%s]" (Group_AquaLink) {channel="iaqualink:controller:pool:status"} +Switch AquaLinkBoosterPump "Booster Pump" (Group_AquaLink) {channel="iaqualink:controller:pool:aux_1"} +Switch AquaLinkPoolLight "Pool Light" (Group_AquaLink) {channel="iaqualink:controller:pool:aux_2"} +Switch AquaLinkSpaLight "Spa Light" (Group_AquaLink) {channel="iaqualink:controller:pool:aux_3"} +Switch AquaLinkVanishingEdge "Vanishing Edge" (Group_AquaLink) {channel="iaqualink:controller:pool:aux_4"} + +Switch AquaLinkAllOffOneTouch "All Off" (Group_AquaLink) {channel="iaqualink:controller:pool:onetouch_1"} +Switch AquaLinkSpaOneTouch "Spa Mode" (Group_AquaLink) {channel="iaqualink:controller:pool:onetouch_2"} +Switch AquaLinkCleanOneTouch "Clean Mode" (Group_AquaLink) {channel="iaqualink:controller:pool:onetouch_3"} +Switch AquaLinkPoolOneTouch "Pool Mode" (Group_AquaLink) {channel="iaqualink:controller:pool:onetouch_4"} + +Number:Temperature AquaLinkSpaTemp "Spa Temperature [%d]" (Group_AquaLink) {channel="iaqualink:controller:pool:spa_temp"} +Number:Temperature AquaLinkPoolTemp "Pool Temperature [%d]" (Group_AquaLink) {channel="iaqualink:controller:pool:pool_temp"} +Number:Temperature AquaLinkAirTemp "Air Temperature [%d]" (Group_AquaLink) {channel="iaqualink:controller:pool:air_temp"} + +Number:Temperature AquaLinkSpaSetpoint "Spa Setpoint [%d]" (Group_AquaLink) {channel="iaqualink:controller:pool:spa_set_point"} +Number:Temperature AquaLinkPoolSetpoint "Pool Setpoint [%d]" (Group_AquaLink) {channel="iaqualink:controller:pool:pool_set_point"} + +Switch AquaLinkSpaPump "Spa Pump" (Group_AquaLink) {channel="iaqualink:controller:pool:spa_pump"} +Switch AquaLinkPoolPump"Pool Pump" (Group_AquaLink) {channel="iaqualink:controller:pool:pool_pump"} + +Number AquaLinkSpaHeaterStatus "Spa Heater [%s]" (Group_AquaLink) {channel="iaqualink:controller:pool:spa_heater_status"} +Number AquaLinkPoolHeaterStatus "Pool Heater [%s]" (Group_AquaLink) {channel="iaqualink:controller:pool:pool_heater_status"} + +Switch AquaLinkSpaHeater "Spa Heater" (Group_AquaLink) {channel="iaqualink:controller:pool:spa_heater"} +Switch AquaLinkPoolHeater "Pool Heater" (Group_AquaLink) {channel="iaqualink:controller:pool:pool_heater"} +``` diff --git a/_addons_bindings/kodi/readme.md b/_addons_bindings/kodi/readme.md index a69417833..53b3e5473 100644 --- a/_addons_bindings/kodi/readme.md +++ b/_addons_bindings/kodi/readme.md @@ -89,7 +89,7 @@ The Kodi thing supports the following channels: | showtitle | String | Title of the currently played tv-show; empty for other types | | album | String | Album name of the currently played song | | artist | String | Artist name of the currently played song or director of the currently played movie | -| playuri | String | Plays the file with the provided URI | +| playuri | String | Plays the file with the provided URI. The URI can be amended by `#timestamp=<s>` where `s` is position in seconds at which the video should be started. | | playfavorite | String | Plays or opens the favorite with the provided title (channel's state options contains available favorites) | | pvr-open-tv | String | Opens the PVR TV channel with the provided name (channel's state options contains available PVR TV channels) | | pvr-open-radio | String | Opens the PVR Radio channel with the provided name (channel's state options contains available PVR Radio channels) | diff --git a/_addons_bindings/mail/readme.md b/_addons_bindings/mail/readme.md index db2024138..dc2748920 100644 --- a/_addons_bindings/mail/readme.md +++ b/_addons_bindings/mail/readme.md @@ -116,6 +116,9 @@ Since there is a separate rule action instance for each `smtp` thing, this needs The first parameter always has to be `mail` and the second is the full Thing UID of the SMTP server that should be used. Once this action instance is retrieved, you can invoke the action method on it. +Please note: all strings are expected to be UTF-8 encoded. +Using different character sets may produce unwanted results. + Examples: ``` diff --git a/_addons_bindings/milight/readme.md b/_addons_bindings/milight/readme.md index c3429a5bb..65f3c34b9 100644 --- a/_addons_bindings/milight/readme.md +++ b/_addons_bindings/milight/readme.md @@ -52,7 +52,7 @@ configuration file. iBox and iBox2 have the version 6, older milight bridges have the version 3. The ID is the MAC address of the bridge in hexadecimal digits. - Bridge milight:bridgeV3:mybridge [ host="192.168.0.70", bridgeid="ACCF23A6C0B4", passwordByte1=0, passwordByte2=0 ] { + Bridge milight:bridgeV3:mybridge [ host="192.168.0.70", bridgeid="ACCF23A6C0B4", passwordByte1=0, passwordByte2=0, repeat=2, delayTime=75 ] { Thing whiteLed myWhite [ zone="0" ] Thing rgbwwLed myRGB [ zone="4" ] Thing rgbLed myOldRGB [ zone="1" ] @@ -62,6 +62,14 @@ The Thing configuration for the bridge uses the following syntax * Bridge milight:bridgeV3:<any name> &lsqb host="<IP-Address of bridge>", bridgeid="<mac>" &rsqb * Bridge milight:bridgeV6:<any name> &lsqb host="<IP-Address of bridge>", bridgeid="<mac>", passwordByte1="<0-255>", passwordByte2="<0-255>" &rsqb + +Optionally, the following parameters can be added + +* repeat=<integer> (defaults to 1, if not defined) + Usually the bridge receives all commands albeit UDP is used. But the actual bulbs might be slightly out of bridge radio range and it sometimes helps to send commands multiple times. +* delayTime=<integer for ms> (defaults to 100, if not defined) + Time to wait before sending another command to the bridge. It is safe to have a wait time of 1/10s but usually sufficient to just wait 50ms. If the value is too high, commands queue up. + The Thing configuration for the bulbs uses the following syntax: &lsqbThing&rsqb <type of bulb> <any name> &lsqb zone="<0-4>" &rsqb diff --git a/_addons_bindings/neohub1/readme.md b/_addons_bindings/neohub1/readme.md index 96eb052fc..ed9ddfe31 100644 --- a/_addons_bindings/neohub1/readme.md +++ b/_addons_bindings/neohub1/readme.md @@ -6,7 +6,7 @@ type: binding description: "The NeoHub binding allows you to connect openhab via TCP/IP to Heatmiser's NeoHub and integrate your NeoStat thermostats onto the bus." source: https://github.com/openhab/openhab1-addons/blob/master/bundles/binding/org.openhab.binding.neohub/README.md since: 1x -install: auto +install: legacy --- <!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository --> diff --git a/_addons_bindings/omnikinverter/readme.md b/_addons_bindings/omnikinverter/readme.md new file mode 100644 index 000000000..70c9211cd --- /dev/null +++ b/_addons_bindings/omnikinverter/readme.md @@ -0,0 +1,70 @@ +--- +id: omnikinverter +label: Omnik Inverter +title: Omnik Inverter - Bindings +type: binding +description: "This binding reads metrics from Omnik Solar Inverters." +since: 2x +install: auto +--- + +<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository --> + +{% include base.html %} + +# Omnik Inverter Binding + +This binding reads metrics from Omnik Solar Inverters. + +## Supported Things + +All Omniksols are expected to function, provided they have the Wifi module. At +moment of writing the _Omniksol-3.0k-TL2_ has been tested. + +## Discovery + +No autodiscovery available + +## Thing Configuration + +| Config | Description | type | Default | +| :------- | :------------ | :----- | :-------- | +| hostname | The hostname or ip through which the inverter can be accessed | string | n/a | +| port | TCP port through which the inverter listens on for incoming connections | integer | 8899 | +| serial | The serial of the wifi module. The Wifi module's SSID contains the number. This is the numerical part only, i.e. without _AP__ | integer | n/a | + +## Channels + +| Channel Type Id | Item Type | Description | +| :---------------- | :---------- | :------------ | +| power | Number:Power | The instantaneous power generation | +| energyToday | Number:Energy | The amount of energy generated today | +| energyTotal | Number:Energy | The total amount of energy generated | + +## Full Example + +### demo.things + +``` +Thing omnikinverter:omnik:70ecb4f0 "Solar Inverter" [ hostname="igen-wifi.lan",serial=604455290] +``` + +### demo.items + +``` +Number OmnikInverterBindingThing_InstantaneousPower "Solar Power" {channel="omnikinverter:omnik:70ecb4f0:power"} +Number OmnikInverterBindingThing_TotalGeneratedEnergyToday "Solar Energy Today" {channel="omnikinverter:omnik:70ecb4f0:energyToday"} +Number OmnikInverterBindingThing_TotalGeneratedEnergy "Solar Energy Total" {channel="omnikinverter:omnik:70ecb4f0:energyTotal"} +``` + +### Sitemap + +``` +Text item=OmnikInverterBindingThing_InstantaneousPower +Text item=OmnikInverterBindingThing_TotalGeneratedEnergyToday label="Today" +Text item=OmnikInverterBindingThing_TotalGeneratedEnergy label="Total" +``` + +## References + +Based on the work of https://github.com/Woutrrr/Omnik-Data-Logger diff --git a/_addons_bindings/pjlinkdevice/readme.md b/_addons_bindings/pjlinkdevice/readme.md new file mode 100644 index 000000000..aaea2570e --- /dev/null +++ b/_addons_bindings/pjlinkdevice/readme.md @@ -0,0 +1,90 @@ +--- +id: pjlinkdevice +label: PJLink +title: PJLink - Bindings +type: binding +description: "This binding allows you to control devices with [PJLink](https://pjlink.jbmia.or.jp/english/) support." +since: 2x +install: auto +--- + +<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository --> + +{% include base.html %} + +# PJLink Binding + +This binding allows you to control devices with [PJLink](https://pjlink.jbmia.or.jp/english/) support. +PJLink is a protocol that was developed to standardize IP control of digital projectors, but can also be used by other device types. + +Aspects that can be controlled via PJLink are power on/off, input source selection and volume/mute setting. + +## Supported Things + +This binding supports devices which implement the PJLink protocol (Class 1). + +Limitations at this point: + +- only IPv4 connections are supported +- only PJLink Class 1 commands are supported. Class 2 devices should work fine nevertheless, it's just the Class 2 features that will not work. + +The binding is tested with the PJLink device test tool (PJLinkTEST4CNT) and an Acer VL7680. + +## Discovery + +Autodiscovery is checking all IP addressess of all class C IPv4 subnets connected to the openHAB system for devices which respond PJLink compliant on the PJLink standard port 4352. + +## Thing Configuration + +The *pjLinkDevice* thing type has the following parameters: + +| Parameter | Description | +|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipAddress | the IPv4 address of the device **Mandatory** | +| tcpPort | the listening TCP port of the devices. *Optional, the default value is 4352* | +| adminPassword | the PJLink password of the device (should be left empty for devices without authentication). *Optional* | +| refreshInterval | the polling interval (in seconds) to update the channel values from the device, can be set to 0 to disable polling. *Optional, the default value is 5* | +| refreshPower | enables polling of the power status. *Optional, the default value is false* | +| refreshMute | enables polling of the mute status. *Optional, the default value is false* | +| refreshInputChannel | enables polling of the selected input channel. *Optional, the default value is false* | +| autoReconnectInterval | seconds between connection retries when connection to the PJLink device has been lost, 0 means never retry, minimum 30s *Optional, the default value is 60* | + + +## Channels + +| Channel | Description | +|-------------------|-------------------------------------------| +| power | Switches the device on/off | +| input | Switches the input channel of the device | +| audioMute | Mutes the device audio | +| videoMute | Mutes the device video | + +## Full Example + +sample.things: + +``` +pjLinkDevice:pjLinkDevice:MyProjector [ ipAddress="192.168.178.10" ] +``` + +sample.items: + +``` +Switch Projector_Power "Projector Power" { channel="pjLinkDevice:pjLinkDevice:MyProjector:power" } +String Projector_Input "Projector Input" { channel="pjLinkDevice:pjLinkDevice:MyProjector:input" } +Switch Projector_AudioMute "Projector Audio Mute" { channel="pjLinkDevice:pjLinkDevice:MyProjector:audioMute" } +Switch Projector_VideoMute "Projector Video Mute" { channel="pjLinkDevice:pjLinkDevice:MyProjector:videoMute" } +``` + +sample.sitemap: + +``` +sitemap sample label="Main Menu" { + Frame { + Switch item=Projector_Power + Selection item=Projector_Input + Switch item=Projector_AudioMute + Switch item=Projector_VideoMute + } +} +``` diff --git a/_addons_bindings/rfxcom/readme.md b/_addons_bindings/rfxcom/readme.md index 46add9a55..7816e0d08 100644 --- a/_addons_bindings/rfxcom/readme.md +++ b/_addons_bindings/rfxcom/readme.md @@ -169,11 +169,13 @@ This binding currently supports following channel types: |-----------------|---------------|------------------------------------------------------------------------------------| | chimesound | Number | Id of the chime sound | | command | Switch | Command channel. | - | commandId | Number | Id of the command (between 0 and 255). | +| commandId | Number | Id of the command (between 0 and 255). | | commandString | String | Id of the command. | | contact | Contact | Contact channel. | | datetime | DateTime | DateTime channel. | | dimminglevel | Dimmer | Dimming level channel. | +| fanspeedstring | String | Set the speed of the device, values could be device specific | +| fanlight | Switch | Enable light of Fan | | forecast | String | Weather forecast from device: NO\_INFO\_AVAILABLE/SUNNY/PARTLY\_CLOUDY/CLOUDY/RAIN | | tempcontrol | Rollershutter | Global control for temperature also setting ON, OFF, UP, DOWN | | humidity | Number | Relative humidity level in percentages. | @@ -239,6 +241,7 @@ This binding currently supports the following things / message types: * [curtain1 - RFXCOM Curtain1 Actuator](#curtain1---rfxcom-curtain1-actuator) * [datetime - RFXCOM Date/time sensor](#datetime---rfxcom-datetime-sensor) * [energy - RFXCOM Energy Sensor](#energy---rfxcom-energy-sensor) +* [fan - RFXCOM Fan Actuator](#fan---rfxcom-fan-actuator) * [humidity - RFXCOM Humidity Sensor](#humidity---rfxcom-humidity-sensor) * [lighting1 - RFXCOM Lighting1 Actuator](#lighting1---rfxcom-lighting1-actuator) * [lighting2 - RFXCOM Lighting2 Actuator](#lighting2---rfxcom-lighting2-actuator) @@ -438,6 +441,45 @@ A DateTime device * RTGR328N - Oregon RTGR328N +### fan - RFXCOM Fan Actuator + +A group of fan devices + +#### Standard Fan + +A Fan device + + +##### Channels + +| Name | Channel Type | Item Type | Remarks | +|--------------|-------------------------------------|-----------|------------------------------| +| command | [command](#channels) | Switch | | +| fanSpeed | [fanspeedstring](#channels) | String | Options: HI, MED, LOW, OFF | +| fanLight | [fanlight](#channels) | Switch | | +| signalLevel | [system.signal-strength](#channels) | Number | | + + +##### Configuration Options + +* deviceId - Device Id + * Device id, example 47360 +* subType - Sub Type + * Specifies device sub type. + * LUCCI_AIR_FAN - Lucci Air fan + * CASAFAN - Casafan + * WESTINGHOUSE_7226640 - Westinghouse 7226640 + +##### Example + +Sitemap: + +```java +Switch item=FanSwitch label="Fan" +Switch item=FanLightSwitch label="Light" mappings=[ON="On"] +Switch item=FanSpeedSwitch label="Speed" mappings=[LOW=Low, MED=Medium, HI=High] +``` + ### energy - RFXCOM Energy Sensor An Energy device diff --git a/_addons_bindings/rotel/readme.md b/_addons_bindings/rotel/readme.md new file mode 100644 index 000000000..ea9244173 --- /dev/null +++ b/_addons_bindings/rotel/readme.md @@ -0,0 +1,354 @@ +--- +id: rotel +label: Rotel +title: Rotel - Bindings +type: binding +description: "This binding can be used to control a Rotel audio device like a surround processor, a surround receiver, a stereo preamplifier, an integrated amplifier, a CD player or a tuner." +since: 2x +install: auto +--- + +<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository --> + +{% include base.html %} + +# Rotel Binding + +This binding can be used to control a Rotel audio device like a surround processor, a surround receiver, a stereo preamplifier, an integrated amplifier, a CD player or a tuner. + +The binding supports different kinds of connections: + +* serial connection, +* serial over IP connection, +* IP connection (for models providing a network interface). + +The binding supports all kinds of Rotel protocols: + +* HEX protocol, +* Old ASCII protocol (named v1 in the binding), +* Recent ASCII protocol (named v2 in the binding). + +For users without serial connector on server side, of course you can add a serial to USB adapter. + +You don't need to have your Rotel device directly connected to your openHAB server. +You can connect it for example to a Raspberry PI and use [ser2net Linux tool](https://sourceforge.net/projects/ser2net/) to make the serial connection available on LAN (serial over IP). + +Recent devices provide a network interface (RJ45 connector). +So you can use the device IP to connect to the device, keeping 9590 as default port. + +The binding has been tested with a RSP-1066 and a RSP-1570. + +## Supported Things + +This binding supports the following thing types: + +| Thing Type | Description | +|------------|---------------------------------------------------------------| +| a11 | Connection to the Rotel A11 integrated amplifier | +| a12 | Connection to the Rotel A12 integrated amplifier | +| a14 | Connection to the Rotel A14 integrated amplifier | +| cd11 | Connection to the Rotel CD11 CD player | +| cd14 | Connection to the Rotel CD14 CD player | +| ra11 | Connection to the Rotel RA-11 integrated amplifier | +| ra12 | Connection to the Rotel RA-12 integrated amplifier | +| ra1570 | Connection to the Rotel RA-1570 integrated amplifier | +| ra1572 | Connection to the Rotel RA-1572 integrated amplifier | +| ra1592 | Connection to the Rotel RA-1592 integrated amplifier | +| rap1580 | Connection to the Rotel RAP-1580 surround amplified processor | +| rc1570 | Connection to the Rotel RC-1570 stereo preamplifier | +| rc1572 | Connection to the Rotel RC-1572 stereo preamplifier | +| rc1590 | Connection to the Rotel RC-1590 stereo preamplifier | +| rcd1570 | Connection to the Rotel RCD-1570 CD player | +| rcd1572 | Connection to the Rotel RCD-1572 CD player | +| rcx1500 | Connection to the Rotel RCX-1500 stereo receiver | +| rdd1580 | Connection to the Rotel RDD-1580 stereo DAC | +| rdg1520 | Connection to the Rotel RDG-1520 tuner | +| rsp1066 | Connection to the Rotel RSP-1066 surround processor | +| rsp1068 | Connection to the Rotel RSP-1068 surround processor | +| rsp1069 | Connection to the Rotel RSP-1069 surround processor | +| rsp1098 | Connection to the Rotel RSP-1098 surround processor | +| rsp1570 | Connection to the Rotel RSP-1570 surround processor | +| rsp1572 | Connection to the Rotel RSP-1572 surround processor | +| rsp1576 | Connection to the Rotel RSP-1576 surround processor | +| rsp1582 | Connection to the Rotel RSP-1582 surround processor | +| rsx1055 | Connection to the Rotel RSX-1055 surround receiver | +| rsx1056 | Connection to the Rotel RSX-1056 surround receiver | +| rsx1057 | Connection to the Rotel RSX-1057 surround receiver | +| rsx1058 | Connection to the Rotel RSX-1058 surround receiver | +| rsx1065 | Connection to the Rotel RSX-1065 surround receiver | +| rsx1067 | Connection to the Rotel RSX-1067 surround receiver | +| rsx1550 | Connection to the Rotel RSX-1550 surround receiver | +| rsx1560 | Connection to the Rotel RSX-1560 surround receiver | +| rsx1562 | Connection to the Rotel RSX-1562 surround receiver | +| rt09 | Connection to the Rotel RT-09 tuner | +| rt11 | Connection to the Rotel RT-11 tuner | +| rt1570 | Connection to the Rotel RT-1570 tuner | +| t11 | Connection to the Rotel T11 tuner | +| t14 | Connection to the Rotel T14 tuner | + +## Discovery + +Discovery is not supported. +You have to add all things manually. + +## Binding Configuration + +There are no overall binding configuration settings that need to be set. +All settings are through thing configuration parameters. + +## Thing Configuration + +The thing requires the following configuration parameters: + +| Parameter Label | Parameter ID | Description | Accepted values | +|-------------------------|------------------|-------------------------------------------------------|-----------------| +| Serial Port | serialPort | Serial port to use for connecting to the Rotel device | | +| Address | host | Host name or IP address of the Rotel device (IP connection) or the machine connected to the Rotel device (serial over IP) | | +| Port | port | Communication port (IP or serial over IP). For IP connection to the Rotel device, keep the default port (9590) | | +| Protocol Version | Protocol | Choose one of the two protocol versions (depends on your device firmware). Default is ASCII_V2 | ASCII_V1 or ASCII_V2 | +| Input Label CD | inputLabelCd | Label setup for the source CD | | +| Input Label Tuner | inputLabelTuner | Label setup for the source Tuner | | +| Input Label Tape | inputLabelTape | Label setup for the source Tape | | +| Input Label USB | inputLabelUsb | Label setup for the source USB | | +| Input Label Video 1 | inputLabelVideo1 | Label setup for the source Video 1 | | +| Input Label Video 2 | inputLabelVideo2 | Label setup for the source Video 2 | | +| Input Label Video 3 | inputLabelVideo3 | Label setup for the source Video 3 | | +| Input Label Video 4 | inputLabelVideo4 | Label setup for the source Video 4 | | +| Input Label Video 5 | inputLabelVideo5 | Label setup for the source Video 5 | | +| Input Label Video 6 | inputLabelVideo6 | Label setup for the source Video 6 | | +| Input Label Multi Input | inputLabelMulti | Label setup for the source Multi Input | | + +All things have the following parameters: serialPort, host and port. +Some have additional parameters listed in the next table: + +| Thing Type | Parameters available in addition to serialPort, host and port | +|------------|---------------------------------------------------------------| +| ra1572 | protocol (ASCII_V2 by default) | +| ra1592 | protocol (ASCII_V2 by default) | +| rc1572 | protocol (ASCII_V2 by default) | +| rcd1572 | protocol (ASCII_V2 by default) | +| rsp1066 | inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5 | +| rsp1068 | inputLabelCd, inputLabelTuner, inputLabelTape, inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5 | +| rsp1069 | inputLabelCd, inputLabelTuner, inputLabelTape, inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5 | +| rsp1098 | inputLabelCd, inputLabelTuner, inputLabelTape, inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5 | +| rsp1570 | inputLabelCd, inputLabelTuner, inputLabelTape, inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5, inputLabelMulti | +| rsp1572 | inputLabelCd, inputLabelTuner, inputLabelUsb, inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5, inputLabelVideo6, inputLabelMulti | +| rsx1055 | inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5 | +| rsx1056 | inputLabelCd, inputLabelTuner, inputLabelTape, inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5 | +| rsx1057 | inputLabelCd, inputLabelTuner, inputLabelTape, inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5 | +| rsx1058 | inputLabelCd, inputLabelTuner, inputLabelTape, inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5 | +| rsx1065 | inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5 | +| rsx1067 | inputLabelCd, inputLabelTuner, inputLabelTape, inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5 | +| rsx1550 | inputLabelCd, inputLabelTuner, inputLabelTape, inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5, inputLabelMulti | +| rsx1560 | inputLabelCd, inputLabelTuner, inputLabelTape, inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5, inputLabelMulti | +| rsx1562 | inputLabelCd, inputLabelTuner, inputLabelUsb, inputLabelVideo1, inputLabelVideo2, inputLabelVideo3, inputLabelVideo4, inputLabelVideo5, inputLabelVideo6, inputLabelMulti | + +Some notes: + +* On Linux, you may get an error stating the serial port cannot be opened when the Rotel binding tries to load. You can get around this by adding the `openhab` user to the `dialout` group like this: `usermod -a -G dialout openhab`. +* Also on Linux you may have issues with the USB if using two serial USB devices e.g. Rotel and RFXcom. See the wiki page for more on symlinking the USB ports [](https://github.com/openhab/openhab1-addons/wiki/symlinks). +* Here is an example of ser2net.conf you can use to share your serial port /dev/ttyUSB0 on IP port 4444 using [ser2net Linux tool](https://sourceforge.net/projects/ser2net/) (take care, the baud rate is Rotel device specific): + +``` +4444:raw:0:/dev/ttyUSB0:19200 8DATABITS NONE 1STOPBIT +``` + + +## Channels + +The following channels are available: + +| Channel ID | Label | Item Type | Description | Possible values (depends on model) | +|--------------|---------------------|-----------|---------------------------------------|------------------------------------| +| power, mainZone#power, zone2#power, zone3#power, zone4#power | Power | Switch | Power ON/OFF the equipment or the zone | ON, OFF | +| source, mainZone#source, zone2#source, zone3#source, zone4#source | Source Input | String | Select the source input | CD, TUNER, TAPE, VIDEO1, VIDEO2, VIDEO3, VIDEO4, VIDEO5, VIDEO6, VIDEO7, VIDEO8, USB, PCUSB, MULTI, PHONO, BLUETOOTH, AUX, AUX1, AUX2, AUX1_COAX, AUX1_OPTICAL, COAX1, COAX2, COAX3, OPTICAL1, OPTICAL2, OPTICAL3, XLR, RCD, FM, DAB, PLAYFI, IRADIO, NETWORK | +| mainZone#recordSource | Record Source | String | Select the source to be recorded | CD, TUNER, TAPE, VIDEO1, VIDEO2, VIDEO3, VIDEO4, VIDEO5, VIDEO6, USB, MAIN | +| dsp, mainZone#dsp | DSP Mode | String | Select the DSP mode | NONE, STEREO3, STEREO5, STEREO7, STEREO9, STEREO11, MUSIC1, MUSIC2, MUSIC3, MUSIC4, PROLOGIC, PLIICINEMA, PLIIMUSIC, PLIIGAME, PLIIZ, NEO6MUSIC, NEO6CINEMA, ATMOS, NEURALX, BYPASS | +| mainZone#volumeUpDown, zone2#volumeUpDown | Volume | Number | Increase or decrease the volume | INCREASE, DECREASE, value | +| volume, mainZone#volume, zone2#volume, zone3#volume, zone4#volume | Volume | Dimmer | Adjust the volume | value between 0 and 100 | +| mute, mainZone#mute, zone2#mute, zone3#mute, zone4#mute | Mute | Switch | Mute/unmute the sound | ON, OFF | +| bass, mainZone#bass | Bass Adjustment | Number | Adjust the bass | INCREASE, DECREASE, value | +| treble, mainZone#treble | Treble Adjustment | Number | Adjust the treble | INCREASE, DECREASE, value | +| playControl | Playback Control | Player | Control the playback | PLAY, PAUSE, NEXT, PREVIOUS | +| track | Current Track | Number | The current CD track number | | +| mainZone#line1 | Front Panel Line 1 | String | The first line displayed on the device front panel | | +| mainZone#line2 | Front Panel Line 2 | String | The second line displayed on the device front panel | | +| frequency | Current Frequency | Number | The current frequency (in kHz) for digital source input | | +| brightness | Front Panel Display Brightness | Dimmer | The backlight brightness level (in %) of the device front panel | | + +Here are the list of channels available for each thing type: + +| Thing Type | Available channels | +|------------|---------------------------------------------------------------------------------------| +| a11 | power, source, volume, mute, bass, treble, brightness | +| a12 | power, source, volume, mute, bass, treble, frequency, brightness | +| a14 | power, source, volume, mute, bass, treble, frequency, brightness | +| cd11 | power, playControl, track, brightness | +| cd14 | power, playControl, track, brightness | +| ra11 | power, source, volume, mute, bass, treble, playControl, frequency, brightness | +| ra12 | power, source, volume, mute, bass, treble, playControl, frequency, brightness | +| ra1570 | power, source, volume, mute, bass, treble, playControl, frequency, brightness | +| ra1572 | power, source, volume, mute, bass, treble, frequency, brightness | +| ra1592 | power, source, volume, mute, bass, treble, frequency, brightness | +| rap1580 | power, source, dsp, volume, mute, brightness | +| rc1570 | power, source, volume, mute, bass, treble, playControl, frequency, brightness | +| rc1572 | power, source, volume, mute, bass, treble, frequency, brightness | +| rc1590 | power, source, volume, mute, bass, treble, frequency, brightness | +| rcd1570 | power, playControl, brightness | +| rcd1572 | power, playControl, track, brightness | +| rcx1500 | power, source, volume, mute, playControl | +| rdd1580 | power, source, playControl, frequency | +| rdg1520 | power, source, playControl | +| rsp1066 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volumeUpDown, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, zone2#power, zone2#source, zone2#volumeUpDown | +| rsp1068 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volume, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, mainZone#line2, zone2#power, zone2#source, zone2#volume, zone2#mute, zone3#power, zone3#source, zone3#volume, zone3#mute, zone4#power, zone4#source, zone4#volume, zone4#mute | +| rsp1069 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volume, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, mainZone#line2, zone2#power, zone2#source, zone2#volume, zone2#mute, zone3#power, zone3#source, zone3#volume, zone3#mute, zone4#power, zone4#source, zone4#volume, zone4#mute | +| rsp1098 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volume, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, zone2#power, zone2#source, zone2#volume, zone2#mute | +| rsp1570 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volume, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, mainZone#line2, zone2#power, zone2#source, zone2#volume, zone2#mute, zone3#power, zone3#source, zone3#volume, zone3#mute, zone4#power, zone4#source, zone4#volume, zone4#mute | +| rsp1572 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volume, mainZone#mute, mainZone#line1, mainZone#line2, zone2#power, zone2#source, zone2#volume, zone2#mute, zone3#power, zone3#source, zone3#volume, zone3#mute, zone4#power, zone4#source, zone4#volume, zone4#mute | +| rsp1576 | power, source, dsp, volume, mute, brightness | +| rsp1582 | power, source, dsp, volume, mute, brightness | +| rsx1055 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volumeUpDown, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, zone2#power, zone2#source, zone2#volumeUpDown | +| rsx1056 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volume, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, zone2#power, zone2#source, zone2#volume, zone2#mute | +| rsx1057 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volume, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, zone2#power, zone2#source, zone2#volume, zone2#mute | +| rsx1058 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volume, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, zone2#power, zone2#source, zone2#volume, zone2#mute, zone3#power, zone3#source, zone3#volume, zone3#mute, zone4#power, zone4#source, zone4#volume, zone4#mute | +| rsx1065 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volumeUpDown, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, mainZone#line2, zone2#power, zone2#source, zone2#volumeUpDown | +| rsx1067 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volume, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, mainZone#line2, zone2#power, zone2#source, zone2#volume, zone2#mute | +| rsx1550 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volume, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, zone2#power, zone2#source, zone2#volume, zone2#mute, zone3#power, zone3#source, zone3#volume, zone3#mute, zone4#power, zone4#source, zone4#volume, zone4#mute | +| rsx1560 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volume, mainZone#mute, mainZone#bass, mainZone#treble, mainZone#line1, mainZone#line2, zone2#power, zone2#source, zone2#volume, zone2#mute, zone3#power, zone3#source, zone3#volume, zone3#mute, zone4#power, zone4#source, zone4#volume, zone4#mute | +| rsx1562 | mainZone#power, mainZone#source, mainZone#recordSource, mainZone#dsp, mainZone#volume, mainZone#mute, mainZone#line1, mainZone#line2, zone2#power, zone2#source, zone2#volume, zone2#mute, zone3#power, zone3#source, zone3#volume, zone3#mute, zone4#power, zone4#source, zone4#volume, zone4#mute | +| rt09 | power, source, playControl, brightness | +| rt11 | power, source, brightness | +| rt1570 | power, source, brightness | +| t11 | power, source, brightness | +| t14 | power, source, brightness | + +## Full Example + +example.things using serial connection: + +``` +Thing rotel:rsp1066:preamp "RSP-1066" [ serialPort="COM1", inputLabelVideo1="VID 1", inputLabelVideo2="VID 2", inputLabelVideo3="VID 3", inputLabelVideo4="VID 4", inputLabelVideo5="VID 5" ] + +Thing rotel:rsp1570:preamp "RSP-1570" [ serialPort="COM2" ] + +Thing rotel:ra1592:preamp "RA-1592" [ serialPort="COM3" ] + +Thing rotel:cd14:cd "CD14" [ serialPort="COM4" ] +``` + +example.things using serial over IP connection: + +``` +Thing rotel:rsp1066:preamp "RSP-1066" [ host="192.168.0.200", port=3000, inputLabelVideo1="VID 1", inputLabelVideo2="VID 2", inputLabelVideo3="VID 3", inputLabelVideo4="VID 4", inputLabelVideo5="VID 5" ] + +Thing rotel:rsp1570:preamp "RSP-1570" [ host="192.168.0.201", port=3000, inputLabelCd="CD", inputLabelTuner="TUNER", inputLabelTape="TAPE", inputLabelVideo1="VIDEO 1", inputLabelVideo2="VIDEO 2", inputLabelVideo3="VIDEO 3", inputLabelVideo4="VIDEO 4", inputLabelVideo5="VIDEO 5", inputLabelMulti="MULTI" ] + +Thing rotel:ra1592:preamp "RA-1592" [ host="192.168.0.202", port=3000, protocol="ASCII_V1" ] + +Thing rotel:cd14:cd "CD14" [ host="192.168.0.203", port=3000 ] +``` + +example.items: + +``` +Switch preamp_power "Power" { channel="rotel:rsp1066:preamp:mainZone#power" } +String preamp_source "Source Input [%s]" { channel="rotel:rsp1066:preamp:mainZone#source" } +String preamp_rec "Record Source [%s]" { channel="rotel:rsp1066:preamp:mainZone#recordSource" } +String preamp_dsp "DSP [%s]" { channel="rotel:rsp1066:preamp:mainZone#dsp" } +Number preamp_volume "Volume [%d]" { channel="rotel:rsp1066:preamp:mainZone#volumeUpDown" } +Switch preamp_mute "Mute" { channel="rotel:rsp1066:preamp:mainZone#mute" } +Number preamp_bass "Bass Adjustment [%d]" { channel="rotel:rsp1066:preamp:mainZone#bass" } +Number preamp_treble "Treble Adjustment [%d]" { channel="rotel:rsp1066:preamp:mainZone#treble" } +String preamp_panel_display "Display [%s]" { channel="rotel:rsp1066:preamp:mainZone#line1" } +Switch preamp_power_zone2 "Zone 2 Power" { channel="rotel:rsp1066:preamp:zone2#power" } +String preamp_source_zone2 "Zone 2 Source Input [%s]" { channel="rotel:rsp1066:preamp:zone2#source" } +Number preamp_volume_zone2 "Zone 2 Volume [%d]" { channel="rotel:rsp1066:preamp:zone2#volumeUpDown" } + +Switch preamp2_power "Power" { channel="rotel:rsp1570:preamp:mainZone#power" } +String preamp2_source "Source Input [%s]" { channel="rotel:rsp1570:preamp:mainZone#source" } +String preamp2_rec "Record Source [%s]" { channel="rotel:rsp1570:preamp:mainZone#recordSource" } +String preamp2_dsp "DSP [%s]" { channel="rotel:rsp1570:preamp:mainZone#dsp" } +Dimmer preamp2_volume "Volume [%d %%]" { channel="rotel:rsp1570:preamp:mainZone#volume" } +Switch preamp2_mute "Mute" { channel="rotel:rsp1570:preamp:mainZone#mute" } +Number preamp2_bass "Bass Adjustment [%d]" { channel="rotel:rsp1570:preamp:mainZone#bass" } +Number preamp2_treble "Treble Adjustment [%d]" { channel="rotel:rsp1570:preamp:mainZone#treble" } +String preamp2_panel_line1 "Display Line1 [%s]" { channel="rotel:rsp1570:preamp:mainZone#line1" } +String preamp2_panel_line2 "Display Line2 [%s]" { channel="rotel:rsp1570:preamp:mainZone#line2" } +Switch preamp2_power_zone2 "Zone 2 Power" { channel="rotel:rsp1570:preamp:zone2#power" } +String preamp2_source_zone2 "Zone 2 Source Input [%s]" { channel="rotel:rsp1570:preamp:zone2#source" } +Dimmer preamp2_volume_zone2 "Zone 2 Volume [%d %%]" { channel="rotel:rsp1570:preamp:zone2#volume" } +Switch preamp2_mute_zone2 "Zone 2 Mute" { channel="rotel:rsp1570:preamp:zone2#mute" } +Switch preamp2_power_zone3 "Zone 3 Power" { channel="rotel:rsp1570:preamp:zone3#power" } +String preamp2_source_zone3 "Zone 3 Source Input [%s]" { channel="rotel:rsp1570:preamp:zone3#source" } +Dimmer preamp2_volume_zone3 "Zone 3 Volume [%d %%]" { channel="rotel:rsp1570:preamp:zone3#volume" } +Switch preamp2_mute_zone3 "Zone 3 Mute" { channel="rotel:rsp1570:preamp:zone3#mute" } +Switch preamp2_power_zone4 "Zone 4 Power" { channel="rotel:rsp1570:preamp:zone4#power" } +String preamp2_source_zone4 "Zone 4 Source Input [%s]" { channel="rotel:rsp1570:preamp:zone4#source" } +Dimmer preamp2_volume_zone4 "Zone 4 Volume [%d %%]" { channel="rotel:rsp1570:preamp:zone4#volume" } +Switch preamp2_mute_zone4 "Zone 4 Mute" { channel="rotel:rsp1570:preamp:zone4#mute" } + +Switch amp_power "Power" { channel="rotel:ra1592:preamp:power" } +String amp_source "Source Input [%s]" { channel="rotel:ra1592:preamp:source" } +Dimmer amp_volume "Volume [%d %%]" { channel="rotel:ra1592:preamp:volume" } +Switch amp_mute "Mute" { channel="rotel:ra1592:preamp:mute" } +Number amp_bass "Bass Adjustment [%d]" { channel="rotel:ra1592:preamp:bass" } +Number amp_treble "Treble Adjustment [%d]" { channel="rotel:ra1592:preamp:treble" } +Dimmer amp_brightness "Display brightness" { channel="rotel:ra1592:preamp:brightness" } + +Switch cd_power "Power" { channel="rotel:cd14:cd:power" } +Player cd_control "Playback" { channel="rotel:cd14:cd:power" } +Number cd_track "Track [%d]" { channel="rotel:cd14:cd:power" } +Dimmer cd_brightness "Display brightness" { channel="rotel:cd14:cd:brightness" } +``` + +example.sitemap: + +``` +Switch item=preamp_power +Selection item=preamp_source +Selection item=preamp_rec +Selection item=preamp_dsp +Setpoint item=preamp_volume minValue=0 maxValue=90 +Switch item=preamp_mute +Setpoint item=preamp_bass minValue=-12 maxValue=12 step=2 +Setpoint item=preamp_treble minValue=-12 maxValue=12 step=2 +Text item=preamp_panel_display +Switch item=preamp_power_zone2 +Selection item=preamp_source_zone2 + +Switch item=preamp2_power +Selection item=preamp2_source +Selection item=preamp2_rec +Selection item=preamp2_dsp +Slider item=preamp2_volume +Switch item=preamp2_mute +Setpoint item=preamp2_bass minValue=-6 maxValue=6 +Setpoint item=preamp2_treble minValue=-6 maxValue=6 +Text item=preamp2_panel_line1 +Text item=preamp2_panel_line2 +Switch item=preamp2_power_zone2 +Selection item=preamp2_source_zone2 +Slider item=preamp2_volume_zone2 +Switch item=preamp2_mute_zone2 +Switch item=preamp2_power_zone3 +Selection item=preamp2_source_zone3 +Slider item=preamp2_volume_zone3 +Switch item=preamp2_mute_zone3 +Switch item=preamp2_power_zone4 +Selection item=preamp2_source_zone4 +Slider item=preamp2_volume_zone4 +Switch item=preamp2_mute_zone4 + +Switch item=amp_power +Selection item=amp_source +Slider item=amp_volume +Switch item=amp_mute +Slider item=amp_bass minValue=-10 maxValue=10 +Slider item=amp_treble minValue=-10 maxValue=10 +Slider item=amp_brightness + +Switch item=cd_power +Default item=cd_control +Text item=cd_track +Slider item=cd_brightness +``` diff --git a/_addons_bindings/satel/readme.md b/_addons_bindings/satel/readme.md index 2c27f78ea..2c6fba7da 100644 --- a/_addons_bindings/satel/readme.md +++ b/_addons_bindings/satel/readme.md @@ -27,14 +27,15 @@ This binding supports following thing types: | Thing type | Description | |------------|------------------------------------------------------------------------------------------------------------------------------------------| -| ethm-1 | Ethernet bridge, supports [ETHM-1](https://www.satel.pl/pl/product/115/) and [ETHM-1 Plus](https://www.satel.pl/pl/product/698/) modules | -| int-rs | RS-232 bridge, supports [INT-RS](https://www.satel.pl/pl/product/123/) and [INT-RS Plus](https://www.satel.pl/pl/product/664/) modules | +| ethm-1 | Ethernet bridge, supports [ETHM-1](https://www.satel.pl/en/product/115/) and [ETHM-1 Plus](https://www.satel.pl/en/product/698/) modules | +| int-rs | RS-232 bridge, supports [INT-RS](https://www.satel.pl/en/product/123/) and [INT-RS Plus](https://www.satel.pl/en/product/664/) modules | | partition | Set of zones representing some physical area or logical relation | | zone | A physical device: reed switch, motion sensor or a virtual zone | | output | An output defined in the system | | shutter | Two outputs that control a roller shutter, one for "up" direction, another one for "down" | | system | A virtual thing describing general status of the alarm system | | event-log | A virtual thing that allows reading records from the alarm system event log | +| atd-100 | Wireless temperature detector [ATD-100](https://www.satel.pl/en/produktid/503) | ## Discovery @@ -100,10 +101,11 @@ Thing partition partition1 [ id=1, forceArming=true ] You can configure the following settings for a zone: -| Name | Required | Description | -|-------------|----------|--------------------------------| -| id | yes | Zone number | -| invertState | no | Changes active (ON) state to 0 | +| Name | Required | Description | +|-------------|----------|--------------------------------------------------------------------------| +| id | yes | Zone number | +| invertState | no | Changes active (ON) state to 0 | +| wireless | no | This zone is monitored by a wireless detector like APD-100, AFD-100, etc | Example: @@ -115,16 +117,17 @@ Thing zone zone1 [ id=1 ] You can configure the following settings for an output: -| Name | Required | Description | -|-------------|----------|-----------------------------------------------------------| -| id | yes | Output number | -| invertState | no | Changes active (ON) state to 0 | -| commandOnly | no | Accepts commands only, does not update state of the thing | +| Name | Required | Description | +|-------------|----------|-----------------------------------------------------------------------| +| id | yes | Output number | +| invertState | no | Changes active (ON) state to 0 | +| commandOnly | no | Accepts commands only, does not update state of the thing | +| wireless | no | This output controls a wireless device like ASP-100 R, ASW-100 E, etc | Example: ``` -Thing output output1 [ id=1, invertState=true ] +Thing output output1 [ id=1, invertState=true, wireless=false ] ``` ### shutter @@ -163,6 +166,21 @@ Example: Thing event-log EventLog [ ] ``` +### atd-100 + +You can configure the following settings for this thing: + +| Name | Required | Description | +|---------|----------|------------------------------------------------------------| +| id | yes | Zone number in the alarm system monitored by this detector | +| refresh | no | Polling interval in minutes, defaults to 15 | + +Example: + +``` +Thing atd-100 KitchenTemp [ id=10, refresh=30 ] +``` + ## Channels ### partition @@ -190,26 +208,30 @@ Thing event-log EventLog [ ] ### zone -| Name | Type | Description | -|------------------------|--------|------------------------| -| violation | Switch | Violation | -| tamper | Switch | Tamper | -| alarm | Switch | Alarm | -| tamper_alarm | Switch | Tamper alarm | -| alarm_memory | Switch | Alarm memory | -| tamper_alarm_memory | Switch | Tamper alarm memory | -| bypass | Switch | Bypass | -| no_violation_trouble | Switch | No violation trouble | -| long_violation_trouble | Switch | Long violation trouble | -| isolate | Switch | Isolate | -| masked | Switch | Masked | -| masked_memory | Switch | Masked memory | +| Name | Type | Description | +|------------------------|--------|-----------------------------------------------------------| +| violation | Switch | Violation | +| tamper | Switch | Tamper | +| alarm | Switch | Alarm | +| tamper_alarm | Switch | Tamper alarm | +| alarm_memory | Switch | Alarm memory | +| tamper_alarm_memory | Switch | Tamper alarm memory | +| bypass | Switch | Bypass | +| no_violation_trouble | Switch | No violation trouble | +| long_violation_trouble | Switch | Long violation trouble | +| isolate | Switch | Isolate | +| masked | Switch | Masked | +| masked_memory | Switch | Masked memory | +| device_lobatt | Switch | Indicates low battery level in the wireless device | +| device_nocomm | Switch | Indicates communication troubles with the wireless device | ### output -| Name | Type | Description | -|-------|--------|---------------------| -| state | Switch | State of the output | +| Name | Type | Description | +|---------------|--------|-----------------------------------------------------------| +| state | Switch | State of the output | +| device_lobatt | Switch | Indicates low battery level in the wireless device | +| device_nocomm | Switch | Indicates communication troubles with the wireless device | ### shutter @@ -240,6 +262,14 @@ Thing event-log EventLog [ ] | description | String | Textual description of the event. | | details | String | Details about the event, usually list of objects related to the event. | +### atd-100 + +| Name | Type | Description | +|---------------|--------------------|-----------------------------------------------------------| +| temperature | Number:Temperature | Current temperature in the zone | +| device_lobatt | Switch | Indicates low battery level in the wireless device | +| device_nocomm | Switch | Indicates communication troubles with the wireless device | + ## Full Example ### satel.things @@ -253,6 +283,8 @@ Bridge satel:ethm-1:home [ host="192.168.0.2", refresh=1000, userCode="1234", en Thing shutter KitchenWindow [ upId=2, downId=3 ] Thing system System [ ] Thing event-log EventLog [ ] + Thing output Siren [ id=17, wireless=true ] + Thing atd-100 KitchenTemp [ id=10, refresh=30 ] } ``` @@ -277,6 +309,11 @@ Number EVENT_LOG_PREV "Event log - previous index [%d]" (Satel) { channel="satel DateTime EVENT_LOG_TIME "Event log - time [%1$tF %1$tR]" (Satel) { channel="satel:event-log:home:EventLog:timestamp" } String EVENT_LOG_DESCR "Event log - description [%s]" (Satel) { channel="satel:event-log:home:EventLog:description" } String EVENT_LOG_DET "Event log - details [%s]" (Satel) { channel="satel:event-log:home:EventLog:details" } +Switch SIREN_LOBATT "Siren: low battery level" (Satel) { channel="satel:output:home:Siren:device_lobatt" } +Switch SIREN_NOCOMM "Siren: no communication" (Satel) { channel="satel:output:home:Siren:device_nocomm" } +Number:Temperature KITCHEN_TEMP "Kitchen temperature [%.1f °C]" <temperature> (Satel) { channel="satel:atd-100:home:KitchenTemp:temperature" } +Switch KITCHEN_TEMP_LOBATT "Kitchen sensor: low battery" (Satel) { channel="satel:atd-100:home:KitchenTemp:device_lobatt" } +Switch KITCHEN_TEMP_NOCOMM "Kitchen sensor: no communication" (Satel) { channel="satel:atd-100:home:KitchenTemp:device_nocomm" } ``` ### satel.sitemap @@ -291,10 +328,15 @@ Frame label="Alarm system" { Switch item=LIVING_ALARM Switch item=BEDROOM_TAMPER Switch item=BEDROOM_TAMPER_M + Switch item=SIREN_LOBATT + Switch item=SIREN_NOCOMM } Frame label="Kitchen" { Switch item=KITCHEN_LAMP Rollershutter item=KITCHEN_BLIND + Text item=KITCHEN_TEMP + Switch item=KITCHEN_TEMP_LOBATT + Switch item=KITCHEN_TEMP_NOCOMM } Text label="Keypad" icon="settings" { Switch item=KEYPAD_CHAR mappings=[ "1"="1", "2"="2", "3"="3" ] diff --git a/_addons_bindings/sinope/doc/openhab.png b/_addons_bindings/sinope/doc/openhab.png new file mode 100644 index 000000000..267a02d67 Binary files /dev/null and b/_addons_bindings/sinope/doc/openhab.png differ diff --git a/_addons_bindings/sinope/readme.md b/_addons_bindings/sinope/readme.md new file mode 100644 index 000000000..1b60d34cb --- /dev/null +++ b/_addons_bindings/sinope/readme.md @@ -0,0 +1,157 @@ +--- +id: sinope +label: Sinopé +title: Sinopé - Bindings +type: binding +description: "The integration happens through the Sinopé (GT150) bridge, which acts as an IP gateway to the Sinopé devices on the 916 Mhz ISM band." +since: 2x +install: auto +--- + +<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository --> + +{% include base.html %} + +# Sinopé Binding + +The integration happens through the Sinopé (GT150) bridge, which acts as an IP gateway to the Sinopé devices on the 916 Mhz ISM band. + +This binding supports multiple gateways with multiple devices. + +## Supported Things + +The Sinopé bridge is required as a "bridge" for accessing any other Sinopé devices. + +Right now, only the thermostat devices (3000W and 4000W) (TH1120RF) are supported. + +## Discovery + +The Sinopé Gateway (bridge) discovery is not supported for now. +It will be added in future release. +The Sinopé devices discovery is implemented. + +## Prerequisites + +### Bridge or the Sinopé Gateway + +First, you will need to get your API key from your Sinopé gateway. + +Grab the latest release of the [sinope-core library](<https://github.com/chaton78/sinope-core/releases>) + +On Windows, you can run the SinopeProtocol.exe (in the zip release). +The gateway parameter is written on the back of the SinopéGateway (example, 002f-c2c2-dd88-aaaa). +The addr parameter is the IP given to your gateway. + +``` +SinopeProtocol.exe -addr [YOUR_GATEWAY_IP_OR_HOSTNAME] -gateway [YOUR_GATEWAY_ID] -login +Getting API Key - PRESS WEB Button +Your api Key is: 0x12 0x57 0x55 0xD5 0xCD 0x4A 0xD5 0x33 +``` + + On other operating systems, using only a JVM, you can invoke directly the java command from the latest release of the [sinope-core library](<https://github.com/chaton78/sinope-core/releases>): + +``` +java -jar core-0.0.3-shaded.jar -addr [YOUR_GATEWAY_IP_OR_HOSTNAME] -gateway [YOUR_GATEWAY_ID] -login +Getting API Key - PRESS WEB Button +Your api Key is: 0x12 0x57 0x55 0xD5 0xCD 0x4A 0xD5 0x33 +``` + +### Thing Discovery + +You can use the same procedure to discover each device you want to use. +You will need to provide the api key from the previous step. +If you use spaces, please, use double quotes to pass the api key (i.e. "0x12 0x57 0x55 0xD5 0xCD 0x4A 0xD5 0x33") + +Use the device procedure to discover it. +For a thermostat, you need to push both buttons. +The application will loop forever, press ctrl-c to exit. + +``` +SinopeProtocol.exe -addr [YOUR_GATEWAY_IP_OR_HOSTNAME] -gateway [YOUR_GATEWAY_ID] -api "[YOUR_API_KEY]" -discover + +It is now time to push both buttons on your device! +Press crtl-c to exit! +Your device id is: 0x00 0x00 0x35 0x86 +It is now time to push both buttons on your device! +Press crtl-c to exit! +``` + +On other operating systems, using only a JVM, you can invoke directly the java command: + +``` +java -jar core-0.0.3-shaded.jar -addr [YOUR_GATEWAY_IP_OR_HOSTNAME] -gateway [YOUR_GATEWAY_ID] -api "[YOUR_API_KEY]" -discover + +It is now time to push both buttons on your device! +Press crtl-c to exit! +Your device id is: 0x00 0x00 0x35 0x86 +It is now time to push both buttons on your device! +Press crtl-c to exit! +``` + +## Thing Configuration + +The Sinopé bridge requires the address, the gateway id and the API key in order for the binding to know where and how to access it. +In the thing file, this looks e.g. like + +``` +Bridge sinope:gateway:home [ hostname="[YOUR_GATEWAY_IP_OR_HOSTNAME]", gatewayId="[YOUR_GATEWAY_ID]", apiKey="0x1F 0x5D 0xC8 0xD5 0xCD 0x3A 0xD7 0x23"] +``` + +The devices are identified by the ids that a Sinopé device returns when you have discovered it. + +``` +thermostat room [ deviceId = "0x00 0x00 0x35 0x86" ] +``` + +## Channels + +Thermostat devices support some of the following channels: + + Channel Type ID | Item Type | Description +---------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------| + insideTemperature | Number (R) | Inside Temperature | + outsideTemperature | Number (R) | Outside Temperature | + setpointTemperature | Number (RW) | Set Point Temperature | + setpointMode | String (RW) | Thermostat set point mode | + heatingLevel | Number (R) | Heating Level | + +## Full Example + +In this example setup the Sinopé Gateway is represented as a Bridge **Home** with thermostat **Room** + +### demo.things: + +``` +Bridge sinope:gateway:home [ hostname="sinope", gatewayId="1234-4567-1234-1234", apiKey="0x12 0x34 0x56 0x78 0x9A 0xBC 0xDE 0xF0"] { + thermostat room [ deviceId = "00003586" ] +} +``` + +### demo.items: + +``` +Number Room_In "Room Temp. [%.2f °C]" <temperature> { channel="sinope:thermostat:home:room:insideTemperature" } +Number Room_Out "Outside Temp. [%.2f °C]" <temperature> { channel="sinope:thermostat:home:room:outsideTemperature" } +Number Room_SetPoint "Room Set Point [%.2f °C]" <temperature> { channel="sinope:thermostat:home:room:setpointTemperature" } +Number Room_SetPointMode "Room Set Point Mode" { channel="sinope:thermostat:home:room:setpointMode" } +Number Room_HeatLevel "Room Heating level [%d]" <heating> { channel="sinope:thermostat:home:room:heatingLevel" } +``` + +### demo.sitemap: + +``` +sitemap demo label="Main Menu" +{ + Frame label="Sinope" { + Text item=Room_In + Text item=Room_Out + Setpoint item=Room_SetPoint label="Set Point [%.1f °C]" step=0.5 minValue=5 maxValue=35 + Switch item=Room_SetPointMode mappings=[2=Manual, 3=Auto, 5=Away] + Slider item=Room_HeatLevel + } +} +``` + +### UI Example + +![Example](doc/openhab.png) diff --git a/_addons_bindings/snmp1/readme.md b/_addons_bindings/snmp1/readme.md index 865872430..973f5a6bf 100644 --- a/_addons_bindings/snmp1/readme.md +++ b/_addons_bindings/snmp1/readme.md @@ -6,7 +6,7 @@ type: binding description: "The SNMP binding allows SNMP GET (polling) and SNMP SET (commanding), and the reception of SNMP TRAPs (asynchronous events). SNMP is often found in network equipment, and the binding can be used to ensure your network is operating correctly. The out binding can be used to configure network settings." source: https://github.com/openhab/openhab1-addons/blob/master/bundles/binding/org.openhab.binding.snmp/README.md since: 1x -install: auto +install: legacy --- <!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository --> diff --git a/_addons_bindings/spotify/readme.md b/_addons_bindings/spotify/readme.md index 91ebe2e9a..a734b7fab 100644 --- a/_addons_bindings/spotify/readme.md +++ b/_addons_bindings/spotify/readme.md @@ -1,7 +1,7 @@ --- id: spotify -label: for Spotify and Spotify Connect Devices -title: for Spotify and Spotify Connect Devices - Bindings +label: Spotify +title: Spotify - Bindings type: binding description: "This binding implements a bridge to the Spotify Player Web API and makes it possible to discover Spotify Connect Devices available on your Spotify Premium account." since: 2x @@ -12,7 +12,7 @@ install: auto {% include base.html %} -# Binding for Spotify and Spotify Connect Devices +# Spotify Binding This binding implements a bridge to the Spotify Player Web API and makes it possible to discover Spotify Connect Devices available on your Spotify Premium account. diff --git a/_addons_bindings/tplinksmarthome/readme.md b/_addons_bindings/tplinksmarthome/readme.md index 8060ffc01..32d36e230 100644 --- a/_addons_bindings/tplinksmarthome/readme.md +++ b/_addons_bindings/tplinksmarthome/readme.md @@ -256,12 +256,12 @@ Manually starting a discovery can also be used to set the ip address directly in The thing has the following configuration parameters: -| Parameter | Description | -|--------------------|-----------------------------------------------------------------------------| -| deviceId | The id of the device. | -| ipAddress | IP Address of the device. | -| refresh | Refresh interval in seconds. Optional, the default value is 30 seconds. | -| transitionPeriod | Duration of state changes in milliseconds, only for light bulbs, default 0. | +| Parameter | Description | +|--------------------|----------------------------------------------------------------------------------------------| +| deviceId | The id of the device. | +| ipAddress | IP Address of the device. | +| refresh | Refresh interval in seconds. Optional. The default is 30 seconds, and 1 second for switches. | +| transitionPeriod | Duration of state changes in milliseconds, only for light bulbs, default 0. | Either `deviceId` or `ipAddress` must be set. @@ -269,18 +269,19 @@ Either `deviceId` or `ipAddress` must be set. All devices support some of the following channels: -| Channel Type ID | Item Type | Description | Thing types supporting this channel | -|------------------|-----------|----------------------------------------------------|---------------------------------------------------------------------------------------------| -| switch | Switch | Switch the Smart Home device on or off. | HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS300, KP100, KP200, KP400, RE270K, RE370K | -| brightness | Dimmer | Set the brightness of Smart Home device or dimmer. | HS220, KB100, KL110, KL120, LB100, LB110, LB120, LB200 | -| colorTemperature | Dimmer | Set the color temperature of Smart Home light. | KB130, KL120, KL130, LB120, LB130, LB230 | -| color | Color | Set the color of the Smart Home light. | KB130, KL130, LB130, LB230 | -| power | Number | Actual energy usage in Watt. | HS110, HS300, KLxxx, LBxxx | -| eneryUsage | Number | Energy Usage in kWh. | HS110, HS300 | -| current | Number | Actual current usage in Ampere. | HS110, HS300 | -| voltage | Number | Actual voltage usage in Volt. | HS110, HS300 | -| led | Switch | Switch the status led on the device on or off. | HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS220, HS300, KP100, KP200, KP400 | -| rssi | Number | Wi-Fi signal strength indicator in dBm. | All | +| Channel Type ID | Item Type | Description | Thing types supporting this channel | +|---------------------|--------------------------|----------------------------------------------------|---------------------------------------------------------------------------------------------| +| switch | Switch | Switch the Smart Home device on or off. | HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS300, KP100, KP200, KP400, RE270K, RE370K | +| brightness | Dimmer | Set the brightness of Smart Home device or dimmer. | HS220, KB100, KL110, KL120, LB100, LB110, LB120, LB200 | +| colorTemperature | Dimmer | Set the color temperature in percentage. | KB130, KL120, KL130, LB120, LB130, LB230 | +| colorTemperatureAbs | Number | Set the color temperature in Kelvin. | KB130, KL120, KL130, LB120, LB130, LB230 | +| color | Color | Set the color of the Smart Home light. | KB130, KL130, LB130, LB230 | +| power | Number:Power | Actual energy usage in Watt. | HS110, HS300, KLxxx, LBxxx | +| eneryUsage | Number:Energy | Energy Usage in kWh. | HS110, HS300 | +| current | Number:ElectricCurrent | Actual current usage in Ampere. | HS110, HS300 | +| voltage | Number:ElectricPotential | Actual voltage usage in Volt. | HS110, HS300 | +| led | Switch | Switch the status led on the device on or off. | HS100, HS103, HS105, HS107, HS110, HS200, HS210, HS220, HS300, KP100, KP200, KP400 | +| rssi | Number:Power | Wi-Fi signal strength indicator in dBm. | All | The outlet devices (HS107, HS300, KP200, KP400) have group channels. This means the channel is prefixed with the group id. @@ -291,6 +292,15 @@ The following group ids are available: | groupSwitch | General channels. e.g. `groupSwitch#switch` | | outlet<number> | The outlet to control. <number> is the number of the outlet (starts with 1). e.g. `outlet1#switch` | +### Channel Refresh + +When the thing receives a `RefreshType` command the channel state is updated from an internal cache. +This cache is updated per refresh interval as configured in the thing. +However for some use cases it's preferable to set the refresh interval higher than the default. +For example for switches the 1 second refresh interval may cause a burden to the network traffic. +Therefore if the refresh interval for switches is set to a value higher than 5 seconds, and for the other devices higher than 1 minute. +Than the a `RefreshType` command will fetch the device state and update the internal cache. + ## Full Example ### tplinksmarthome.things: @@ -305,11 +315,11 @@ tplinksmarthome:lb130:bulb2 "Living Room Bulb 2" [ deviceId="00000000000000000 ### tplinksmarthome.items: ``` -Switch TP_L_TV "TV" { channel="tplinksmarthome:hs100:tv:switch" } -Switch TP_L_Laptop "Laptop" { channel="tplinksmarthome:hs300:laptop:outlet1#switch" } -Number TP_L_RSSI "Signal [%d] dB" <signal> { channel="tplinksmarthome:hs100:tv:rssi" } -Dimmer TP_LB_Bulb "Dimmer [%d %%]" <slider> { channel="tplinksmarthome:lb110:bulb1:brightness" } -Dimmer TP_LB_ColorT "Color Temperature [%d] %%" <slider> { channel="tplinksmarthome:lb130:bulb2:colorTemperature" } -Color TP_LB_Color "Color" <slider> { channel="tplinksmarthome:lb130:bulb2:color" } -Switch TP_LB_ColorS "Switch" { channel="tplinksmarthome:lb130:bulb2:color" } +Switch TP_L_TV "TV" { channel="tplinksmarthome:hs100:tv:switch" } +Switch TP_L_Laptop "Laptop" { channel="tplinksmarthome:hs300:laptop:outlet1#switch" } +Number:Power TP_L_RSSI "Signal [%d %unit%]" <signal> { channel="tplinksmarthome:hs100:tv:rssi" } +Dimmer TP_LB_Bulb "Dimmer [%d %%]" <slider> { channel="tplinksmarthome:lb110:bulb1:brightness" } +Dimmer TP_LB_ColorT "Color Temperature [%d %%]" <slider> { channel="tplinksmarthome:lb130:bulb2:colorTemperature" } +Color TP_LB_Color "Color" <slider> { channel="tplinksmarthome:lb130:bulb2:color" } +Switch TP_LB_ColorS "Switch" { channel="tplinksmarthome:lb130:bulb2:color" } ``` diff --git a/_addons_bindings/tradfri/readme.md b/_addons_bindings/tradfri/readme.md index b932005f8..df1dcc2f1 100644 --- a/_addons_bindings/tradfri/readme.md +++ b/_addons_bindings/tradfri/readme.md @@ -21,10 +21,9 @@ This binding integrates the IKEA TRÅDFRI gateway and devices connected to it (s Beside the gateway (thing type "gateway"), the binding currently supports colored bulbs, dimmable warm white bulbs as well as white spectrum bulbs and control outlets. The binding also supports read-only data from remote controls and motion sensors (e.g. the battery status). -The TRÅDFRI controller and sensor devices currently cannot be observed right away. -We assume that they are communicating directly with the bulbs or lamps without routing their commands through the gateway. +The TRÅDFRI controller and sensor devices currently cannot be observed right away because they are communicating directly with the bulbs or lamps without routing their commands through the gateway. This makes it nearly impossible to trigger events for pressed buttons. -We only can access some static data like the present status or battery level. +We only can access some static data like the present status or battery level. The thing type ids are defined according to the lighting devices defined for ZigBee LightLink ([see page 24, table 2](https://www.nxp.com/documents/user_manual/JN-UG-3091.pdf). These are: @@ -55,8 +54,9 @@ The following matrix lists the capabilities (channels) for each of the supported For first pairing - the gateway requires a `host` parameter for the hostname or IP address and a `code`, which is the security code that is printed on the bottom of the gateway. Optionally, a `port` can be configured, but any standard gateway uses the default port 5684. +The gateway requires at least firmware version 1.2.42 to connect to this binding. -The `code` is used during the initialization for retrieving unique identity and pre-shared key from the gateway (fw version 1.2.0042 onwards) and then it's discarded from the configuration. The newly created authentication data is stored in advanced parameters `identity` and `preSharedKey`. +The `code` is used during the initialization for retrieving unique identity and pre-shared key from the gateway and then it's discarded from the configuration. The newly created authentication data is stored in advanced parameters `identity` and `preSharedKey`. On each initialization if the code is present in the thing configuration - the `identity` and `preSharedKey` are recreated and the `code` is again discarded. The devices require only a single (integer) parameter, which is their instance id. Unfortunately, this is not displayed anywhere in the IKEA app, but it seems that they are sequentially numbered starting with 65537 for the first device. If in doubt, use the auto-discovered things to find out the correct instance ids. @@ -64,14 +64,14 @@ The devices require only a single (integer) parameter, which is their instance i ## Channels The dimmable bulbs support the `brightness` channel. -The white spectrum bulbs additionally also support the `color_temperature` channel. +The white spectrum bulbs additionally also support the `color_temperature` channel. Full color bulbs support the `color_temperature` and `color` channels. Brightness can be changed with the `color` channel. The remote control and the motion sensor supports the `battery_level` and `battery_low` channels for reading the battery status. -The control outlet supports the 'power' channel. +The control outlet supports the `power` channel. Refer to the matrix above. @@ -105,7 +105,7 @@ Dimmer Light1 { channel="tradfri:0100:mygateway:myDimmableBulb:brightness" } Dimmer Light2_Brightness { channel="tradfri:0220:mygateway:myColorTempBulb:brightness" } Dimmer Light2_ColorTemperature { channel="tradfri:0220:mygateway:myColorTempBulb:color_temperature" } Color ColorLight { channel="tradfri:0210:mygateway:myColorBulb:color" } -Number RemoteControlBatteryLevel { channel="tradfri:0830:mygateway:myRemoteControl:battery_level" } +Number RemoteControlBatteryLevel { channel="tradfri:0830:mygateway:myRemoteControl:battery_level" } Switch RemoteControlBatteryLow { channel="tradfri:0830:mygateway:myRemoteControl:battery_low" } Switch ControlOutlet { channel="tradfri:0010:mygateway:myControlOutlet:power" } ``` diff --git a/_addons_bindings/zigbee/readme.md b/_addons_bindings/zigbee/readme.md index 28cc14e0c..e7fe69089 100644 --- a/_addons_bindings/zigbee/readme.md +++ b/_addons_bindings/zigbee/readme.md @@ -200,41 +200,43 @@ The thing type is ```coordinator_xbee```. Other XBee S2C devices should also be The following devices have been tested by openHAB users with the binding. The absence of a device in this list does not mean it will not work - if the device is a standard ZigBee device similar to ones on this list, then it should work. -| Device | Description | -|------------------------------------------------|---------------------------------------------------| -| Busch-Jaeger 6711 U | Relay Insert | -| Busch-Jaeger 6715 U | LED-Dimmer Insert | -| Busch-Jaeger 6735 | Control Element (1-channel) | -| Busch-Jaeger 6735/01 | Control Element (1-channel, battery-operated) | -| Busch-Jaeger 6736 | Control Element (2-channel) | -| GE Bulbs | | -| GE Tapt Wall Switch | On/Off Switch | -| Hue Bulbs | Color LED Bulb | -| Hue Dimmer | Hue Dimmer Switch Remote *note2* | -| Hue Motion Sensor | Motion and Luminance sensor | -| Innr Bulbs | *note1* | -| Osram Bulbs | | -| Osram Motion Sensor | Osram Smart+ Motion Sensor | -| SmartThings Plug | Metered Plug | -| SmartThings Motion Sensor | CentraLite 3325-S Motion and Temperature sensor | -| SmartThings Contact Sensor | Contact and Temperature sensor | -| Telkonet EcoInsight Thermostat | Intelligent HVAC Thermostat | -| Tradfri Bulbs | | -| Tradfri Motion Sensor | | -| Tradfri Outlet | | -| Tradfri Repeater | | -| Trust Bulbs | *note1* | -| Ubisys modules | D1 Dimmer, S1/S2 Switch modules | -| Xiaomi Aqara Door and Window Sensor | | -| Xiaomi Aqara Temperature and Humidity Sensor | | -| Xiaomi Aqara Human Motion Sensor | | -| Xiaomi Aqara Wireless Mini Switch | | -| Xiaomi Aqara Wireless Remote Switch | Double Rocker variant | -| Shenzhen Ksentry Electronics On Off Controller | Relay | +| Device | Description | +| ---------------------------------------------- | --------------------------------------------------- | +| Busch-Jaeger 6711 U | Relay Insert | +| Busch-Jaeger 6715 U | LED-Dimmer Insert | +| Busch-Jaeger 6735 | Control Element (1-channel) | +| Busch-Jaeger 6735/01 | Control Element (1-channel, battery-operated) | +| Busch-Jaeger 6736 | Control Element (2-channel) | +| Eurotronic Spirit Thermostat | Radiator Thermostat | +| GE Bulbs | | +| GE Tapt Wall Switch | On/Off Switch | +| Hue Bulbs | Color LED Bulb | +| Hue Dimmer | Hue Dimmer Switch Remote *[<sup>[2]</sup>](#note2)* | +| Hue Motion Sensor | Motion and Luminance sensor | +| Innr Bulbs | *[<sup>[1]</sup>](#note1)* | +| Innr SP 120 | Smart Plug *[<sup>[1]</sup>](#note1)* | +| Osram Bulbs | | +| Osram Motion Sensor | Osram Smart+ Motion Sensor | +| SmartThings Plug | Metered Plug | +| SmartThings Motion Sensor | CentraLite 3325-S Motion and Temperature sensor | +| SmartThings Contact Sensor | Contact and Temperature sensor | +| Telkonet EcoInsight Thermostat | Intelligent HVAC Thermostat | +| Tradfri Bulbs | | +| Tradfri Motion Sensor | | +| Tradfri Outlet | | +| Tradfri Repeater | | +| Trust Bulbs | *[<sup>[1]</sup> ](#note1)* | +| Ubisys modules | D1 Dimmer, S1/S2 Switch modules | +| Xiaomi Aqara Door and Window Sensor | | +| Xiaomi Aqara Temperature and Humidity Sensor | | +| Xiaomi Aqara Human Motion Sensor | | +| Xiaomi Aqara Wireless Mini Switch | | +| Xiaomi Aqara Wireless Remote Switch | Double Rocker variant | +| Shenzhen Ksentry Electronics On Off Controller | Relay | -Note 1: Some bulbs may not work with the Telegesis dongle. +<a name="note1"></a> *Note 1: Some devices may not work with the Telegesis dongle.* -Note 2: The Hue Dimmer can be integrated but needs additional rule-configuration to work properly. See below for example. +<a name="note2"></a> *Note 2: The Hue Dimmer can be integrated but needs additional rule-configuration to work properly. See below for example.* ## Discovery diff --git a/_addons_bindings/zwave/doc/abus/shbw10000_0_0.md b/_addons_bindings/zwave/doc/abus/shbw10000_0_0.md new file mode 100644 index 000000000..2d7e834de --- /dev/null +++ b/_addons_bindings/zwave/doc/abus/shbw10000_0_0.md @@ -0,0 +1,198 @@ +--- +layout: documentation +title: SHBW10000 - ZWave +--- + +{% include base.html %} + +# SHBW10000 PIR Multisensor +This describes the Z-Wave device *SHBW10000*, manufactured by *ABUS Security-Center GmbH & Co. KG * with the thing type UID of ```abus_shbw10000_00_000```. + +The device is in the category of *Motion Detector*, defining Motion sensors/detectors. + +![SHBW10000 product image](https://www.cd-jackson.com/zwave_device_uploads/1103/1103_default.jpg) + + +The SHBW10000 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 SHBW10000 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. Refer to the *Wakeup Information* section below for further information. + +## Overview + +The SHBW10000 was developed for use in home automation systems that use the Z-Wave wireless standard. + +The multisensor has the following sensors: + + * PIR + * temperature + * atmospheric humidity + * lights + +The motion sensor lets you know when something moves within a certain range and can then trigger various scenes/actions. + +The device also reports the current room temperature, humidity and illuminance. + +In conjunction with configurable scenes, smart functions can also be initiated in addition to monitoring, e.g. if temperature <20 degrees, heating on. + +### Inclusion Information + +Click the + (Add) button in your Z-Wave App and follow the further instructions. + +Press the Button on the device once. + +The App will show if the Add device process was successful. The Status LED will light up for 2 seconds. + +Repeat the inclusion process if it was not successful. + +### Exclusion Information + +Click the - (Remove) button in your Z-Wave App and follow the further instructions. + +Press the Button on the device once. + +The App will show if the Remove device process was successful. + +Repeat the exclusion process if it was not successful. + +### Wakeup Information + +The SHBW10000 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. + + +If included: + +The device sends a wake up notification command to the node devices which are connected by a wake up command. + +The LED will light up when information is received, and will go out when there is no exchange for 10 seconds. + +If not included: nothing + +### General Usage Information + +Keep pressing the Button on the device for more than 5 seconds (the flash interval of the Status LED is now accelerated) + +The device is now restored to factory settings + +Note: This procedure should only be used if the primary gateway is not capable of acting. + +If the device is set to the factory setting, the status is set to "not included", the association settings and possible configurations are reset to default. + +## Channels + +The following table summarises the channels available for the SHBW10000 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Sensor (luminance) | sensor_luminance | sensor_luminance | | Number | +| Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number | +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | + +### Binary Sensor +Indicates if a sensor has triggered. + +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| ON | Triggered | +| OFF | Untriggered | + +### Sensor (luminance) +Indicates the current light reading. + +The ```sensor_luminance``` channel is of type ```sensor_luminance``` and supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. + +### Sensor (relative humidity) +Indicates the current relative humidity. + +The ```sensor_relhumidity``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. + +### Sensor (temperature) +Indicates the current temperature. + +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. + +### Alarm (burglar) +Indicates if the burglar alarm is triggered. + +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + +### Battery Level +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 is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. + + +## Device Configuration + +The device has no configuration parameters defined. + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The SHBW10000 supports 2 association groups. + +### Group 1: Reports + + * Z-Wave Plus Lifeline Notification Report: Sensor will send Notification Report when Motion Detection Unknown Location and (Event inactive). + * Multilevel Sensor Report: Sensor will send Multilevel Sensor Report (Temperature, humidity, luminance) interval of 2 hours. + * Battery Report. Sensor will send Battery Report when the battery level is low and the battery report’s value is 255 (0xFF). + * Device Reset Locally. + +Association group 1 supports 5 nodes. + +### Group 2: Send Basic Set when PIR trigger + +Send Basic Set when PIR trigger + +Association group 2 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SENSOR_BINARY_V1| | +| COMMAND_CLASS_SENSOR_MULTILEVEL_V5| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V8| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_BATTERY_V1| | +| COMMAND_CLASS_WAKE_UP_V2| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | + +### Documentation Links + +* [Manual SHBW10000](https://www.cd-jackson.com/zwave_device_uploads/1103/ABUS-SHBW10000-BDA-EN-1-3-v2-.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1103). diff --git a/_addons_bindings/zwave/doc/aeon/zw100_1_10.md b/_addons_bindings/zwave/doc/aeon/zw100_1_10.md index c454a0e49..5bfb0ec8f 100644 --- a/_addons_bindings/zwave/doc/aeon/zw100_1_10.md +++ b/_addons_bindings/zwave/doc/aeon/zw100_1_10.md @@ -18,7 +18,9 @@ The ZW100 supports routing. This allows the device to communicate using other ro ## Overview -Battery or USB powered PIR motion sensor, operating distance: Up to 500 feet/150 metres outdoors. +Battery or USB powered PIR motion sensor, + +operating distance: Up to 500 feet/150 metres outdoors. ### Inclusion Information @@ -77,7 +79,7 @@ The following table summarises the channels available for the ZW100 -: | Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number | | Motion Alarm | alarm_motion | alarm_motion | Motion | Switch | | Tamper Alarm | alarm_tamper | alarm_tamper | | Switch | -| Battery Level | battery-level | Battery | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Sensor (temperature) Indicates the current temperature. diff --git a/_addons_bindings/zwave/doc/aeon/zw122_0_0.md b/_addons_bindings/zwave/doc/aeon/zw122_0_0.md index af95de9db..5722faad5 100644 --- a/_addons_bindings/zwave/doc/aeon/zw122_0_0.md +++ b/_addons_bindings/zwave/doc/aeon/zw122_0_0.md @@ -53,19 +53,19 @@ The following table summarises the channels available for the ZW122 -: | Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | | Alarm (heat) | alarm_heat | alarm_heat | Fire | Switch | | Alarm (flood) | alarm_flood | alarm_flood | Water | Switch | -| Battery Level | battery-level | Battery | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | | Alarm (flood) 1 | alarm_flood1 | alarm_flood | Water | Switch | | Alarm (flood) 2 | alarm_flood2 | alarm_flood | Water | Switch | ### Sensor (temperature) Indicates the current temperature. -The ```sensor_temperature``` channel and is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Alarm (burglar) Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` channel and is of type ```alarm_burglar``` and 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -77,7 +77,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Alarm (heat) Indicates if a heat alarm is triggered. -The ```alarm_heat``` channel and is of type ```alarm_heat``` and supports the ```Switch``` item and is in the ```Fire``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_heat``` channel is of type ```alarm_heat``` and supports the ```Switch``` item and is in the ```Fire``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -89,7 +89,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Alarm (flood) Indicates if the flood alarm is triggered. -The ```alarm_flood``` channel and is of type ```alarm_flood``` and supports the ```Switch``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_flood``` channel is of type ```alarm_flood``` and supports the ```Switch``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -99,12 +99,14 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level -Channel type information on this channel is not found. +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 is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Alarm (flood) 1 Indicates if the flood alarm is triggered. -The ```alarm_flood1``` channel and is of type ```alarm_flood``` and supports the ```Switch``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_flood1``` channel is of type ```alarm_flood``` and supports the ```Switch``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -116,7 +118,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Alarm (flood) 2 Indicates if the flood alarm is triggered. -The ```alarm_flood2``` channel and is of type ```alarm_flood``` and supports the ```Switch``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_flood2``` channel is of type ```alarm_flood``` and supports the ```Switch``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: diff --git a/_addons_bindings/zwave/doc/benext/p1dongle_0_0.md b/_addons_bindings/zwave/doc/benext/p1dongle_0_0.md index 7a763cc0e..a73411059 100644 --- a/_addons_bindings/zwave/doc/benext/p1dongle_0_0.md +++ b/_addons_bindings/zwave/doc/benext/p1dongle_0_0.md @@ -119,7 +119,14 @@ This parameter has the configuration ID ```config_4_2``` and is of type ```INTEG Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The P1-dongle supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/building36/adcs2000tra_0_0.md b/_addons_bindings/zwave/doc/building36/adcs2000tra_0_0.md index c3ed29ae6..2e5ee4ae0 100644 --- a/_addons_bindings/zwave/doc/building36/adcs2000tra_0_0.md +++ b/_addons_bindings/zwave/doc/building36/adcs2000tra_0_0.md @@ -74,13 +74,151 @@ This channel provides the battery level as a percentage and also reflects the lo ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 8 configuration parameters available in the ADC-S2000-T-RA. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Wake Up Period | Seconds to stay awake following button press | +| 2 | Low Battery Level | Battery level | +| 3 | Temperature Reporting Threshold | Tenths of a degree Fahrenheit. A value of 10 would be 1.0F. | +| 4 | Configuration Bitmask | Configuration Bitmask | +| 5 | Battery Reporting Interval | Battery Reporting Interval | +| 7 | Temperature Reporting Interval | Temperature Reporting Interval | +| 8 | Temperature Calibration Offset | Temperature Calibration Offset | +| 9 | Mandatory Temperature Reporting Interval | Mandatory Temperature Reporting Interval | +| | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | +| | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | + +### Parameter 1: Wake Up Period + +Seconds to stay awake following button press + +Values in the range 10 to 32768 may be set. + +The manufacturer defined default value is ```32768```. + +This parameter has the configuration ID ```config_1_2``` and is of type ```INTEGER```. + + +### Parameter 2: Low Battery Level + +Battery level + +Values in the range 1000 to 2500 may be set. + +The manufacturer defined default value is ```2500```. + +This parameter has the configuration ID ```config_2_2``` and is of type ```INTEGER```. + + +### Parameter 3: Temperature Reporting Threshold + +Tenths of a degree Fahrenheit. A value of 10 would be 1.0F. + +Values in the range 0 to 100 may be set. + +The manufacturer defined default value is ```100```. + +This parameter has the configuration ID ```config_3_2``` and is of type ```INTEGER```. + + +### Parameter 4: Configuration Bitmask + +Configuration Bitmask + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Will not send temperature reports | +| 2 | Send reports when the temperature changes. | + +The manufacturer defined default value is ```2``` (Send reports when the temperature changes.). + +This parameter has the configuration ID ```config_4_2``` and is of type ```INTEGER```. + + +### Parameter 5: Battery Reporting Interval + +Battery Reporting Interval +Number of wake up intervals between autonomous battery reports. The wake up interval is set in the Wake Up Command Class. +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```255```. + +This parameter has the configuration ID ```config_5_2``` and is of type ```INTEGER```. + + +### Parameter 7: Temperature Reporting Interval + +Temperature Reporting Interval +The number of wake up intervals between autonomous temperature reports. + +If this value is zero, autonomous temperature reporting based on wake up interval is disabled. +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_7_2``` and is of type ```INTEGER```. + + +### Parameter 8: Temperature Calibration Offset + +Temperature Calibration Offset +Tenths of a degree Fahrenheit. A value of 10 would be 1.0F.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range -100 to 100 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_8_2``` and is of type ```INTEGER```. + + +### Parameter 9: Mandatory Temperature Reporting Interval + +Mandatory Temperature Reporting Interval +The number of seconds between temperature reports. +Values in the range 60 to 64800 may be set. + +The manufacturer defined default value is ```64800```. + +This parameter has the configuration ID ```config_9_2``` and is of type ```INTEGER```. + +### Wakeup Interval + +The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications. + +This setting is defined in *seconds*. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances. + +Note that this setting does not affect the devices ability to send sensor data, or notification events. + +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_node``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The ADC-S2000-T-RA supports 2 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: Sensor Multilevel Temperature Report. + + +Association group 2 supports 5 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/cbcc/swzcs1_0_0.md b/_addons_bindings/zwave/doc/cbcc/swzcs1_0_0.md index d48668043..9771cf92d 100644 --- a/_addons_bindings/zwave/doc/cbcc/swzcs1_0_0.md +++ b/_addons_bindings/zwave/doc/cbcc/swzcs1_0_0.md @@ -17,21 +17,32 @@ The SW-ZCS-1 supports routing. This allows the device to communicate using other ## 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/236) to improve the documentation. +The wall switch is in “Gateway” Mode as soon as it is added in a Z-Wave® network managed by a home automation gateway. + +The wall switch becomes then the gateway’s assistant, capable to launch up to 16 different scenes through it (SCENE Profile) or directly associated to your Z-Wave® compatible devices (MONO or DUO Profile). + +### Inclusion Information + + 1. Simultaneously push on 1 and 2, during 1sec. The LED glows in pink to confirm the selection + 2. Push on 1, within 10 seconds. The LED blinks in pink to confirm your choice The LED blinks in green to confirm the procedure + +### Exclusion Information + + 1. Simultaneously push on 1 and 2, during 1sec. The LED glows in pink to confirm the selection + 2. Push on 1, within 10 seconds. The LED blinks in pink to confirm your choice The LED blinks in green to confirm the procedure ## Channels The following table summarises the channels available for the SW-ZCS-1 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -105,6 +116,7 @@ Association group 2 supports 5 nodes. | COMMAND_CLASS_BASIC_V1| | | COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_ASSOCIATION_V1| | | COMMAND_CLASS_VERSION_V1| | diff --git a/_addons_bindings/zwave/doc/centralite/3210l_0_0.md b/_addons_bindings/zwave/doc/centralite/3210l_0_0.md index a2674f450..00bec1810 100644 --- a/_addons_bindings/zwave/doc/centralite/3210l_0_0.md +++ b/_addons_bindings/zwave/doc/centralite/3210l_0_0.md @@ -38,7 +38,7 @@ The following table summarises the channels available for the 3210-L -: ### Switch [Deprecated] Switch the power on and off. -The ```switch_binary``` channel and is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. **Note:** This channel is marked as deprecated so should not be used. @@ -52,7 +52,14 @@ The device has no configuration parameters defined. Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The 3210-L supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/cooper/rf9540n_0_0.md b/_addons_bindings/zwave/doc/cooper/rf9540n_0_0.md index 92eceba88..a0c48060f 100644 --- a/_addons_bindings/zwave/doc/cooper/rf9540n_0_0.md +++ b/_addons_bindings/zwave/doc/cooper/rf9540n_0_0.md @@ -38,39 +38,35 @@ To exclude this device from a Z-Wave network, select the command on your Z-Wave The following table summarises the channels available for the RF9540-N -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | -| Dimmer Ramp Time | config_decimal | | Number | -| Alarm | alarm_general | Door | Switch | -| Local Device Protection | protection_local | | Number | -| Indicator Light Control | indicator_level | | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | +| Dimmer Ramp Time | config_decimal | config_decimal | | Number | +| Alarm | alarm_general | alarm_general | Alarm | Switch | +| Local Device Protection | protection_local | protection_local | | Number | +| Indicator Light Control | indicator_level | indicator_level | | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Dimmer Ramp Time - Generic class for configuration parameter. -The ```config_decimal``` channel supports the ```Number``` item. +The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -80,10 +76,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Local Device Protection - Sets the local protection mode. -The ```protection_local``` channel supports the ```Number``` item. +The ```protection_local``` channel is of type ```protection_local``` and supports the ```Number``` item. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -93,10 +88,9 @@ The following state translation is provided for this channel to the ```Number``` | 2 | No operation possible | ### Indicator Light Control - Sets the indicator brightness. -The ```indicator_level``` channel supports the ```Dimmer``` item. +The ```indicator_level``` channel is of type ```indicator_level``` and supports the ```Dimmer``` item. diff --git a/_addons_bindings/zwave/doc/cooper/rf9601_0_0.md b/_addons_bindings/zwave/doc/cooper/rf9601_0_0.md new file mode 100644 index 000000000..d33802edd --- /dev/null +++ b/_addons_bindings/zwave/doc/cooper/rf9601_0_0.md @@ -0,0 +1,223 @@ +--- +layout: documentation +title: RF9601 - ZWave +--- + +{% include base.html %} + +# RF9601 Z-Wave Plus wireless switch +This describes the Z-Wave device *RF9601*, manufactured by *Cooper Wiring Devices* with the thing type UID of ```cooper_rf9601_00_000```. +This version of the device is limited to firmware versions below 255.0 + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![RF9601 product image](https://www.cd-jackson.com/zwave_device_uploads/1099/1099_default.png) + + +The RF9601 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 between other devices in the mesh network. + +## Overview + +The Z-Wave Plus wireless switch replaces regular switches or dimmers (where a neutral is present) to provide local and remote ON/OFF control for LED, CFL, incandescent, magnetic low-voltage, electronic low-voltage, and fluorescent lighting loads. The Z-Wave Plus wireless switch provides other programmable functions (scenes, events, association, child lockout, etc.) when used with Z-Wave compliant controllers. Each switch can be manually and remotely controlled by commands sent from an Z-Wave controller or other Z-Wave compatible controllers. The switch could be also controlled by wired 3-way switch. Eaton’s Z-Wave switches are Z-Wave Plus certified. Eaton’s Z-Wave accessory switches are Z-Wave Plus certified and comply with latest S2 security standards for advanced cyber security. + +### Inclusion Information + + 1. This product may be added to a new or existing Z-Wave network. An Eaton Wiring Devices Z-Wave device has a blue LED, which will blink when the device is not included in a ZWave network. The LED stops blinking when the device is in a network. + 2. To include this device in a Z-Wave network, select the command on your Z Wave controller for inclusion (Install, Add Device, Add Node, Include Device, etc.). Then press the device switch one time to include it in the network. + 3. Based on the controller, the controller may ask to scan the QR code or manually enter 5 digit code under the QR code to install the device as a secured device + 4. After the device is added to the network, the LED will stop blinking + +### Exclusion Information + +To exclude this device from a Z-Wave network, select the command on your Z-Wave controller for exclusion (Uninstall, Remove Device, Remove Node, Exclude Device, etc.). Then press the device switch one time to exclude it from the network. The LED will start blinking.  + +## Channels + +The following table summarises the channels available for the RF9601 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | +| Alarm | alarm_general | alarm_general | Alarm | Switch | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Scene Number +Triggers when a scene button is pressed. + +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. + +### Alarm +Indicates if an alarm is triggered. + +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + + + +## Device Configuration + +The following table provides a summary of the 7 configuration parameters available in the RF9601. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Delayed OFF Time | | +| 2 | Panic ON Time | | +| 3 | Panic OFF Time | | +| 5 | Power up state | | +| 6 | Panic mode enable | | +| 13 | Blue LED brightness level when switch is ON | | +| 14 | Blue LED brightness level when switch is OFF | | + +### Parameter 1: Delayed OFF Time + + + +Values in the range 0 to 127 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Panic ON Time + + + +Values in the range 0 to 127 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Panic OFF Time + + + +Values in the range 0 to 127 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 5: Power up state + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Off | +| 2 | On | +| 3 | Last State | + +The manufacturer defined default value is ```3``` (Last State). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 6: Panic mode enable + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Off | +| 1 | On | + +The manufacturer defined default value is ```0``` (Off). + +This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```. + + +### Parameter 13: Blue LED brightness level when switch is ON + + + +Values in the range 0 to 4 may be set. + +The manufacturer defined default value is ```4```. + +This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```. + + +### Parameter 14: Blue LED brightness level when switch is OFF + + + +Values in the range 0 to 4 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_14_1``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The RF9601 supports 2 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: Set + +On/Off + +Association group 2 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_SCENE_ACTIVATION_V1| | +| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_PROTECTION_V1| | +| COMMAND_CLASS_NODE_NAMING_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_SECURITY_V1| | + +### Documentation Links + +* [Instruction Sheet](https://www.cd-jackson.com/zwave_device_uploads/1099/RF9601-and-RF9617-Instruction-Sheet.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1099). diff --git a/_addons_bindings/zwave/doc/cooper/rf9617_0_0.md b/_addons_bindings/zwave/doc/cooper/rf9617_0_0.md new file mode 100644 index 000000000..52e16d1d5 --- /dev/null +++ b/_addons_bindings/zwave/doc/cooper/rf9617_0_0.md @@ -0,0 +1,218 @@ +--- +layout: documentation +title: RF9617 - ZWave +--- + +{% include base.html %} + +# RF9617 Z-Wave Plus smart accessory switch +This describes the Z-Wave device *RF9617*, manufactured by *Cooper Wiring Devices* with the thing type UID of ```cooper_rf9617_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![RF9617 product image](https://www.cd-jackson.com/zwave_device_uploads/1105/1105_default.jpg) + + +The RF9617 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 between other devices in the mesh network. + +## Overview + +Z-Wave Plus accessory switches can be paired with Z-Wave Plus wireless switches (RF9601) to provide multi-location ON/OFF control forup to (5) locations. These are ideal when there’s no traveler wire between the two locations in a 3-way application. Z-Wave Plus accessorieswill need to be associated with the load controlling switch using a compatible Z-Wave compliant controller. + +### Inclusion Information + +Put the controller into inclusion mode, press the Install button once + +### Exclusion Information + +Put the controller into exclusion mode, press the Install button once + +## Channels + +The following table summarises the channels available for the RF9617 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | +| Alarm | alarm_general | alarm_general | Alarm | Switch | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Scene Number +Triggers when a scene button is pressed. + +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. + +### Alarm +Indicates if an alarm is triggered. + +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + + + +## Device Configuration + +The following table provides a summary of the 7 configuration parameters available in the RF9617. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Delayed Off Time | | +| 2 | Panic On Time | | +| 3 | Panic Off Time | | +| 5 | Power Up State | | +| 6 | Panic Mode Enable | | +| 13 | Blue LED Brightness Level while Switch is ON | | +| 14 | Blue LED Brightness Level while Switch is OFF | | + +### Parameter 1: Delayed Off Time + + + +Values in the range 0 to 127 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Panic On Time + + + +Values in the range 0 to 127 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Panic Off Time + + + +Values in the range 0 to 127 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 5: Power Up State + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Off | +| 2 | On | +| 3 | Last State | + +The manufacturer defined default value is ```1``` (Off). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 6: Panic Mode Enable + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Off | +| 1 | On | + +The manufacturer defined default value is ```0``` (Off). + +This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```. + + +### Parameter 13: Blue LED Brightness Level while Switch is ON + + + +Values in the range 0 to 4 may be set. + +The manufacturer defined default value is ```4```. + +This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```. + + +### Parameter 14: Blue LED Brightness Level while Switch is OFF + + + +Values in the range 0 to 4 may be set. + +The manufacturer defined default value is ```2```. + +This parameter has the configuration ID ```config_14_1``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The RF9617 supports 2 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: Set + +On/Off + +Association group 2 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_SCENE_ACTIVATION_V1| | +| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_PROTECTION_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_SECURITY_V1| | + +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/1105/RF9601-and-RF9617-Instruction-Sheet.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1105). diff --git a/_addons_bindings/zwave/doc/cooper/rf9642_0_0.md b/_addons_bindings/zwave/doc/cooper/rf9642_0_0.md new file mode 100644 index 000000000..f7b1df212 --- /dev/null +++ b/_addons_bindings/zwave/doc/cooper/rf9642_0_0.md @@ -0,0 +1,270 @@ +--- +layout: documentation +title: RF9642 - ZWave +--- + +{% include base.html %} + +# RF9642 Z-Wave Plus smart accessory dimmer +This describes the Z-Wave device *RF9642*, manufactured by *Cooper Wiring Devices* with the thing type UID of ```cooper_rf9642_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![RF9642 product image](https://www.cd-jackson.com/zwave_device_uploads/1104/1104_default.jpg) + + +The RF9642 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 between other devices in the mesh network. + +## Overview + +Z-Wave Plus accessory dimmers can be paired with Z-Wave Plus universal smart dimmers to provide multi-location ON/OFF/BRIGHT/DIM control for up to (5) locations. These are ideal when there’s no traveler wire between the two locations in a 3-way application. Z-Wave Plus accessories will need to be associated with the load controlling dimmer using a compatible Z-Wave compliant controller Compatible with Z-Wave Plus universal dimmers (RF9640-N, RF9643-N) for wireless 3-way control, eliminating the need for traditional 3-way wiring or dedicated traveler wire + +### Inclusion Information + +Put the controller into inclusion mode, press the Install button once + +### Exclusion Information + +Put the controller into exclusion mode, press the Install button once + +## Channels + +The following table summarises the channels available for the RF9642 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | +| Dimmer Ramp Time [Deprecated]| config_decimal | config_decimal | | Number | +| Alarm | alarm_general | alarm_general | Alarm | Switch | + +### 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 is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. + +### Scene Number +Triggers when a scene button is pressed. + +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. + +### Dimmer Ramp Time [Deprecated] +Generic class for configuration parameter. + +The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. + +**Note:** This channel is marked as deprecated so should not be used. + +### Alarm +Indicates if an alarm is triggered. + +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + + + +## Device Configuration + +The following table provides a summary of the 10 configuration parameters available in the RF9642. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Delayed OFF Time | | +| 2 | Panic On Time | | +| 3 | Panic Off | | +| 5 | Power Up State | | +| 6 | Panic Mode Enable | | +| 7 | Dimmer Ramp Time | | +| 13 | Blue LED Brightness Level while dimmer is ON | | +| 14 | Blue LED Brightness Level while dimmer is OFF | | +| 15 | Amber LED Brightness Level while dimmer is ON | | +| 16 | Amber LED Brightness Level while dimmer is OFF | | + +### Parameter 1: Delayed OFF Time + + + +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Panic On Time + + + +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Panic Off + + + +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 5: Power Up State + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Off | +| 2 | On | +| 3 | Last State | + +The manufacturer defined default value is ```1``` (Off). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 6: Panic Mode Enable + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Off | +| 1 | On | + +The manufacturer defined default value is ```0``` (Off). + +This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```. + + +### Parameter 7: Dimmer Ramp Time + + + +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 13: Blue LED Brightness Level while dimmer is ON + + + +Values in the range 0 to 4 may be set. + +The manufacturer defined default value is ```4```. + +This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```. + + +### Parameter 14: Blue LED Brightness Level while dimmer is OFF + + + +Values in the range 0 to 4 may be set. + +The manufacturer defined default value is ```2```. + +This parameter has the configuration ID ```config_14_1``` and is of type ```INTEGER```. + + +### Parameter 15: Amber LED Brightness Level while dimmer is ON + + + +Values in the range 0 to 4 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_15_1``` and is of type ```INTEGER```. + + +### Parameter 16: Amber LED Brightness Level while dimmer is OFF + + + +Values in the range 0 to 4 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_16_1``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The RF9642 supports 3 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: Set + +On/Off + +Association group 2 supports 5 nodes. + +### Group 3: Dim + +Up/Down + +Association group 3 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| Linked to BASIC| +| COMMAND_CLASS_SCENE_ACTIVATION_V1| | +| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_PROTECTION_V1| | +| COMMAND_CLASS_NODE_NAMING_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_SECURITY_V1| | + +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/1104/RF9642-Z-Instruction-Sheet.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1104). diff --git a/_addons_bindings/zwave/doc/cooper/rftr9505_0_0.md b/_addons_bindings/zwave/doc/cooper/rftr9505_0_0.md index f5566916c..95e05f176 100644 --- a/_addons_bindings/zwave/doc/cooper/rftr9505_0_0.md +++ b/_addons_bindings/zwave/doc/cooper/rftr9505_0_0.md @@ -57,7 +57,149 @@ The following state translation is provided for this channel to the ```Switch``` ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 4 configuration parameters available in the RFTR9505. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 2 | Panic ON time | Panic ON time | +| 3 | Panic OFF time | Panic OFF time | +| 5 | Power Up State | Power up state of the device after power loss | +| 6 | Panic mode enable | Enables this device to participate in panic mode | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 2: Panic ON time + +Panic ON time +The amount of time in seconds the switch will turn on for when panic mode is triggered.  + +<table> + <tr> + <td> + <strong>Value</strong> + </td> + + <td> + <strong>Time</strong> + </td> + </tr> + + <tr> + <td> + 0 to 127 + </td> + + <td> + 0 to 127 seconds + </td> + </tr> + + <tr> + <td> + -128 to -1 + </td> + + <td> + 128 to 255 seconds + </td> + </tr> +</table>This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range -128 to 127 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Panic OFF time + +Panic OFF time +The amount of time in seconds the switch will turn off when panic mode is triggered.  + +<table> + <tr> + <td> + <strong>Value</strong> + </td> + + <td> + <strong>Time</strong> + </td> + </tr> + + <tr> + <td> + 0 to 127 + </td> + + <td> + 0 to 127 seconds + </td> + </tr> + + <tr> + <td> + -128 to -1 + </td> + + <td> + 128 to 255 seconds + </td> + </tr> +</table>This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range -128 to 127 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 5: Power Up State + +Power up state of the device after power loss + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Off | +| 2 | On | +| 3 | Last state | + +The manufacturer defined default value is ```3``` (Last state). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 6: Panic mode enable + +Enables this device to participate in panic mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Off | +| 1 | On | + +The manufacturer defined default value is ```0``` (OFF). + +This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups diff --git a/_addons_bindings/zwave/doc/cooper/rfwc5_0_0.md b/_addons_bindings/zwave/doc/cooper/rfwc5_0_0.md index a4de1151a..733df7687 100644 --- a/_addons_bindings/zwave/doc/cooper/rfwc5_0_0.md +++ b/_addons_bindings/zwave/doc/cooper/rfwc5_0_0.md @@ -44,56 +44,114 @@ Press the All Off (Inclusion) button one time The following table summarises the channels available for the RFWC5 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch Button 1 | switch_binary | Switch | Switch | -| Scene Number 1 | scene_number | | Number | -| Indicator Light Control 1 | indicator_level | | Dimmer | -| Switch Button 2 | switch_binary1 | Switch | Switch | -| Scene Number 2 | scene_number1 | | Number | -| Indicator Light Control 2 | indicator_level1 | | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch Button 1 | switch_binary | switch_binary | Switch | Switch | +| Scene Number 1 | scene_number | scene_number | | Number | +| Indicator Light Control 1 | indicator_level | indicator_level | | Dimmer | +| Switch Button 2 | switch_binary1 | switch_binary | Switch | Switch | +| Scene Number 2 | scene_number1 | scene_number | | Number | +| Indicator Light Control 2 | indicator_level1 | indicator_level | | Dimmer | ### Switch Button 1 - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number 1 - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Indicator Light Control 1 - Sets the indicator brightness. -The ```indicator_level``` channel supports the ```Dimmer``` item. +The ```indicator_level``` channel is of type ```indicator_level``` and supports the ```Dimmer``` item. ### Switch Button 2 - Switch the power on and off. -The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number 2 - Triggers when a scene button is pressed. -The ```scene_number1``` channel supports the ```Number``` item. +The ```scene_number1``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Indicator Light Control 2 - Sets the indicator brightness. -The ```indicator_level1``` channel supports the ```Dimmer``` item. +The ```indicator_level1``` channel is of type ```indicator_level``` and supports the ```Dimmer``` item. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 5 configuration parameters available in the RFWC5. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Group 1 Level | Group 1 Level | +| 2 | Group 2 Level | Group 2 Level | +| 3 | Group 3 Level | Group 3 Level | +| 4 | Group 4 Level | Group 4 Level | +| 5 | Group 5 Level | Group 5 Level | + +### Parameter 1: Group 1 Level + +Group 1 Level +Value 0x00-0x63 or 0xFF is the level for all nodes listed in the Group 1 +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```10```. + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Group 2 Level + +Group 2 Level +Value 0x00-0x63 or 0xFF is the level for all nodes listed in the Group 2 +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```20```. + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Group 3 Level + +Group 3 Level +Value 0x00-0x63 or 0xFF is the level for all nodes listed in the Group 3 +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```30```. + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Group 4 Level + +Group 4 Level +Value 0x00-0x63 or 0xFF is the level for all nodes listed in the Group 4 +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```40```. + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 5: Group 5 Level + +Group 5 Level +Value 0x00-0x63 or 0xFF is the level for all nodes listed in the Group 5 +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```50```. + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + ## Association Groups @@ -126,10 +184,10 @@ Association group 4 supports 232 nodes. Association group 5 supports 232 nodes. -### Group 127: Group 255 +### Group 255: Group 255 -Association group 127 supports 1 node. +Association group 255 supports 1 node. ## Technical Information diff --git a/_addons_bindings/zwave/doc/danfoss/010101_0_0.md b/_addons_bindings/zwave/doc/danfoss/010101_0_0.md index 6ed071536..a711ce4ee 100644 --- a/_addons_bindings/zwave/doc/danfoss/010101_0_0.md +++ b/_addons_bindings/zwave/doc/danfoss/010101_0_0.md @@ -42,36 +42,32 @@ Short push middle button The following table summarises the channels available for the 010101 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset | time_offset | Temperature | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset - Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. @@ -108,6 +104,7 @@ Association group 1 supports 1 node. | COMMAND_CLASS_BATTERY_V1| | | COMMAND_CLASS_CLOCK_V1| | | COMMAND_CLASS_WAKE_UP_V2| | +| COMMAND_CLASS_ASSOCIATION_V1| | | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_MULTI_CMD_V1| | diff --git a/_addons_bindings/zwave/doc/danfoss/014g0160_0_0.md b/_addons_bindings/zwave/doc/danfoss/014g0160_0_0.md index 1b9dcd85f..ff5f32efb 100644 --- a/_addons_bindings/zwave/doc/danfoss/014g0160_0_0.md +++ b/_addons_bindings/zwave/doc/danfoss/014g0160_0_0.md @@ -268,6 +268,7 @@ The device does not support associations. | COMMAND_CLASS_BASIC_V1| | | COMMAND_CLASS_SENSOR_MULTILEVEL_V5| | | COMMAND_CLASS_THERMOSTAT_SETPOINT_V2| | +| COMMAND_CLASS_SCHEDULE_V1| | | COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_BATTERY_V1| | diff --git a/_addons_bindings/zwave/doc/danfoss/dthermz5_0_0.md b/_addons_bindings/zwave/doc/danfoss/dthermz5_0_0.md index 9dbe2341a..93bce5620 100644 --- a/_addons_bindings/zwave/doc/danfoss/dthermz5_0_0.md +++ b/_addons_bindings/zwave/doc/danfoss/dthermz5_0_0.md @@ -90,12 +90,11 @@ This channel provides the battery level as a percentage and also reflects the lo ## Device Configuration -The following table provides a summary of the 12 configuration parameters available in the DTHERMZ5. +The following table provides a summary of the 11 configuration parameters available in the DTHERMZ5. Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 1 | Valve Type | Type of Valve being controlled | | 1 | Temperature Report threshold | Range is from 0.1 to 10°C 1=0.1°C 100=10°C | | 2 | Set-point display resolution | range from 0.1 to 10°C 1=0.1°C 100=10°C | | 3 | Min Set-point and override limit | from min 0°C to max setpoint override limit 0=0°C 40=40°C | @@ -110,24 +109,6 @@ Detailed information on each parameter can be found in the sections below. | | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | | | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | -### Parameter 1: Valve Type - -Type of Valve being controlled -Parameter 1: Valve type: - - * 0 = Normal Closed (NC) default - * 1 = Normal Open (NO) - -Mix of NC and NO types of valves is not supported - -Most systems use NC valves -Values in the range 0 to 0 may be set. - -The manufacturer defined default value is ```0```. - -This parameter has the configuration ID ```config_1_0``` and is of type ```INTEGER```. - - ### Parameter 1: Temperature Report threshold Range is from 0.1 to 10°C 1=0.1°C 100=10°C diff --git a/_addons_bindings/zwave/doc/danfoss/hrvccm_0_0.md b/_addons_bindings/zwave/doc/danfoss/hrvccm_0_0.md index ec36ee3a8..75e766eda 100644 --- a/_addons_bindings/zwave/doc/danfoss/hrvccm_0_0.md +++ b/_addons_bindings/zwave/doc/danfoss/hrvccm_0_0.md @@ -8,18 +8,33 @@ title: HRVCCM - ZWave # HRVCCM Air CCM This describes the Z-Wave device *HRVCCM*, manufactured by *Danfoss* with the thing type UID of ```danfoss_hrvccm_00_000```. +The device is in the category of *HVAC*, defining Air condition devices, Fans. + +![HRVCCM product image](https://www.cd-jackson.com/zwave_device_uploads/166/166_default.png) + + The HRVCCM 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 between other devices in the mesh network. ## 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/166) to improve the documentation. +Manages the HRV unit based on algorithms and input from the HRV AirDial and the optional HRV PC Tool + +**For use only with Danfoss Air Dial controllers.** + +### Inclusion Information + +**For use only with Danfoss Air Dial controllers.** + +### Exclusion Information + +**For use only with Danfoss Air Dial controllers.** ## Channels The following table summarises the channels available for the HRVCCM -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| @@ -45,6 +60,10 @@ The device does not support associations. | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_MANUFACTURER_PROPRIETARY_V1| | +### Documentation Links + +* [Installation](https://www.cd-jackson.com/zwave_device_uploads/166/AIR-installation-guide-VIEWA402-hi-res.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/danfoss/lcz251_0_0.md b/_addons_bindings/zwave/doc/danfoss/lcz251_0_0.md index 19ca32c8d..a00dfefc1 100644 --- a/_addons_bindings/zwave/doc/danfoss/lcz251_0_0.md +++ b/_addons_bindings/zwave/doc/danfoss/lcz251_0_0.md @@ -49,23 +49,21 @@ The wakeup period does not impact the devices ability to report events or sensor The following table summarises the channels available for the LCZ251 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -97,6 +95,7 @@ Association group 1 supports 1 node. | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_BATTERY_V1| | | COMMAND_CLASS_WAKE_UP_V2| | +| COMMAND_CLASS_ASSOCIATION_V1| | | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_MULTI_CMD_V1| | diff --git a/_addons_bindings/zwave/doc/devolo/mt02646_0_0.md b/_addons_bindings/zwave/doc/devolo/mt02646_0_0.md index 10b70aabd..8d67a2298 100644 --- a/_addons_bindings/zwave/doc/devolo/mt02646_0_0.md +++ b/_addons_bindings/zwave/doc/devolo/mt02646_0_0.md @@ -32,64 +32,56 @@ Push the front button three times rapidly within 2 seconds. The following table summarises the channels available for the MT02646 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (power factor) | meter_powerfactor | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (amps) | meter_current | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Reset the total power consumption | meter_reset | Energy | Switch | -| Alarm | alarm_general | Door | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (power factor) | meter_powerfactor | meter_powerfactor | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Reset the total power consumption | meter_reset | meter_reset | Energy | Switch | +| Alarm | alarm_general | alarm_general | Alarm | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (power factor) - Indicates the instantaneous power factor. -The ```meter_powerfactor``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Reset the total power consumption - Reset the meter. -The ```meter_reset``` channel supports the ```Switch``` item and is in the ```Energy``` category. +The ```meter_reset``` channel is of type ```meter_reset``` and supports the ```Switch``` item and is in the ```Energy``` category. ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -308,6 +300,7 @@ Association group 1 supports 1 node. ### Documentation Links * [English User Manual](https://www.cd-jackson.com/zwave_device_uploads/1/Manual-devolo-Home-Control-Metering-Plug-com.pdf) +* [TZE96 manual](https://www.cd-jackson.com/zwave_device_uploads/1/TZE96-manual.pdf) --- diff --git a/_addons_bindings/zwave/doc/devolo/mt2652_0_0.md b/_addons_bindings/zwave/doc/devolo/mt2652_0_0.md index fb6e637c6..2194b29fc 100644 --- a/_addons_bindings/zwave/doc/devolo/mt2652_0_0.md +++ b/_addons_bindings/zwave/doc/devolo/mt2652_0_0.md @@ -43,24 +43,22 @@ Click button 2 in management mode. The following table summarises the channels available for the MT2652 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: | Event ID | Event Description | @@ -74,11 +72,10 @@ This channel provides the scene, and the event as a decimal value in the form `` | 6 | 5 x keypress | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/devolo/mt2756_0_0.md b/_addons_bindings/zwave/doc/devolo/mt2756_0_0.md index acbbb2584..9159738f4 100644 --- a/_addons_bindings/zwave/doc/devolo/mt2756_0_0.md +++ b/_addons_bindings/zwave/doc/devolo/mt2756_0_0.md @@ -21,12 +21,24 @@ The MT2756 does not permanently listen for messages sent from the controller - i The Home Control Water Sensor is a water sensor and warns you about flooding or leaking water. As soon as water touches the open metal contacts, the device triggers an alarm. The Home Control Water Sensor is ideal for use in locations such as under a sink, under the supply valve of a washing machine or on an aquarium. It is equipped with an integrated LED and a release button. +### Inclusion Information + + * Pressing the tamper key three times within 1.5  seconds to enter the inclusion mode. + * After add successful, the device will wake to receive the setting command from Z-Wave™  Controller about 20 seconds. + +### Exclusion Information + +Press tamper key three times within 1.5 seconds to enter the exclusion mode. + ### Wakeup Information The MT2756 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. + +None given + ## Channels The following table summarises the channels available for the MT2756 -: diff --git a/_addons_bindings/zwave/doc/devolo/mt2759_0_0.md b/_addons_bindings/zwave/doc/devolo/mt2759_0_0.md new file mode 100644 index 000000000..484efb907 --- /dev/null +++ b/_addons_bindings/zwave/doc/devolo/mt2759_0_0.md @@ -0,0 +1,934 @@ +--- +layout: documentation +title: MT2759 - ZWave +--- + +{% include base.html %} + +# MT2759 Home Control Wall Mounted Switch +This describes the Z-Wave device *MT2759*, manufactured by *Devolo* with the thing type UID of ```devolo_mt2759_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![MT2759 product image](https://www.cd-jackson.com/zwave_device_uploads/1107/1107_default.png) + + +The MT2759 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 between other devices in the mesh network. + +## Overview + +This Z-Wave module is used for switching on or off the electrical device (e.g. light or fan). The module operates on 868,4 MHz. The module can be controlled either through Z-wave network or through the wall switch. The module is designed to be mounted inside a “flush mounting box”, hidden behind a traditional wall switch. Module measures power consumption of electrical device and supports connection of digital temperature sensor. It is designed to act as repeater in order to improve range and stability of Z-wave network. + +# Supported switches + +Module supports mono stable switches (push button) and bi stable switches. The module is factory set to operate with bi stable switches. + +### Inclusion Information + +# Module Inclusion (Adding to Z-wave network) + + * Connect module to power supply (with temperature sensor connected if purchased*), + * enable add/remove mode on main controller + * auto inclusion (works for about 2 minutes after connected to power supply) or + * press push button I1 three times within 5 s (3 times change switch state within 5 seconds) or + * press service button S (only applicable for 24 V SELVsupply voltage) for more than 2 second + + +NOTE 1: For auto inclusion procedure, first set main controller into inclusion mode and then connect module to power supply. +NOTE 2: When connecting temperature sensor to module that has already been included, you have to exclude module first. Switch off power supply, connect the sensor and re include the module. + +### Exclusion Information + +Module Exclusion/Reset (Removing from Z-Wave network) + + * Connect module to power supply + * bring module within maximum 1 meter (3 feet) of the main controller, + * enable add/remove mode on main controller + * press push button I1 five times within 5 s (5 times change switch state within 5 seconds) in the first 60 seconds after the module is  connected to the power supply or + * press service button S (only applicable for 24 V SELV supply voltage) for more than 6 seconds. + +By this function all parameters of the module are set to default values and own ID is deleted. + +Please use this procedure only when the network primary controller is missing or otherwise inoperable. + +If push button I1 is pressed three times within 5 s (or service button S is pressed more than 2 and less than 6 seconds) module is excluded, but configuration parameters are not set to default values. + +NOTE: If the module is included with parameters 100 or 101 with values different to default and module reset is done, wait at least 30s before next inclusion. + +## Channels + +The following table summarises the channels available for the MT2759 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Alarm (power) | alarm_power | alarm_power | Energy | Switch | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Electric meter (watts) 1 | meter_watts1 | meter_watts | Energy | Number | +| Electric meter (kWh) 1 | meter_kwh1 | meter_kwh | Energy | Number | +| Alarm (power) 1 | alarm_power1 | alarm_power | Energy | Switch | +| Binary Sensor 2 | sensor_binary2 | sensor_binary | | Switch | +| Alarm (burglar) 2 | alarm_burglar2 | alarm_burglar | Door | Switch | +| Binary Sensor 3 | sensor_binary3 | sensor_binary | | Switch | +| Alarm (burglar) 3 | alarm_burglar3 | alarm_burglar | Door | Switch | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Binary Sensor +Indicates if a sensor has triggered. + +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| ON | Triggered | +| OFF | Untriggered | + +### Electric meter (watts) +Indicates the instantaneous power consumption. + +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Electric meter (kWh) +Indicates the energy consumption (kWh). + +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Alarm (power) +Indicates if a power alarm is triggered. + +The ```alarm_power``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + +### Switch 1 +Switch the power on and off. + +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Electric meter (watts) 1 +Indicates the instantaneous power consumption. + +The ```meter_watts1``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Electric meter (kWh) 1 +Indicates the energy consumption (kWh). + +The ```meter_kwh1``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Alarm (power) 1 +Indicates if a power alarm is triggered. + +The ```alarm_power1``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + +### Binary Sensor 2 +Indicates if a sensor has triggered. + +The ```sensor_binary2``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| ON | Triggered | +| OFF | Untriggered | + +### Alarm (burglar) 2 +Indicates if the burglar alarm is triggered. + +The ```alarm_burglar2``` channel is of type ```alarm_burglar``` and 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. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + +### Binary Sensor 3 +Indicates if a sensor has triggered. + +The ```sensor_binary3``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| ON | Triggered | +| OFF | Untriggered | + +### Alarm (burglar) 3 +Indicates if the burglar alarm is triggered. + +The ```alarm_burglar3``` channel is of type ```alarm_burglar``` and 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. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + + + +## Device Configuration + +The following table provides a summary of the 15 configuration parameters available in the MT2759. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | (I1) Input 1 switch type | (I1) Input 1 switch type | +| 2 | (I2) Input 2 contact type | (I2) Input 2 contact type | +| 3 | (I3) Input 3 contact type | (I3) Input 3 contact type | +| 10 | ALL ON/ALL OFF | Activate / deactivate functions ALL ON/ALL OFF | +| 11 | Automatic turning off | Automatic turning off output after set time | +| 12 | Automatic turning on | Automatic turning on output after set time | +| 15 | Auto off / on, s or ms selection | Automatic turning off / on seconds or milliseconds selection | +| 30 | Saving the state | Saving the state of the relay after a power failure | +| 40 | Power reporting (W) on power change | Power reporting in Watts on power change | +| 42 | Power reporting (W) by time interval | Power reporting in Watts by time interval | +| 63 | Output Switch selection | Output Switch selection | +| 100 | Enable / Disable Endpoint I2 | Enable / Disable Endpoint I2 or select Notification Type and Event | +| 101 | Enable / Disable Endpoint I3 | Enable / Disable Endpoint I3 or select Notification Type and Event | +| 110 | Temperature sensor offset settings | Temperature sensor offset settings | +| 120 | Temperature sensor reporting | Temperature sensor reporting | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 1: (I1) Input 1 switch type + +(I1) Input 1 switch type +<table> + <tr> + <td> + Values + </td> + + <td> + Description + </td> + </tr> + + <tr> + <td> + </td> + + <td> + mono stable switch type (push button) + </td> + </tr> + + <tr> + <td> + 1 + </td> + + <td> + bi stable switch type (default) + </td> + </tr> +</table> +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | mono stable switch type (push button) | +| 1 | bi-stable switch type (default) | + +The manufacturer defined default value is ```1``` (bi-stable switch type (default)). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: (I2) Input 2 contact type + +(I2) Input 2 contact type + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | NO (normally open) input type (default) | +| 1 | NC (normally close) input type | + +The manufacturer defined default value is ```0``` (NO (normally open) input type (default)). + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: (I3) Input 3 contact type + +(I3) Input 3 contact type + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | NO (normally open) input type (default) | +| 1 | NC (normally close) input type | + +The manufacturer defined default value is ```0``` (NO (normally open) input type (default)). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 10: ALL ON/ALL OFF + +Activate / deactivate functions ALL ON/ALL OFF +HC Switch relay module responds to commands ALL ON / ALL OFF that may be sent by the main controller or by other controller belonging to the system. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | NONE | +| 1 | ALL OFF | +| 2 | ALL ON | +| 255 | ALL ON / ALL OFF (Default) | + +The manufacturer defined default value is ```255``` (ALL ON / ALL OFF (Default)). + +This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```. + + +### Parameter 11: Automatic turning off + +Automatic turning off output after set time +When relay is ON it goes automatically OFF after time defined by this parameter. Timer is reset to zero each time the module receive ON command regardless from where it comes (push button, associated module, controller,..). + + * default value 0 + * 0 = Auto OFF disabled + * 1 - 32535 = 1 second (0,01s) - 32535 seconds (325,35s) + +Auto OFF enabled with define time, step is 1s or 10ms according to parameter nr. 15. +The following option values may be configured, in addition to values in the range 0 to 32535 -: + +| Value | Description | +|--------|-------------| +| 0 | AUTO OFF disabled | + +The manufacturer defined default value is ```0``` (AUTO OFF disabled). + +This parameter has the configuration ID ```config_11_2``` and is of type ```INTEGER```. + + +### Parameter 12: Automatic turning on + +Automatic turning on output after set time +When relay is OFF it goes automatically ON after time defined by this parameter. Timer is reset to zero each time the module receive OFF command regardless from where it come s (push button, associated module, controller,..). + +Available configuration parameters (data type is 2 Byte DEC): + + * default value 0 + * 0 Auto ON disabled + * 1 32535 = 1second (0,01s) 32536 seconds (325,35s) + +Auto ON enabled with define time, step is 1s or 10m s according to parameter nr. 15. +The following option values may be configured, in addition to values in the range 0 to 32535 -: + +| Value | Description | +|--------|-------------| +| 0 | AUTO ON disabled | + +The manufacturer defined default value is ```0``` (AUTO ON disabled). + +This parameter has the configuration ID ```config_12_2``` and is of type ```INTEGER```. + + +### Parameter 15: Auto off / on, s or ms selection + +Automatic turning off / on seconds or milliseconds selection +NOTE: Parameter is the same for turning OFF or ON. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | seconds selected (default) | +| 1 | milliseconds selected | + +The manufacturer defined default value is ```0``` (seconds selected (default)). + +This parameter has the configuration ID ```config_15_1``` and is of type ```INTEGER```. + + +### Parameter 30: Saving the state + +Saving the state of the relay after a power failure + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | HC Switch relay module saves its state | +| 1 | HC Switch relay module returns to "off" position | + +The manufacturer defined default value is ```0``` (HC Switch relay module saves its state ). + +This parameter has the configuration ID ```config_30_1``` and is of type ```INTEGER```. + + +### Parameter 40: Power reporting (W) on power change + +Power reporting in Watts on power change +Set value means percentage, set value from 0 - 100 = 0% - 100%. Available configuration parameters (data type is 1 Byte DEC): + + * default value 10 = 10% + * 0 = reporting disabled + * 1-100 = 1% - 100% reporting enabled + +Power report is send (push) only when actual power in Watts in real time changes for more than set percentage comparing to previous actual power in Watts , step is When using low power loads, It is recommended to set parameter no. 40 to a higher value (e.g. 50%). + +NOTE: if power changed is less than 1W, the report is not send (pushed), independent of percentage set. +The following option values may be configured, in addition to values in the range 0 to 100 -: + +| Value | Description | +|--------|-------------| +| 0 | Reporting disabled | + +The manufacturer defined default value is ```10```. + +This parameter has the configuration ID ```config_40_1``` and is of type ```INTEGER```. + + +### Parameter 42: Power reporting (W) by time interval + +Power reporting in Watts by time interval +Set value means time interval (0 - 32535) in seconds, when power report is send. Available configuration parameters (data type is 2 Byte DEC): + + * default value 300 = 300s + * 0 reporting disabled + * 30-32535 = 30 seconds - 32535 seconds. Reporting enabled. + Power report is send with time interval set by entered value. +The following option values may be configured, in addition to values in the range 0 to 32535 -: + +| Value | Description | +|--------|-------------| +| 0 | Reporting disabled | + +The manufacturer defined default value is ```300```. + +This parameter has the configuration ID ```config_42_2``` and is of type ```INTEGER```. + + +### Parameter 63: Output Switch selection + +Output Switch selection +Set value means the type of the device that is connected to the output. The device type can be normally open (NO) or normally close (NC). +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | (NC) output is 0V (default) | +| 1 | (NO) output is 230V / 24V | + +The manufacturer defined default value is ```0``` ((NC) output is 0V (default)). + +This parameter has the configuration ID ```config_63_1``` and is of type ```INTEGER```. + + +### Parameter 100: Enable / Disable Endpoint I2 + +Enable / Disable Endpoint I2 or select Notification Type and Event +# Enable / Disable Endpoint I2 or select Notification Type and Event + +Enabling I2 means that Endpoint (I2) will be present on UI. Disabling it will result in hiding the endpoint according to the parameter set value. Additionally, a Notification Type and Event can be selected for the endpoint. Available configuration parameters (data type is 1 Byte DEC): + +## Endpoint device type selection: + +notification sensor (1-6): + +GENERIC\_TYPE\_SENSOR\_NOTIFICATION, SPECIFIC\_TYPE\_NOTIFICATION\_SENSOR + +<table> + <tr> + <td> + Values + </td> + + <td> + Description + </td> + </tr> + + <tr> + <td> + 1 + </td> + + <td> + Home Security: Motion Detection, unknown loc. (Default) + </td> + </tr> + + <tr> + <td> + 2 + </td> + + <td> + Carbon Monoxide; Carbon Monoxide detected, unknown location. + </td> + </tr> + + <tr> + <td> + 3 + </td> + + <td> + Carbon Dioxide; Carbon Dioxide detected, unknown location. + </td> + </tr> + + <tr> + <td> + 4 + </td> + + <td> + Water Alarm; Water Leak detected, unknown loc. + </td> + </tr> + + <tr> + <td> + 5 + </td> + + <td> + Heat Alarm; Overheat detected, unknown loc. + </td> + </tr> + + <tr> + <td> + 6 + </td> + + <td> + Smoke Alarm; Smoke detected, unknown loc. + </td> + </tr> + + <tr> + <td> + </td> + + <td> + Endpoint I2 disabled + </td> + </tr> +</table> + +binary sensor (9): + +GENERIC\_TYPE\_SENSOR\_BINARY, SPECIFIC\_TYPE\_NOT\_USED + +NOTE 1 : After parameter change, first exclude module (without setting parameters to default value) then wait at least 30s and then re include the module! + +NOTE 2: If parameter is set to value 9, the messages will be sent to Home Security! +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Endpoint I2 disabled | +| 1 | Home Security: Motion Detection | +| 2 | Carbon Monoxide | +| 3 | Carbon Dioxide | +| 4 | Water Alarm | +| 5 | Heat Alarm | +| 6 | Smoke Alarm | + +The manufacturer defined default value is ```1``` (Home Security: Motion Detection). + +This parameter has the configuration ID ```config_100_1``` and is of type ```INTEGER```. + + +### Parameter 101: Enable / Disable Endpoint I3 + +Enable / Disable Endpoint I3 or select Notification Type and Event +# Enable / Disable Endpoint I3 or select Notification Type and Event + +Enabling I3 means that Endpoint (I3) will be present on UI. Disabling it will result in hiding the endpoint according to the parameter set value. Additionally, a Notification Type and Event can be selected for the endpoint. Available configuration parameters (data type is 1 Byte DEC): + +## Endpoint device type selection: + +notification sensor (1-6): + +GENERIC\_TYPE\_SENSOR\_NOTIFICATION, SPECIFIC\_TYPE\_NOTIFICATION\_SENSOR + +<table> + <tr> + <td> + Values + </td> + + <td> + Description + </td> + </tr> + + <tr> + <td> + 1 + </td> + + <td> + Home Security: Motion Detection, unknown loc. (Default) + </td> + </tr> + + <tr> + <td> + 2 + </td> + + <td> + Carbon Monoxide; Carbon Monoxide detected, unknown location. + </td> + </tr> + + <tr> + <td> + 3 + </td> + + <td> + Carbon Dioxide; Carbon Dioxide detected, unknown location. + </td> + </tr> + + <tr> + <td> + 4 + </td> + + <td> + Water Alarm; Water Leak detected, unknown loc. + </td> + </tr> + + <tr> + <td> + 5 + </td> + + <td> + Heat Alarm; Overheat detected, unknown loc. + </td> + </tr> + + <tr> + <td> + 6 + </td> + + <td> + Smoke Alarm; Smoke detected, unknown loc. + </td> + </tr> + + <tr> + <td> + </td> + + <td> + Endpoint I3 disabled + </td> + </tr> +</table> + +binary sensor (9): + +GENERIC\_TYPE\_SENSOR\_BINARY, SPECIFIC\_TYPE\_NOT\_USED + +NOTE 1 : After parameter change, first exclude module (without setting parameters to default value) then wait at least 30s and then re include the module! + +NOTE 2: If parameter is set to value 9, the messages will be sent to Home Security! +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Endpoint I3 disabled | +| 1 | Home Security: Motion Detection (Default) | +| 2 | Carbon Monoxide | +| 3 | Carbon Dioxide | +| 4 | Water Alarm | +| 5 | Heat Alarm | +| 6 | Smoke Alarm | + +The manufacturer defined default value is ```1``` (Home Security: Motion Detection (Default)). + +This parameter has the configuration ID ```config_101_1``` and is of type ```INTEGER```. + + +### Parameter 110: Temperature sensor offset settings + +Temperature sensor offset settings +Set value is added or subtracted to actual measured value by sensor. Available configuration parameters (data type is 2 Byte DEC): + +<table> + <tr> + <td> + Values + </td> + + <td> + Description + </td> + </tr> + + <tr> + <td> + 32536 + </td> + + <td> +  is 0.0C (Default) + </td> + </tr> + + <tr> + <td> + 1 –100 + </td> + + <td> + From 1 to 100 value from 0.1°C to 10.0°C is added to actual measured temperature. + </td> + </tr> + + <tr> + <td> + 1001 –1100 + </td> + + <td> + From 1001 to 1100 value from 0.1 °C to 10.0 °C is subtracted to actual measured temperature. + </td> + </tr> +</table> +Values in the range 1 to 32536 may be set. + +The manufacturer defined default value is ```32536```. + +This parameter has the configuration ID ```config_110_2``` and is of type ```INTEGER```. + + +### Parameter 120: Temperature sensor reporting + +Temperature sensor reporting +If digital temperature sensor is connected, module reports measured temperature on temperature change defined by this parameter. Available configuration parameters (data type is 1 Byte DEC): + +<table> + <tr> + <td> + Values + </td> + + <td> + Description + </td> + </tr> + + <tr> + <td> + 5 + </td> + + <td> + 0,5°C (default) + </td> + </tr> + + <tr> + <td> + </td> + + <td> + Reporting disabled + </td> + </tr> + + <tr> + <td> + 1 –127 + </td> + + <td> + 0,1°C - 12,7°C, step is 0,1°C + </td> + </tr> +</table> +Values in the range 0 to 127 may be set. + +The manufacturer defined default value is ```5```. + +This parameter has the configuration ID ```config_120_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The MT2759 supports 9 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. +Lifeline group (reserved for communication with the main controller), 1 node allowed. + +Association group 1 supports 1 node. + +### Group 2: Basic On/Off I1 + +basic on/off (triggered at change of the output Q state and reflecting its state) up to 16 nodes. + +Association group 2 supports 16 nodes. + +### Group 3: Basic On/Off I2 + +basic on/off (triggered at change of the input I2 state and reflecting its state) up to 16 nodes. + +Association group 3 supports 16 nodes. + +### Group 4: Reporting I2 + +Notification report (triggered at change of the input I2 state and reflecting its state) up to 16 nodes. + +Association group 4 supports 16 nodes. + +### Group 5: Binary Sensor Report I2 + +Binary sensor (triggered at change of the input I2 state and reflecting its state) up to 16 nodes. + +Association group 5 supports 16 nodes. + +### Group 6: Basic On/Off I3 + +basic on/off (triggered at change of the input I3 state an d reflecting its state) up to 16 nodes. + +Association group 6 supports 16 nodes. + +### Group 7: Reporting I3 + +notification report (triggered at change of the input I3 state and reflecting its state) up to 16 nodes. + +Association group 7 supports 16 nodes. + +### Group 8: Binary Sensor Report I3 + +binary sensor report (triggered at change of the input I3 state and reflecting its state) up to 16 nodes. + +Association group 8 supports 16 nodes. + +### Group 9: Multi-Level Sensor Reporting + +multilevel sensor report (triggered at change of temperature sensor) up to 16 nodes. + +Association group 9 supports 16 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_SENSOR_BINARY_V1| | +| COMMAND_CLASS_METER_V3| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_MULTI_CHANNEL_V2| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V5| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +| COMMAND_CLASS_SECURITY_V1| | +#### Endpoint 1 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_METER_V3| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ALARM_V5| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 2 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SENSOR_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ALARM_V5| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 3 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SENSOR_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ALARM_V5| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | + +### Documentation Links + +* [Manual DE](https://www.cd-jackson.com/zwave_device_uploads/1107/Home-Control-Schalter-Unterputz-2019-04-03.pdf) +* [Manual EN](https://www.cd-jackson.com/zwave_device_uploads/1107/Manual-Devolo-HCswitch-FM.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1107). diff --git a/_addons_bindings/zwave/doc/dlink/dchz510_0_0.md b/_addons_bindings/zwave/doc/dlink/dchz510_0_0.md index 35746b95a..e0c5a362e 100644 --- a/_addons_bindings/zwave/doc/dlink/dchz510_0_0.md +++ b/_addons_bindings/zwave/doc/dlink/dchz510_0_0.md @@ -35,23 +35,21 @@ The DCH-Z510 mydlink Z-Wave Siren is a wireless siren. The following table summarises the channels available for the DCH-Z510 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Binary Sensor | sensor_binary | Door | Switch | -| Start sound | notification_send | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Start sound | notification_send | notification_send | | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -61,7 +59,6 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Start sound - <table> <tr> <td> @@ -308,7 +305,7 @@ The following state translation is provided for this channel to the ```Switch``` Sends a notification. -The ```notification_send``` channel supports the ```Number``` item. +The ```notification_send``` channel is of type ```notification_send``` and supports the ```Number``` item. @@ -398,6 +395,7 @@ Association group 1 supports 8 nodes. | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_POWERLEVEL_V1| | | COMMAND_CLASS_FIRMWARE_UPDATE_MD_V2| | +| COMMAND_CLASS_ASSOCIATION_V1| | | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_SECURITY_V1| | diff --git a/_addons_bindings/zwave/doc/eco/dwzwave2_0_0.md b/_addons_bindings/zwave/doc/eco/dwzwave2_0_0.md index 92fd59c42..1581542a4 100644 --- a/_addons_bindings/zwave/doc/eco/dwzwave2_0_0.md +++ b/_addons_bindings/zwave/doc/eco/dwzwave2_0_0.md @@ -31,7 +31,9 @@ The DWZWAVE2 does not permanently listen for messages sent from the controller - ### Exclusion Information -Not provided + 1. Remove the battery from the Sensor. + 2. Leave the battery out for at least ten (10) seconds. + 3. Reinstall the battery into the Sensor. ### Wakeup Information @@ -40,7 +42,7 @@ The DWZWAVE2 does not permanently listen for messages sent from the controller - 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. -Not provided +Press the "+" button once. ## Channels @@ -85,7 +87,64 @@ This channel provides the battery level as a percentage and also reflects the lo ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 2 configuration parameters available in the DWZWAVE2. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Sending Basic Sets to Association group 2 | Sending Basic Sets to Association group 2 | +| 2 | Sending sensor binary report | Sending sensor binary report | +| | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | +| | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | + +### Parameter 1: Sending Basic Sets to Association group 2 + +Sending Basic Sets to Association group 2 + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Off | +| 255 | On | + +The manufacturer defined default value is ```0``` (Off). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Sending sensor binary report + +Sending sensor binary report + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Off | +| 255 | On | + +The manufacturer defined default value is ```0``` (Off). + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + +### Wakeup Interval + +The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications. + +This setting is defined in *seconds*. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances. + +Note that this setting does not affect the devices ability to send sensor data, or notification events. + +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_node``` and is of type ```INTEGER```. + ## Association Groups diff --git a/_addons_bindings/zwave/doc/eco/tiltzwave2_0_0.md b/_addons_bindings/zwave/doc/eco/tiltzwave2_0_0.md index 2fb541213..58ecf3009 100644 --- a/_addons_bindings/zwave/doc/eco/tiltzwave2_0_0.md +++ b/_addons_bindings/zwave/doc/eco/tiltzwave2_0_0.md @@ -42,17 +42,16 @@ Remove the cover, close the cover. The following table summarises the channels available for the TILTZWAVE2 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_door | Door | Contact | -| Alarm | alarm_general | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_door | sensor_door | Door | Contact | +| Alarm | alarm_general | alarm_general | Alarm | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - Indicates if the door/window is open or closed. -The ```sensor_door``` channel supports the ```Contact``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_door``` channel is of type ```sensor_door``` and supports the ```Contact``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Contact``` item type -: @@ -62,10 +61,9 @@ The following state translation is provided for this channel to the ```Contact`` | CLOSED | Closed | ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -75,11 +73,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -125,6 +122,7 @@ Association group 2 supports 5 nodes. ### Documentation Links * [English User Manual](https://www.cd-jackson.com/zwave_device_uploads/139/Ecolink-TILTZWAVE2-ECO-manual-rev1.pdf) +* [Updated Manual](https://www.cd-jackson.com/zwave_device_uploads/139/Tilt-ZWave-Plus-Manual-R1-04-021816kgs.pdf) --- diff --git a/_addons_bindings/zwave/doc/essence/es800zwe_0_0.md b/_addons_bindings/zwave/doc/essence/es800zwe_0_0.md index b0b3b85a6..199234d83 100644 --- a/_addons_bindings/zwave/doc/essence/es800zwe_0_0.md +++ b/_addons_bindings/zwave/doc/essence/es800zwe_0_0.md @@ -69,8 +69,8 @@ To remove your Z-Wave Plus Extender from the existing network: The following table summarises the channels available for the ES800ZWE -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| @@ -82,7 +82,14 @@ The device has no configuration parameters defined. Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The ES800ZWE supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 3 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/evolve/lrmas_0_0.md b/_addons_bindings/zwave/doc/evolve/lrmas_0_0.md index b8c14f1df..d611c1036 100644 --- a/_addons_bindings/zwave/doc/evolve/lrmas_0_0.md +++ b/_addons_bindings/zwave/doc/evolve/lrmas_0_0.md @@ -10,42 +10,52 @@ This describes the Z-Wave device *LRM-AS*, manufactured by *Evolve* with the thi The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. +![LRM-AS product image](https://www.cd-jackson.com/zwave_device_uploads/39/39_default.png) + + The LRM-AS 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 between other devices in the mesh network. ## 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/39) to improve the documentation. +Scene Capable Wall Switch DimmerThe LRM-AS Wall Mounted Dimmer is a component of the Evolve lighting control system. Inclusion of the LRM-AS Wall Mounted Dimmer allows remote ON/ OFF control and dimming of lights connected.  + +### Inclusion Information + +Tap the button. + +### Exclusion Information + +Tap the button 3 times, then press and hold (Ex. tap, tap, tap, hold) ## Channels The following table summarises the channels available for the LRM-AS -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Binary Sensor | sensor_binary | Door | Switch | -| Alarm | alarm_general | Door | Switch | -| Battery Level | battery-level | Battery | Number | - -### Switch +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch [Deprecated]| switch_binary | switch_binary | Switch | Switch | +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Alarm | alarm_general | alarm_general | Alarm | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | +### Switch [Deprecated] Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +**Note:** This channel is marked as deprecated so should not be used. ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -55,10 +65,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -68,11 +77,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -181,6 +189,7 @@ Association group 1 supports 5 nodes. | COMMAND_CLASS_ALARM_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_BATTERY_V1| | +| COMMAND_CLASS_ASSOCIATION_V1| | | COMMAND_CLASS_VERSION_V1| | ### Documentation Links diff --git a/_addons_bindings/zwave/doc/evolve/ltm5_0_0.md b/_addons_bindings/zwave/doc/evolve/ltm5_0_0.md index 4f6f67815..c0b47b93d 100644 --- a/_addons_bindings/zwave/doc/evolve/ltm5_0_0.md +++ b/_addons_bindings/zwave/doc/evolve/ltm5_0_0.md @@ -8,33 +8,38 @@ title: LTM-5 - ZWave # LTM-5 Wall Mount Accessory Switch This describes the Z-Wave device *LTM-5*, manufactured by *Evolve* with the thing type UID of ```evolve_ltm5_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![LTM-5 product image](https://www.cd-jackson.com/zwave_device_uploads/38/38_default.png) + + The LTM-5 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 between other devices in the mesh network. ## 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/38) to improve the documentation. +The 3-Way Wall Mounted Switch (LTM-5) is the Evolve in-wall accessory switch, used for creating virtual 3-way and 4-way circuits, as well as wirelessly controlling Evolve lighting devices and plug-in modules.  The LTM-5 does not directly control a load. Instead, it communicates with other load controlling devices or plug-in modules.  +  +There is a small LED on the device, which remains illuminated and flickers when sending a command to another Evolve device. ## Channels The following table summarises the channels available for the LTM-5 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. @@ -206,6 +211,10 @@ Association group 1 supports 5 nodes. | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_INDICATOR_V1| | +### Documentation Links + +* [Product Overview](https://www.cd-jackson.com/zwave_device_uploads/38/LTM-5.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/fakro/arz2_1_1.md b/_addons_bindings/zwave/doc/fakro/arz2_1_1.md index 71bc09742..180413a65 100644 --- a/_addons_bindings/zwave/doc/fakro/arz2_1_1.md +++ b/_addons_bindings/zwave/doc/fakro/arz2_1_1.md @@ -43,18 +43,18 @@ The following table summarises the channels available for the ARZ 1.1 -: ### Switch Switch the power on and off. -The ```switch_binary``` channel and is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and 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 and is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Alarm (power) Indicates if a power alarm is triggered. -The ```alarm_power``` channel and is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_power``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: diff --git a/_addons_bindings/zwave/doc/fakro/vmzsolar_0_0.md b/_addons_bindings/zwave/doc/fakro/vmzsolar_0_0.md index 202b00305..9d39237a7 100644 --- a/_addons_bindings/zwave/doc/fakro/vmzsolar_0_0.md +++ b/_addons_bindings/zwave/doc/fakro/vmzsolar_0_0.md @@ -17,7 +17,15 @@ The VMZ Solar supports routing. This allows the device to communicate using othe ## 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/670) to improve the documentation. +The VMZ Solar awning blind is intended for installation on facade windows. The device is equippedin the wireless module of the ZWave control system + +### Inclusion Information + +Within 10s press the programming button P on the awning blind until the network status LED flashes once 0.5s + +### Exclusion Information + +Within 10s press P on the awning and hold until the network status LED will light up for 5s ## Channels @@ -27,21 +35,23 @@ The following table summarises the channels available for the VMZ Solar -: |--------------|------------|--------------|----------|-----------| | Switch | switch_binary | switch_binary | Switch | Switch | | Blinds control | blinds_control | blinds_control | Blinds | Rollershutter | -| Battery Level | battery-level | Battery | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Switch Switch the power on and off. -The ```switch_binary``` channel and is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Blinds control Provides start / stop control of blinds. -The ```blinds_control``` channel and is of type ```blinds_control``` and supports the ```Rollershutter``` item and is in the ```Blinds``` category. +The ```blinds_control``` channel is of type ```blinds_control``` and supports the ```Rollershutter``` item and is in the ```Blinds``` category. ### Battery Level -Channel type information on this channel is not found. +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 is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/fibaro/fgsd002_0_0.md b/_addons_bindings/zwave/doc/fibaro/fgsd002_0_0.md index adedc51e4..9db9f0a7c 100644 --- a/_addons_bindings/zwave/doc/fibaro/fgsd002_0_0.md +++ b/_addons_bindings/zwave/doc/fibaro/fgsd002_0_0.md @@ -45,25 +45,44 @@ The wakeup period does not impact the devices ability to report events or sensor Click the B-button once. +### General Usage Information + +**BATTERY REPLACEMENT PROCEDURE** +Once a Fibaro Smoke Sensor has reported low battery level or battery is +discharged, it should be replaced observing the following procedure: + + 1. Detach the sensor from its cover by turning the device counter-clockwise. + 2. Remove the flat battery from the device. Then press and hold the B-button for 3 seconds. + 3. Insert a new CR123A battery observing the polarities shown inside. Visual indicator will signal Z-Wave network inclusion status (green - device included, red - device not included). + 4. Test Fibaro Smoke Sensor’s operation by performing a self-test (see p. VI). + 5. Attach the device into the cover by turning clockwise. + +**Self-test may be triggered manually** + + 1. Make sure the device is powered by the battery + 2. Press and hold the B-button. The visual indicator will glow white and the short alarm will sound. Keep holding the B-button. After 3 seconds from the first beep smoke chamber operation will be checked. + +Triggering fire alarm and beep mean positive result and should occur within 10 seconds. No fire alarm means that the sensor is malfunctioning. + ## Channels The following table summarises the channels available for the FGSD002 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Temperature Sensor | sensor_temperature | Temperature | Number:Temperature | -| Smoke Alarm | alarm_smoke | Smoke | Switch | -| Tamper Alarm | alarm_tamper | | Switch | -| Low Battery Alarm | alarm_battery | | Switch | -| Hardware Failure Alarm | alarm_system | | Switch | -| Heat Alarm | alarm_heat | | Switch | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset | time_offset | Temperature | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Temperature Sensor | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Smoke Alarm | alarm_smoke | alarm_smoke | Smoke | Switch | +| Tamper Alarm | alarm_tamper | alarm_tamper | | Switch | +| Low Battery Alarm | alarm_battery | alarm_battery | LowBattery | Switch | +| Hardware Failure Alarm | alarm_system | alarm_system | | Switch | +| Heat Alarm | alarm_heat | alarm_heat | Fire | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | ### Temperature Sensor Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Smoke Alarm removed event specfic @@ -74,7 +93,7 @@ event  2 is real smoke Indicates if a smoke is triggered. -The ```alarm_smoke``` channel supports the ```Switch``` item and is in the ```Smoke``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_smoke``` channel is of type ```alarm_smoke``` and supports the ```Switch``` item and is in the ```Smoke``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -86,7 +105,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Tamper Alarm Indicates if the tamper alarm is triggered. -The ```alarm_tamper``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_tamper``` channel is of type ```alarm_tamper``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -98,7 +117,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Low Battery Alarm Indicates if the low battery alarm is triggered. -The ```alarm_battery``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_battery``` channel is of type ```alarm_battery``` and supports the ```Switch``` item and is in the ```LowBattery``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -110,7 +129,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Hardware Failure Alarm Indicates if a system alarm is triggered. -The ```alarm_system``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_system``` channel is of type ```alarm_system``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -122,7 +141,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Heat Alarm Indicates if a heat alarm is triggered. -The ```alarm_heat``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_heat``` channel is of type ```alarm_heat``` and supports the ```Switch``` item and is in the ```Fire``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -134,12 +153,12 @@ The following state translation is provided for this channel to the ```Switch``` ### Battery Level 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. diff --git a/_addons_bindings/zwave/doc/fibaro/fgsd002_3_2.md b/_addons_bindings/zwave/doc/fibaro/fgsd002_3_2.md index fca78ece5..6edd205ba 100644 --- a/_addons_bindings/zwave/doc/fibaro/fgsd002_3_2.md +++ b/_addons_bindings/zwave/doc/fibaro/fgsd002_3_2.md @@ -43,31 +43,50 @@ The FGSD002 does not permanently listen for messages sent from the controller - 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. -Click the B-button once. +Click the B-button once to wakeup the device. Minimum wake-interval accepted by the device is 4200. + +### General Usage Information + +**BATTERY REPLACEMENT PROCEDURE** +Once a Fibaro Smoke Sensor has reported low battery level or battery is +discharged, it should be replaced observing the following procedure: + + 1. Detach the sensor from its cover by turning the device counter-clockwise. + 2. Remove the flat battery from the device. Then press and hold the B-button for 3 seconds. + 3. Insert a new CR123A battery observing the polarities shown inside. Visual indicator will signal Z-Wave network inclusion status (green - device included, red - device not included). + 4. Test Fibaro Smoke Sensor’s operation by performing a self-test (see p. VI). + 5. Attach the device into the cover by turning clockwise. + +**Self-test may be triggered manually** + + 1. Make sure the device is powered by the battery + 2. Press and hold the B-button. The visual indicator will glow white and the short alarm will sound. Keep holding the B-button. After 3 seconds from the first beep smoke chamber operation will be checked. + +Triggering fire alarm and beep mean positive result and should occur within 10 seconds. No fire alarm means that the sensor is malfunctioning. ## Channels The following table summarises the channels available for the FGSD002 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Temperature Sensor | sensor_temperature | Temperature | Number:Temperature | -| Heat Alarm | alarm_heat | Fire | Switch | -| Smoke Alarm | alarm_smoke | Smoke | Switch | -| Hardware Failure Alarm | alarm_system | | Switch | -| Tamper Alarm | alarm_tamper | | Switch | -| Low Battery Alarm | alarm_battery | LowBattery | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Temperature Sensor | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Heat Alarm | alarm_heat | alarm_heat | Fire | Switch | +| Smoke Alarm | alarm_smoke | alarm_smoke | Smoke | Switch | +| Hardware Failure Alarm | alarm_system | alarm_system | | Switch | +| Tamper Alarm | alarm_tamper | alarm_tamper | | Switch | +| Low Battery Alarm | alarm_battery | alarm_battery | LowBattery | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Temperature Sensor Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Heat Alarm Indicates if a heat alarm is triggered. -The ```alarm_heat``` channel supports the ```Switch``` item and is in the ```Fire``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_heat``` channel is of type ```alarm_heat``` and supports the ```Switch``` item and is in the ```Fire``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -79,7 +98,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Smoke Alarm Indicates if a smoke is triggered. -The ```alarm_smoke``` channel supports the ```Switch``` item and is in the ```Smoke``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_smoke``` channel is of type ```alarm_smoke``` and supports the ```Switch``` item and is in the ```Smoke``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -91,7 +110,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Hardware Failure Alarm Indicates if a system alarm is triggered. -The ```alarm_system``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_system``` channel is of type ```alarm_system``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -103,7 +122,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Tamper Alarm Indicates if the tamper alarm is triggered. -The ```alarm_tamper``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_tamper``` channel is of type ```alarm_tamper``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -115,7 +134,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Low Battery Alarm Indicates if the low battery alarm is triggered. -The ```alarm_battery``` channel supports the ```Switch``` item and is in the ```LowBattery``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_battery``` channel is of type ```alarm_battery``` and supports the ```Switch``` item and is in the ```LowBattery``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -127,8 +146,8 @@ The following state translation is provided for this channel to the ```Switch``` ### Battery Level 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/fibaro/fgwdseu_0_0.md b/_addons_bindings/zwave/doc/fibaro/fgwdseu_0_0.md new file mode 100644 index 000000000..39426579e --- /dev/null +++ b/_addons_bindings/zwave/doc/fibaro/fgwdseu_0_0.md @@ -0,0 +1,945 @@ +--- +layout: documentation +title: FGWDSEU - ZWave +--- + +{% include base.html %} + +# FGWDSEU WALLI SWITCH FIBARO DOUBLE SWITCH +This describes the Z-Wave device *FGWDSEU*, manufactured by *[Fibargroup](http://www.fibaro.com/)* with the thing type UID of ```fibaro_fgwdseu_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![FGWDSEU product image](https://www.cd-jackson.com/zwave_device_uploads/1064/1064_default.jpg) + + +The FGWDSEU 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 between other devices in the mesh network. + +## Overview + +FIBARO Walli Double Switch is a smart wall switch designed to control one or two light sources via Z-Wave network. It measures active power and energy consumed by the controlled load. You can install it with provided cover plate or other compatible.  +Main features of FIBARO Walli Double Switch:  + +Can be used with: + + * Conventional incandescent and halogen light sources, + * LED lamps, + * Fluorescent lamps, + * Electronic transformers (for ELV halogen lamps and LED bulbs), + * Ferromagnetic transformers (for MLV halogen lamps). + * Can be used with provided cover plate or one of the following: + * GIRA – System 55 (Standard 55, E2, Event, Event Clear),  + * Legrand – Céliane,  + * Schneider – Odace. + * Active power and energy consumption metering. + * Supports Z-Wave network Security Modes: S0 with AES-128 encryption and S2 Authenticated with PRNG-based encryption.  + * Works as Z-Wave signal repeater (all non-battery operated devices within the network will act as repeaters to increase reliability of the network).  + * May be used with all devices certified with the Z-Wave Plus certificate and should be compatible with such devices produced by other manufacturers.  + +### Inclusion Information + +Adding (Inclusion) – Z-Wave device learning mode, allowing to add the device to existing Z-Wave network. i If you want to change single/double switch operating mode (see “Single/Double Switch operating mode” on page 14), you must do it before adding the device to the Z-Wave network. 5.1: Adding manually To add the device to the Z-Wave network manually: 1. Power the device. 2. Set the main controller in (Security/non-Security Mode) add mode (see the controller’s manual). 3. Quickly, three times click one of the buttons. 4. If you are adding in Security S2 Authenticated, input the underlined part of the DSK (label on the bottom of the box). 5. LED will start blinking yellow, wait for the adding process to end. 6. Adding result will be confirmed by the Z-Wave controller’s message and the LED frame: • Green – successful (non-secure, S0, S2 non-authenticated), • Magenta – successful (Security S2 Authenticated), • Red – not successful. + +### Exclusion Information + +Removing (Exclusion) – Z-Wave device learning mode, allowing to remove the device from existing Z-Wave network. Removing also results in resetting the device to factory defaults. + +To remove the device from the Z-Wave network: + + 1. Power the device. + 2. Set the main controller into remove mode (see the controller’s manual). + 3. Quickly, three times click one of the buttons. + 4. LED will start blinking yellow, wait for the removing process to end. + 5. Successful removing will be confirmed by the Z-Wave controller’s message and red LED colour. + +## Channels + +The following table summarises the channels available for the FGWDSEU -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Switch | switch_binary1 | switch_binary | Switch | Switch | +| Electric meter (kWh) | meter_kwh1 | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts1 | meter_watts | Energy | Number | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Electric meter (kWh) +Indicates the energy consumption (kWh). + +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Electric meter (watts) +Indicates the instantaneous power consumption. + +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Switch +Switch the power on and off. + +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Electric meter (kWh) +Indicates the energy consumption (kWh). + +The ```meter_kwh1``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Electric meter (watts) +Indicates the instantaneous power consumption. + +The ```meter_watts1``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + + + +## Device Configuration + +The following table provides a summary of the 39 configuration parameters available in the FGWDSEU. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Remember device state | Remember device state | +| 2 | First channel – overload safety switch | First channel – overload safety switch | +| 3 | Second channel – overload safety switch | Second channel – overload safety switch | +| 10 | LED Frame - power limit | LED frame – power limit | +| 11 | LED frame – colour when ON | LED frame – colour when ON | +| 12 | LED frame – colour when OFF | LED frame – colour when OFF | +| 13 | LED frame – brightness | LED frame – brightness | +| 20 | Buttons operation | Buttons operation | +| 24 | Buttons orientation | Buttons orientation | +| 25 | Outputs orientation | Outputs orientation (Only in Double Switch Mode) | +| 30 | Alarm configuration - 1st slot | Alarm configuration - 1st slot | +| 31 | Alarm configuration - 2nd slot | Alarm configuration - 2nd slot | +| 32 | Alarm configuration - 3rd slot | Alarm configuration - 3rd slot | +| 33 | Alarm configuration - 4th slot | Alarm configuration - 4th slot | +| 34 | Alarm configuration - 5th slot | Alarm configuration - 5th slot | +| 35 | Alarm configuration – duration | Alarm configuration – duration | +| 40 | First button – scenes sent | First button – scenes sent | +| 41 | Second button – scenes sent | Second button – scenes sent | +| 60 | Power reports – include self-consumption | Power reports – include self-consumption | +| 61 | Power reports for first channel – on change | Power reports for first channel – on change | +| 62 | Power reports for first channel – periodic | Power reports for first channel – periodic | +| 63 | Power reports for second channel – on change | Power reports for second channel – on change | +| 64 | Power reports for second channel – periodic | Power reports for second channel – periodic | +| 65 | Energy reports for first channel – on change | Energy reports for first channel – on change | +| 66 | Energy reports for first channel – periodic | Energy reports for first channel – periodic | +| 67 | Energy reports for second channel – on change | Energy reports for second channel – on change | +| 68 | Energy reports for second channel – periodic | Energy reports for second channel – periodic | +| 150 | First channel – operating mode | First channel – operating mode | +| 151 | Second channel – operating mode | Second channel – operating mode | +| 152 | 1st ch - reaction to switch | First channel - reaction to switch for delayed OFF / pulse modes | +| 153 | 2nd ch - reaction to switch | Second channel - reaction to switch for delayed OFF / pulse modes | +| 154 | 1st ch - time parameter for delayed | First channel - time parameter for delayed OFF / pulse modes | +| 155 | 2nd ch - time parameter for delayed | Second channel - time parameter for delayed OFF / pulse modes | +| 156 | 1st ch – ON value sent to 2nd/3rd | First channel – Switch ON value sent to 2nd and 3rd association groups | +| 157 | 1st ch – OFF value sent to 2nd/3rd | First channel – Switch OFF value sent to 2nd and 3rd association groups | +| 158 | 1st ch – Double Click value sent to 2nd/3rd | First channel – Double Click value sent to 2nd and 3rd association groups | +| 159 | 2nd ch – ON value sent to 4th/5th | Second channel – Switch ON value sent to 4th and 5th association groups | +| 160 | 2nd ch – OFF value sent to 4th/5th | Second channel – Switch OFF value sent to 4th and 5th association groups | +| 161 | 2nd ch – Double Click value sent to 4th/5th | Second channel – Double Click value sent to 4th and 5th association groups | + +### Parameter 1: Remember device state + +Remember device state + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | remains switched off after restoring power | +| 1 | restores remembered state after restoring power | + +The manufacturer defined default value is ```1``` (restores remembered state after restoring power). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: First channel – overload safety switch + +First channel – overload safety switch +This function allows to turn off the controlled device in case of exceeding the defined power. Controlled device can be turned back on via button or sending a control frame.  + +**Single Switch Mode** + +0 – function disabled +10-45000 (1.0-4500.0W, step 0.1W) – power threshold + +**Double Switch Mode** + +0 – function disabled +10-36200 (1.0-3620.0W, step 0.1W) – power threshold +Values in the range 0 to 45000 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_2_4``` and is of type ```INTEGER```. + + +### Parameter 3: Second channel – overload safety switch + +Second channel – overload safety switch +**Only in Double Switch Mode** +This function allows to turn off the controlled device in case of exceeding the defined power. Controlled device can be turned back on via button or sending a control frame. + +Available values 0 – function disabled +10-36200 (1.0-3620.0W, step 0.1W) – power threshold +Values in the range 0 to 36200 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_3_4``` and is of type ```INTEGER```. + + +### Parameter 10: LED Frame - power limit + +LED frame – power limit +This parameter determines maximum active power. Exceeding it results in the LED frame flashing violet. Function is active only when parameter 11 is set to 8 or 9. + +Single Switch Mode +Default value 36800 (3680W) +Available values 500-36800 (50.0-3680.0W, step 0.1W) – power threshold + +Double Switch Mode +Default value 30000 (3000W) +Available values 500-30000 (50.0-3000.0W, step 0.1W) – power threshold +Values in the range 500 to 30000 may be set. + +The manufacturer defined default value is ```30000```. + +This parameter has the configuration ID ```config_10_4``` and is of type ```INTEGER```. + + +### Parameter 11: LED frame – colour when ON + +LED frame – colour when ON + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED disabled | +| 1 | White | +| 2 | Red | +| 3 | Green | +| 4 | Blue | +| 5 | Yellow | +| 6 | Cyan | +| 7 | Magenta | +| 8 | smoothly dep. on measured power | +| 9 | in steps dep on measured power | + +The manufacturer defined default value is ```0``` (LED disabled). + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + + +### Parameter 12: LED frame – colour when OFF + +LED frame – colour when OFF +This parameter defines the LED colour when the device is OFF. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED disabled | +| 1 | White | +| 2 | Red | +| 3 | Green | +| 4 | Blue | +| 5 | Yellow | +| 6 | Cyan | +| 7 | Magenta | + +The manufacturer defined default value is ```0``` (LED disabled). + +This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```. + + +### Parameter 13: LED frame – brightness + +LED frame – brightness +This parameter allows to adjust the LED frame brightness. + +Available values +0 – LED disabled +1-100 (1-100% brightness) +101 – brightness directly proportional to measured power +102 – brightness inversely proportional to measured power  +Values in the range 0 to 102 may be set. + +The manufacturer defined default value is ```100```. + +This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```. + + +### Parameter 20: Buttons operation + +Buttons operation +This parameter defines how device buttons should control the channels. + +**Single Switch Mode +** Default value 1 ** +** Available values +1 – 1st and 2nd button toggle the load +2 – 1st button turns the load ON, 2nd button turns the load OFF + +**Double Switch Mode +** Default Value 3 +Available values +1 – 1st and 2nd button toggle both channels +2 – 1st button turns both channels ON, 2nd button turns both channels OFF +3 – 1st button toggles 1st channel, 2nd button toggles 2nd channel +4 – 1st button single click turns 1st channel ON, 1st button double click turns 2nd channel ON, 2nd button single click turns both channels OFF +Values in the range 1 to 4 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_20_1``` and is of type ```INTEGER```. + + +### Parameter 24: Buttons orientation + +Buttons orientation +This parameter allows reversing the operation of the buttons. +Available values +0 – default (1st button controls 1st channel, 2nd button controls 2nd channel) +1 – reversed (1st button controls 2nd channel, 2nd button controls 1st channel) +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | default | +| 1 | reversed | + +The manufacturer defined default value is ```0``` (default). + +This parameter has the configuration ID ```config_24_1``` and is of type ```INTEGER```. + + +### Parameter 25: Outputs orientation + +Outputs orientation (Only in Double Switch Mode) +This parameter allows reversing the operation of Q1 and Q2 without changing the wiring (e.g. in case of invalid connection). Changing orientation turns both outputs off. +Available values +0 – default (Q1 - 1st channel, Q2 - 2nd channel) +1 – reversed (Q1 - 2nd channel, Q2 - 1st channel) +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | default | +| 1 | reversed | + +The manufacturer defined default value is ```0``` (default). + +This parameter has the configuration ID ```config_25_1``` and is of type ```INTEGER```. + + +### Parameter 30: Alarm configuration - 1st slot + +Alarm configuration - 1st slot +This parameter determines to which alarm frames and how the device should react. The parameters consist of 4 bytes, three most significant bytes are set according to the official Z-Wave protocol specification. +Available values +1B [MSB] – Notification Type +2B – Notification Status +3B – Event/State Parameters +4B [LSB] – action: + 0x00 – no action + 0xX1 – turn ON + 0xX2 – turn OFF + 0xX3 – turn ON/OFF continuously + 0x0X – no action on LED frame + 0x1X – LED frame blinks red + 0x2X – LED frame blinks green + 0x4X – LED frame blinks blue + 0x8X – disable LED frame + 0xFX – LED frame LAPD signal (red-white-blue) +Values in the range 0 to 0 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_30_4``` and is of type ```INTEGER```. + + +### Parameter 31: Alarm configuration - 2nd slot + +Alarm configuration - 2nd slot +This parameter determines to which alarm frames and how the device should react. The parameters consist of 4 bytes, three most significant bytes are set according to the official Z-Wave protocol specification. +Available values +1B [MSB] – Notification Type +2B – Notification Status +3B – Event/State Parameters +4B [LSB] – action: + 0x00 – no action + 0xX1 – turn ON + 0xX2 – turn OFF + 0xX3 – turn ON/OFF continuously + 0x0X – no action on LED frame + 0x1X – LED frame blinks red + 0x2X – LED frame blinks green + 0x4X – LED frame blinks blue + 0x8X – disable LED frame + 0xFX – LED frame LAPD signal (red-white-blue) +Values in the range 0 to 0 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_31_4``` and is of type ```INTEGER```. + + +### Parameter 32: Alarm configuration - 3rd slot + +Alarm configuration - 3rd slot +This parameter determines to which alarm frames and how the device should react. The parameters consist of 4 bytes, three most significant bytes are set according to the official Z-Wave protocol specification. +Available Values +1B [MSB] – Notification Type +2B – Notification Status +3B – Event/State Parameters +4B [LSB] – action: + 0x00 – no action + 0xX1 – turn ON + 0xX2 – turn OFF + 0xX3 – turn ON/OFF continuously + 0x0X – no action on LED frame + 0x1X – LED frame blinks red + 0x2X – LED frame blinks green + 0x4X – LED frame blinks blue + 0x8X – disable LED frame + 0xFX – LED frame LAPD signal (red-white-blue) +Values in the range 0 to 0 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_32_4``` and is of type ```INTEGER```. + + +### Parameter 33: Alarm configuration - 4th slot + +Alarm configuration - 4th slot +This parameter determines to which alarm frames and how the device should react. The parameters consist of 4 bytes, three most significant bytes are set according to the official Z-Wave protocol specification. +Available values +1B [MSB] – Notification Type +2B – Notification Status +3B – Event/State Parameters +4B [LSB] – action: + 0x00 – no action + 0xX1 – turn ON + 0xX2 – turn OFF + 0xX3 – turn ON/OFF continuously + 0x0X – no action on LED frame + 0x1X – LED frame blinks red + 0x2X – LED frame blinks green + 0x4X – LED frame blinks blue + 0x8X – disable LED frame + 0xFX – LED frame LAPD signal (red-white-blue) +Values in the range 0 to 0 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_33_4``` and is of type ```INTEGER```. + + +### Parameter 34: Alarm configuration - 5th slot + +Alarm configuration - 5th slot +This parameter determines to which alarm frames and how the device should react. The parameters consist of 4 bytes, three most significant bytes are set according to the official Z-Wave protocol specification. +Available values +1B [MSB] – Notification Type +2B – Notification Status +3B – Event/State Parameters +4B [LSB] – action: + 0x00 – no action + 0xX1 – turn ON + 0xX2 – turn OFF + 0xX3 – turn ON/OFF continuously + 0x0X – no action on LED frame + 0x1X – LED frame blinks red + 0x2X – LED frame blinks green + 0x4X – LED frame blinks blue + 0x8X – disable LED frame + 0xFX – LED frame LAPD signal (red-white-blue) +Values in the range 0 to 0 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_34_4``` and is of type ```INTEGER```. + + +### Parameter 35: Alarm configuration – duration + +Alarm configuration – duration +This parameter defines duration of alarm sequence. When time set in this parameter elapses, alarm is cancelled, LED frame and relay restore normal operation, but do not recover state from before the alarm. +Available values +0 – infinite +1-32400 (1s-9h, 1s step) – duration +Values in the range 0 to 32400 may be set. + +The manufacturer defined default value is ```600```. + +This parameter has the configuration ID ```config_35_2``` and is of type ```INTEGER```. + + +### Parameter 40: First button – scenes sent + +First button – scenes sent +This parameter determines which actions result in sending scene IDs assigned to them. Values can be combined (e.g. 1+2=3 means that scenes for single and double click are sent). Enabling scenes for triple click disables entering the device in learn mode by triple clicking. +Available values +1 – Key pressed 1 time +2 – Key pressed 2 times +4 – Key pressed 3 times +8 – Key hold down and key released +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Key pressed 1 time | +| 2 | Key pressed 2 times | +| 4 | Key pressed 3 times | +| 8 | Key hold down and key released | + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_40_1``` and is of type ```INTEGER```. + + +### Parameter 41: Second button – scenes sent + +Second button – scenes sent +This parameter determines which actions result in sending scene IDs assigned to them. Values can be combined (e.g. 1+2=3 means that scenes for single and double click are sent). Enabling scenes for triple click disables entering the device in learn mode by triple clicking.  +Available values +1 – Key pressed 1 time +2 – Key pressed 2 times +4 – Key pressed 3 times +8 – Key hold down and key released +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Key pressed 1 time | +| 2 | Key pressed 2 times | +| 4 | Key pressed 3 times | +| 8 | Key hold down and key released | + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_41_1``` and is of type ```INTEGER```. + + +### Parameter 60: Power reports – include self-consumption + +Power reports – include self-consumption +This parameter determines whether the power measurements for Endpoint 1 should include power consumed by the device itself. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Self-consumption not included | +| 1 | Self-consumption included | + +The manufacturer defined default value is ```0``` (Self-consumption not included). + +This parameter has the configuration ID ```config_60_1``` and is of type ```INTEGER```. + + +### Parameter 61: Power reports for first channel – on change + +Power reports for first channel – on change +This parameter defines minimal change (from the last reported) in measured power that results in sending new report. For loads under 50W the parameter is irrelevant, report are sent every 5W change. +Available values +0 – reporting on change disabled +1-500 (1-500%, 1% step) – minimal change +Values in the range 0 to 500 may be set. + +The manufacturer defined default value is ```15```. + +This parameter has the configuration ID ```config_61_2``` and is of type ```INTEGER```. + + +### Parameter 62: Power reports for first channel – periodic + +Power reports for first channel – periodic +This parameter defines reporting interval for measured power. Periodic reports are independent from changes in value (parameter 61). +Available values +0 – periodic reports disabled +30-32400 (30s-9h, 1s step) – time interval +Values in the range 0 to 32400 may be set. + +The manufacturer defined default value is ```2600```. + +This parameter has the configuration ID ```config_62_2``` and is of type ```INTEGER```. + + +### Parameter 63: Power reports for second channel – on change + +Power reports for second channel – on change +**Only in Double Switch Mode** + +This parameter defines minimal change (from the last reported) in measured power that results in sending new report. For loads under 50W the parameter is irrelevant, report are sent every 5W change. +Available values +0 – reporting on change disabled +1-500 (1-500%, 1% step) – minimal change +Values in the range 0 to 500 may be set. + +The manufacturer defined default value is ```15```. + +This parameter has the configuration ID ```config_63_2``` and is of type ```INTEGER```. + + +### Parameter 64: Power reports for second channel – periodic + +Power reports for second channel – periodic +**Only in Double Switch Mode** + +This parameter defines reporting interval for measured power. Periodic reports are independent from changes in value (parameter 63). +Available values +0 – periodic reports disabled +30-32400 (30s-9h, 1s step) – time interval +Values in the range 0 to 32400 may be set. + +The manufacturer defined default value is ```3600```. + +This parameter has the configuration ID ```config_64_2``` and is of type ```INTEGER```. + + +### Parameter 65: Energy reports for first channel – on change + +Energy reports for first channel – on change +This parameter defines minimal change (from the last reported) in measured energy that results in sending new report. +Available values +0 – reporting on change disabled +1-500 (0.01-5kWh, 0.01kWh step) – minimal change +Values in the range 0 to 500 may be set. + +The manufacturer defined default value is ```10```. + +This parameter has the configuration ID ```config_65_2``` and is of type ```INTEGER```. + + +### Parameter 66: Energy reports for first channel – periodic + +Energy reports for first channel – periodic +This parameter defines reporting interval for measured energy. Periodic reports are independent from changes in value (parameter 65). +Available values +0 – periodic reports disabled +30-32400 (30s-9h, 1s step) – time interval +Values in the range 0 to 32400 may be set. + +The manufacturer defined default value is ```3600```. + +This parameter has the configuration ID ```config_66_2``` and is of type ```INTEGER```. + + +### Parameter 67: Energy reports for second channel – on change + +Energy reports for second channel – on change +**Only in Double Switch Mode** + +Description This parameter defines minimal change (from the last reported) in measured energy that results in sending new report. +Available values +0 – reporting on change disabled +1-500 (0.01-5kWh, 0.01kWh step) – minimal change +Values in the range 0 to 500 may be set. + +The manufacturer defined default value is ```10```. + +This parameter has the configuration ID ```config_67_2``` and is of type ```INTEGER```. + + +### Parameter 68: Energy reports for second channel – periodic + +Energy reports for second channel – periodic +**Only in Double Switch Mode** + +Description This parameter defines reporting interval for measured energy. Periodic reports are independent from changes in value (parameter 67). +Available values +0 – periodic reports disabled +30-32400 (30s-9h, 1s step) – time interval +Values in the range 0 to 32400 may be set. + +The manufacturer defined default value is ```3600```. + +This parameter has the configuration ID ```config_68_2``` and is of type ```INTEGER```. + + +### Parameter 150: First channel – operating mode + +First channel – operating mode +This parameter allows to choose operating for the 1st channel . +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | standard operation | +| 1 | delayed OFF | +| 2 | single pulse | + +The manufacturer defined default value is ```0``` (standard operation). + +This parameter has the configuration ID ```config_150_1``` and is of type ```INTEGER```. + + +### Parameter 151: Second channel – operating mode + +Second channel – operating mode +**Only in Double Switch Mode** + +This parameter allows to choose operating for the 2nd channel. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | standard operation | +| 1 | delayed OFF | +| 2 | single pulse | + +The manufacturer defined default value is ```0``` (standard operation). + +This parameter has the configuration ID ```config_151_1``` and is of type ```INTEGER```. + + +### Parameter 152: 1st ch - reaction to switch + +First channel - reaction to switch for delayed OFF / pulse modes +This parameter determines how the device in timed mode reacts to pushing the button for 1st channel. The parameter is relevant only for button toggles modes (parameter 20 set to 1 or 3). +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | cancel mode and set default state | +| 1 | no reaction - mode runs until it ends | +| 2 | reset timer - start counting from the beginning | + +The manufacturer defined default value is ```0``` (cancel mode and set default state). + +This parameter has the configuration ID ```config_152_1``` and is of type ```INTEGER```. + + +### Parameter 153: 2nd ch - reaction to switch + +Second channel - reaction to switch for delayed OFF / pulse modes +**Only in Double Switch Mode** + +This parameter determines how the device in timed mode reacts to pushing the button for 2nd channel. The parameter is relevant only for button toggles modes (parameter 20 set to 1 or 3). +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | cancel mode and set default state | +| 1 | no reaction - mode runs until it ends | +| 2 | reset timer - start counting from the beginning | + +The manufacturer defined default value is ```0``` (cancel mode and set default state). + +This parameter has the configuration ID ```config_153_1``` and is of type ```INTEGER```. + + +### Parameter 154: 1st ch - time parameter for delayed + +First channel - time parameter for delayed OFF / pulse modes +This parameter allows to set time parameter used in timed modes for 1st channel (parameter 150). Delay time for switching off or duration of the pulse. +Available values +0 – 0.1 second +1-32000 (1-32000s, 1s step) – time parameter +Values in the range 0 to 32000 may be set. + +The manufacturer defined default value is ```50```. + +This parameter has the configuration ID ```config_154_2``` and is of type ```INTEGER```. + + +### Parameter 155: 2nd ch - time parameter for delayed + +Second channel - time parameter for delayed OFF / pulse modes +**Only in Double Switch Mode** + +This parameter allows to set time parameter used in timed modes for 2nd channel (parameter 151). Delay time for switching off or duration of the pulse. +Available values +0 – 0.1 second +1-32000 (1-32000s, 1s step) – time parameter +Values in the range 0 to 32000 may be set. + +The manufacturer defined default value is ```50```. + +This parameter has the configuration ID ```config_155_2``` and is of type ```INTEGER```. + + +### Parameter 156: 1st ch – ON value sent to 2nd/3rd + +First channel – Switch ON value sent to 2nd and 3rd association groups +This parameter defines value sent with Switch ON command to devices associated in 2nd and 3rd association group for manual changes of Endpoint 1 state. +Available values +0-99 or 255 +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```255```. + +This parameter has the configuration ID ```config_156_2``` and is of type ```INTEGER```. + + +### Parameter 157: 1st ch – OFF value sent to 2nd/3rd + +First channel – Switch OFF value sent to 2nd and 3rd association groups +This parameter defines value sent with Switch OFF command to devices associated in 2nd and 3rd association group for manual changes of Endpoint 1 state. +Available values +0-99 or 255 +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_157_2``` and is of type ```INTEGER```. + + +### Parameter 158: 1st ch – Double Click value sent to 2nd/3rd + +First channel – Double Click value sent to 2nd and 3rd association groups +This parameter defines value sent with Double Click command to devices associated in 2nd and 3rd association group for manual changes of Endpoint 1 state. +Available values +0-99 or 255 +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```99```. + +This parameter has the configuration ID ```config_158_2``` and is of type ```INTEGER```. + + +### Parameter 159: 2nd ch – ON value sent to 4th/5th + +Second channel – Switch ON value sent to 4th and 5th association groups +**Only in Double Switch Mode** + +This parameter defines value sent with Switch ON command to devices associated in 4th and 5th association group for manual changes of Endpoint 2 state. +Available values +0-99 or 255  +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```255```. + +This parameter has the configuration ID ```config_159_2``` and is of type ```INTEGER```. + + +### Parameter 160: 2nd ch – OFF value sent to 4th/5th + +Second channel – Switch OFF value sent to 4th and 5th association groups +**Only in Double Switch Mode** + +This parameter defines value sent with Switch OFF command to devices associated in 4th and 5th association group for manual changes of Endpoint 2 state. +Available values +0-99 or 255 +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_160_2``` and is of type ```INTEGER```. + + +### Parameter 161: 2nd ch – Double Click value sent to 4th/5th + +Second channel – Double Click value sent to 4th and 5th association groups +**Only in Double Switch Mode** + +This parameter defines value sent with Double Click command to devices associated in 4th and 5th association group for manual changes of Endpoint 2 state. +Available values +0-99 or 255 +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```99```. + +This parameter has the configuration ID ```config_161_2``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The FGWDSEU supports 5 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. +1st association group – “Lifeline” reports the device status and allows for assigning single device only (main controller by default). + +Association group 1 supports 1 node. + +### Group 2: ON/OFF (1) + +2nd association group – “On/Off (1)” is used to turn the associated devices on/off reflecting button operation for 1st channel (uses Basic command class). + +Association group 2 supports 5 nodes. + +### Group 3: Dimmer (1) + +3rd association group – “Dimmer (1)” is used to change level of associated devices reflecting button operation for 1st channel (uses Switch Multilevel command class). + +Association group 3 supports 5 nodes. + +### Group 4: ON/OFF (2) + +4th association group* – “On/Off (2)” is used to turn the associated devices on/off reflecting button operation for 2nd channel (uses Basic command class). + +Association group 4 supports 5 nodes. + +### Group 5: Dimmer (2) + +5th association group* – “Dimmer (2)” is used to change level of associated devices reflecting button operation for 2nd channel (uses Switch Multilevel command class). + +Association group 5 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_APPLICATION_STATUS_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_METER_V3| | +| COMMAND_CLASS_CRC_16_ENCAP_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_CENTRAL_SCENE_V3| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V2| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V2| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_PROTECTION_V2| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V4| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_SECURITY_V1| | +#### Endpoint 1 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_APPLICATION_STATUS_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_METER_V3| | +| COMMAND_CLASS_CRC_16_ENCAP_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_CENTRAL_SCENE_V3| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V2| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V2| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_PROTECTION_V2| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V4| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_SECURITY_V1| | + +### Documentation Links + +* [FGWDSEU-221 Manual](https://www.cd-jackson.com/zwave_device_uploads/1064/FGWDSEU-221-T-EN-0-16.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1064). diff --git a/_addons_bindings/zwave/doc/fibaro/fgwoe011_0_0.md b/_addons_bindings/zwave/doc/fibaro/fgwoe011_0_0.md index 71edc5bbf..a7385e9e7 100644 --- a/_addons_bindings/zwave/doc/fibaro/fgwoe011_0_0.md +++ b/_addons_bindings/zwave/doc/fibaro/fgwoe011_0_0.md @@ -627,7 +627,7 @@ Association group 2 supports 5 nodes. | COMMAND_CLASS_NO_OPERATION_V1| | | COMMAND_CLASS_BASIC_V1| | | COMMAND_CLASS_APPLICATION_STATUS_V1| | -| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_METER_V3| | | COMMAND_CLASS_CRC_16_ENCAP_V1| | | COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | diff --git a/_addons_bindings/zwave/doc/forest/shuttlesl_0_0.md b/_addons_bindings/zwave/doc/forest/shuttlesl_0_0.md index 907130033..7ea9682ea 100644 --- a/_addons_bindings/zwave/doc/forest/shuttlesl_0_0.md +++ b/_addons_bindings/zwave/doc/forest/shuttlesl_0_0.md @@ -35,13 +35,12 @@ You can also reset the device, but only use this if your main controller is not The following table summarises the channels available for the Shuttle S/L -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Blinds Control | blinds_control | blinds_control | Blinds | Rollershutter | ### Switch - Switch binary command can be used to turn the Shuttle LZ fully open or fully closed. Value: @@ -52,10 +51,9 @@ Value: Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. - -### Dimmer +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. +### Blinds Control Values 0-99 (%) are used to set the rail to the preferred position. Value 255 is used to set the curtain fully open. @@ -76,10 +74,9 @@ Primary switch type: 0x03 Secondary switch type: 0x00 (NOT SUPPORTED) -The brightness channel allows to control the brightness of a light. - It is also possible to switch the light on and off. +Provides start / stop control of blinds. -The ```switch_dimmer``` channel supports the ```Dimmer``` item and is in the ```DimmableLight``` category. +The ```blinds_control``` channel is of type ```blinds_control``` and supports the ```Rollershutter``` item and is in the ```Blinds``` category. diff --git a/_addons_bindings/zwave/doc/fortrezz/ssa1_0_0.md b/_addons_bindings/zwave/doc/fortrezz/ssa1_0_0.md index af75550a8..0ccad5081 100644 --- a/_addons_bindings/zwave/doc/fortrezz/ssa1_0_0.md +++ b/_addons_bindings/zwave/doc/fortrezz/ssa1_0_0.md @@ -43,10 +43,10 @@ After connecting power to the SSA1, you can test the alarm mode after manually e The following table summarises the channels available for the SSA1/SSA2 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Alarm (burglar) | alarm_burglar | Door | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | ### Dimmer If a Z-Wave MultiLevel Switch Set or Basic Set signal with a **value of 67 to 99 or 255** is received by the SSA1, the unit will sound a 117-decibel audible alarm and will flash the strobe lights. A **value of 1 to 33** will turn on only the strobe lights while a v**alue of 34 to 66** will turn on only the siren. The same messages with **value 0** will turn off both the siren and strobe lights. Or, the SSA1 can be turned off locally by quickly pressing the button three (3) times. The SSA1 only returns 0, 33, 66, or 99 in response to a Multilevel Switch Get or Basic Get command depending on the mode @@ -54,12 +54,12 @@ If a Z-Wave MultiLevel Switch Set or Basic Set signal with a **value of 67 to 99 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Alarm (burglar) Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: diff --git a/_addons_bindings/zwave/doc/ge/12718_0_0.md b/_addons_bindings/zwave/doc/ge/12718_0_0.md index f52b2c2bb..c58f614f5 100644 --- a/_addons_bindings/zwave/doc/ge/12718_0_0.md +++ b/_addons_bindings/zwave/doc/ge/12718_0_0.md @@ -8,28 +8,38 @@ title: 12718 - ZWave # 12718 Smart Dimmer This describes the Z-Wave device *12718*, manufactured by *Jasco Products* with the thing type UID of ```ge_12718_00_000```. -The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. +The device is in the category of *Light Bulb*, defining Devices that illuminate something, such as bulbs, etc.. + +![12718 product image](https://www.cd-jackson.com/zwave_device_uploads/339/339_default.png) + The 12718 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 between other devices in the mesh network. ## 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/339) to improve the documentation. + Transform any home into a smart home with the GE Z-Wave Smart Lighting Control Lamp Module with Dimmer Control. The lamp module enables wireless control of on/off and dim functions for standard incandescent table and floor lamps, as well as dimmable fluorescent, LED and CFL fixtures and more! Use the dimmer control to customize the lighting output and create the perfect ambiance for any room. The space-saving horizontal module plugs into a standard wall receptacle without blocking the second outlet or obstructing placement of furniture. It provides a Z-Wave enabled outlet for the lamp you would like to control and one always-on, standard pass-through AC outlet for other electrical appliances. Take control of your home lighting with GE Z-Wave Smart Lighting Controls!  + +### Inclusion Information + +Single press and release the manual/program button on the smart dimmer to include it in the network + +### Exclusion Information + +Single press and release the manual/program button on the smart dimmer to exclude it from the network ## Channels The following table summarises the channels available for the 12718 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. diff --git a/_addons_bindings/zwave/doc/ge/12725_0_0.md b/_addons_bindings/zwave/doc/ge/12725_0_0.md new file mode 100644 index 000000000..c76d9440f --- /dev/null +++ b/_addons_bindings/zwave/doc/ge/12725_0_0.md @@ -0,0 +1,237 @@ +--- +layout: documentation +title: GE 12725 - ZWave +--- + +{% include base.html %} + +# GE 12725 In-Wall Dimmer +This describes the Z-Wave device *GE 12725*, manufactured by *Jasco Products* with the thing type UID of ```ge_12725_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![GE 12725 product image](https://www.cd-jackson.com/zwave_device_uploads/486/486_default.jpg) + + +The GE 12725 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 between other devices in the mesh network. + +## Overview + +RF controlled, in-wall 1000w dimmer, interchangeable paddle + +### Inclusion Information + +Press and release the top or bottom of the dimmer smart switch (rocker) to add it in the network. + +### Exclusion Information + +Press and release the top or bottom of the dimmer smart switch (rocker) to remove it from the network. + +## Channels + +The following table summarises the channels available for the GE 12725 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | + +### 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 is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. + + + +## Device Configuration + +The following table provides a summary of the 9 configuration parameters available in the GE 12725. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 3 | Night Light | Night Light | +| 4 | Invert Switch | Invert Switch | +| 5 | Ignore Start-Level (Receiving) | This dimmer will start dimming from its current level. | +| 7 | On/Off Command Dim Step | On/Off Command Dim Step | +| 8 | On/Off Command Dim Rate | On/Off Command Dim Rate | +| 9 | Local Control Dim Step | Local Control Dim Step | +| 10 | Local Control Dim Rate | Local Control Dim Rate | +| 11 | ALL ON/ALL OFF Dim Step | ALL ON/ALL OFF Dim Step | +| 12 | ALL ON/ALL OFF Dim Rate | ALL ON/ALL OFF Dim Rate | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 3: Night Light + +Night Light +Defines the behavior of the blue LED. Default is Night Light mode where LED is on when switch is off. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED on when switch is OFF | +| 1 | LED on when switch is ON | +| 2 | LED always off | + +The manufacturer defined default value is ```0``` (LED on when switch is OFF). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Invert Switch + +Invert Switch +Invert the ON/OFF Switch State. + +Setting this parameter to Yes will change the top of the switch to OFF and the bottom to ON.  + +Note: If you invert the switches and also install the product upside down, the load will now be control +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | No | +| 1 | Yes | + +The manufacturer defined default value is ```0``` (No). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 5: Ignore Start-Level (Receiving) + +This dimmer will start dimming from its current level. + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | No | +| 1 | Yes | + +The manufacturer defined default value is ```0``` (No). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 7: On/Off Command Dim Step + +On/Off Command Dim Step +Indicates how many levels the dimmer will change for each dimming step. +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 8: On/Off Command Dim Rate + +On/Off Command Dim Rate +This value indicates in 10 millisecond resolution This sets how often the dim level will change. + +For example, if you set this parameter to 1, then every 10ms the dim level will change. + +If you set it to 255, then every 2.55 seconds the dim level will change. +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```. + + +### Parameter 9: Local Control Dim Step + +Local Control Dim Step +Indicates how many levels the dimmer will change for each dimming step. +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: Local Control Dim Rate + +Local Control Dim Rate +This value indicates in 10 millisecond resolution. This sets how often the dim level will change. + +For example, if you set this parameter to 1, then every 10ms the dim level will change. + +If you set it to 255, then every 2.55 seconds the dim level will change. +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```. + + +### Parameter 11: ALL ON/ALL OFF Dim Step + +ALL ON/ALL OFF Dim Step +Indicates how many levels the dimmer will change for each dimming step. +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + + +### Parameter 12: ALL ON/ALL OFF Dim Rate + +ALL ON/ALL OFF Dim Rate +This value indicates in 10 millisecond resolution. This sets how often the dim level will change. + +For example, if you set this parameter to 1, then every 10ms the dim level will change. + +If you set it to 255, then every 2.55 seconds the dim level will change.  +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The device does not support associations. +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| Linked to BASIC| +| COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_VERSION_V1| | + +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/486/GE-ZW3006-manual-Gen-5.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/486). diff --git a/_addons_bindings/zwave/doc/ge/12727_0_0.md b/_addons_bindings/zwave/doc/ge/12727_0_0.md index 2ee8cb4ab..481a37b37 100644 --- a/_addons_bindings/zwave/doc/ge/12727_0_0.md +++ b/_addons_bindings/zwave/doc/ge/12727_0_0.md @@ -8,33 +8,41 @@ title: 12727 - ZWave # 12727 GE 12727 Z-Wave Wireless Lighting Control Smart Toggle Switch This describes the Z-Wave device *12727*, manufactured by *Jasco Products* with the thing type UID of ```ge_12727_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![12727 product image](https://www.cd-jackson.com/zwave_device_uploads/259/259_default.png) + + The 12727 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 between other devices in the mesh network. ## Overview + * The switch enables you to wirelessly control lights turning them on and off, schedule a timed event, or create a custom scene from anywhere in the world, at any time of the day. + * Easily replace any standard in-wall switch with the GE Z-Wave Smart Switch to control permanently installed lighting or fans with your mobile device or computer using any Z-Wave certified gateway. Can be controlled in groups of multiple lights or turned on or off within ambient interior lighting scene + ### Inclusion Information -1. Follow the instructions for your Z-wave certified controller to include a device to the Z-wave network. + 1. Follow the instructions for your Z-wave certified controller to include a device to the Z-wave network. + 2. Once the controller is ready to include your device, press up and release the toggle switch to include it in the network. + Note: Your controller may need to be within 10 feet of the device to be included. + 3. Once your controller has confirmed that the device has been included, refresh the Z-wave network to optimize performance. -2. Once the controller is ready to include your device, press up and release the toggle switch to include it in the network. +### Exclusion Information -Note: Your controller may need to be within 10 feet of the device to be included. - -3. Once your controller has confirmed that the device has been included, refresh the Z-wave network to optimize performance. +Press up and release the toggle switch ## Channels The following table summarises the channels available for the 12727 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -46,7 +54,7 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| | 4 | Invert switch | Invert switch | -| 29 | Load Sensing | | +| 29 | Load Sensing | Load Sensing | | | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | ### Parameter 4: Invert switch @@ -67,7 +75,7 @@ This parameter has the configuration ID ```config_4_1``` and is of type ```INTEG ### Parameter 29: Load Sensing - +Load Sensing Load Sensing Load sensing is disabled when shipped from the factory. This feature can be enabled if desired. Setting parameter 29 to a value of 1 will enable the Load Sense function Values in the range 0 to 1 may be set. diff --git a/_addons_bindings/zwave/doc/ge/12729_0_0.md b/_addons_bindings/zwave/doc/ge/12729_0_0.md index b0987703c..521dcb770 100644 --- a/_addons_bindings/zwave/doc/ge/12729_0_0.md +++ b/_addons_bindings/zwave/doc/ge/12729_0_0.md @@ -17,30 +17,33 @@ The 12729 supports routing. This allows the device to communicate using other ro ## Overview + * The dimmer allows you to wirelessly schedule, control and adjust the brightness of any hard-wired, dimmable light in your home anywhere in the world, at any time of the day. + * Easily replace any standard in-wall switch with the GE Z-Wave controlled dimmer switch to turn lighting On/Off or adjust dim levels with your mobile device or computer using any Z-Wave certified gateway. Can be controlled in groups of multiple lights or turned on or off within ambient interior lighting scenes. + ### Inclusion Information -1. Follow the instructions for your Z-wave certified controller to include a device to the Z-wave network. + 1. Follow the instructions for your Z-wave certified controller to include a device to the Z-wave network. + 2. Once the controller is ready to include your device, press up and release the toggle switch to include it in the network. + Note: Your controller may need to be within 10 feet of the device to be included. + 3. Once your controller has confirmed that the device has been included, refresh the Z-wave network to optimize performance. -2. Once the controller is ready to include your device, press up and release the toggle switch to include it in the network. +### Exclusion Information -Note: Your controller may need to be within 10 feet of the device to be included. - -3. Once your controller has confirmed that the device has been included, refresh the Z-wave network to optimize performance. +Press up and release the toggle switch ## Channels The following table summarises the channels available for the 12729 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. diff --git a/_addons_bindings/zwave/doc/ge/12730zw4002_0_0.md b/_addons_bindings/zwave/doc/ge/12730zw4002_0_0.md index b8cf188da..283378cc3 100644 --- a/_addons_bindings/zwave/doc/ge/12730zw4002_0_0.md +++ b/_addons_bindings/zwave/doc/ge/12730zw4002_0_0.md @@ -50,22 +50,163 @@ Note: To exclude and reset the device, follow the instructions provided by your The following table summarises the channels available for the GE 12340 (ZW4002) -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 8 configuration parameters available in the GE 12340 (ZW4002). +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 3 | LED Light | Sets when the LED on the switch is lit. | +| 4 | Invert Switch | Invert Switch | +| 7 | Z-Wave Command Dim Step | Z-Wave Command Dim Step | +| 8 | Z-Wave Command Dim Rate | Z-Wave Command Dim Rate | +| 9 | Local Control Dim Step | Local Control Dim Step | +| 10 | Local Control Dim Rate | Local Control Dim Rate | +| 11 | ALL ON/ALL OFF Dim Step | ALL ON/ALL OFF Dim Step | +| 12 | ALL ON/ALL OFF Dim Rate | ALL ON/ALL OFF Dim Rate | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 3: LED Light + +Sets when the LED on the switch is lit. + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED on when light off | +| 1 | LED on when light on | +| 2 | LED always off | + +The manufacturer defined default value is ```0``` (LED on when light off). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Invert Switch + +Invert Switch +Change the top of the switch to OFF and the bottom of the switch to ON, if the switch was installed upside down. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | No | +| 1 | Yes | + +The manufacturer defined default value is ```0``` (No). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 7: Z-Wave Command Dim Step + +Z-Wave Command Dim Step +Indicates how many levels the dimmer will change for each dimming step. + +Both the number of steps (or levels) that the dimmer will change and the timing of the steps can be modified to suit personal preferences. The timing of the steps can be adjusted in 10 millisecond intervals. As an example, the default setting for parameter 8 is 3. This means that the lighting level will change every 30 milliseconds when the Dim Command is received. A value of 255 would mean that the level would change every 2.55 seconds. Combined, the two parameters allow dim rate adjustments from 10 milliseconds to 4.2 minutes to go from maximum-to-minimum or minimum-to-maximum brightness levels. +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 8: Z-Wave Command Dim Rate + +Z-Wave Command Dim Rate +This value indicates in 10 millisecond resolution, how often the dim level will change. For example, if you set this parameter to 1, then every 10ms the dim level will change. If you set it to 255, then every 2.55 seconds the dim level will change + +Both the number of steps (or levels) that the dimmer will change and the timing of the steps can be modified to suit personal preferences. The timing of the steps can be adjusted in 10 millisecond intervals. As an example, the default setting for parameter 8 is 3. This means that the lighting level will change every 30 milliseconds when the Dim Command is received. A value of 255 would mean that the level would change every 2.55 seconds. Combined, the two parameters allow dim rate adjustments from 10 milliseconds to 4.2 minutes to go from maximum-to-minimum or minimum-to-maximum brightness levels. +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```. + + +### Parameter 9: Local Control Dim Step + +Local Control Dim Step +Indicates how many levels the dimmer will change for each dimming step + +Both the number of steps (or levels) that the dimmer will change and the timing of the steps can be modified to suit personal preferences. The timing of the steps can be adjusted in 10 millisecond intervals. As an example, the default setting for parameter 8 is 3. This means that the lighting level will change every 30 milliseconds when the Dim Command is received. A value of 255 would mean that the level would change every 2.55 seconds. Combined, the two parameters allow dim rate adjustments from 10 milliseconds to 4.2 minutes to go from maximum-to-minimum or minimum-to-maximum brightness levels. + +. +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: Local Control Dim Rate + +Local Control Dim Rate +This value indicates in 10 millisecond resolution, how often the dim level will change. For example, if you set this parameter to 1, then every 10ms the dim level will change. If you set it to 255, then every 2.55 seconds the dim level will change. + +Both the number of steps (or levels) that the dimmer will change and the timing of the steps can be modified to suit personal preferences. The timing of the steps can be adjusted in 10 millisecond intervals. As an example, the default setting for parameter 8 is 3. This means that the lighting level will change every 30 milliseconds when the Dim Command is received. A value of 255 would mean that the level would change every 2.55 seconds. Combined, the two parameters allow dim rate adjustments from 10 milliseconds to 4.2 minutes to go from maximum-to-minimum or minimum-to-maximum brightness levels. + +. +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```. + + +### Parameter 11: ALL ON/ALL OFF Dim Step + +ALL ON/ALL OFF Dim Step +Indicates how many levels the dimmer will change for each dimming step. + +Both the number of steps (or levels) that the dimmer will change and the timing of the steps can be modified to suit personal preferences. The timing of the steps can be adjusted in 10 millisecond intervals. As an example, the default setting for parameter 8 is 3. This means that the lighting level will change every 30 milliseconds when the Dim Command is received. A value of 255 would mean that the level would change every 2.55 seconds. Combined, the two parameters allow dim rate adjustments from 10 milliseconds to 4.2 minutes to go from maximum-to-minimum or minimum-to-maximum brightness levels. +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + + +### Parameter 12: ALL ON/ALL OFF Dim Rate + +ALL ON/ALL OFF Dim Rate +This value indicates in 10 millisecond resolution, how often the dim level will change. For example, if you set this parameter to 1, then every 10ms the dim level will change. If you set it to 255, then every 2.55 seconds the dim level will change. + +Both the number of steps (or levels) that the dimmer will change and the timing of the steps can be modified to suit personal preferences. The timing of the steps can be adjusted in 10 millisecond intervals. As an example, the default setting for parameter 8 is 3. This means that the lighting level will change every 30 milliseconds when the Dim Command is received. A value of 255 would mean that the level would change every 2.55 seconds. Combined, the two parameters allow dim rate adjustments from 10 milliseconds to 4.2 minutes to go from maximum-to-minimum or minimum-to-maximum brightness levels. +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups diff --git a/_addons_bindings/zwave/doc/ge/14280_0_0.md b/_addons_bindings/zwave/doc/ge/14280_0_0.md index 254e2e230..8be9ed0cb 100644 --- a/_addons_bindings/zwave/doc/ge/14280_0_0.md +++ b/_addons_bindings/zwave/doc/ge/14280_0_0.md @@ -46,28 +46,131 @@ Press and release the manual/program button. The following table summarises the channels available for the ZW3107 / GE 14280 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 6 configuration parameters available in the ZW3107 / GE 14280. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 3 | LED Light | LED Light | +| 7 | Dim Rate | number of steps or levels | +| 8 | Dim Rate Adjustments (From Z-Wave Controller) | Timing of the steps | +| 9 | Dim rate Adjustments (When Manually Controlled) | number of steps or levels | +| 10 | Dim Rate Adjustments | (When Manually Controlled) | +| 11 | Dim Rate Adjustments | (When Receiving All-On/All-Off Command) | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 3: LED Light + +LED Light + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED Light on when Z-Wave turned OFF | +| 1 | LED Light on when Z-Wave Turned On | +| 2 | LED Light always OFF | + +The manufacturer defined default value is ```0``` (LED Light on when Z-Wave turned OFF). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 7: Dim Rate + +number of steps or levels + +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 8: Dim Rate Adjustments (From Z-Wave Controller) + +Timing of the steps + +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```. + + +### Parameter 9: Dim rate Adjustments (When Manually Controlled) + +number of steps or levels + +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: Dim Rate Adjustments + +(When Manually Controlled) +Timing of the steps +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```. + + +### Parameter 11: Dim Rate Adjustments + +(When Receiving All-On/All-Off Command) +number of steps of levels +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The ZW3107 / GE 14280 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 1 node. + ## Technical Information ### Endpoints @@ -78,7 +181,7 @@ The device does not support associations. |---------------|---------| | COMMAND_CLASS_NO_OPERATION_V1| | | COMMAND_CLASS_BASIC_V1| | -| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| | +| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| Linked to BASIC| | COMMAND_CLASS_SWITCH_ALL_V1| | | COMMAND_CLASS_CRC_16_ENCAP_V1| | | COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | diff --git a/_addons_bindings/zwave/doc/ge/14282_0_0.md b/_addons_bindings/zwave/doc/ge/14282_0_0.md new file mode 100644 index 000000000..89cf8fe8d --- /dev/null +++ b/_addons_bindings/zwave/doc/ge/14282_0_0.md @@ -0,0 +1,139 @@ +--- +layout: documentation +title: GE Plug in Smart Switch - ZWave +--- + +{% include base.html %} + +# GE Plug in Smart Switch GE Plug in Smart Switch Zwave Plus +This describes the Z-Wave device *GE Plug in Smart Switch*, manufactured by *Jasco Products* with the thing type UID of ```ge_14282_00_000```. + +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![GE Plug in Smart Switch product image](https://www.cd-jackson.com/zwave_device_uploads/517/517_default.jpg) + + +The GE Plug in Smart Switch 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 between other devices in the mesh network. + +## Overview + +Transform any home into a smart home with the GE Z-Wave Smart Lighting Control and Appliance Module. The lighting control enables wireless control of on/off functions for standard table and floor lamps, and is compatible with incandescent, LED, Xenon, Halogen, fluorescent and compact fluorescent bulbs. Easily controlled by your mobile device or computer using any Z-Wave certified gateway, the space-saving horizontal module plugs into a standard wall receptacle without blocking the second outlet or obstructing placement of furniture. It provides dual simultaneous Z-Wave enabled outlets for the lamp or appliance that you would like to control and a regular pass-through AC outlet for other electrical appliances. Perfect for plug-in fans, heaters, lamps and more! Take control of your home lighting with GE Z-Wave Smart Lighting Controls! + +### Inclusion Information + +Once the controller is ready to include your smart switch, single press and release the manual/program button on the smart switch to include it in the network. + +### Exclusion Information + +Once the controller is ready to Exclude your device, press and release the manual/program button on the smart switch to exclude it from the network. + +## Channels + +The following table summarises the channels available for the GE Plug in Smart Switch -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + + + +## Device Configuration + +The following table provides a summary of the 1 configuration parameters available in the GE Plug in Smart Switch. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 3 | LED light | control LED light behavior. Default is on when connected device is off | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 3: LED light + +control LED light behavior. Default is on when connected device is off + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | reset to factory default | +| 1 | LED is on when connected device is on | +| 2 | LED is off at all times | + +The manufacturer defined default value is ```0``` (reset to factory default). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The GE Plug in Smart Switch supports 3 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: Basic Set and is controlled with the local load + + +Association group 2 supports 5 nodes. + +### Group 3: Controlled by double pressing the On or Off button + +Basic Set and is controlled by double pressing the On or Off button + +Association group 3 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_CRC_16_ENCAP_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | + +### Documentation Links + +* [User Manual](https://www.cd-jackson.com/zwave_device_uploads/517/ge-zwaveplus-plug-in-smart-switch-manual.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/517). diff --git a/_addons_bindings/zwave/doc/ge/14285_0_0.md b/_addons_bindings/zwave/doc/ge/14285_0_0.md index edbd90373..93ea3a3d1 100644 --- a/_addons_bindings/zwave/doc/ge/14285_0_0.md +++ b/_addons_bindings/zwave/doc/ge/14285_0_0.md @@ -116,13 +116,101 @@ This channel provides the scene, and the event as a decimal value in the form `` ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 4 configuration parameters available in the GE/Jasco 14285. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Product State after Power Reset | Product State after Power Reset | +| 2 | Energy Report Mode | Energy Report Mode | +| 3 | Energy Report Frequency | Energy Report Frequency | +| 19 | Alternate Exclusion | Alternate Exclusion | + +### Parameter 1: Product State after Power Reset + +Product State after Power Reset + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Return to last state | +| 1 | Return to off | +| 2 | Return to on | + +The manufacturer defined default value is ```0``` (Return to last state). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Energy Report Mode + +Energy Report Mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Once monthly | +| 1 | Reports based on Parameter 3 setting | +| 2 | Once daily | + +The manufacturer defined default value is ```0``` (Once monthly). + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Energy Report Frequency + +Energy Report Frequency + +Values in the range 5 to 60 may be set. + +The manufacturer defined default value is ```5```. + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 19: Alternate Exclusion + +Alternate Exclusion +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Default | +| 1 | Alternate Exclusion (3 button presses) | + +The manufacturer defined default value is ```0``` (Default). + +This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The GE/Jasco 14285 supports 3 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: Basic Set, controlled by local load + + +Association group 2 supports 5 nodes. + +### Group 3: Basic Set, + +controlled by pressing the On or Off button +Basic Set, controlled by pressing the On or Off button + +Association group 3 supports 5 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/ge/14288_0_0.md b/_addons_bindings/zwave/doc/ge/14288_0_0.md index 85d6d1466..372b59582 100644 --- a/_addons_bindings/zwave/doc/ge/14288_0_0.md +++ b/_addons_bindings/zwave/doc/ge/14288_0_0.md @@ -8,32 +8,43 @@ title: 14288 - ZWave # 14288 In-Wall Outlet This describes the Z-Wave device *14288*, manufactured by *Jasco Products* with the thing type UID of ```ge_14288_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![14288 product image](https://www.cd-jackson.com/zwave_device_uploads/714/714_default.png) + + The 14288 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 between other devices in the mesh network. ## 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/714) to improve the documentation. +Transform any home into a smart home with the GE Z-Wave Plus In-Wall Tamper-Resistant Smart Outlet. The GE Z-Wave Plus In-Wall Tamper-Resistant Smart Outlet enables wireless control of on/off functions from the Z-Wave controlled outlet, and is compatible with incandescent, LED, Halogen, fluorescent and compact fluorescent bulbs. The Smart Outlet replaces your current electrical outlet, uses your existing wiring, and provides a Z-Wave enabled outlet for the lamp or appliance that you would like to control and a standard pass-through AC outlet for other electrical appliances. The receptacle requires in-wall installation with hardwired connections. Take control of your smart home lighting with the GE Z-Wave Plus Wireless Smart Outlet Control. + +### Inclusion Information + +Once the controller is ready to add your device, press and release the Program Button to add it in the network. + +### Exclusion Information + +Once the controller is ready to remove your device, press and release the manual/program button to remove it from the network. ## Channels The following table summarises the channels available for the 14288 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. @@ -44,10 +55,10 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 3 | | LED Light configuration | +| 3 | LED Light configuration | LED Light configuration | | | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | -### Parameter 3: +### Parameter 3: LED Light configuration LED Light configuration 0 - LED On when load is Off, Led Off when load is On @@ -59,11 +70,11 @@ The following option values may be configured -: | Value | Description | |--------|-------------| -| 0 | LED On when load is Off, Led Off when load is On | -| 1 | LED On when load is On, LED Off when laod is Off (Default) | +| 0 | LED On when load is Off | +| 1 | LED On when load is On | | 2 | LED always off | -The manufacturer defined default value is ```1``` (LED On when load is On, LED Off when laod is Off (Default)). +The manufacturer defined default value is ```1``` (LED On when load is On). This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. @@ -131,6 +142,10 @@ Association group 3 supports 5 nodes. | COMMAND_CLASS_ASSOCIATION_V2| | | COMMAND_CLASS_VERSION_V2| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/714/14288.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/ge/14289_0_0.md b/_addons_bindings/zwave/doc/ge/14289_0_0.md index e9744491c..92ab92c95 100644 --- a/_addons_bindings/zwave/doc/ge/14289_0_0.md +++ b/_addons_bindings/zwave/doc/ge/14289_0_0.md @@ -33,35 +33,171 @@ Put smart lighting control at your fingertips with the GE Z-Wave Plus Touch Sens The following table summarises the channels available for the GE 14289 (ZW3009) -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 8 configuration parameters available in the GE 14289 (ZW3009). +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 3 | Adjust Button LED Light | Adjust Button LED Light | +| 4 | Invert Switch | Invert Switch | +| 7 | Dim Rate Steps (From Z-Wave Controller) | Dim Rate Steps (From Z-Wave Controller) | +| 8 | Dim Rate Timing (From Z-Wave Controller) | Dim Rate Timing (From Z-Wave Controller) | +| 9 | Dim Rate Steps (When Manually Controlled) | Dim Rate Steps (When Manually Controlled) | +| 10 | Dim Rate Timing (When Manually Controlled) | Dim Rate Timing (When Manually Controlled) | +| 11 | Dim Rate Steps (When Receiving All-On/Off Command) | Dim Rate Steps (When Receiving All-On/Off Command) | +| 12 | Dim Rate Timing (All-On/Off Command) | Dim Rate Timing (All-On/Off Command) | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 3: Adjust Button LED Light + +Adjust Button LED Light + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED ON / Device OFF | +| 1 | LED ON / Device ON | +| 2 | Disable LED | + +The manufacturer defined default value is ```0``` (LED ON / Device OFF). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Invert Switch + +Invert Switch + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Default | +| 1 | Invert Switch | + +The manufacturer defined default value is ```0``` (Default). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 7: Dim Rate Steps (From Z-Wave Controller) + +Dim Rate Steps (From Z-Wave Controller) + +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 8: Dim Rate Timing (From Z-Wave Controller) + +Dim Rate Timing (From Z-Wave Controller) + +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_8_2``` and is of type ```INTEGER```. + + +### Parameter 9: Dim Rate Steps (When Manually Controlled) + +Dim Rate Steps (When Manually Controlled) + +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: Dim Rate Timing (When Manually Controlled) + +Dim Rate Timing (When Manually Controlled) + +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_10_2``` and is of type ```INTEGER```. + + +### Parameter 11: Dim Rate Steps (When Receiving All-On/Off Command) + +Dim Rate Steps (When Receiving All-On/Off Command) + +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + + +### Parameter 12: Dim Rate Timing (All-On/Off Command) + +Dim Rate Timing (All-On/Off Command) +Dim Rate Timing (When Receiving All-On/Off Command) +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_12_2``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The GE 14289 (ZW3009) supports 2 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: Basic Set and is controlled with the local load. + + +Association group 2 supports 5 nodes. + ## Technical Information ### Endpoints @@ -90,6 +226,7 @@ The device does not support associations. ### Documentation Links * [User guide](https://www.cd-jackson.com/zwave_device_uploads/946/14289-QSG-v1.pdf) +* [Product Page](https://www.cd-jackson.com/zwave_device_uploads/946/14289-Product-Page.pdf) --- diff --git a/_addons_bindings/zwave/doc/ge/14292_0_0.md b/_addons_bindings/zwave/doc/ge/14292_0_0.md new file mode 100644 index 000000000..a63ad8fa1 --- /dev/null +++ b/_addons_bindings/zwave/doc/ge/14292_0_0.md @@ -0,0 +1,137 @@ +--- +layout: documentation +title: GE 14292 - ZWave +--- + +{% include base.html %} + +# GE 14292 In-Wall Toggle Switch +This describes the Z-Wave device *GE 14292*, manufactured by *Jasco Products* with the thing type UID of ```ge_14292_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![GE 14292 product image](https://www.cd-jackson.com/zwave_device_uploads/606/606_default.jpg) + + +The GE 14292 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 between other devices in the mesh network. + +## Overview + +Transform any home into a smart home with the GE Z-Wave Smart Toggle Switch. The In-Wall Smart Toggle Switch can easily replaces any standard in-wall switch and remotely controls a light in your home. Your home will be equipped with ultimate flexibility with the GE Z-Wave Smart Toggle Switch, capable of being used by itself or with up to four add-on switches. Screw terminal installation provides improved space efficiency when replacing existing switches and the integrated LED indicator light allows you to easily locate the switch in a dark room.  + +### Inclusion Information + + 1. Once the controller is ready to include your device, press up and release on the toggle to include it in the network.  + 2. Once your controller has confirmed that the device has been included, refresh the Z-Wave network to optimize performance.  + +### Exclusion Information + +Once the controller is ready to exclude your device, press up and release on the toggle to exclude it from the network.  + +## Channels + +The following table summarises the channels available for the GE 14292 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Scene Number +Triggers when a scene button is pressed. + +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. + + + +## Device Configuration + +The following table provides a summary of the 1 configuration parameters available in the GE 14292. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 4 | Invert Switch | Invert Switch | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 4: Invert Switch + +Invert Switch +If the switch is accidentally installed upside down with “On” at the bottom and “Off” at the top, the default On/Off rocker settings can be reversed by changing parameter 4’s value to “1”. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Normal Switch Install | +| 1 | Inverted Switch Install | + +The manufacturer defined default value is ```0``` (Normal Switch Install). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The GE 14292 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. +Lifeline + +Association group 1 supports 1 node. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_SCENE_ACTIVATION_V1| | +| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | +| COMMAND_CLASS_CRC_16_ENCAP_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | + +### Documentation Links + +* [GE Jasco 14292 Quick Start Guide](https://www.cd-jackson.com/zwave_device_uploads/606/14292-QSG-v1.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/606). diff --git a/_addons_bindings/zwave/doc/ge/14295_0_0.md b/_addons_bindings/zwave/doc/ge/14295_0_0.md new file mode 100644 index 000000000..6ee4bf42f --- /dev/null +++ b/_addons_bindings/zwave/doc/ge/14295_0_0.md @@ -0,0 +1,225 @@ +--- +layout: documentation +title: GE 14295 - ZWave +--- + +{% include base.html %} + +# GE 14295 In-Wall Dimmer Switch +This describes the Z-Wave device *GE 14295*, manufactured by *Jasco Products* with the thing type UID of ```ge_14295_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![GE 14295 product image](https://www.cd-jackson.com/zwave_device_uploads/680/680_default.png) + + +The GE 14295 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 between other devices in the mesh network. + +## Overview + +Transform any home into a smart home with the GE Z-Wave In-Wall Smart Toggle Dimmer. The dimmer enables wireless control of on/off and dim functions of hard-wired dimmable LED/CFL and incandescent lighting. The dimmer replaces your current light switch, uses your existing wiring, and provides Z-Wave wireless and in-wall control of overhead lighting. Use the dimmer feature to customize the lighting output and create the perfect ambiance for any room. Providing ultimate flexibility, the In-Wall Smart Dimmer allows you to operate the switch by itself or easily integrate the switch three-way or four-way wiring configurations by adding the GE Add-On Switch. Single Pole wiring configuration controls the light from one location. Three-way wiring configuration controls the light from two separate locations. Four-way wiring configuration controls the light from three separate locations. The GE Add-On Switch is required for three-way or four-way installations. Take control of your home lighting with GE Z-Wave Wireless Lighting Controls! + +### Inclusion Information + +1. Follow the instructions for your Z-Wave certified controller to include a device to the Z-Wave network. + +2. Once the controller is ready to include your device, press and release the top or bottom of the wireless smart dimmer(rocker) to include it in the network.  + +### Exclusion Information + +1. Follow the instructions for your Z-Wave certified controller to exclude a device from the Z-Wave network. + +2. Once the controller is ready to Exclude your device, press and release the top or bottom of the wireless smart dimmer (rocker) to exclude it from the network.  + +## Channels + +The following table summarises the channels available for the GE 14295 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | + +### 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 is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. + +### Scene Number +Triggers when a scene button is pressed. + +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. + + + +## Device Configuration + +The following table provides a summary of the 7 configuration parameters available in the GE 14295. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 4 | Invert Switch | Invert the ON/OFF Switch State. | +| 7 | Dim Rate Adjustments | Number of steps or levels | +| 8 | Dim Rate Adjustments | Timing of steps or levels | +| 9 | Dim Rate Adjustments | Number of steps or levels | +| 10 | Dim Rate Adjustments | Timing of steps | +| 11 | Dim Rate Adjustments | Number of steps or levels | +| 12 | Dim Rate Adjustments | Timing of steps or levels | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 4: Invert Switch + +Invert the ON/OFF Switch State. + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | (Default) No | +| 1 | Yes | + +The manufacturer defined default value is ```0``` ((Default) No). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 7: Dim Rate Adjustments + +Number of steps or levels + +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 8: Dim Rate Adjustments + +Timing of steps or levels + +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_8_2``` and is of type ```INTEGER```. + + +### Parameter 9: Dim Rate Adjustments + +Number of steps or levels + +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: Dim Rate Adjustments + +Timing of steps + +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_10_2``` and is of type ```INTEGER```. + + +### Parameter 11: Dim Rate Adjustments + +Number of steps or levels + +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + + +### Parameter 12: Dim Rate Adjustments + +Timing of steps or levels + +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_12_2``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The GE 14295 supports 3 association groups. + +### Group 1: Association Group 1 + +Z-Wave Plus Lifeline, Multilevel Switch Report + +Association group 1 supports 5 nodes. + +### Group 2: Association Group 2 + +Supports Basic Set and is controlled with the local load + +Association group 2 supports 5 nodes. + +### Group 3: Association Group 3 + +Supports Basic Set and is controlled by double pressing the On or Off button + +Association group 3 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_MULTILEVEL_V2| Linked to BASIC| +| COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_SCENE_ACTIVATION_V1| | +| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | +| COMMAND_CLASS_CRC_16_ENCAP_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | + +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/680/14295-QSG-v1.pdf) +* [GE14295_Parameter](https://www.cd-jackson.com/zwave_device_uploads/680/GE14295-Parameter.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/680). diff --git a/_addons_bindings/zwave/doc/ge/14299_0_0.md b/_addons_bindings/zwave/doc/ge/14299_0_0.md new file mode 100644 index 000000000..889694438 --- /dev/null +++ b/_addons_bindings/zwave/doc/ge/14299_0_0.md @@ -0,0 +1,285 @@ +--- +layout: documentation +title: GE/Jasco 14299 - ZWave +--- + +{% include base.html %} + +# GE/Jasco 14299 GE/Jasco In-Wall 1000W Incandescent Smart Dimmer +This describes the Z-Wave device *GE/Jasco 14299*, manufactured by *Jasco Products* with the thing type UID of ```ge_14299_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![GE/Jasco 14299 product image](https://www.cd-jackson.com/zwave_device_uploads/862/862_default.jpg) + + +The GE/Jasco 14299 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. Refer to the *Wakeup Information* section below for further information. + +## Overview + +**Basic operation** + +The connected light can be turned ON/OFF and adjust dim levels in two ways: + + 1. Manually from the front panel of the In-Wall Dimmer. + 2. Remotely with a Z-Wave Controller . + +**Manual control** + +The Front Panel Rocker Dimmer allows the user to turn ON/OFF the connected fixture. + + 1. To turn the connected fixture ON: press and release the top of the rocker. + 2. To turn the connected fixture OFF: press and release the bottom of the rocker. + +**Adjust dim level** + + 1. To increase brightness: press and hold the top of the rocker. + 2. To decrease brightness: press and hold the bottom of the rocker. + +**Disable / Enable LED** + + 1. Press UP three (3) times then quickly press and release DOWN one (1) time. + 2. Repeat to disable/enable LED. + +**This device supports Association Command Class (3 Groups)** + + 1. Association Group 1 supports Lifeline, Switch Multilevel Report + 2. Association Group 2 supports Basic Set and is controlled by pressing the On or Off button with the local load + 3. Association Group 3 supports Basic Set and is controlled by double pressing the On or Off button + 4. Each Association Group supports 5 total nodes + +### Inclusion Information + +**Adding your device to a Z-Wave network** + + 1. Follow the instructions for your Z-Wave certified controller to add a device to the Z-Wave network. + 2. Once the controller is ready to add your device, press and release the top or bottom of the wireless smart switch (rocker) to add it in the network. + +Please reference the controller's manual for instructions. + +### Exclusion Information + +**To remove and reset the device** + + 1. Follow the instructions for your Z-Wave certified controller to remove a device from the Z-Wave network. + 2. Once the controller is ready to remove your device, press and release the top or bottom of the wireless smart dimmer (rocker) to remove it from the network. + +**To return your switch to factory defaults:** + +Quickly press ON (Top) button three (3) times then immediately press the OFF (Bottom) button three (3) times. The LED will flash ON/OFF 5 times when completed successfully. Note: This should only be used in the event your network’s primary controller is missing or otherwise inoperable. + +### Wakeup Information + +The GE/Jasco 14299 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. + +## Channels + +The following table summarises the channels available for the GE/Jasco 14299 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | + +### 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 is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. + +### Scene Number +Triggers when a scene button is pressed. + +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. + + + +## Device Configuration + +The following table provides a summary of the 8 configuration parameters available in the GE/Jasco 14299. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 3 | LED Light | LED Light | +| 4 | Invert Switch | Invert Switch | +| 7 | Dim Rate Adjustments | number of steps or levels | +| 8 | Dim Rate Adjustments | timing of steps | +| 9 | Dim Rate Adjustments | number of steps or levels | +| 10 | Dim Rate Adjustments | timing of steps | +| 11 | Dim Rate Adjustments | number of steps or levels | +| 12 | Dim Rate Adjustments | timing of steps | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 3: LED Light + +LED Light + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED ON when load is OFF | +| 1 | LED ON when load is ON | +| 2 | LED always OFF | + +The manufacturer defined default value is ```0``` (LED ON when load is OFF). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Invert Switch + +Invert Switch + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Default | +| 1 | Invert Switch | + +The manufacturer defined default value is ```0``` (Default). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 7: Dim Rate Adjustments + +number of steps or levels + +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 8: Dim Rate Adjustments + +timing of steps + +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_8_2``` and is of type ```INTEGER```. + + +### Parameter 9: Dim Rate Adjustments + +number of steps or levels + +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: Dim Rate Adjustments + +timing of steps + +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_10_2``` and is of type ```INTEGER```. + + +### Parameter 11: Dim Rate Adjustments + +number of steps or levels + +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + + +### Parameter 12: Dim Rate Adjustments + +timing of steps + +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_12_2``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The GE/Jasco 14299 supports 3 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: controlled with the local load + +controlled with the local load +Support Basic Set and is controlled with the local load + +Association group 2 supports 5 nodes. + +### Group 3: controlled by double pressing the On or Off button + +controlled by double pressing the On or Off button +Supports Basic Set and is controlled by double pressing the On or Off button + +Association group 3 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_SWITCH_MULTILEVEL_V2| | +| COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_SCENE_ACTIVATION_V1| | +| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | +| COMMAND_CLASS_CRC_16_ENCAP_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | + +### Documentation Links + +* [GE Jasco In-Wall 1000W Incandescant Smart Dimmer Manual](https://www.cd-jackson.com/zwave_device_uploads/862/14299-QSG-v2.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/862). diff --git a/_addons_bindings/zwave/doc/ge/14318_0_0.md b/_addons_bindings/zwave/doc/ge/14318_0_0.md index 7da6b10e7..66e08fe81 100644 --- a/_addons_bindings/zwave/doc/ge/14318_0_0.md +++ b/_addons_bindings/zwave/doc/ge/14318_0_0.md @@ -8,10 +8,25 @@ title: Jasco 14318 - ZWave # Jasco 14318 Jasco 3-way Light Switch This describes the Z-Wave device *Jasco 14318*, manufactured by *Jasco Products* with the thing type UID of ```ge_14318_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![Jasco 14318 product image](https://www.cd-jackson.com/zwave_device_uploads/717/717_default.png) + + The Jasco 14318 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. Refer to the *Wakeup Information* section below for further information. ## Overview +Transform any home into a smart home with the Jasco Z-Wave In-Wall Smart Switch. The on/off switch replaces your current light switch, uses your existing wiring, and provides Z-Wave wireless and in-wall control of overhead lighting. The switch enables wireless control of on/off functions of direct wire incandescent, LED, xenon, halogen and fluorescent lighting. Providing ultimate flexibility, the Jasco Z-Wave Smart Lighting Control On/Off Switch allows you to operate the switch by itself or easily integrate the switch with two-way, three-way or four-way wiring configurations by adding the Jasco Add-On switch. Single pole wiring configuration turns the light or appliance on/off from one location. Three-way wiring configuration turns the light on/off from two separate locations. Four-way wiring configuration turns the light on/off from three separate locations. The Jasco Add-On Switch is required for Three-way or Four-way installations. The lighting control includes a blue LED indicator light to easily locate the switch in a dark room. Take control of your home lighting with Jasco Z-Wave Smart Lighting Controls! + +### Inclusion Information + +Once the controller is ready to include your device, press and release the top or bottom of the wireless smart switch(rocker) to include it in the network. + +### Exclusion Information + +Once the controller is ready to exclude your device, press and release the top button of the wireless smart switch (rocker) to exclude it from the network. + ### Wakeup Information The Jasco 14318 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. @@ -22,34 +37,105 @@ The wakeup period does not impact the devices ability to report events or sensor The following table summarises the channels available for the Jasco 14318 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 2 configuration parameters available in the Jasco 14318. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 3 | LED Light | LED Light | +| 4 | Invert Switch | Invert Switch | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 3: LED Light + +LED Light + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | LED light on when Z-Wave turned on | +| 2 | LED light always off | + +The manufacturer defined default value is ```1``` (LED light on when Z-Wave turned on). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Invert Switch + +Invert Switch + +The following option values may be configured, in addition to values in the range 0 to 1 -: + +| Value | Description | +|--------|-------------| +| 1 | Invert Switch | + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The Jasco 14318 supports 3 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: ontrolled with the local load. + +Supports Basic Set +Supports Basic Set and is controlled with the local load. + +Association group 2 supports 5 nodes. + +### Group 3: ontrolled by double pressing the On or Off button. + +Supports Basic Set +Supports Basic Set and is controlled by double pressing the On or Off button. + +Association group 3 supports 5 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/ge/26933_0_0.md b/_addons_bindings/zwave/doc/ge/26933_0_0.md index 407952804..797c90ae6 100644 --- a/_addons_bindings/zwave/doc/ge/26933_0_0.md +++ b/_addons_bindings/zwave/doc/ge/26933_0_0.md @@ -88,12 +88,12 @@ The following table summarises the channels available for the In-Wall Smart Moti 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 and is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number Triggers when a scene button is pressed. -The ```scene_number``` channel and is of type ```scene_number``` and supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Operation Mode Sets how the light responds to motion @@ -102,12 +102,12 @@ Sets how the light responds to motion Generic class for configuration parameter. -The ```config_decimal``` channel and is of type ```config_decimal``` and supports the ```Number``` item. +The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. ### Alarm (burglar) Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` channel and is of type ```alarm_burglar``` and 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -120,12 +120,12 @@ The following state translation is provided for this channel to the ```Switch``` The brightness channel allows to control the brightness of a light. It is also possible to switch the light on and off. -The ```switch_dimmer1``` channel and is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. +The ```switch_dimmer1``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Motion Alarm Indicates if a motion alarm is triggered. -The ```alarm_motion2``` channel and is of type ```alarm_motion``` and supports the ```Switch``` item and is in the ```Motion``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_motion2``` channel is of type ```alarm_motion``` and supports the ```Switch``` item and is in the ```Motion``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -179,7 +179,7 @@ The following option values may be configured -: | 30 | 30 minutes | | 255 | Disable timeout | -The manufacturer defined default value is ```5``` (5 minutes). +The manufacturer defined default value is ```5``` ( 5 minutes). This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. @@ -419,10 +419,10 @@ The following option values may be configured -: | Value | Description | |--------|-------------| -| 0 | Dim up the light to the default level quickly (Default) | +| 0 | Dim up the light quickly (Default) | | 1 | Dim up the light to the default level slowly | -The manufacturer defined default value is ```0``` (Dim up the light to the default level quickly (Default)). +The manufacturer defined default value is ```0``` (Dim up the light quickly (Default)). This parameter has the configuration ID ```config_18_1``` and is of type ```INTEGER```. @@ -435,10 +435,10 @@ The following option values may be configured -: | Value | Description | |--------|-------------| -| 0 | Press and release any button on the switch (Default) | -| 1 | Press and release “X” btn and repeat for “ON“ btn | +| 0 | Press and release any button (Default) | +| 1 | Press & release “X” btn & then “ON“ btn | -The manufacturer defined default value is ```0``` (Press and release any button on the switch (Default)). +The manufacturer defined default value is ```0``` (Press and release any button (Default)). This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```. diff --git a/_addons_bindings/zwave/doc/ge/28167_0_0.md b/_addons_bindings/zwave/doc/ge/28167_0_0.md new file mode 100644 index 000000000..de72f9342 --- /dev/null +++ b/_addons_bindings/zwave/doc/ge/28167_0_0.md @@ -0,0 +1,229 @@ +--- +layout: documentation +title: GE 28167 (ZW3104) - ZWave +--- + +{% include base.html %} + +# GE 28167 (ZW3104) Plug-In Smart Dimmer +This describes the Z-Wave device *GE 28167 (ZW3104)*, manufactured by *Jasco Products* with the thing type UID of ```ge_28167_00_000```. + +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![GE 28167 (ZW3104) product image](https://www.cd-jackson.com/zwave_device_uploads/577/577_default.png) + + +The GE 28167 (ZW3104) 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. Refer to the *Wakeup Information* section below for further information. + +## Overview + +Transform any home into a smart home with the GE Z-Wave Plug-In Smart Dimmer. The Smart Dimmer enables wireless control of on/off and dim functions for standard incandescent table and floor lamps, as well as dimmable fluorescent, LED and CFL fixtures and more! Use the dimmer control to customize the lighting output and create the perfect ambiance for any room. The space-saving horizontal module plugs into a standard wall receptacle without blocking the second outlet or obstructing placement of furniture. The Dimmer provides one Z-Wave enabled outlet for the lamp you would like to control. Take control of your home lighting with GE Z-Wave Smart Lighting Controls! + +### Inclusion Information + +Once the controller is ready to add your smart dimmer, single press and release the manual/program button on the smart dimmer to add it in the network. + +### Exclusion Information + +Once the controller is ready to remove your device, press and release the manual/program button on the smart dimmer to remove it from the network + +### Wakeup Information + +The GE 28167 (ZW3104) 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. + +## Channels + +The following table summarises the channels available for the GE 28167 (ZW3104) -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | + +### 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 is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. + +### Scene Number +Triggers when a scene button is pressed. + +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. + + + +## Device Configuration + +The following table provides a summary of the 7 configuration parameters available in the GE 28167 (ZW3104). +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 3 | LED Light | LED Light | +| 7 | Dim Rate Adjustments (From Z-Wave Controller) | Dim Rate Adjustments (From Z-Wave Controller) | +| 8 | Dim Rate Adjustments (From Z-Wave Controller) | Dim Rate Adjustments (From Z-Wave Controller) | +| 9 | Dim Rate Adjustments (When Manually Controlled) | Dim Rate Adjustments (When Manually Controlled) | +| 10 | Dim Rate Adjustments (When Manually Controlled) | Dim Rate Adjustments (When Manually Controlled) | +| 11 | Dim Rate Adjustments (All-On/Off Commands) | Dim Rate Adjustments (All-On/Off Commands) | +| 12 | Dim Rate Adjustments (All-On/Off Command) | Dim Rate Adjustments (All-On/Off Command) | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 3: LED Light + +LED Light + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED On when light is turned Off | +| 1 | LED On when light is turned On | +| 2 | LED always Off | + +The manufacturer defined default value is ```0``` (LED On when light is turned Off). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 7: Dim Rate Adjustments (From Z-Wave Controller) + +Dim Rate Adjustments (From Z-Wave Controller) +Number of steps or levels +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 8: Dim Rate Adjustments (From Z-Wave Controller) + +Dim Rate Adjustments (From Z-Wave Controller) +Timing of steps +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_8_2``` and is of type ```INTEGER```. + + +### Parameter 9: Dim Rate Adjustments (When Manually Controlled) + +Dim Rate Adjustments (When Manually Controlled) +Number of steps or levels +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: Dim Rate Adjustments (When Manually Controlled) + +Dim Rate Adjustments (When Manually Controlled) +Timing of steps +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_10_2``` and is of type ```INTEGER```. + + +### Parameter 11: Dim Rate Adjustments (All-On/Off Commands) + +Dim Rate Adjustments (All-On/Off Commands) +Dim Rate Adjustments (When Receiving All-On/Off Commands) + +Number of steps or levels +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + + +### Parameter 12: Dim Rate Adjustments (All-On/Off Command) + +Dim Rate Adjustments (All-On/Off Command) +Dim Rate Adjustments (When Receiving All-On/Off Command) + +Timing of steps +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_12_2``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The GE 28167 (ZW3104) supports 3 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: Association Group 2 + +supports Basic Set and is controlled with the local load + +Association group 2 supports 5 nodes. + +### Group 3: Association Group 3 + +supports Basic Set and is controlled by double pressing the button + +Association group 3 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_SWITCH_MULTILEVEL_V2| | +| COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_SCENE_ACTIVATION_V1| | +| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | +| COMMAND_CLASS_CRC_16_ENCAP_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | + +### Documentation Links + +* [GE/Jasco 28167 manual - Quick Start Guide](https://www.cd-jackson.com/zwave_device_uploads/577/28167-QSG-v1.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/577). diff --git a/_addons_bindings/zwave/doc/ge/28177_0_0.md b/_addons_bindings/zwave/doc/ge/28177_0_0.md index aefa272d0..af9279f9a 100644 --- a/_addons_bindings/zwave/doc/ge/28177_0_0.md +++ b/_addons_bindings/zwave/doc/ge/28177_0_0.md @@ -8,46 +8,55 @@ title: 28177 - ZWave # 28177 GE Z-Wave Plus Wireless Smart Lighting Control Appliance Module This describes the Z-Wave device *28177*, manufactured by *Jasco Products* with the thing type UID of ```ge_28177_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![28177 product image](https://www.cd-jackson.com/zwave_device_uploads/761/761_default.png) + + The 28177 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 between other devices in the mesh network. ## 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/761) to improve the documentation. +Transform any home into a smart home with the plug-in GE Z-Wave Plus 2-Outlet Smart Switch with 2 USB Ports. The dual USB ports allow the Z-Wave switch to function as a wall charger for USB compatible devices. The smart switch enables you to wirelessly control to turn lights on and off, schedule a timed event or create a custom scene from anywhere in the world, at any time of the day. Helping to cut energy costs and keep your home safe, it also features a space-saving, horizontal design keeps one outlet free for your convenience and full Z-Wave control from smartphones, tablets, PC's and Z-Wave enabled wireless remotes. Take control of your home lighting with GE Z-Wave Plus 2-Outlet Smart Switch with dual USB charging Ports! + +### Inclusion Information + +Once the controller is ready to add your smart switch, single press and release the manual/program button on the smart switch to add it in the network. + +### Exclusion Information + +Once the controller is ready to Exclude your device, press and release the manual/program button on the smart switch to remove it from the network ## Channels The following table summarises the channels available for the 28177 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Scene Number | scene_number | | Number | -| Switch 1 | switch_binary1 | Switch | Switch | -| Switch 2 | switch_binary2 | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Switch 2 | switch_binary2 | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Switch 1 - Switch the power on and off. -The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 2 - Switch the power on and off. -The ```switch_binary2``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -97,9 +106,10 @@ Association groups allow the device to send unsolicited reports to the controlle The 28177 supports 3 association groups. -### Group 1: Z-Wave Plus Lifeline +### Group 1: Lifeline -Z-Wave Plus Lifeline +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. +Lifeline Association group 1 supports 5 nodes. @@ -157,6 +167,10 @@ Association group 3 supports 5 nodes. | COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | | COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/761/28177-QSG-and-Parameters.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/ge/35931_0_0.md b/_addons_bindings/zwave/doc/ge/35931_0_0.md index c26f263dc..63bf91bc7 100644 --- a/_addons_bindings/zwave/doc/ge/35931_0_0.md +++ b/_addons_bindings/zwave/doc/ge/35931_0_0.md @@ -8,38 +8,125 @@ title: 35931 - ZWave # 35931 Enbrighten 60W Dimmable Light Bulb This describes the Z-Wave device *35931*, manufactured by *Jasco Products* with the thing type UID of ```ge_35931_00_000```. +The device is in the category of *Light Bulb*, defining Devices that illuminate something, such as bulbs, etc.. + +![35931 product image](https://www.cd-jackson.com/zwave_device_uploads/536/536_default.png) + + The 35931 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 between other devices in the mesh network. ## 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/536) to improve the documentation. +Breathe new life into your home’s Z-Wave network when you upgrade to an Enbrighten Smart LED Bulb. This 60-watt equivalent bulb works with all standard light fixtures and lamps, allowing you to update to smart control without compromising the design of your home. No wiring is required — simply replace your existing E26 light bulb with the smart bulb (E26 base, A19 style) and begin enjoying the long life of your new light. This Enbrighten Dimmable LED Bulb has full-range dimmability, saving you energy costs year-round. From the convenience of your smartphone or tablet, turn the lights on and off, dim or brighten your room and set lights according to your schedule. At 750 lumens, this LED bulb consumes only 9 watts of power while burning brightly for up to 25,000 hours. Experience the bright side of life with the Enbrighten Smart LED Bulb. + +### Inclusion Information + +Once the controller is ready to include your LED Smart Bulb, turn on power to the socket. The Enbrighten LED Smart Bulb will be automatically included into your network within 30 seconds, and the smart bulb will flash 2 times to signify successful inclusion into your network. + +### Exclusion Information + +Once the controller is ready to exclude your LED Smart Bulb, turn on power to the socket. Tthe smart bulb will flash 2 times to signify successful exclusion from your network. ## Channels The following table summarises the channels available for the 35931 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 3 configuration parameters available in the 35931. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Dim level when light is turned ON | Dim level when light is turned ON | +| 9 | Dimming/Brightening Step Level | Dimming/Brightening Step Level | +| 10 | Dimming/Brightening Step Timing | Dimming/Brightening Step Timing | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 1: Dim level when light is turned ON + +Dim level when light is turned ON + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Full brightness | +| 1 | Last brightness setting | + +The manufacturer defined default value is ```0``` (Full brightness). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 9: Dimming/Brightening Step Level + +Dimming/Brightening Step Level +You may change the dimming step level when you adjust the brightness by your controller/gateway. + +When the value is low, dimming/brightening is gradual. + +When the value is high, dimming/brightening is rapid. +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: Dimming/Brightening Step Timing + +Dimming/Brightening Step Timing +You may change the dimming speed quicker or slower. + +When the value is low, the step timing is quick. + +When the value is high, the step timing is slow. +Values in the range 1 to 10 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The 35931 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/ge/45603_0_0.md b/_addons_bindings/zwave/doc/ge/45603_0_0.md index e342e879f..79b4c9d31 100644 --- a/_addons_bindings/zwave/doc/ge/45603_0_0.md +++ b/_addons_bindings/zwave/doc/ge/45603_0_0.md @@ -43,15 +43,14 @@ Jasco's Z-Wave Plug-In Lamp and Appliance Module allows you the option to adjust The following table summarises the channels available for the 45603 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -114,6 +113,7 @@ The device does not support associations. | COMMAND_CLASS_NO_OPERATION_V1| | | COMMAND_CLASS_BASIC_V1| | | COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_PROTECTION_V1| | | COMMAND_CLASS_VERSION_V1| | diff --git a/_addons_bindings/zwave/doc/ge/45605_0_0.md b/_addons_bindings/zwave/doc/ge/45605_0_0.md index 5ae53b9e9..014778726 100644 --- a/_addons_bindings/zwave/doc/ge/45605_0_0.md +++ b/_addons_bindings/zwave/doc/ge/45605_0_0.md @@ -17,25 +17,31 @@ The 45605 supports routing. This allows the device to communicate using other ro ## 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/45) to improve the documentation. +Transform any home into a smart home with the Jasco Z-Wave Wireless Lighting Control Duplex Receptacle. The Jasco Z-Wave duplex receptacle enables wireless control of on/off functions from the Z-Wave controlled outlet, and is compatible with incandescent, LED, Xenon, Halogen, fluorescent and compact fluorescent bulbs. The duplex receptacle includes a blue LED indicator light to easily locate the receptacle in a dark room. The receptacle replaces your current electrical outlet, uses your existing wiring and provides a Z-Wave enabled outlet for the lamp or appliance that you would like to control and a standard pass-through AC outlet for other electrical appliances. The receptacle requires in-wall installation with hardwired connections. Take control of your home lighting with Jasco Z-Wave Wireless Lighting Controls!  + +### Inclusion Information + +Once the controller is ready to add your device, press and release the Program Button to add it in the network. + +### Exclusion Information + +Press and release the Program Button ## Channels The following table summarises the channels available for the 45605 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Night Light | config_decimal | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Night Light | config_decimal | config_decimal | | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Night Light - Defines the behaviour of the blue LED 0 = LED on when switch is OFF @@ -46,7 +52,7 @@ Defines the behaviour of the blue LED Generic class for configuration parameter. -The ```config_decimal``` channel supports the ```Number``` item. +The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. diff --git a/_addons_bindings/zwave/doc/ge/45606_0_0.md b/_addons_bindings/zwave/doc/ge/45606_0_0.md index e6020c3b3..89fe8d9e5 100644 --- a/_addons_bindings/zwave/doc/ge/45606_0_0.md +++ b/_addons_bindings/zwave/doc/ge/45606_0_0.md @@ -8,26 +8,38 @@ title: 45606 - ZWave # 45606 2-Way Dimmer Switch This describes the Z-Wave device *45606*, manufactured by *Jasco Products* with the thing type UID of ```ge_45606_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![45606 product image](https://www.cd-jackson.com/zwave_device_uploads/41/41_default.png) + + The 45606 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 between other devices in the mesh network. ## 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/41) to improve the documentation. +Wireless Lighting Control, On/Off/Dim Dimmer Switch + +### Inclusion Information + +Tap the top or bottom of the rocker + +### Exclusion Information + +Tap the top or bottom of the rocker ## Channels The following table summarises the channels available for the 45606 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. diff --git a/_addons_bindings/zwave/doc/ge/45607_0_0.md b/_addons_bindings/zwave/doc/ge/45607_0_0.md index fb7abcff3..e8056eba5 100644 --- a/_addons_bindings/zwave/doc/ge/45607_0_0.md +++ b/_addons_bindings/zwave/doc/ge/45607_0_0.md @@ -8,26 +8,38 @@ title: 45607 - ZWave # 45607 2-Way Dimmer Switch This describes the Z-Wave device *45607*, manufactured by *Jasco Products* with the thing type UID of ```ge_45607_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![45607 product image](https://www.cd-jackson.com/zwave_device_uploads/377/377_default.png) + + The 45607 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 between other devices in the mesh network. ## 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/377) to improve the documentation. +Transform any home into a smart home with the Jasco Z-Wave Wireless Lighting Control Dimmer Switch. The Jasco Z-Wave Wireless Lighting Control Dimmer Switch enables wireless control of on/off and dim functions of hard-wired incandescent lighting. The dimmer switch replaces your current light switch, uses your existing wiring, and provides Z-Wave wireless and in-wall control of overhead lighting. Use the dimmer feature to customize the lighting output and create the perfect ambiance for any room. Providing ultimate flexibility, the Jasco Z-Wave Wireless Lighting Control Dimmer Switch allows you to operate the switch by itself or easily integrate the switch with two-way, three-way or four-way wiring configurations by adding the Jasco Auxiliary switch for Z-Wave. Two-way wiring configuration turns the light or appliance on/off from one location. Three-way wiring configuration turns the light or appliance on/off from two separate locations. Four-way wiring configuration turns the light or appliance on/off from three separate locations. The Jasco Auxiliary Switch for Z-Wave is required for three-way or four-way installations. The dimmer switch includes an LED indicator light to easily locate the switch in a dark room. Take control of your home lighting with Jasco Z-Wave Wireless Lighting Controls!  + +### Inclusion Information + +Tap the top or bottom of the rocker. + +### Exclusion Information + +Tap the top or bottom of the rocker. ## Channels The following table summarises the channels available for the 45607 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. @@ -38,35 +50,23 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 3 | Night Light | Defines the behavior of the blue LED. -Default is Night Light mode where LED is on when switch is off. | -| 4 | Invert Switch | Change the top of the switch to OFF and the bottom -of the switch to ON. -Note: If you invert the switches and also install the product upside down, -remember the load will now be controlled by the right, not the left switch. | +| 3 | Night Light | Night Light | +| 4 | Invert Switch | Invert Switch | | 5 | Ignore Start-Level (Receiving) | This dimmer will start dimming from its current level. | | 7 | On/Off Command Dim Step | Indicates how many levels the dimmer will change for each dimming step. | -| 8 | On/Off Command Dim Rate | This value indicates in 10 millisecond resolution, -how often the dim level will change. For example, if you set this parameter to 1, -then every 10ms the dim level will change. If you set it to 255, then every 2.55 -seconds the dim level w | +| 8 | On/Off Command Dim Rate | On/Off Command Dim Rate | | 9 | Local Control Dim Step | Indicates how many levels the dimmer will change for each dimming step. | -| 10 | Local Control Dim Rate | This value indicates in 10 millisecond resolution, -how often the dim level will change. For example, if you set this parameter to 1, -then every 10ms the dim level will change. If you set it to 255, then every 2.55 -seconds the dim level will | +| 10 | Local Control Dim Rate | Local Control Dim Rate | | 11 | ALL ON/ALL OFF Dim Step | Indicates how many levels the dimmer will change for each dimming step. | -| 12 | ALL ON/ALL OFF Dim Rate | This value indicates in 10 millisecond resolution, -how often the dim level will change. For example, if you set this parameter to 1, -then every 10ms the dim level will change. If you set it to 255, then every 2.55 -seconds the dim level w | +| 12 | ALL ON/ALL OFF Dim Rate | ALL ON/ALL OFF Dim Rate | | | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | ### Parameter 3: Night Light -Defines the behavior of the blue LED. -Default is Night Light mode where LED is on when switch is off. +Night Light +Defines the behavior of the blue LED. +Default is Night Light mode where LED is on when switch is off. The following option values may be configured -: | Value | Description | @@ -82,11 +82,10 @@ This parameter has the configuration ID ```config_3_1``` and is of type ```INTEG ### Parameter 4: Invert Switch -Change the top of the switch to OFF and the bottom -of the switch to ON. -Note: If you invert the switches and also install the product upside down, -remember the load will now be controlled by the right, not the left switch. +Invert Switch +Change the top of the switch to OFF and the bottom  of the switch to ON. +Note: If you invert the switches and also install the product upside down, remember the load will now be controlled by the right, not the left switch. The following option values may be configured -: | Value | Description | @@ -128,11 +127,12 @@ This parameter has the configuration ID ```config_7_1``` and is of type ```INTEG ### Parameter 8: On/Off Command Dim Rate -This value indicates in 10 millisecond resolution, -how often the dim level will change. For example, if you set this parameter to 1, -then every 10ms the dim level will change. If you set it to 255, then every 2.55 -seconds the dim level w +On/Off Command Dim Rate +This value indicates in 10 millisecond resolution, how often the dim level will change. +For example, if you set this parameter to 1,  then every 10ms the dim level will change. + +If you set it to 255, then every 2.55 seconds the dim level will change. Values in the range 1 to 255 may be set. The manufacturer defined default value is ```3```. @@ -153,11 +153,12 @@ This parameter has the configuration ID ```config_9_1``` and is of type ```INTEG ### Parameter 10: Local Control Dim Rate -This value indicates in 10 millisecond resolution, -how often the dim level will change. For example, if you set this parameter to 1, -then every 10ms the dim level will change. If you set it to 255, then every 2.55 -seconds the dim level will +Local Control Dim Rate +This value indicates in 10 millisecond resolution, how often the dim level will change. +For example, if you set this parameter to 1, then every 10ms the dim level will change. + +If you set it to 255, then every 2.55 <br>seconds the dim level will change. Values in the range 1 to 255 may be set. The manufacturer defined default value is ```3```. @@ -178,11 +179,12 @@ This parameter has the configuration ID ```config_11_1``` and is of type ```INTE ### Parameter 12: ALL ON/ALL OFF Dim Rate -This value indicates in 10 millisecond resolution, -how often the dim level will change. For example, if you set this parameter to 1, -then every 10ms the dim level will change. If you set it to 255, then every 2.55 -seconds the dim level w +ALL ON/ALL OFF Dim Rate +This value indicates in 10 millisecond resolution, how often the dim level will change. +For example, if you set this parameter to 1, then every 10ms the dim level will change. + +If you set it to 255, then every 2.55 seconds the dim level will change. Values in the range 1 to 255 may be set. The manufacturer defined default value is ```3```. @@ -226,6 +228,10 @@ The device does not support associations. | COMMAND_CLASS_POWERLEVEL_V1| | | COMMAND_CLASS_VERSION_V1| | +### Documentation Links + +* [Kit Manual](https://www.cd-jackson.com/zwave_device_uploads/377/GE-45613-manual.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/ge/zw1001_0_0.md b/_addons_bindings/zwave/doc/ge/zw1001_0_0.md index 4f45bb29f..8ad2b058e 100644 --- a/_addons_bindings/zwave/doc/ge/zw1001_0_0.md +++ b/_addons_bindings/zwave/doc/ge/zw1001_0_0.md @@ -8,6 +8,8 @@ title: ZW1001 - ZWave # ZW1001 Smart Outlet This describes the Z-Wave device *ZW1001*, manufactured by *Jasco Products* with the thing type UID of ```ge_zw1001_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + ![ZW1001 product image](https://www.cd-jackson.com/zwave_device_uploads/46/46_default.jpg) @@ -15,21 +17,28 @@ The ZW1001 supports routing. This allows the device to communicate using other r ## 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/46) to improve the documentation. +Transform any home into a smart home with the GE Z-Wave Smart Lighting Control Duplex Receptacle. The GE Z-Wave duplex receptacle enables wireless control of on/off functions from the Z-Wave controlled outlet, and is compatible with incandescent, LED, Xenon, Halogen, fluorescent and compact fluorescent bulbs. The duplex receptacle includes a blue LED indicator light to easily locate the receptacle in a dark room. The receptacle replaces your current electrical outlet, uses your existing wiring and provides a Z-Wave enabled outlet for the lamp or appliance that you would like to control and a standard pass-through AC outlet for other electrical appliances. The receptacle requires in-wall installation with hardwired connections. Take control of your home lighting with GE Z-Wave Smart Lighting Controls!  + +### Inclusion Information + +Once the controller is ready to include your device, press and release the Program Button to include it in the network. + +### Exclusion Information + +Press and release the Program Button to exlude it from the network. ## Channels The following table summarises the channels available for the ZW1001 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. diff --git a/_addons_bindings/zwave/doc/ge/zw3003_0_0.md b/_addons_bindings/zwave/doc/ge/zw3003_0_0.md index 404e96ea3..462c8172c 100644 --- a/_addons_bindings/zwave/doc/ge/zw3003_0_0.md +++ b/_addons_bindings/zwave/doc/ge/zw3003_0_0.md @@ -19,20 +19,27 @@ The ZW3003, GE 12724 supports routing. This allows the device to communicate usi Also goes by GE / Jasco catalog number 12724. +### Inclusion Information + +When prompted by your primary controller, tap the top or bottom of the rocker. + +### Exclusion Information + +Tap the top or bottom of the rocker. + ## Channels The following table summarises the channels available for the ZW3003, GE 12724 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. @@ -43,28 +50,23 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 3 | Night Light | Defines the behavior of the blue LED. -Default is Night Light mode where LED is on when switch is off. | -| 4 | Invert Switch | Invert the ON/OFF Switch State. -Setting this parameter to Yes will change the top of the switch to OFF and the bottom to ON. -Note: If you invert the switches and also install the product upside down, the load will now be control | +| 3 | Night Light | Night Light | +| 4 | Invert Switch | Invert Switch | | 5 | Ignore Start-Level (Receiving) | This dimmer will start dimming from its current level. | -| 7 | On/Off Command Dim Step | Indicates how many levels the dimmer will change for each dimming step. | -| 8 | On/Off Command Dim Rate | This value indicates in 10 millisecond resolution. -This sets how often the dim level will change. For example, if you set this parameter to 1, then every 10ms the dim level will change. If you set it to 255, then every 2.55 seconds the | -| 9 | Local Control Dim Step | Indicates how many levels the dimmer will change for each dimming step. | -| 10 | Local Control Dim Rate | This value indicates in 10 millisecond resolution. -This sets how often the dim level will change. For example, if you set this parameter to 1, then every 10ms the dim level will change. If you set it to 255, then every 2.55 seconds the | -| 11 | ALL ON/ALL OFF Dim Step | Indicates how many levels the dimmer will change for each dimming step. | -| 12 | ALL ON/ALL OFF Dim Rate | This value indicates in 10 millisecond resolution. -This sets how often the dim level will change. For example, if you set this parameter to 1, then every 10ms the dim level will change. If you set it to 255, then every 2.55 seconds the | +| 7 | On/Off Command Dim Step | On/Off Command Dim Step | +| 8 | On/Off Command Dim Rate | On/Off Command Dim Rate | +| 9 | Local Control Dim Step | Local Control Dim Step | +| 10 | Local Control Dim Rate | Local Control Dim Rate | +| 11 | ALL ON/ALL OFF Dim Step | ALL ON/ALL OFF Dim Step | +| 12 | ALL ON/ALL OFF Dim Rate | ALL ON/ALL OFF Dim Rate | | | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | ### Parameter 3: Night Light -Defines the behavior of the blue LED. -Default is Night Light mode where LED is on when switch is off. +Night Light +Defines the behavior of the blue LED. +Default is Night Light mode where LED is on when switch is off. The following option values may be configured -: | Value | Description | @@ -80,10 +82,12 @@ This parameter has the configuration ID ```config_3_1``` and is of type ```INTEG ### Parameter 4: Invert Switch -Invert the ON/OFF Switch State. -Setting this parameter to Yes will change the top of the switch to OFF and the bottom to ON. -Note: If you invert the switches and also install the product upside down, the load will now be control +Invert Switch +Invert the ON/OFF Switch State. +Setting this parameter to Yes will change the top of the switch to OFF and the bottom to ON. + +Note: If you invert the switches and also install the product upside down, the load will now be control The following option values may be configured -: | Value | Description | @@ -114,8 +118,8 @@ This parameter has the configuration ID ```config_5_1``` and is of type ```INTEG ### Parameter 7: On/Off Command Dim Step +On/Off Command Dim Step Indicates how many levels the dimmer will change for each dimming step. - Values in the range 1 to 99 may be set. The manufacturer defined default value is ```1```. @@ -125,9 +129,12 @@ This parameter has the configuration ID ```config_7_1``` and is of type ```INTEG ### Parameter 8: On/Off Command Dim Rate -This value indicates in 10 millisecond resolution. -This sets how often the dim level will change. For example, if you set this parameter to 1, then every 10ms the dim level will change. If you set it to 255, then every 2.55 seconds the +On/Off Command Dim Rate +This value indicates in 10 millisecond resolution. This sets how often the dim level will change. +For example, if you set this parameter to 1, then every 10ms the dim level will change. + +If you set it to 255, then every 2.55 seconds the dim level will change. Values in the range 1 to 255 may be set. The manufacturer defined default value is ```3```. @@ -137,8 +144,8 @@ This parameter has the configuration ID ```config_8_1``` and is of type ```INTEG ### Parameter 9: Local Control Dim Step +Local Control Dim Step Indicates how many levels the dimmer will change for each dimming step. - Values in the range 1 to 99 may be set. The manufacturer defined default value is ```1```. @@ -148,9 +155,12 @@ This parameter has the configuration ID ```config_9_1``` and is of type ```INTEG ### Parameter 10: Local Control Dim Rate -This value indicates in 10 millisecond resolution. -This sets how often the dim level will change. For example, if you set this parameter to 1, then every 10ms the dim level will change. If you set it to 255, then every 2.55 seconds the +Local Control Dim Rate +This value indicates in 10 millisecond resolution. This sets how often the dim level will change. +For example, if you set this parameter to 1, then every 10ms the dim level will change. + +If you set it to 255, then every 2.55 seconds the dim level will change. Values in the range 1 to 255 may be set. The manufacturer defined default value is ```3```. @@ -160,8 +170,8 @@ This parameter has the configuration ID ```config_10_1``` and is of type ```INTE ### Parameter 11: ALL ON/ALL OFF Dim Step +ALL ON/ALL OFF Dim Step Indicates how many levels the dimmer will change for each dimming step. - Values in the range 1 to 99 may be set. The manufacturer defined default value is ```1```. @@ -171,9 +181,12 @@ This parameter has the configuration ID ```config_11_1``` and is of type ```INTE ### Parameter 12: ALL ON/ALL OFF Dim Rate -This value indicates in 10 millisecond resolution. -This sets how often the dim level will change. For example, if you set this parameter to 1, then every 10ms the dim level will change. If you set it to 255, then every 2.55 seconds the +ALL ON/ALL OFF Dim Rate +This value indicates in 10 millisecond resolution. This sets how often the dim level will change. +For example, if you set this parameter to 1, then every 10ms the dim level will change. + +If you set it to 255, then every 2.55 seconds the dim level will change. Values in the range 1 to 255 may be set. The manufacturer defined default value is ```3```. diff --git a/_addons_bindings/zwave/doc/ge/zw3102_0_0.md b/_addons_bindings/zwave/doc/ge/zw3102_0_0.md index 89d36427e..d460ba974 100644 --- a/_addons_bindings/zwave/doc/ge/zw3102_0_0.md +++ b/_addons_bindings/zwave/doc/ge/zw3102_0_0.md @@ -10,64 +10,58 @@ This describes the Z-Wave device *ZW3102*, manufactured by *Jasco Products* with The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. -![ZW3102 product image](https://www.cd-jackson.com/zwave_device_uploads/753/753_default.jpg) +![ZW3102 product image](https://www.cd-jackson.com/zwave_device_uploads/753/753_default.png) The ZW3102 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 between other devices in the mesh network. ## 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/753) to improve the documentation. +Energy Monitoring Lamp Module ## Channels The following table summarises the channels available for the ZW3102 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Electric meter (power factor) | meter_powerfactor | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (amps) | meter_current | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Electric meter (power factor) | meter_powerfactor | meter_powerfactor | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Electric meter (power factor) - Indicates the instantaneous power factor. -The ```meter_powerfactor``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. diff --git a/_addons_bindings/zwave/doc/ge/zw4002_0_0.md b/_addons_bindings/zwave/doc/ge/zw4002_0_0.md index 1e1c94fed..5cda6b3df 100644 --- a/_addons_bindings/zwave/doc/ge/zw4002_0_0.md +++ b/_addons_bindings/zwave/doc/ge/zw4002_0_0.md @@ -54,16 +54,15 @@ Tap up or down The following table summarises the channels available for the ZW4002 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. @@ -98,7 +97,9 @@ This parameter has the configuration ID ```config_3_1``` and is of type ```INTEG ### Parameter 4: Invert Switch Invert the ON/OFF Switch State -Setting this parameter to Yes will change the top of the switch to OFF and the bottom to ON.  Note: If you invert the switches and also install the product upside down, the load will now be control. +Setting this parameter to Yes will change the top of the switch to OFF and the bottom to ON. + +Note: If you invert the switches and also install the product upside down, the load will now be control. The following option values may be configured -: | Value | Description | @@ -164,6 +165,7 @@ Association group 3 supports 5 nodes. | COMMAND_CLASS_SWITCH_ALL_V1| | | COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_ASSOCIATION_V1| | | COMMAND_CLASS_VERSION_V1| | ### Documentation Links diff --git a/_addons_bindings/zwave/doc/ge/zw4004_0_0.md b/_addons_bindings/zwave/doc/ge/zw4004_0_0.md new file mode 100644 index 000000000..f9b590cad --- /dev/null +++ b/_addons_bindings/zwave/doc/ge/zw4004_0_0.md @@ -0,0 +1,108 @@ +--- +layout: documentation +title: GE ZW4004 - ZWave +--- + +{% include base.html %} + +# GE ZW4004 GE Z-Wave Wireless Smart Lighting and Appliance Control - 40 Amp +This describes the Z-Wave device *GE ZW4004*, manufactured by *Jasco Products* with the thing type UID of ```ge_zw4004_00_000```. + +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![GE ZW4004 product image](https://www.cd-jackson.com/zwave_device_uploads/655/655_default.png) + + +The GE ZW4004 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 between other devices in the mesh network. + +## Overview + +Outdoor 40amp Direct Wire Box Control with Energy Monitoring + +### Inclusion Information + +Once the controller is ready to include your device, press and release the exterior-mounted push button to include it in the network. + +### Exclusion Information + +Press and release the exterior-mounted push button to exclude it from the network. + +## Channels + +The following table summarises the channels available for the GE ZW4004 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Electric meter (power factor) | meter_powerfactor | meter_powerfactor | Energy | Number | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Electric meter (kWh) +Indicates the energy consumption (kWh). + +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Electric meter (volts) +Indicates the instantaneous voltage. + +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Electric meter (watts) +Indicates the instantaneous power consumption. + +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Electric meter (amps) +Indicates the instantaneous current consumption. + +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Electric meter (power factor) +Indicates the instantaneous power factor. + +The ```meter_powerfactor``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + + + +## Device Configuration + +The device has no configuration parameters defined. + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The device does not support associations. +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_METER_V3| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_VERSION_V1| | + +### Documentation Links + +* [Specifications](https://www.cd-jackson.com/zwave_device_uploads/655/JA45734-Specifications.pdf) +* [Product Manual](https://www.cd-jackson.com/zwave_device_uploads/655/JA45734-Manual.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/655). diff --git a/_addons_bindings/zwave/doc/ge/zw4005_0_0.md b/_addons_bindings/zwave/doc/ge/zw4005_0_0.md index bc3b29866..e73e2eec5 100644 --- a/_addons_bindings/zwave/doc/ge/zw4005_0_0.md +++ b/_addons_bindings/zwave/doc/ge/zw4005_0_0.md @@ -10,25 +10,35 @@ This describes the Z-Wave device *ZW4005, 12722*, manufactured by *Jasco Product The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. +![ZW4005, 12722 product image](https://www.cd-jackson.com/zwave_device_uploads/48/48_default.png) + + The ZW4005, 12722 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 between other devices in the mesh network. ## Overview Also marketed as GE / Jasco 12722. +### Inclusion Information + +Once the controller is ready to include your smart switch, press and release the top or bottom button on the smart switch to include it in the network. + +### Exclusion Information + +Once the controller is ready to exclude your device, press and release the top or bottom button on the smart switch to exclude it from the network. + ## Channels The following table summarises the channels available for the ZW4005, 12722 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -39,18 +49,16 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 3 | Night Light | Defines the behavior of the blue LED. -Default is Night Light mode where LED is on when switch is off. | -| 4 | Invert Switch | Invert the ON/OFF Switch State. -Setting this parameter to Yes will change the top of the switch to OFF and the bottom to ON. -Note: If you invert the switches and also install the product upside down, the load will now be control | +| 3 | Night Light | Night Light | +| 4 | Invert Switch | Invert Switch | | | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | ### Parameter 3: Night Light -Defines the behavior of the blue LED. -Default is Night Light mode where LED is on when switch is off. +Night Light +Defines the behavior of the blue LED. +Default is Night Light mode where LED is on when switch is off. The following option values may be configured -: | Value | Description | @@ -66,10 +74,10 @@ This parameter has the configuration ID ```config_3_1``` and is of type ```INTEG ### Parameter 4: Invert Switch -Invert the ON/OFF Switch State. -Setting this parameter to Yes will change the top of the switch to OFF and the bottom to ON. -Note: If you invert the switches and also install the product upside down, the load will now be control +Invert Switch +Invert the ON/OFF Switch State. Setting this parameter to Yes will change the top of the switch to OFF and the bottom to ON. +Note: If you invert the switches and also install the product upside down, the load will now be control The following option values may be configured -: | Value | Description | @@ -111,7 +119,7 @@ The device does not support associations. |---------------|---------| | COMMAND_CLASS_NO_OPERATION_V1| | | COMMAND_CLASS_BASIC_V1| | -| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_SWITCH_ALL_V1| | | COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | diff --git a/_addons_bindings/zwave/doc/ge/zw4102_0_0.md b/_addons_bindings/zwave/doc/ge/zw4102_0_0.md index 3cfa686ff..5f6a62f37 100644 --- a/_addons_bindings/zwave/doc/ge/zw4102_0_0.md +++ b/_addons_bindings/zwave/doc/ge/zw4102_0_0.md @@ -8,60 +8,67 @@ title: ZW4102 - ZWave # ZW4102 Energy Monitoring Appliance Module This describes the Z-Wave device *ZW4102*, manufactured by *Jasco Products* with the thing type UID of ```ge_zw4102_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![ZW4102 product image](https://www.cd-jackson.com/zwave_device_uploads/646/646_default.png) + + The ZW4102 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 between other devices in the mesh network. ## 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/646) to improve the documentation. +RF controlled, energy monitoring plug-in relay + +### Inclusion Information + +Tap the button (press and release) + +### Exclusion Information + +Tap the button (press and release) ## Channels The following table summarises the channels available for the ZW4102 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Electric meter (amps) | meter_current | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Electric meter (power factor) | meter_powerfactor | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (power factor) | meter_powerfactor | meter_powerfactor | Energy | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (power factor) - Indicates the instantaneous power factor. -The ```meter_powerfactor``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. @@ -91,6 +98,10 @@ The device does not support associations. | COMMAND_CLASS_PROTECTION_V1| | | COMMAND_CLASS_VERSION_V1| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/646/User-Manual-1372499.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/ge/zw6302_0_0.md b/_addons_bindings/zwave/doc/ge/zw6302_0_0.md index b5a0539f6..79d67804b 100644 --- a/_addons_bindings/zwave/doc/ge/zw6302_0_0.md +++ b/_addons_bindings/zwave/doc/ge/zw6302_0_0.md @@ -19,26 +19,40 @@ The ZW6302 does not permanently listen for messages sent from the controller - i ## Overview +Make the move toward convenience with the Z-Wave Portable Smart Motion Sensor for your home.  This Z-Wave compatible device boosts the safety of your home by working with your home’s gateway  to wirelessly trigger scenes and send alerts to your smartphone or tablet whenever motion is detected.  +Use the included batteries for easy placement anywhere, plug into the wall using a AC adapter and  USB cable – never replace batteries again.  + +### Inclusion Information + +Once the controller is ready to include your motion sensor, press and release the button on the sensor to include it in the network + +### Exclusion Information + +Once the controller is ready to exclude your motion sensor, press and release the button on the sensor to exclude it from the network.  + ### Wakeup Information The ZW6302 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. + +Press and release the button on the sensor + ## Channels The following table summarises the channels available for the ZW6302 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Motion Alarm | alarm_motion | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Motion Alarm | alarm_motion | alarm_motion | Motion | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -50,7 +64,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Motion Alarm Indicates if a motion alarm is triggered. -The ```alarm_motion``` 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. +The ```alarm_motion``` channel is of type ```alarm_motion``` and supports the ```Switch``` item and is in the ```Motion``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -62,8 +76,8 @@ The following state translation is provided for this channel to the ```Switch``` ### Battery Level 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -76,7 +90,7 @@ Detailed information on each parameter can be found in the sections below. | 13 | Motion Sensor | Motion Sensor | | 18 | PIR Timeout Duration | PIR Timeout Duration in Minutes | | 20 | Basic Set, Notification and Basic Report | Basic Set, Notification and Basic Report | -| 28 | Enable & Disable the LED indication when PIR is triggered | Enable & Disable the LED indication when PIR is triggered | +| 28 | Enable & Disable the LED indication | Enable & Disable the LED indication | | | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | | | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | @@ -105,10 +119,10 @@ The following option values may be configured, in addition to values in the rang | Value | Description | |--------|-------------| -| 1 | 1 Minute | -| 2 | 2 Minutes | -| 5 | 5 Minutes | -| 10 | 10 Minutes | +| 1 | One Minute | +| 2 | Two Minutes | +| 5 | Five Minutes | +| 10 | Ten Minutes | | 255 | Test Mode [5 seconds] | The manufacturer defined default value is ```60```. @@ -133,10 +147,10 @@ The manufacturer defined default value is ```1``` (Motion Sensor will send out N This parameter has the configuration ID ```config_20_1``` and is of type ```INTEGER```. -### Parameter 28: Enable & Disable the LED indication when PIR is triggered +### Parameter 28: Enable & Disable the LED indication +Enable & Disable the LED indication Enable & Disable the LED indication when PIR is triggered - The following option values may be configured -: | Value | Description | diff --git a/_addons_bindings/zwave/doc/goodway/78008_0_0.md b/_addons_bindings/zwave/doc/goodway/78008_0_0.md index 4602403b9..32d55ceeb 100644 --- a/_addons_bindings/zwave/doc/goodway/78008_0_0.md +++ b/_addons_bindings/zwave/doc/goodway/78008_0_0.md @@ -43,17 +43,16 @@ can include 2 extern sensors The following table summarises the channels available for the 78008 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Alarm | alarm_general | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Alarm | alarm_general | alarm_general | Alarm | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -63,10 +62,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -76,11 +74,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -93,7 +90,7 @@ Detailed information on each parameter can be found in the sections below. | 1 | Basic set level for nodes of group2 | 255: Binary switch ON, 1-99: Dimmer level | | 2 | Basic set OFF delay time for nodes of group2 | 0: Disable, 0-127 Second | | 3 | Delay time to enter standby mode | After force to wake up, delay time to enter standby mode again | -| 4 | In standby, delay time to enter standby after wake up | In standby mode, after wake up, delay time for standby again | +| 4 | Delay time to enter standby after wake up | Delay time to enter standby after wake up | | 5 | Set waiting exclusion time | Set waiting exclusion time | | 6 | Activate/Deactivate WUT standby mode | 0: Always wake up, 1: Enter standby mode | | 7 | Activate/Deactivate Tamper alarm mode | 0: Disable, 1: Enable | @@ -140,9 +137,9 @@ The manufacturer defined default value is ```10```. This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. -### Parameter 4: In standby, delay time to enter standby after wake up +### Parameter 4: Delay time to enter standby after wake up -In standby mode, after wake up, delay time for standby again +Delay time to enter standby after wake up In standby mode, after wake up, delay time for standby again Values in the range 1 to 255 may be set. @@ -221,11 +218,11 @@ The following option values may be configured -: | Value | Description | |--------|-------------| -| 3 | 3 minutes | -| 5 | 5 minutes | -| 10 | 10 minutes | +| 3 | Report every 3 minutes | +| 5 | Report every 5 minutes | +| 10 | Report every 10 minutes | -The manufacturer defined default value is ```3``` (3 minutes). +The manufacturer defined default value is ```3``` (Report every 3 minutes). This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. diff --git a/_addons_bindings/zwave/doc/goodway/td1311_0_0.md b/_addons_bindings/zwave/doc/goodway/td1311_0_0.md index fc5ee1c74..f46177971 100644 --- a/_addons_bindings/zwave/doc/goodway/td1311_0_0.md +++ b/_addons_bindings/zwave/doc/goodway/td1311_0_0.md @@ -8,6 +8,8 @@ title: TD1311 - ZWave # TD1311 In wall Power Monitor Switch This describes the Z-Wave device *TD1311*, manufactured by *Good Way Technology Co., Ltd* with the thing type UID of ```goodway_td1311_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + ![TD1311 product image](https://www.cd-jackson.com/zwave_device_uploads/476/476_default.jpg) @@ -15,69 +17,97 @@ The TD1311 supports routing. This allows the device to communicate using other r ## 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/476) to improve the documentation. + * Small form factor that fits in most gang boxes worldwide + * Switch and Monitor power consumption + * Switch and Monitor via Z-Wave + * Latest Z-Wave protocol and commands + * Optimized antenna range ## Channels The following table summarises the channels available for the TD1311 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Switch 1 | switch_binary1 | Switch | Switch | -| Electric meter (kWh) 1 | meter_kwh1 | Energy | Number | -| Electric meter (watts) 1 | meter_watts1 | Energy | Number | -| Switch 2 | switch_binary2 | Switch | Switch | -| Electric meter (kWh) 2 | meter_kwh2 | Energy | Number | -| Electric meter (watts) 2 | meter_watts2 | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Electric meter (kWh) 1 | meter_kwh1 | meter_kwh | Energy | Number | +| Electric meter (watts) 1 | meter_watts1 | meter_watts | Energy | Number | +| Switch 2 | switch_binary2 | switch_binary | Switch | Switch | +| Electric meter (kWh) 2 | meter_kwh2 | meter_kwh | Energy | Number | +| Electric meter (watts) 2 | meter_watts2 | meter_watts | Energy | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 1 - Switch the power on and off. -The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (kWh) 1 - Indicates the energy consumption (kWh). -The ```meter_kwh1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh1``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) 1 - Indicates the instantaneous power consumption. -The ```meter_watts1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts1``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Switch 2 - Switch the power on and off. -The ```switch_binary2``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (kWh) 2 - Indicates the energy consumption (kWh). -The ```meter_kwh2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh2``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) 2 - Indicates the instantaneous power consumption. -The ```meter_watts2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts2``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 1 configuration parameters available in the TD1311. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Meter Report duration | Meter Report duration | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 1: Meter Report duration + +Meter Report duration + +Values in the range 5 to 1092 may be set. + +The manufacturer defined default value is ```30```. + +This parameter has the configuration ID ```config_1_2``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups diff --git a/_addons_bindings/zwave/doc/graber/csz1_0_0.md b/_addons_bindings/zwave/doc/graber/csz1_0_0.md index 89d31e4d6..f0d240f80 100644 --- a/_addons_bindings/zwave/doc/graber/csz1_0_0.md +++ b/_addons_bindings/zwave/doc/graber/csz1_0_0.md @@ -8,6 +8,8 @@ title: CSZ1 - ZWave # CSZ1 Cellular Shade Radio Z-Wave This describes the Z-Wave device *CSZ1*, manufactured by *Graber* with the thing type UID of ```graber_csz1_00_000```. +The device is in the category of *Blinds*, defining Roller shutters, window blinds, etc.. + ![CSZ1 product image](https://www.cd-jackson.com/zwave_device_uploads/587/587_default.png) @@ -29,31 +31,28 @@ See http://products.z-wavealliance.org/products/1749 The following table summarises the channels available for the CSZ1 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -64,7 +63,14 @@ The device has no configuration parameters defined. Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The CSZ1 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 1 node. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/greenwave/gwpn5_0_0.md b/_addons_bindings/zwave/doc/greenwave/gwpn5_0_0.md index 2000a17cc..00cbb08a9 100644 --- a/_addons_bindings/zwave/doc/greenwave/gwpn5_0_0.md +++ b/_addons_bindings/zwave/doc/greenwave/gwpn5_0_0.md @@ -10,6 +10,9 @@ This describes the Z-Wave device *GWPN5*, manufactured by *GreenWave Reality Inc The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. +![GWPN5 product image](https://www.cd-jackson.com/zwave_device_uploads/264/264_default.png) + + The GWPN5 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 between other devices in the mesh network. ## Overview @@ -32,51 +35,47 @@ On the PowerNode, press and hold the **Sync** button for approximately one secon The following table summarises the channels available for the GWPN5 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Alarm | alarm_general | Door | Switch | -| Switch 1 | switch_binary1 | Switch | Switch | -| Electric meter (watts) 1 | meter_watts1 | Energy | Number | -| Electric meter (kWh) 1 | meter_kwh1 | Energy | Number | -| Switch 2 | switch_binary2 | Switch | Switch | -| Electric meter (watts) 2 | meter_watts2 | Energy | Number | -| Electric meter (kWh) 2 | meter_kwh2 | Energy | Number | -| Switch 3 | switch_binary3 | Switch | Switch | -| Electric meter (watts) 3 | meter_watts3 | Energy | Number | -| Electric meter (kWh) 3 | meter_kwh3 | Energy | Number | -| Switch 4 | switch_binary4 | Switch | Switch | -| Electric meter (watts) 4 | meter_watts4 | Energy | Number | -| Electric meter (kWh) 4 | meter_kwh4 | Energy | Number | -| Switch 5 | switch_binary5 | Switch | Switch | -| Electric meter (watts) 5 | meter_watts5 | Energy | Number | -| Electric meter (kWh) 5 | meter_kwh5 | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Alarm | alarm_general | alarm_general | Alarm | Switch | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Electric meter (watts) 1 | meter_watts1 | meter_watts | Energy | Number | +| Electric meter (kWh) 1 | meter_kwh1 | meter_kwh | Energy | Number | +| Switch 2 | switch_binary2 | switch_binary | Switch | Switch | +| Electric meter (watts) 2 | meter_watts2 | meter_watts | Energy | Number | +| Electric meter (kWh) 2 | meter_kwh2 | meter_kwh | Energy | Number | +| Switch 3 | switch_binary3 | switch_binary | Switch | Switch | +| Electric meter (watts) 3 | meter_watts3 | meter_watts | Energy | Number | +| Electric meter (kWh) 3 | meter_kwh3 | meter_kwh | Energy | Number | +| Switch 4 | switch_binary4 | switch_binary | Switch | Switch | +| Electric meter (watts) 4 | meter_watts4 | meter_watts | Energy | Number | +| Electric meter (kWh) 4 | meter_kwh4 | meter_kwh | Energy | Number | +| Switch 5 | switch_binary5 | switch_binary | Switch | Switch | +| Electric meter (watts) 5 | meter_watts5 | meter_watts | Energy | Number | +| Electric meter (kWh) 5 | meter_kwh5 | meter_kwh | Energy | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -86,94 +85,79 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Switch 1 - Switch the power on and off. -The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (watts) 1 - Indicates the instantaneous power consumption. -The ```meter_watts1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts1``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 1 - Indicates the energy consumption (kWh). -The ```meter_kwh1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh1``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Switch 2 - Switch the power on and off. -The ```switch_binary2``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (watts) 2 - Indicates the instantaneous power consumption. -The ```meter_watts2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts2``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 2 - Indicates the energy consumption (kWh). -The ```meter_kwh2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh2``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Switch 3 - Switch the power on and off. -The ```switch_binary3``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary3``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (watts) 3 - Indicates the instantaneous power consumption. -The ```meter_watts3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts3``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 3 - Indicates the energy consumption (kWh). -The ```meter_kwh3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh3``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Switch 4 - Switch the power on and off. -The ```switch_binary4``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary4``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (watts) 4 - Indicates the instantaneous power consumption. -The ```meter_watts4``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts4``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 4 - Indicates the energy consumption (kWh). -The ```meter_kwh4``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh4``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Switch 5 - Switch the power on and off. -The ```switch_binary5``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary5``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (watts) 5 - Indicates the instantaneous power consumption. -The ```meter_watts5``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts5``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 5 - Indicates the energy consumption (kWh). -The ```meter_kwh5``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh5``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. @@ -321,7 +305,7 @@ Association group 4 supports 1 node. |---------------|---------| | COMMAND_CLASS_NO_OPERATION_V1| | | COMMAND_CLASS_BASIC_V1| | -| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_SWITCH_ALL_V1| | | COMMAND_CLASS_METER_V2| | | COMMAND_CLASS_CRC_16_ENCAP_V1| | @@ -336,35 +320,35 @@ Association group 4 supports 1 node. | Command Class | Comment | |---------------|---------| | COMMAND_CLASS_BASIC_V1| | -| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_METER_V2| | #### Endpoint 2 | Command Class | Comment | |---------------|---------| | COMMAND_CLASS_BASIC_V1| | -| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_METER_V2| | #### Endpoint 3 | Command Class | Comment | |---------------|---------| | COMMAND_CLASS_BASIC_V1| | -| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_METER_V2| | #### Endpoint 4 | Command Class | Comment | |---------------|---------| | COMMAND_CLASS_BASIC_V1| | -| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_METER_V2| | #### Endpoint 5 | Command Class | Comment | |---------------|---------| | COMMAND_CLASS_BASIC_V1| | -| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_METER_V2| | ### Documentation Links diff --git a/_addons_bindings/zwave/doc/hank/acc01_0_0.md b/_addons_bindings/zwave/doc/hank/acc01_0_0.md new file mode 100644 index 000000000..e173bc00c --- /dev/null +++ b/_addons_bindings/zwave/doc/hank/acc01_0_0.md @@ -0,0 +1,138 @@ +--- +layout: documentation +title: ACC01 - ZWave +--- + +{% include base.html %} + +# ACC01 HKZW +This describes the Z-Wave device *ACC01*, manufactured by *[Hank](http://www.hank-tech.com/)* with the thing type UID of ```hank_acc01_00_000```. + +The device is in the category of *Remote Control*, defining Any portable or hand-held device that controls the status of something, e.g. remote control, keyfob etc.. + +![ACC01 product image](https://www.cd-jackson.com/zwave_device_uploads/725/725_default.png) + + +The ACC01 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 between other devices in the mesh network. + +## Overview + +ACC01 is an IR Transceiver based on Z-Wave technology. It is used for sending IR codes to infrared communicaiton controlling devices suchas TV, air condition, and TV box. + +### Inclusion Information + +Triple click the Z-Button within 1.5 seconds. + +For secure inclusion, press and hold the button for 3 seconds. + +### Exclusion Information + +Triple click the Z-Button within 1.5 seconds. + +## Channels + +The following table summarises the channels available for the ACC01 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| + + + +## Device Configuration + +The following table provides a summary of the 3 configuration parameters available in the ACC01. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 93 | Clear IR information | Clear IR information | +| 254 | Enable/Disable configuration | | +| 255 | Reset & remove from Z-Wave network | Reset & remove from Z-Wave network | + +### Parameter 93: Clear IR information + +Clear IR information + +The following option values may be configured, in addition to values in the range 1 to 1431655765 -: + +| Value | Description | +|--------|-------------| +| 1431655765 | Clear IR Information | + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_93_4``` and is of type ```INTEGER```. + + +### Parameter 254: Enable/Disable configuration + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Unlock | +| 1 | Lock | + +The manufacturer defined default value is ```0``` (Unlock). + +This parameter has the configuration ID ```config_254_1``` and is of type ```INTEGER```. + + +### Parameter 255: Reset & remove from Z-Wave network + +Reset & remove from Z-Wave network +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +The following option values may be configured, in addition to values in the range 1 to 1431655765 -: + +| Value | Description | +|--------|-------------| +| 1431655765 | Reset & remove from network | + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_255_4``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The ACC01 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_SIMPLE_AV_CONTROL_V1| Linked to BASIC| + +### Documentation Links + +* [User Manual](https://www.cd-jackson.com/zwave_device_uploads/725/HKZW-ACC01-MANUL.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/725). diff --git a/_addons_bindings/zwave/doc/hank/hkzwms01_0_0.md b/_addons_bindings/zwave/doc/hank/hkzwms01_0_0.md index 608251340..118b527de 100644 --- a/_addons_bindings/zwave/doc/hank/hkzwms01_0_0.md +++ b/_addons_bindings/zwave/doc/hank/hkzwms01_0_0.md @@ -8,53 +8,69 @@ title: HKZW_MS01 - ZWave # HKZW_MS01 Multisensor This describes the Z-Wave device *HKZW_MS01*, manufactured by *[Hank](http://www.hank-tech.com/)* with the thing type UID of ```hank_hkzwms01_00_000```. +The device is in the category of *Sensor*, defining Device used to measure something. + +![HKZW_MS01 product image](https://www.cd-jackson.com/zwave_device_uploads/675/675_default.png) + + The HKZW_MS01 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 HKZW_MS01 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. Refer to the *Wakeup Information* section below for further information. ## Overview +Detects motion, temperature, humidity, and luminance + +### Inclusion Information + +Triple click the Z-Button + +Hold Z-button for 3 seconds for secure inclusion + +### Exclusion Information + +Triple click the Z-Button + ### Wakeup Information The HKZW_MS01 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. + +Press the Z-Button + ## Channels The following table summarises the channels available for the HKZW_MS01 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Sensor (relative humidity) | sensor_relhumidity | Humidity | Number | -| Sensor (luminance) | sensor_luminance | | Number | -| Alarm (burglar) | alarm_burglar | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number | +| Sensor (luminance) | sensor_luminance | sensor_luminance | | Number | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) - Indicates the current relative humidity. -The ```sensor_relhumidity``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Sensor (luminance) - Indicates the current light reading. -The ```sensor_luminance``` channel supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_luminance``` channel is of type ```sensor_luminance``` and supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. ### Alarm (burglar) - Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -64,11 +80,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -92,16 +107,16 @@ The following option values may be configured -: | Value | Description | |--------|-------------| -| 1 | 1 | -| 2 | 2 | -| 3 | 3 | -| 4 | 4 | -| 5 | 5 | -| 6 | 6 | -| 7 | 7 | -| 8 | 8 | +| 1 | Sensitivity 1 | +| 2 | Sensitivity 2 | +| 3 | Sensitivity 3 | +| 4 | Sensitivity 4 | +| 5 | Sensitivity 5 | +| 6 | Sensitivity 6 | +| 7 | Sensitivity 7 | +| 8 | Sensitivity 8 | -The manufacturer defined default value is ```8``` (8). +The manufacturer defined default value is ```8``` (Sensitivity 8). This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```. @@ -199,6 +214,10 @@ Association group 2 supports 5 nodes. | COMMAND_CLASS_ASSOCIATION_V2| | | COMMAND_CLASS_VERSION_V2| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/675/HKZW-MS01-MANUL.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/hank/hkzws001_0_0.md b/_addons_bindings/zwave/doc/hank/hkzws001_0_0.md index ad170cd0e..772dd448d 100644 --- a/_addons_bindings/zwave/doc/hank/hkzws001_0_0.md +++ b/_addons_bindings/zwave/doc/hank/hkzws001_0_0.md @@ -8,6 +8,11 @@ title: HKZW-SO01 - ZWave # HKZW-SO01 Smart Plug with two USB ports This describes the Z-Wave device *HKZW-SO01*, manufactured by *[Hank](http://www.hank-tech.com/)* with the thing type UID of ```hank_hkzws001_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![HKZW-SO01 product image](https://www.cd-jackson.com/zwave_device_uploads/570/570_default.png) + + The HKZW-SO01 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 between other devices in the mesh network. ## Overview @@ -58,58 +63,51 @@ To remove Smart Plug from the Z-Wave network: The following table summarises the channels available for the HKZW-SO01 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | -| Electric meter (amps) | meter_current | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Electric meter (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. diff --git a/_addons_bindings/zwave/doc/hank/hkzwso03_0_0.md b/_addons_bindings/zwave/doc/hank/hkzwso03_0_0.md index 1d7eab835..04449256c 100644 --- a/_addons_bindings/zwave/doc/hank/hkzwso03_0_0.md +++ b/_addons_bindings/zwave/doc/hank/hkzwso03_0_0.md @@ -213,7 +213,14 @@ This parameter has the configuration ID ```switchall_mode``` and is of type ```I Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The HKZW_SO03 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/hank/rgbbulb_0_0.md b/_addons_bindings/zwave/doc/hank/rgbbulb_0_0.md index 3e4467d75..776cb2ecf 100644 --- a/_addons_bindings/zwave/doc/hank/rgbbulb_0_0.md +++ b/_addons_bindings/zwave/doc/hank/rgbbulb_0_0.md @@ -10,49 +10,56 @@ This describes the Z-Wave device *RGB bulb*, manufactured by *[Hank](http://www. The device is in the category of *Light Bulb*, defining Devices that illuminate something, such as bulbs, etc.. +![RGB bulb product image](https://www.cd-jackson.com/zwave_device_uploads/598/598_default.png) + + The RGB bulb 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 between other devices in the mesh network. ## 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/598) to improve the documentation. +A smart bulb with over 16 million colors + +### Inclusion Information + +Toggle the wall switch off and on 3 times quickly (within 3 seconds) ending with On + +### Exclusion Information + +Toggle the wall switch off and on 3 times quickly (within 3 seconds) ending with On ## Channels The following table summarises the channels available for the RGB bulb -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | -| Color Control | color_color | | Color | -| Color Temperature | color_temperature | ColorLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | +| Color Control | color_color | color_color | ColorLight | Color | +| Color Temperature | color_temperature | color_temperature | ColorLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Color Control - The color channel allows to control the color of a light. It is also possible to dim values and switch the light on and off. -The ```color_color``` channel supports the ```Color``` item. +The ```color_color``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category. ### Color Temperature - The color temperature channel allows to set the color temperature of a light from 0 (cold) to 100 (warm). -The ```color_temperature``` channel supports the ```Dimmer``` item and is in the ```ColorLight``` category. +The ```color_temperature``` channel is of type ```color_temperature``` and supports the ```Dimmer``` item and is in the ```ColorLight``` category. @@ -78,11 +85,11 @@ The following option values may be configured -: | Value | Description | |--------|-------------| -| 0 | RGB BULB memorizes its state after a power failure | -| 1 | Device will be on after power supply is reconnected | -| 2 | Device will be off after power supply is reconnected | +| 0 | Memorizes its state | +| 1 | On | +| 2 | Off | -The manufacturer defined default value is ```0``` (RGB BULB memorizes its state after a power failure). +The manufacturer defined default value is ```0``` (Memorizes its state ). This parameter has the configuration ID ```config_21_1``` and is of type ```INTEGER```. @@ -146,7 +153,7 @@ This parameter has the configuration ID ```config_61_4``` and is of type ```INTE RGB BULB will exclude from the Z-Wave network with this particular command -The following option values may be configured -: +The following option values may be configured, in addition to values in the range 1 to 1431655765 -: | Value | Description | |--------|-------------| diff --git a/_addons_bindings/zwave/doc/hank/scn04_0_0.md b/_addons_bindings/zwave/doc/hank/scn04_0_0.md index 7d7b51b64..52ba65239 100644 --- a/_addons_bindings/zwave/doc/hank/scn04_0_0.md +++ b/_addons_bindings/zwave/doc/hank/scn04_0_0.md @@ -8,6 +8,11 @@ title: SCN04 - ZWave # SCN04 Four-key Scene Controller This describes the Z-Wave device *SCN04*, manufactured by *[Hank](http://www.hank-tech.com/)* with the thing type UID of ```hank_scn04_00_000```. +The device is in the category of *Remote Control*, defining Any portable or hand-held device that controls the status of something, e.g. remote control, keyfob etc.. + +![SCN04 product image](https://www.cd-jackson.com/zwave_device_uploads/697/697_default.png) + + The SCN04 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 SCN04 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. Refer to the *Wakeup Information* section below for further information. @@ -55,16 +60,15 @@ Press and hold any button for three seconds. The following table summarises the channels available for the SCN04 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Scene Number | scene_number | | Number | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Scene Number | scene_number | scene_number | | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: | Event ID | Event Description | @@ -78,11 +82,10 @@ This channel provides the scene, and the event as a decimal value in the form `` | 6 | 5 x keypress | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/hank/so05_0_0.md b/_addons_bindings/zwave/doc/hank/so05_0_0.md index e514cdb1c..bbe632a6c 100644 --- a/_addons_bindings/zwave/doc/hank/so05_0_0.md +++ b/_addons_bindings/zwave/doc/hank/so05_0_0.md @@ -8,6 +8,8 @@ title: HKZW-SO05 - ZWave # HKZW-SO05 Smart Plug This describes the Z-Wave device *HKZW-SO05*, manufactured by *[Hank](http://www.hank-tech.com/)* with the thing type UID of ```hank_so05_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + ![HKZW-SO05 product image](https://www.cd-jackson.com/zwave_device_uploads/487/487_default.jpg) @@ -85,50 +87,44 @@ Supporting firmware OTA; The following table summarises the channels available for the HKZW-SO05 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Scene Number | scene_number | | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Electric meter (amps) | meter_current | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. @@ -195,7 +191,7 @@ The following option values may be configured -: |--------|-------------| | 0 | Function is disabled | | 1 | Send Basic Report | -| 2 | Only when load condition is not changed by command. | +| 2 | Only when load is not changed | The manufacturer defined default value is ```1``` (Send Basic Report). @@ -210,10 +206,10 @@ The following option values may be configured -: | Value | Description | |--------|-------------| -| 0 | Will work in indicator mode. | -| 1 | Indicate load for 5 seconds after load has changed. | +| 0 | Work in indicator mode. | +| 1 | Indicate for 5 seconds after load has changed. | -The manufacturer defined default value is ```0``` (Will work in indicator mode.). +The manufacturer defined default value is ```0``` (Work in indicator mode.). This parameter has the configuration ID ```config_27_1``` and is of type ```INTEGER```. diff --git a/_addons_bindings/zwave/doc/heiman/hs1caz_0_0.md b/_addons_bindings/zwave/doc/heiman/hs1caz_0_0.md index 125b7d61d..b12239763 100644 --- a/_addons_bindings/zwave/doc/heiman/hs1caz_0_0.md +++ b/_addons_bindings/zwave/doc/heiman/hs1caz_0_0.md @@ -65,21 +65,23 @@ The HS1CA-Z does not permanently listen for messages sent from the controller - 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. + +Not provided + ## Channels The following table summarises the channels available for the HS1CA-Z -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Alarm (CO) | alarm_co | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Alarm (CO) | alarm_co | alarm_co | | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -89,10 +91,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Alarm (CO) - Indicates if the carbon monoxide alarm is triggered. -The ```alarm_co``` 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. +The ```alarm_co``` channel is of type ```alarm_co``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -102,11 +103,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/heiman/hs1htz_0_0.md b/_addons_bindings/zwave/doc/heiman/hs1htz_0_0.md index 3c8fb0d4d..a186fa01c 100644 --- a/_addons_bindings/zwave/doc/heiman/hs1htz_0_0.md +++ b/_addons_bindings/zwave/doc/heiman/hs1htz_0_0.md @@ -44,34 +44,36 @@ The HS1HT-Z does not permanently listen for messages sent from the controller - 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. + +  Wake up Notification is transmitted every 24 hours by default. + +-  Wake up Notification is transmitted after Notification Report is Transmitted + ## Channels The following table summarises the channels available for the HS1HT-Z -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Sensor (relative humidity) | sensor_relhumidity | Humidity | Number | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) - Indicates the current relative humidity. -The ```sensor_relhumidity``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/heiman/m4172_0_0.md b/_addons_bindings/zwave/doc/heiman/m4172_0_0.md index 81fac27d4..a88bf46d0 100644 --- a/_addons_bindings/zwave/doc/heiman/m4172_0_0.md +++ b/_addons_bindings/zwave/doc/heiman/m4172_0_0.md @@ -1,43 +1,60 @@ --- layout: documentation -title: M417-2 - ZWave +title: HS3WL-Z - ZWave --- {% include base.html %} -# M417-2 Smart Water Leakage Sensor -This describes the Z-Wave device *M417-2*, manufactured by *[Heiman Technology Co. Ltd](http://www.heimantech.com/)* with the thing type UID of ```heiman_m4172_00_000```. +# HS3WL-Z Smart Water Leakage Sensor +This describes the Z-Wave device *HS3WL-Z*, manufactured by *[Heiman Technology Co. Ltd](http://www.heimantech.com/)* with the thing type UID of ```heiman_m4172_00_000```. The device is in the category of *Sensor*, defining Device used to measure something. -The M417-2 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. +![HS3WL-Z product image](https://www.cd-jackson.com/zwave_device_uploads/738/738_default.png) -The M417-2 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. Refer to the *Wakeup Information* section below for further information. + +The HS3WL-Z 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 HS3WL-Z 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. Refer to the *Wakeup Information* section below for further information. ## Overview +The device will report alarm information if detect the status change of water and no water after press Networking_Button. Red LED blinks once when sensor detects water or no water. + +### Inclusion Information + + * Press the Networking_Button 3 times within 1.5s, Green LED is Blinking 4 times within 1 second. + * If Inclusion Process is successful, Green led will turn off. + +### Exclusion Information + + * Press the Networking_Button 3 times within 1.5s + * If Exclusion Process is successful, Green led is Blinking 6 times, then turn off. + ### Wakeup Information -The M417-2 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 HS3WL-Z 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. + +Not provided + ## Channels -The following table summarises the channels available for the M417-2 -: +The following table summarises the channels available for the HS3WL-Z -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Alarm (burglar) | alarm_burglar | Door | Switch | -| Alarm (flood) | alarm_flood | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | +| Alarm (flood) | alarm_flood | alarm_flood | Water | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -47,10 +64,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Alarm (burglar) - Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -60,10 +76,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Alarm (flood) - Indicates if the flood alarm is triggered. -The ```alarm_flood``` 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. +The ```alarm_flood``` channel is of type ```alarm_flood``` and supports the ```Switch``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -73,11 +88,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -88,7 +102,7 @@ The device has no configuration parameters defined. Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The M417-2 supports 1 association group. +The HS3WL-Z supports 1 association group. ### Group 1: Lifeline @@ -117,6 +131,10 @@ Association group 1 supports 5 nodes. | COMMAND_CLASS_ASSOCIATION_V2| | | COMMAND_CLASS_VERSION_V2| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/738/HS3WL-Z-S2documentation.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/heltun/hezwthermfl2_0_0.md b/_addons_bindings/zwave/doc/heltun/hezwthermfl2_0_0.md index b099e0448..33d8eb225 100644 --- a/_addons_bindings/zwave/doc/heltun/hezwthermfl2_0_0.md +++ b/_addons_bindings/zwave/doc/heltun/hezwthermfl2_0_0.md @@ -68,37 +68,37 @@ The following table summarises the channels available for the HE-ZW-THERM-FL2 -: ### Sensor (luminance) Indicates the current light reading. -The ```sensor_luminance``` channel and is of type ```sensor_luminance``` and supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_luminance``` channel is of type ```sensor_luminance``` and supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. ### Sensor (temperature) Indicates the current temperature. -The ```sensor_temperature``` channel and is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) Indicates the current relative humidity. -The ```sensor_relhumidity``` channel and is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Sensor (soil temperature) Indicates the current temperature. -The ```sensor_soiltemperature``` channel and is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_soiltemperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Electric meter (kWh) Indicates the energy consumption (kWh). -The ```meter_kwh``` channel and is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) Indicates the instantaneous power consumption. -The ```meter_watts``` channel and is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Thermostat mode Sets the thermostat. -The ```thermostat_mode``` channel and is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -121,7 +121,7 @@ The following state translation is provided for this channel to the ```Number``` ### Operating State Sets the thermostat operating state. -The ```thermostat_state``` channel and is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -137,18 +137,880 @@ The following state translation is provided for this channel to the ```Number``` ### Setpoint (heating) Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel and is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Clock Time Offset Provides the current time difference for the devices time. -The ```time_offset``` channel and is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 61 configuration parameters available in the HE-ZW-THERM-FL2. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Degree Mode | Degree Mode | +| 2 | External input mode | External input mode | +| 3 | Mode number | Mode number | +| 4 | Source sensor | Source sensor | +| 5 | Power reg on | Power Regulation ON time, min | +| 6 | Power reg off | Power Regulation OFF time, min | +| 7 | Dry time | Dry time | +| 8 | Time by controller | Time correction by controller | +| 9 | Time format | Time format | +| 10 | Week day | Manually set week day | +| 11 | Hour | Manually set time hour | +| 12 | Mins | Manually set time minute | +| 13 | Air temp min | Air Temperature Minimum in degree, value * 10 | +| 14 | Air temp max | Air Temperature Maximum in degree, x10 | +| 15 | Floor temp min | Floor Temperature Minimum in degree, x10 | +| 16 | Floor temp max | Floor Temperature Maximum in degree, x10 | +| 17 | Floor sensor resistance | Floor Sensor Resistance, kohm | +| 18 | Air temp calibration | Air Temperature Calibration in degree x10 | +| 19 | Floor temp calibration | Floor Temperature Calibration in degree x10 | +| 20 | Temp hysteresis | Temperature Hysteresis in degree, x10 | +| 21 | Temp diff to send values | Temperature difference to send to controller, value x10 | +| 22 | Active display brightness | Active display brightness level. | +| 23 | Inactive display brightness | Inactive display brightness level. | +| 24 | Auto LCD brightness | Auto LCD brightness control | +| 25 | Auto bright level 1 | Auto bright level 1 | +| 26 | Auto bright level 2 | Auto bright level 2 | +| 27 | Auto bright level 3 | Auto bright level 3 | +| 28 | Basic set action | Basic set action | +| 51 | Touch sensitivity | Touch buttons sensitivity. | +| 52 | Morning start time | Morning start time | +| 53 | Day start time | Day start time | +| 54 | Evening start time | Evening start time | +| 55 | Night Start time | Night Start time | +| 56 | Monday morning temp | Monday morning temp | +| 57 | Monday day temp | Monday day temp | +| 58 | Monday evening temp | Monday evening temp | +| 59 | Monday night temp | Monday night temp | +| 60 | Tuesday morning temp | Tuesday morning temp | +| 61 | Tuesday day temp | Tuesday day temp | +| 62 | Tuesday evening temp | Tuesday evening temp | +| 63 | Tuesday night temp | Tuesday night temp | +| 64 | Wednesday morning temp | Wednesday morning temp | +| 65 | Wednesday day temp | Wednesday day temp | +| 66 | Wednesday evening temp | Wednesday evening temp | +| 67 | Wednesday night temp | Wednesday night temp | +| 68 | Thursday morning temp | Thursday morning temp | +| 69 | Thursday day temp | Thursday day temp | +| 70 | Thursday evening temp | Thursday evening temp | +| 71 | Thursday night temp | Thursday night temp | +| 72 | Friday morning temp | Friday morning temp | +| 73 | Friday day temp | Friday day temp | +| 74 | Friday evening temp | Friday evening temp | +| 75 | Friday night temp | Friday night temp | +| 76 | Saturday morning temp | Saturday morning temp | +| 77 | Saturday day temp | Saturday day temp | +| 78 | Saturday evening temp | Saturday evening temp | +| 79 | Saturday night temp | Saturday night temp | +| 80 | Sunday morning temp | Sunday morning temp | +| 81 | Sunday day temp | Sunday day temp | +| 82 | Sunday evening temp | Sunday evening temp | +| 83 | Sunday night temp | Sunday night temp | + +### Parameter 1: Degree Mode + +Degree Mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Centigrade | +| 1 | Fahrenheit | + +The manufacturer defined default value is ```0``` (Centigrade). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: External input mode + +External input mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Ignore external input | +| 1 | Trigger on input | +| 2 | Latch on input | + +The manufacturer defined default value is ```1``` (Trigger on input). + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Mode number + +Mode number +Mode number for EXT input action. This parameter allows selecting which operating mode the thermostat should go to if the external input is short-circuited. + +1=COM, 2=TIME, 3=DRY, 4=ECO, 5=VAC, 6=MAN. + +**Note:** When thermostat goes to MAN mode it will be in IDLE state till HEATING key is not pressed manually. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | COM | +| 2 | TIME | +| 3 | DRY | +| 4 | ECO | +| 5 | VAC | +| 6 | MAN | + +The manufacturer defined default value is ```2``` (TIME). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Source sensor + +Source sensor +Source Sensor: +1=A, 2=AF, 3=F, 4=FA, 5=P, 6=PA, 7=PF. +A=Air sensor, AF - Air sensor + Floor sensor, F - Floor sensor, FA - Floor sensor +Air sensor, P - Power regulator, PA - Power regulator + Air sensor, PF - Power regulator + Floor sensor +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Air sensor | +| 2 | Air and Floor sensors | +| 3 | Floor sensor | +| 4 | Floor and Air sensor | +| 5 | Power regulator | +| 6 | Power regulator and Air sensor | +| 7 | Power regulator and Floor sensor | + +The manufacturer defined default value is ```3``` (Floor sensor). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 5: Power reg on + +Power Regulation ON time, min + +Values in the range 10 to 90 may be set. + +The manufacturer defined default value is ```15```. + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 6: Power reg off + +Power Regulation OFF time, min + +Values in the range 10 to 90 may be set. + +The manufacturer defined default value is ```15```. + +This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```. + + +### Parameter 7: Dry time + +Dry time + +Values in the range 5 to 90 may be set. + +The manufacturer defined default value is ```30```. + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 8: Time by controller + +Time correction by controller + +Values in the range 0 to 1 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```. + + +### Parameter 9: Time format + +Time format + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | 24 hour | +| 1 | 12 hour (AM / PM) | + +The manufacturer defined default value is ```0``` (24 hour). + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: Week day + +Manually set week day +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 1 to 7 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```. + + +### Parameter 11: Hour + +Manually set time hour +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 23 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + + +### Parameter 12: Mins + +Manually set time minute +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 59 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```. + + +### Parameter 13: Air temp min + +Air Temperature Minimum in degree, value * 10 +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 360 may be set. + +The manufacturer defined default value is ```210```. + +This parameter has the configuration ID ```config_13_2``` and is of type ```INTEGER```. + + +### Parameter 14: Air temp max + +Air Temperature Maximum in degree, x10 +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 50 to 370 may be set. + +The manufacturer defined default value is ```270```. + +This parameter has the configuration ID ```config_14_2``` and is of type ```INTEGER```. + + +### Parameter 15: Floor temp min + +Floor Temperature Minimum in degree, x10 +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 360 may be set. + +The manufacturer defined default value is ```180```. + +This parameter has the configuration ID ```config_15_2``` and is of type ```INTEGER```. + + +### Parameter 16: Floor temp max + +Floor Temperature Maximum in degree, x10 +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 50 to 370 may be set. + +The manufacturer defined default value is ```320```. + +This parameter has the configuration ID ```config_16_2``` and is of type ```INTEGER```. + + +### Parameter 17: Floor sensor resistance + +Floor Sensor Resistance, kohm + +Values in the range 1 to 100 may be set. + +The manufacturer defined default value is ```10```. + +This parameter has the configuration ID ```config_17_1``` and is of type ```INTEGER```. + + +### Parameter 18: Air temp calibration + +Air Temperature Calibration in degree x10 +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range -95 to 95 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_18_1``` and is of type ```INTEGER```. + + +### Parameter 19: Floor temp calibration + +Floor Temperature Calibration in degree x10 +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range -95 to 95 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```. + + +### Parameter 20: Temp hysteresis + +Temperature Hysteresis in degree, x10 +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 1 to 95 may be set. + +The manufacturer defined default value is ```5```. + +This parameter has the configuration ID ```config_20_1``` and is of type ```INTEGER```. + + +### Parameter 21: Temp diff to send values + +Temperature difference to send to controller, value x10 +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 1 to 10 may be set. + +The manufacturer defined default value is ```2```. + +This parameter has the configuration ID ```config_21_1``` and is of type ```INTEGER```. + + +### Parameter 22: Active display brightness + +Active display brightness level. +Active display brightness level. Must be greater than or equal param 23 +Values in the range 1 to 4 may be set. + +The manufacturer defined default value is ```4```. + +This parameter has the configuration ID ```config_22_1``` and is of type ```INTEGER```. + + +### Parameter 23: Inactive display brightness + +Inactive display brightness level. +Inactive display brightness level. Must be less than or equal param 22 +Values in the range 1 to 4 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_23_1``` and is of type ```INTEGER```. + + +### Parameter 24: Auto LCD brightness + +Auto LCD brightness control + +Values in the range 0 to 1 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_24_1``` and is of type ```INTEGER```. + + +### Parameter 25: Auto bright level 1 + +Auto bright level 1 +Auto brightness level 1 max lumens +Values in the range 0 to 5000 may be set. + +The manufacturer defined default value is ```30```. + +This parameter has the configuration ID ```config_25_2``` and is of type ```INTEGER```. + + +### Parameter 26: Auto bright level 2 + +Auto bright level 2 +Auto brightness level 2 max lumens +Values in the range 0 to 5000 may be set. + +The manufacturer defined default value is ```200```. + +This parameter has the configuration ID ```config_26_2``` and is of type ```INTEGER```. + + +### Parameter 27: Auto bright level 3 + +Auto bright level 3 +Auto brightness level 3 max lumens +Values in the range 0 to 5000 may be set. + +The manufacturer defined default value is ```3000```. + +This parameter has the configuration ID ```config_27_2``` and is of type ```INTEGER```. + + +### Parameter 28: Basic set action + +Basic set action + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | COM | +| 2 | TIME | +| 3 | DRY | +| 4 | ECO | +| 5 | VAC | +| 6 | MAN | + +The manufacturer defined default value is ```6``` (MAN). + +This parameter has the configuration ID ```config_28_1``` and is of type ```INTEGER```. + + +### Parameter 51: Touch sensitivity + +Touch buttons sensitivity. +Touch buttons sensitivity. + + * 20=Super sensitive. + * 70=lowest sensitivity. +Values in the range 20 to 70 may be set. + +The manufacturer defined default value is ```50```. + +This parameter has the configuration ID ```config_51_1``` and is of type ```INTEGER```. + + +### Parameter 52: Morning start time + +Morning start time +Morning start time. +Format: HHMM. e.g.08:00 should be sent as 0800 +Values in the range 0 to 2359 may be set. + +The manufacturer defined default value is ```600```. + +This parameter has the configuration ID ```config_52_2``` and is of type ```INTEGER```. + + +### Parameter 53: Day start time + +Day start time +Day start time. Format: HHMM. +Values in the range 0 to 2359 may be set. + +The manufacturer defined default value is ```900```. + +This parameter has the configuration ID ```config_53_2``` and is of type ```INTEGER```. + + +### Parameter 54: Evening start time + +Evening start time +Evening start time. Format: HHMM. +Values in the range 0 to 2359 may be set. + +The manufacturer defined default value is ```1800```. + +This parameter has the configuration ID ```config_54_2``` and is of type ```INTEGER```. + + +### Parameter 55: Night Start time + +Night Start time +Night start time. Format: HHMM. +Values in the range 0 to 2359 may be set. + +The manufacturer defined default value is ```2300```. + +This parameter has the configuration ID ```config_55_2``` and is of type ```INTEGER```. + + +### Parameter 56: Monday morning temp + +Monday morning temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```240```. + +This parameter has the configuration ID ```config_56_2``` and is of type ```INTEGER```. + + +### Parameter 57: Monday day temp + +Monday day temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```200```. + +This parameter has the configuration ID ```config_57_2``` and is of type ```INTEGER```. + + +### Parameter 58: Monday evening temp + +Monday evening temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```230```. + +This parameter has the configuration ID ```config_58_2``` and is of type ```INTEGER```. + + +### Parameter 59: Monday night temp + +Monday night temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```180```. + +This parameter has the configuration ID ```config_59_2``` and is of type ```INTEGER```. + + +### Parameter 60: Tuesday morning temp + +Tuesday morning temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```240```. + +This parameter has the configuration ID ```config_60_2``` and is of type ```INTEGER```. + + +### Parameter 61: Tuesday day temp + +Tuesday day temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```200```. + +This parameter has the configuration ID ```config_61_2``` and is of type ```INTEGER```. + + +### Parameter 62: Tuesday evening temp + +Tuesday evening temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```230```. + +This parameter has the configuration ID ```config_62_2``` and is of type ```INTEGER```. + + +### Parameter 63: Tuesday night temp + +Tuesday night temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```180```. + +This parameter has the configuration ID ```config_63_2``` and is of type ```INTEGER```. + + +### Parameter 64: Wednesday morning temp + +Wednesday morning temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```240```. + +This parameter has the configuration ID ```config_64_2``` and is of type ```INTEGER```. + + +### Parameter 65: Wednesday day temp + +Wednesday day temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```200```. + +This parameter has the configuration ID ```config_65_2``` and is of type ```INTEGER```. + + +### Parameter 66: Wednesday evening temp + +Wednesday evening temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```230```. + +This parameter has the configuration ID ```config_66_2``` and is of type ```INTEGER```. + + +### Parameter 67: Wednesday night temp + +Wednesday night temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```180```. + +This parameter has the configuration ID ```config_67_2``` and is of type ```INTEGER```. + + +### Parameter 68: Thursday morning temp + +Thursday morning temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```240```. + +This parameter has the configuration ID ```config_68_2``` and is of type ```INTEGER```. + + +### Parameter 69: Thursday day temp + +Thursday day temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```200```. + +This parameter has the configuration ID ```config_69_2``` and is of type ```INTEGER```. + + +### Parameter 70: Thursday evening temp + +Thursday evening temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```230```. + +This parameter has the configuration ID ```config_70_2``` and is of type ```INTEGER```. + + +### Parameter 71: Thursday night temp + +Thursday night temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```180```. + +This parameter has the configuration ID ```config_71_2``` and is of type ```INTEGER```. + + +### Parameter 72: Friday morning temp + +Friday morning temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```240```. + +This parameter has the configuration ID ```config_72_2``` and is of type ```INTEGER```. + + +### Parameter 73: Friday day temp + +Friday day temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```200```. + +This parameter has the configuration ID ```config_73_2``` and is of type ```INTEGER```. + + +### Parameter 74: Friday evening temp + +Friday evening temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```230```. + +This parameter has the configuration ID ```config_74_2``` and is of type ```INTEGER```. + + +### Parameter 75: Friday night temp + +Friday night temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```180```. + +This parameter has the configuration ID ```config_75_2``` and is of type ```INTEGER```. + + +### Parameter 76: Saturday morning temp + +Saturday morning temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```240```. + +This parameter has the configuration ID ```config_76_2``` and is of type ```INTEGER```. + + +### Parameter 77: Saturday day temp + +Saturday day temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```200```. + +This parameter has the configuration ID ```config_77_2``` and is of type ```INTEGER```. + + +### Parameter 78: Saturday evening temp + +Saturday evening temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```230```. + +This parameter has the configuration ID ```config_78_2``` and is of type ```INTEGER```. + + +### Parameter 79: Saturday night temp + +Saturday night temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```180```. + +This parameter has the configuration ID ```config_79_2``` and is of type ```INTEGER```. + + +### Parameter 80: Sunday morning temp + +Sunday morning temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```240```. + +This parameter has the configuration ID ```config_80_2``` and is of type ```INTEGER```. + + +### Parameter 81: Sunday day temp + +Sunday day temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```200```. + +This parameter has the configuration ID ```config_81_2``` and is of type ```INTEGER```. + + +### Parameter 82: Sunday evening temp + +Sunday evening temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```230```. + +This parameter has the configuration ID ```config_82_2``` and is of type ```INTEGER```. + + +### Parameter 83: Sunday night temp + +Sunday night temp +Centigrade value * 10 + +e.g. 22.5 = 225 +Values in the range 40 to 370 may be set. + +The manufacturer defined default value is ```180```. + +This parameter has the configuration ID ```config_83_2``` and is of type ```INTEGER```. + ## Association Groups diff --git a/_addons_bindings/zwave/doc/hogar/htp4s1fb_2_2.md b/_addons_bindings/zwave/doc/hogar/htp4s1fb_2_2.md index 1fa55a8cd..0391a6e90 100644 --- a/_addons_bindings/zwave/doc/hogar/htp4s1fb_2_2.md +++ b/_addons_bindings/zwave/doc/hogar/htp4s1fb_2_2.md @@ -9,6 +9,8 @@ title: HTP-4S1-FB - ZWave This describes the Z-Wave device *HTP-4S1-FB*, manufactured by *[Hogar Controls](http://hogarcontrols.com/)* with the thing type UID of ```hogar_htp4s1fb_02_002```. This version of the device is limited to firmware versions above 2.2 +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + ![HTP-4S1-FB product image](https://www.cd-jackson.com/zwave_device_uploads/545/545_default.jpg) @@ -56,43 +58,38 @@ The wakeup period does not impact the devices ability to report events or sensor The following table summarises the channels available for the HTP-4S1-FB -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Switch 1 | switch_binary1 | Switch | Switch | -| Switch 2 | switch_binary2 | Switch | Switch | -| Switch 3 | switch_binary3 | Switch | Switch | -| Switch 4 | switch_binary4 | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Switch 2 | switch_binary2 | switch_binary | Switch | Switch | +| Switch 3 | switch_binary3 | switch_binary | Switch | Switch | +| Switch 4 | switch_binary4 | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 1 - Switch the power on and off. -The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 2 - Switch the power on and off. -The ```switch_binary2``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 3 - Switch the power on and off. -The ```switch_binary3``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary3``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 4 - Switch the power on and off. -The ```switch_binary4``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary4``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -148,6 +145,10 @@ The device does not support associations. | COMMAND_CLASS_BASIC_V1| | | COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/545/4Touch.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/hogar/htp850xx_0_0.md b/_addons_bindings/zwave/doc/hogar/htp850xx_0_0.md index 99747734a..a0807337e 100644 --- a/_addons_bindings/zwave/doc/hogar/htp850xx_0_0.md +++ b/_addons_bindings/zwave/doc/hogar/htp850xx_0_0.md @@ -31,71 +31,62 @@ Touch and hold any key on the panel excess 10 seconds. All indication lights bli The following table summarises the channels available for the HTP-8S0-XX -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Switch 1 | switch_binary1 | Switch | Switch | -| Switch 2 | switch_binary2 | Switch | Switch | -| Switch 3 | switch_binary3 | Switch | Switch | -| Switch 4 | switch_binary4 | Switch | Switch | -| Switch 5 | switch_binary5 | Switch | Switch | -| Switch 6 | switch_binary6 | Switch | Switch | -| Switch 7 | switch_binary7 | Switch | Switch | -| Switch 8 | switch_binary8 | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Switch 2 | switch_binary2 | switch_binary | Switch | Switch | +| Switch 3 | switch_binary3 | switch_binary | Switch | Switch | +| Switch 4 | switch_binary4 | switch_binary | Switch | Switch | +| Switch 5 | switch_binary5 | switch_binary | Switch | Switch | +| Switch 6 | switch_binary6 | switch_binary | Switch | Switch | +| Switch 7 | switch_binary7 | switch_binary | Switch | Switch | +| Switch 8 | switch_binary8 | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 1 - Switch the power on and off. -The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 2 - Switch the power on and off. -The ```switch_binary2``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 3 - Switch the power on and off. -The ```switch_binary3``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary3``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 4 - Switch the power on and off. -The ```switch_binary4``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary4``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 5 - Switch the power on and off. -The ```switch_binary5``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary5``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 6 - Switch the power on and off. -The ```switch_binary6``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary6``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 7 - Switch the power on and off. -The ```switch_binary7``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary7``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 8 - Switch the power on and off. -The ```switch_binary8``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary8``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -107,7 +98,62 @@ The device has no configuration parameters defined. Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The HTP-8S0-XX supports 9 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 1 node. + +### Group 2: HGT-01 + +Basic Set + +Association group 2 supports 5 nodes. + +### Group 3: HGT-01 + +Switch Binary Set + +Association group 3 supports 5 nodes. + +### Group 4: HGT-02 + +Basic Set + +Association group 4 supports 5 nodes. + +### Group 5: HGT-02 + +Switch Binary Set + +Association group 5 supports 5 nodes. + +### Group 6: HGT-03 + +Basic Set + +Association group 6 supports 5 nodes. + +### Group 7: HGT-03 + +Switch Binary Set + +Association group 7 supports 5 nodes. + +### Group 8: HGT-04 + +Basic Set + +Association group 8 supports 5 nodes. + +### Group 9: HGT-04 + +Switch Binary Set + +Association group 9 supports 5 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/hogar/lmsxzwcl_0_0.md b/_addons_bindings/zwave/doc/hogar/lmsxzwcl_0_0.md new file mode 100644 index 000000000..764f19064 --- /dev/null +++ b/_addons_bindings/zwave/doc/hogar/lmsxzwcl_0_0.md @@ -0,0 +1,221 @@ +--- +layout: documentation +title: Lumi LM-S4ZW (C-L) - ZWave +--- + +{% include base.html %} + +# Lumi LM-S4ZW (C-L) Z-Wave Switch with 2 on/off light switches and 2 up/down blinds switches +This describes the Z-Wave device *Lumi LM-S4ZW (C-L)*, manufactured by *[Hogar Controls](http://hogarcontrols.com/)* with the thing type UID of ```hogar_lmsxzwcl_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![Lumi LM-S4ZW (C-L) product image](https://www.cd-jackson.com/zwave_device_uploads/1111/1111_default.png) + + +The Lumi LM-S4ZW (C-L) 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 between other devices in the mesh network. + +## Overview + +4 Button Z-Wave Switch: 2 lights and 2 buttons for up/down blinds control. + + * Operating Voltage: 100 - 240V/50Hz + * Operating Temperature: 0 - 50ºC + * Power: 700w/button + * Dimension: 125 x 95 x 34,1 mm (rectangular) + +### Inclusion Information + +Touch and hold any key on the panel for more than 5 seconds. All indication lights will blinks in blue. At this point release the key, the touch panel will start inclusion process. + +### Exclusion Information + +Touch and hold any key on the panel for more than 5 seconds. All indication lights will blinks blue in color. At this point release the key, the touch panel will start exclusion process. + +## Channels + +The following table summarises the channels available for the Lumi LM-S4ZW (C-L) -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Dimmer 1 | switch_dimmer1 | switch_dimmer | DimmableLight | Dimmer | +| Switch 2 | switch_binary2 | switch_binary | Switch | Switch | +| Dimmer 2 | switch_dimmer2 | switch_dimmer | DimmableLight | Dimmer | +| Switch 3 | switch_binary3 | switch_binary | Switch | Switch | +| Dimmer 3 | switch_dimmer3 | switch_dimmer | DimmableLight | Dimmer | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and 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 is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. + +### Switch 1 +Switch the power on and off. + +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Dimmer 1 +The brightness channel allows to control the brightness of a light. + It is also possible to switch the light on and off. + +The ```switch_dimmer1``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. + +### Switch 2 +Switch the power on and off. + +The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Dimmer 2 +The brightness channel allows to control the brightness of a light. + It is also possible to switch the light on and off. + +The ```switch_dimmer2``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. + +### Switch 3 +Switch the power on and off. + +The ```switch_binary3``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Dimmer 3 +The brightness channel allows to control the brightness of a light. + It is also possible to switch the light on and off. + +The ```switch_dimmer3``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. + + + +## Device Configuration + +The device has no configuration parameters defined. + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The Lumi LM-S4ZW (C-L) supports 9 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: HGT-01 + +Basic Set + +Association group 2 supports 5 nodes. + +### Group 3: HGT-01 + +Switch Binary Set + +Association group 3 supports 5 nodes. + +### Group 4: HGT-02 + +Basic Set + +Association group 4 supports 5 nodes. + +### Group 5: HGT-02 + +Switch Binary Set + +Association group 5 supports 5 nodes. + +### Group 6: HGT-03 + +Basic Set + +Association group 6 supports 5 nodes. + +### Group 7: HGT-03 + +Switch Binary Set + +Association group 7 supports 5 nodes. + +### Group 8: HGT-04 + +Basic Set + +Association group 8 supports 5 nodes. + +### Group 9: HGT-04 + +Switch Binary Set + +Association group 9 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_MULTI_CHANNEL_V2| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 1 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +#### Endpoint 2 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +#### Endpoint 3 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | + +### Documentation Links + +* [Lumi LM-SxZW Manual](https://www.cd-jackson.com/zwave_device_uploads/1111/Lumi-LM-SxZW-Manual.pdf) +* [[Official] Lumi Switch Manual in English](https://www.cd-jackson.com/zwave_device_uploads/1111/User-Manual-Switch4-V1-0.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1111). diff --git a/_addons_bindings/zwave/doc/hogar/lumilmsxzwcl_0_0.md b/_addons_bindings/zwave/doc/hogar/lumilmsxzwcl_0_0.md new file mode 100644 index 000000000..3b2d4e085 --- /dev/null +++ b/_addons_bindings/zwave/doc/hogar/lumilmsxzwcl_0_0.md @@ -0,0 +1,204 @@ +--- +layout: documentation +title: Lumi LM-SxZW (C-L) - ZWave +--- + +{% include base.html %} + +# Lumi LM-SxZW (C-L) Z-Wave Switch with 4 on/off light switches +This describes the Z-Wave device *Lumi LM-SxZW (C-L)*, manufactured by *[Hogar Controls](http://hogarcontrols.com/)* with the thing type UID of ```hogar_lumilmsxzwcl_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![Lumi LM-SxZW (C-L) product image](https://www.cd-jackson.com/zwave_device_uploads/1112/1112_default.png) + + +The Lumi LM-SxZW (C-L) 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 between other devices in the mesh network. + +## Overview + +With a stunning glass face and an advanced capacitive touch sensor, all you need to do is just use a finger for turning your lights on and off. Tap once on the backlit touch button to switch the device on and tap it again to turn it off, it’s that simple. This 4 Touch Switch ensures an accurate response to every command that is sent through it. + +The Hogar 4 Touch Switch can operate either independently or as a part of the Hogar smart home automation system, and even with any other certified Z-Wave home automation system. It is an extremely easy-to-use panel that can be installed in a standard BS 2 gang box. Its operating capabilities include a bi-stable mode, a relay mode or a touch pulse mode for scene control with a maximum load current of 3 amp. It communicates with the Hogar smart home automation system using the Z-Wave wireless communication protocol. + +### Inclusion Information + +Touch and hold any key on the panel for more than 5 seconds. All indication lights will blink in blue. At this point release the key, the touch panel will start the inclusion process. + +### Exclusion Information + +ouch and hold any key on the panel for more than 5 seconds. All indication lights will blink blue in color. At this point release the key, the touch panel will start the exclusion process.  + +## Channels + +The following table summarises the channels available for the Lumi LM-SxZW (C-L) -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Switch 2 | switch_binary2 | switch_binary | Switch | Switch | +| Switch 3 | switch_binary3 | switch_binary | Switch | Switch | +| Switch 4 | switch_binary4 | switch_binary | Switch | Switch | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Switch 1 +Switch the power on and off. + +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Switch 2 +Switch the power on and off. + +The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Switch 3 +Switch the power on and off. + +The ```switch_binary3``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Switch 4 +Switch the power on and off. + +The ```switch_binary4``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + + + +## Device Configuration + +The device has no configuration parameters defined. + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The Lumi LM-SxZW (C-L) supports 9 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 1 node. + +### Group 2: HGT-01 Basic Set + +Command: Basic Set Send Basic Set command to the other node in this association group when active endpoint 1. + +Association group 2 supports 5 nodes. + +### Group 3: HGT-01 Switch Binary Set + +Command: Switch Binary Set Send Switch Binary Set command to the other node in this association group when active endpoint 1. + +Association group 3 supports 5 nodes. + +### Group 4: HGT-02 Basic Set + +Command: Basic Set Send Basic Set command to the other node in this association group when active endpoint 2. + +Association group 4 supports 5 nodes. + +### Group 5: HGT-02 Switch Binary Set + +Command: Switch Binary Set Send Switch Binary Set command to the other node in this association group when active endpoint 2. + +Association group 5 supports 5 nodes. + +### Group 6: HGT-03 Basic Set + +Command: Basic Set Send Basic Set command to the other node in this association group when active endpoint 3. + +Association group 6 supports 5 nodes. + +### Group 7: HGT-03 Switch Binary Set + +Command: Switch Binary Set Send Switch Binary Set command to the other node in this association group when active endpoint 3. + +Association group 7 supports 5 nodes. + +### Group 8: HGT-04 Basic Set + +Command: Basic Set Send Basic Set command to the other node in this association group when active endpoint 4. + +Association group 8 supports 5 nodes. + +### Group 9: HGT-04 Switch Binary Set + +Command: Switch Binary Set Send Switch Binary Set command to the other node in this association group when active endpoint 4. + +Association group 9 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_MULTI_CHANNEL_V2| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 1 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 2 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 3 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 4 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | + +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/1112/4-Touch-Modular-Switch-compressed.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1112). diff --git a/_addons_bindings/zwave/doc/homeseer/hsfls100_0_0.md b/_addons_bindings/zwave/doc/homeseer/hsfls100_0_0.md index 6630ce7a1..2054346fd 100644 --- a/_addons_bindings/zwave/doc/homeseer/hsfls100_0_0.md +++ b/_addons_bindings/zwave/doc/homeseer/hsfls100_0_0.md @@ -43,8 +43,8 @@ The following table summarises the channels available for the HS-FLS100+ -: | Binary Sensor | sensor_binary | sensor_binary | | Switch | | Sensor (luminance) | sensor_luminance | sensor_luminance | | Number | | PIR Trigger Off period | config_decimal | config_decimal | | Number | -| Lux sensor threshold [Deprecated]| config_decimal | config_decimal | | Number | -| Auto Report luminance interval [Deprecated]| config_decimal | config_decimal | | Number | +| Lux sensor threshold | config_decimal | config_decimal | | Number | +| Auto Report luminance interval | config_decimal | config_decimal | | Number | | Alarm (power) | alarm_power | alarm_power | Energy | Switch | | Motion Alarm | alarm_motion | alarm_motion | Motion | Switch | @@ -79,7 +79,7 @@ Generic class for configuration parameter. The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. -### Lux sensor threshold [Deprecated] +### Lux sensor threshold Factory default at 50 Setting = 0: always don’t turn ON light @@ -92,9 +92,7 @@ Generic class for configuration parameter. The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. -**Note:** This channel is marked as deprecated so should not be used. - -### Auto Report luminance interval [Deprecated] +### Auto Report luminance interval Default: 10 Setting: 0~1440 (min.) @@ -103,8 +101,6 @@ Generic class for configuration parameter. The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. -**Note:** This channel is marked as deprecated so should not be used. - ### Alarm (power) Indicates if a power alarm is triggered. diff --git a/_addons_bindings/zwave/doc/homeseer/hsls100_0_0.md b/_addons_bindings/zwave/doc/homeseer/hsls100_0_0.md index aeb34c592..f60dc5313 100644 --- a/_addons_bindings/zwave/doc/homeseer/hsls100_0_0.md +++ b/_addons_bindings/zwave/doc/homeseer/hsls100_0_0.md @@ -46,20 +46,19 @@ Press and hold the Z button for more that 5 seconds and release The following table summarises the channels available for the HS-LS100+ -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Heat Alarm | alarm_heat | | Switch | -| Flood Alarm | alarm_flood | Door | Switch | -| Tamper Alarm | alarm_tamper | | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Heat Alarm | alarm_heat | alarm_heat | Fire | Switch | +| Flood Alarm | alarm_flood | alarm_flood | Water | Switch | +| Tamper Alarm | alarm_tamper | alarm_tamper | | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -69,16 +68,14 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Heat Alarm - Indicates if a heat alarm is triggered. -The ```alarm_heat``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_heat``` channel is of type ```alarm_heat``` and supports the ```Switch``` item and is in the ```Fire``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -88,10 +85,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Flood Alarm - Indicates if the flood alarm is triggered. -The ```alarm_flood``` 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. +The ```alarm_flood``` channel is of type ```alarm_flood``` and supports the ```Switch``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -101,10 +97,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Tamper Alarm - Indicates if the tamper alarm is triggered. -The ```alarm_tamper``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_tamper``` channel is of type ```alarm_tamper``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -114,11 +109,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -135,7 +129,7 @@ Detailed information on each parameter can be found in the sections below. | 19 | Temperature report time (minute) | Temperature report time (minute) | | 20 | Set the high temperature alarm trigger value | Set the high temperature alarm trigger value | | 22 | Set the low temperature alarm trigger value | Set the low temperature alarm trigger value | -| 24 | Enable/Disable blinking LED when alarm being triggered | Enable/Disable blinking LED when alarm being triggered | +| 24 | Enable/Disable blinking alarm LED | Enable/Disable blinking alarm LED | | 32 | Level of low battery | Level of low battery | | | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | | | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | @@ -236,9 +230,9 @@ The manufacturer defined default value is ```320```. This parameter has the configuration ID ```config_22_2``` and is of type ```INTEGER```. -### Parameter 24: Enable/Disable blinking LED when alarm being triggered +### Parameter 24: Enable/Disable blinking alarm LED -Enable/Disable blinking LED when alarm being triggered +Enable/Disable blinking alarm LED The following option values may be configured -: diff --git a/_addons_bindings/zwave/doc/homeseer/hspa100_0_0.md b/_addons_bindings/zwave/doc/homeseer/hspa100_0_0.md index 60d33596e..af7daf46b 100644 --- a/_addons_bindings/zwave/doc/homeseer/hspa100_0_0.md +++ b/_addons_bindings/zwave/doc/homeseer/hspa100_0_0.md @@ -17,40 +17,90 @@ The HS-PA100+ supports routing. This allows the device to communicate using othe ## 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/774) to improve the documentation. +The connected lighting devices can be controlled manually with a push button, your smartphone or a Home Automation system such as HomeSeer. Depending on the capability of your controller/gateway, once the Plug-in Module has been added to your network, you may assign it to a Group or Scene and change its status via your controller/gateway + +### Inclusion Information + +Press the button on the front + +### Exclusion Information + +Power the module off and then back on ## Channels The following table summarises the channels available for the HS-PA100+ -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 1 configuration parameters available in the HS-PA100+. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 3 | Night Light | Night Light | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 3: Night Light + +Night Light + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED OFF when light is ON | +| 1 | LED ON when light is OFF | +| 2 | LED always OFF | + +The manufacturer defined default value is ```2``` (LED always OFF). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The HS-PA100+ supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 1 node. + ## Technical Information ### Endpoints @@ -78,6 +128,7 @@ The device does not support associations. ### Documentation Links * [Quick Start Leaflet](https://www.cd-jackson.com/zwave_device_uploads/774/HomeSeer-HS-PA100-Quick-Start.pdf) +* [User Guide](https://www.cd-jackson.com/zwave_device_uploads/774/ZL-PA-100-UG-v3.pdf) --- diff --git a/_addons_bindings/zwave/doc/homeseer/hswd100_0_0.md b/_addons_bindings/zwave/doc/homeseer/hswd100_0_0.md index 7320baaa9..58c0fba92 100644 --- a/_addons_bindings/zwave/doc/homeseer/hswd100_0_0.md +++ b/_addons_bindings/zwave/doc/homeseer/hswd100_0_0.md @@ -17,29 +17,35 @@ The HS-WD100+ supports routing. This allows the device to communicate using othe ## 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/346) to improve the documentation. +HS-WD100+ is a Z-Wave wall dimmer that’s designed for wireless on-off-dim control of connected dimmable lighting loads.  + +### Inclusion Information + +Tap the paddle of your new HomeSeer switch to begin the inclusion process. This will take a few moments to complete.  + +### Exclusion Information + +Single click and release the rocker switch.  ## Channels The following table summarises the channels available for the HS-WD100+ -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: | Event ID | Event Description | diff --git a/_addons_bindings/zwave/doc/homeseer/hsws100_0_0.md b/_addons_bindings/zwave/doc/homeseer/hsws100_0_0.md index bd9891740..75e2c5524 100644 --- a/_addons_bindings/zwave/doc/homeseer/hsws100_0_0.md +++ b/_addons_bindings/zwave/doc/homeseer/hsws100_0_0.md @@ -8,6 +8,8 @@ title: HS-WS100+ - ZWave # HS-WS100+ Scene Capable Wall Switch This describes the Z-Wave device *HS-WS100+*, manufactured by *[HomeSeer Technologies](http://www.homeseer.com/)* with the thing type UID of ```homeseer_hsws100_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + ![HS-WS100+ product image](https://www.cd-jackson.com/zwave_device_uploads/351/351_default.jpg) @@ -15,28 +17,34 @@ The HS-WS100+ supports routing. This allows the device to communicate using othe ## 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/351) to improve the documentation. +HS-WS100+ is a Z-Wave wall switch that’s designed for wireless on-off control of connected lighting and appliance loads.  + +### Inclusion Information + +Tap the paddle of your new HomeSeer switch to begin the inclusion process. This will take a few moments to complete. + +### Exclusion Information + +Single click and release the rocker switch.   ## Channels The following table summarises the channels available for the HS-WS100+ -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: | Event ID | Event Description | diff --git a/_addons_bindings/zwave/doc/honeywell/39339_0_0.md b/_addons_bindings/zwave/doc/honeywell/39339_0_0.md index e18d8b13a..0506aea36 100644 --- a/_addons_bindings/zwave/doc/honeywell/39339_0_0.md +++ b/_addons_bindings/zwave/doc/honeywell/39339_0_0.md @@ -41,23 +41,21 @@ Press and release the manual/program button. The following table summarises the channels available for the 39339 (ZW3107) -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. @@ -208,7 +206,7 @@ Association group 3 supports 5 nodes. |---------------|---------| | COMMAND_CLASS_NO_OPERATION_V1| | | COMMAND_CLASS_BASIC_V1| | -| COMMAND_CLASS_SWITCH_MULTILEVEL_V2| | +| COMMAND_CLASS_SWITCH_MULTILEVEL_V2| Linked to BASIC| | COMMAND_CLASS_SWITCH_ALL_V1| | | COMMAND_CLASS_SCENE_ACTIVATION_V1| | | COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | diff --git a/_addons_bindings/zwave/doc/honeywell/39349_0_0.md b/_addons_bindings/zwave/doc/honeywell/39349_0_0.md index 493a526c5..fd4dba543 100644 --- a/_addons_bindings/zwave/doc/honeywell/39349_0_0.md +++ b/_addons_bindings/zwave/doc/honeywell/39349_0_0.md @@ -42,12 +42,12 @@ The following table summarises the channels available for the 39349 -: ### Switch Switch the power on and off. -The ```switch_binary``` channel and is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number Triggers when a scene button is pressed. -The ```scene_number``` channel and is of type ```scene_number``` and supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. @@ -127,7 +127,7 @@ Association group 3 supports 5 nodes. |---------------|---------| | COMMAND_CLASS_NO_OPERATION_V1| | | COMMAND_CLASS_BASIC_V1| | -| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_SWITCH_ALL_V1| | | COMMAND_CLASS_SCENE_ACTIVATION_V1| | | COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | diff --git a/_addons_bindings/zwave/doc/honeywell/39351_0_0.md b/_addons_bindings/zwave/doc/honeywell/39351_0_0.md index 72296be08..8b2655f97 100644 --- a/_addons_bindings/zwave/doc/honeywell/39351_0_0.md +++ b/_addons_bindings/zwave/doc/honeywell/39351_0_0.md @@ -56,12 +56,12 @@ The following table summarises the channels available for the 39351 / Jasco ZW30 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 and is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number Triggers when a scene button is pressed. -The ```scene_number``` channel and is of type ```scene_number``` and supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. diff --git a/_addons_bindings/zwave/doc/honeywell/39358_0_0.md b/_addons_bindings/zwave/doc/honeywell/39358_0_0.md index 0c293e96e..e2b234d25 100644 --- a/_addons_bindings/zwave/doc/honeywell/39358_0_0.md +++ b/_addons_bindings/zwave/doc/honeywell/39358_0_0.md @@ -70,29 +70,63 @@ Quickly press ON (Top) button three (3) times then immediately press the OFF (Bo The following table summarises the channels available for the 39358 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 1 configuration parameters available in the 39358. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 4 | Invert Switch | Invert Switch | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 4: Invert Switch + +Invert Switch +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Default | +| 1 | Invert | + +The manufacturer defined default value is ```0``` (Default). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups diff --git a/_addons_bindings/zwave/doc/honeywell/zw4201_0_0.md b/_addons_bindings/zwave/doc/honeywell/zw4201_0_0.md index 9b4bddbd6..1211305b2 100644 --- a/_addons_bindings/zwave/doc/honeywell/zw4201_0_0.md +++ b/_addons_bindings/zwave/doc/honeywell/zw4201_0_0.md @@ -35,22 +35,20 @@ If your Z-Wave certified controller features remote access, you can now control The following table summarises the channels available for the Plug-in Outdoor Smart Switch -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. @@ -62,7 +60,26 @@ The device has no configuration parameters defined. Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The Plug-in Outdoor Smart Switch supports 3 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: Local Load + +Supports Basic Set and is controlled with the local load. + +Association group 2 supports 5 nodes. + +### Group 3: Double Press on/off + +Supports Basic Set and is controlled by double pressing on/off button. + +Association group 3 supports 5 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/horstmann/asrzw_0_0.md b/_addons_bindings/zwave/doc/horstmann/asrzw_0_0.md index 48498c082..f0faeca5a 100644 --- a/_addons_bindings/zwave/doc/horstmann/asrzw_0_0.md +++ b/_addons_bindings/zwave/doc/horstmann/asrzw_0_0.md @@ -8,32 +8,72 @@ title: ASR-ZW - ZWave # ASR-ZW Thermostat Receiver This describes the Z-Wave device *ASR-ZW*, manufactured by *Horstmann Controls Limited* with the thing type UID of ```horstmann_asrzw_00_000```. +The device is in the category of *HVAC*, defining Air condition devices, Fans. + +![ASR-ZW product image](https://www.cd-jackson.com/zwave_device_uploads/310/310_default.png) + + The ASR-ZW 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 between other devices in the mesh network. ## 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/310) to improve the documentation. +The ASR–ZW receiver unit receives the Z-Wave radio signals from the HRT4–ZW room thermostat. In the unlikely event of a communication failure it is possible to override the system and switch On and Off using the On/Off buttons on the ASR-ZW receiver as a local override. + +If the override is used to override the HRT4-ZW thermostat when it is functioning correctly then the override will be cancelled by the next switching operation of the thermostat and normal operation will be resumed. In any case, with no further intervention, normal operation will be restored within one hour of the override being operated. + +### Inclusion Information + +# Stage 1 + + 1. Set the number 1 DIL switch on the back of the HRT4-ZW thermostat to the On (Up) position and the display on the HRT4-ZW will change to show the letter ‘I’. If the letter ‘L’ appears, carry out stage 1A opposite. + 2. Power up the ASR-ZW receiver unit + 3. The network LED on the ASR-ZW receiver should be flashing. + 4. Press the dial on the front of the HRT4-ZW thermostat once so that the ‘I’ in the display flashes. + 5. Press and hold the network button on the ASR-ZW receiver until the On indicator flashes (green) before the Off indicator becomes solid red. + + 6. After a few seconds the radio mast symbol will appear in the display along with the letters IP. + 7. Reset the number 1 DIL switch on the back of the HRT4-ZW to the Off position and the temperature should return in the display. + 8. Now check the receiver responds to the thermostat on and off commands by increasing and decreasing the temperature settings until it switches accordingly. **N.B.** There is a half second delay in switching On and Off on receipt of the command. + 9. The Z-Wave communication link is now successfully established + +# Stage 1A – Only used if ‘L’ is displayed instead of ‘I’ + + 1.  Turn the dial of the HRT4-ZW until the letter P appears in the display. + 2.  Press the dial twice. + 3.  A second P should appear in the display which now shows \`PP’. + 4.  Turn the dial until the letter ‘I’ appears in the display and return to Stage 1 instruction. + +# Stage 2 – Only used if the above procedure does not establish a successful communication link + + 1. Turn the dial until the letter P appears in the display. + 2. Press the dial twice and PP should appear in the display. + 3. Now turn the dial until letter E appears in the display. + 4. Press the dial once and the display should flash. + 5. Press and hold the network button on the ASR-ZW receiver until it starts to flash. 6 + 6. Turn the dial until the letter \`I’ appears in the display and return to the main instruction. + +### Exclusion Information + +Not Provided ## Channels The following table summarises the channels available for the ASR-ZW -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Thermostat mode | thermostat_mode | Temperature | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | diff --git a/_addons_bindings/zwave/doc/horstmann/c17zw_0_0.md b/_addons_bindings/zwave/doc/horstmann/c17zw_0_0.md index a78289f8d..4c5b99a2d 100644 --- a/_addons_bindings/zwave/doc/horstmann/c17zw_0_0.md +++ b/_addons_bindings/zwave/doc/horstmann/c17zw_0_0.md @@ -8,6 +8,8 @@ title: C17-ZW - ZWave # C17-ZW Timeswitch This describes the Z-Wave device *C17-ZW*, manufactured by *Horstmann Controls Limited* with the thing type UID of ```horstmann_c17zw_00_000```. +The device is in the category of *HVAC*, defining Air condition devices, Fans. + ![C17-ZW product image](https://www.cd-jackson.com/zwave_device_uploads/652/652_default.jpg) @@ -15,21 +17,30 @@ The C17-ZW supports routing. This allows the device to communicate using other r ## 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/652) to improve the documentation. +The CentaurPlus ZW is a timeswitch which is connected to its own room thermostat - the HRT4-ZW - using the latest Z-wave wireless technology.  + +Where it has been used to replace your existing time control it is likely that there was no room thermostat fitted previously + +### Inclusion Information + +For inclusion, put the controller in inclusion mode and press and hold the 'Boost' and 'Enter' buttons on the front of the CENTAURPLUS C17-ZW . Once included the indicator next to the radio symbol will appear (solid)   + +### Exclusion Information + +For exclusion put the controller in exclusion mode and Press and hold the 'Boost' and 'Enter' buttons on the front of the CENTAURPLUS C17-ZW until an indicator disappears in its display against the radio aerial symbol ## Channels The following table summarises the channels available for the C17-ZW -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -60,6 +71,7 @@ The device does not support associations. ### Documentation Links * [User Manual](https://www.cd-jackson.com/zwave_device_uploads/652/user-guide-CentaurPlus-ZW--C17ZW-and-HRT4-ZW.pdf) +* [Installation Instructions](https://www.cd-jackson.com/zwave_device_uploads/652/installer-guide-CentaurPlus-ZW--c17zw-and-hrt4zw.pdf) --- diff --git a/_addons_bindings/zwave/doc/horstmann/ses302_0_0.md b/_addons_bindings/zwave/doc/horstmann/ses302_0_0.md index c3e9b30ac..834fc26b3 100644 --- a/_addons_bindings/zwave/doc/horstmann/ses302_0_0.md +++ b/_addons_bindings/zwave/doc/horstmann/ses302_0_0.md @@ -19,60 +19,69 @@ The SES 302 does not permanently listen for messages sent from the controller - ## Overview + The SES 302 measures temperature whilst the SES 303 measures temperature and humidity. The sensors are battery-operated devices which transmit information to an associated device in a network. + +### Inclusion Information + +Press and hold SES 302/ SES 303 button for more than 1 second and then release. + +### Exclusion Information + +Not Provided + ### Wakeup Information The SES 302 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. + +Sending Node Information + +Press and hold SES 302/303 button for more than 1 second and then release. + ## Channels The following table summarises the channels available for the SES 302 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Battery Level | battery-level | Battery | Number | -| Sensor (temperature) 1 | sensor_temperature1 | Temperature | Number:Temperature | -| Battery Level | battery-level | Battery | Number | -| Sensor (temperature) 2 | sensor_temperature2 | Temperature | Number:Temperature | -| Sensor (temperature) 3 | sensor_temperature3 | Temperature | Number:Temperature | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Sensor (temperature) 1 | sensor_temperature1 | sensor_temperature | Temperature | Number:Temperature | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Sensor (temperature) 2 | sensor_temperature2 | sensor_temperature | Temperature | Number:Temperature | +| Sensor (temperature) 3 | sensor_temperature3 | sensor_temperature | Temperature | Number:Temperature | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Sensor (temperature) 1 - Indicates the current temperature. -The ```sensor_temperature1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature1``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Battery Level - 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 ```battery-level1``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level1``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Sensor (temperature) 2 - Indicates the current temperature. -The ```sensor_temperature2``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature2``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (temperature) 3 - Indicates the current temperature. -The ```sensor_temperature3``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature3``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. @@ -141,7 +150,15 @@ This parameter has the configuration ID ```wakeup_node``` and is of type ```INTE Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The SES 302 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. +Z-Wave Plus Lifeline, in which multilevel sensor report, Battery low alarm are reported. Each endpoint supports 1 association group. + +Association group 1 supports 2 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/horstmann/ses303_0_0.md b/_addons_bindings/zwave/doc/horstmann/ses303_0_0.md index cfd1f1678..b3fc60a6e 100644 --- a/_addons_bindings/zwave/doc/horstmann/ses303_0_0.md +++ b/_addons_bindings/zwave/doc/horstmann/ses303_0_0.md @@ -19,40 +19,54 @@ The SES 303 does not permanently listen for messages sent from the controller - ## Overview +The Environmental Sensor (SES 303) measures temperature and humidity. The sensors are battery-operated devices which transmit information to an associated device in a network. It can support either 1 thermistor (SES 001) or up to 4 external digital temperature sensors (SES 002/003). SES 303 operates on 2x AA batteries, providing a nominal life of 2 years (with on-board sensors operating with the default configuration). + +### Inclusion Information + +On the SES 303, press the button, hold and release after 1 second to send a request (Network Information Frame) to join the network. + +On successful inclusion the LED will flash 2 times. The total process can take up to 20 seconds. If the LED flashes 4-times this means that the inclusion process has failed, so try moving the SES 303 to another position and repeat the Inclusion steps. If the inclusion process fails again, the device may be already included in another network. So first exclude and then include the device. The controller will show when the inclusion operation is successful. + +### Exclusion Information + +On the SES 303, press the button, hold and release after 1 second to send a request (Network Information Frame) to remove from the network. + +On successful exclusion the LED will flash 2 times. The total process can take up to 2 seconds. If the LED flashes 4-times this means that the exclusion process has failed, so try moving the SES 303 to another position and repeat the exclusion steps. The controller will show when the exclusion operation is successful. + ### Wakeup Information The SES 303 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. + +Device can be wakeup by button press of more then one second, devcie will stay in wakeup state for about 10 seconds + ## Channels The following table summarises the channels available for the SES 303 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Sensor (relative humidity) | sensor_relhumidity | Humidity | Number | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) - Indicates the current relative humidity. -The ```sensor_relhumidity``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -159,7 +173,15 @@ This parameter has the configuration ID ```wakeup_node``` and is of type ```INTE Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The SES 303 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. +Z-Wave Plus Lifeline, in which multilevel sensor report, Battery low alarm are reported. Each endpoint supports 1 association group. + +Association group 1 supports 2 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/horstmann/srt323_0_0.md b/_addons_bindings/zwave/doc/horstmann/srt323_0_0.md index c256e0d8a..82dfa5eab 100644 --- a/_addons_bindings/zwave/doc/horstmann/srt323_0_0.md +++ b/_addons_bindings/zwave/doc/horstmann/srt323_0_0.md @@ -19,33 +19,48 @@ The SRT323 does not permanently listen for messages sent from the controller - i ## Overview +The SRT323 has been developed to control central heating systems where the demand temperature can be set locally or remotely by a third party device. The SRT323 also has the capability to act as a temperature sensor + +### Inclusion Information + +Set DIL switch 1 to ’ON’ position on the back of the unit, scroll through the function menu by rotating the dial until **L** is displayed + +Once the character starts flashing the installer has 60 sec to activate the 3rd party unit. Once the 3rd party unit has been activated the process must be completed within 240 sec or SRT323 will timeout. Preferably, start the process to add a node from the controller then press the dial of the SRT323 + +### Exclusion Information + +Not Provided + ### Wakeup Information The SRT323 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. + +Not Provided + ## Channels The following table summarises the channels available for the SRT323 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Operating State | thermostat_state | Temperature | Number | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Sensor (temperature) Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -68,7 +83,7 @@ The following state translation is provided for this channel to the ```Number``` ### Operating State Sets the thermostat operating state. -The ```thermostat_state``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -84,13 +99,13 @@ The following state translation is provided for this channel to the ```Number``` ### Setpoint (heating) Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Battery Level 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/horstmann/swm301_0_0.md b/_addons_bindings/zwave/doc/horstmann/swm301_0_0.md index 36bb0a92a..b25b4ae9f 100644 --- a/_addons_bindings/zwave/doc/horstmann/swm301_0_0.md +++ b/_addons_bindings/zwave/doc/horstmann/swm301_0_0.md @@ -8,6 +8,8 @@ title: SWM301 - ZWave # SWM301 Z-Wave Module for Water Meter This describes the Z-Wave device *SWM301*, manufactured by *Horstmann Controls Limited* with the thing type UID of ```horstmann_swm301_00_000```. +The device is in the category of *Sensor*, defining Device used to measure something. + ![SWM301 product image](https://www.cd-jackson.com/zwave_device_uploads/459/459_default.jpg) @@ -28,6 +30,13 @@ The RF module records the meter reading by backlash-free pick-up on the litre wh 3. Repeat the step 2 if LED is not flashed once. 4. The controller will indicate the successful inclusion/ exclusion operation. +### Exclusion Information + + 1. Put network controller in Inclusion / Exclusion mode. + 2. Hold a small magnet near to reed switch until the LED is turned on. Remove magnet right away when LED turned on. LED will remain on for next 4 seconds and then it will flash once to indicate NIF is sent. + 3. Repeat the step 2 if LED is not flashed once. + 4. The controller will indicate the successful inclusion/ exclusion operation. + ### Wakeup Information The SWM301 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. @@ -43,36 +52,32 @@ SWM301 will wake up for 10 seconds after sending NIF The following table summarises the channels available for the SWM301 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Water meter (amps) | meter_water_cubic_meters | Energy | Number | -| Battery Level | battery-level | Battery | Number | -| Alarm (heat) | alarm_heat | | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Water meter (amps) | meter_water_cubic_meters | meter_water_cubic_meters | Water | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Alarm (heat) | alarm_heat | alarm_heat | Fire | Switch | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Water meter (amps) - Indicates the instantaneous water consumption. -The ```meter_water_cubic_meters``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_water_cubic_meters``` channel is of type ```meter_water_cubic_meters``` and supports the ```Number``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Alarm (heat) - Indicates if a heat alarm is triggered. -The ```alarm_heat``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_heat``` channel is of type ```alarm_heat``` and supports the ```Switch``` item and is in the ```Fire``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: diff --git a/_addons_bindings/zwave/doc/icontrol/pipernv_0_0.md b/_addons_bindings/zwave/doc/icontrol/pipernv_0_0.md new file mode 100644 index 000000000..94a1c2d7d --- /dev/null +++ b/_addons_bindings/zwave/doc/icontrol/pipernv_0_0.md @@ -0,0 +1,68 @@ +--- +layout: documentation +title: Piper NV - ZWave +--- + +{% include base.html %} + +# Piper NV Piper NV Security camera / sensor +This describes the Z-Wave device *Piper NV*, manufactured by *Icontrol Networks* with the thing type UID of ```icontrol_pipernv_00_000```. + +![Piper NV product image](https://www.cd-jackson.com/zwave_device_uploads/538/538_default.png) + + +The Piper NV 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 between other devices in the mesh network. + +## Overview + +Piper is a smart home security system with no required monthly fees that you control from your mobile device. It combines advanced video monitoring technology with valuable sensor information to immediately alert you of what’s going on while you’re away. + +## Channels + +The following table summarises the channels available for the Piper NV -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| + + + +## Device Configuration + +The device has no configuration parameters defined. + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The device does not support associations. +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| Linked to BASIC| +| COMMAND_CLASS_APPLICATION_STATUS_V1| | +| COMMAND_CLASS_CRC_16_ENCAP_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_ASSOCIATION_V1| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_SECURITY_V1| | + +### Documentation Links + +* [Command Classes](https://www.cd-jackson.com/zwave_device_uploads/538/ZC10-16115326.pdf) +* [Z-wave conformance](https://www.cd-jackson.com/zwave_device_uploads/538/pics.pdf) +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/538/PIP-UserManualContent-291116-0905-386.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/538). diff --git a/_addons_bindings/zwave/doc/idlock/idl150_0_0.md b/_addons_bindings/zwave/doc/idlock/idl150_0_0.md index 199acacc6..b000e3ab8 100644 --- a/_addons_bindings/zwave/doc/idlock/idl150_0_0.md +++ b/_addons_bindings/zwave/doc/idlock/idl150_0_0.md @@ -7,6 +7,7 @@ title: ID-150 - ZWave # ID-150 Z wave module for ID Lock 150 and 101 This describes the Z-Wave device *ID-150*, manufactured by *ID Lock AS* with the thing type UID of ```idlock_idl150_00_000```. +This version of the device is limited to firmware versions below 1.5 The device is in the category of *Lock*, defining Devices whose primary pupose is locking something. @@ -53,19 +54,20 @@ Configuration parameters 2 RFID Registration Configuration and 10 Retrieve RFID The following table summarises the channels available for the ID-150 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Door Lock | lock_door | Door | Switch | -| Entry Notification | alarm_entry | Door | Switch | -| Alarm (emergency) | alarm_emergency | | Switch | -| Alarm (burglar) | alarm_burglar | Door | Switch | -| Alarm (raw) | alarm_raw | | String | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Door Lock | lock_door | lock_door | Door | Switch | +| Door State [Deprecated]| sensor_door | sensor_door | Door | Contact | +| Entry Notification | alarm_entry | alarm_entry | Door | Switch | +| Alarm (emergency) | alarm_emergency | alarm_emergency | Alarm | Switch | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | +| Alarm (raw) | alarm_raw | alarm_raw | | String | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Door Lock Lock and unlock the door. -The ```lock_door``` channel supports the ```Switch``` item and is in the ```Door``` category. +The ```lock_door``` channel is of type ```lock_door``` and supports the ```Switch``` item and is in the ```Door``` category. The following state translation is provided for this channel to the ```Switch``` item type -: | Value | Label | @@ -73,10 +75,24 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Locked | | OFF | Unlocked | +### Door State [Deprecated] +Indicates if the door/window is open or closed. + +The ```sensor_door``` channel is of type ```sensor_door``` and supports the ```Contact``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Contact``` item type -: + +| Value | Label | +|-------|-----------| +| OPEN | Open | +| CLOSED | Closed | + +**Note:** This channel is marked as deprecated so should not be used. + ### Entry Notification Indicates if the entry alarm is triggered. -The ```alarm_entry``` 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. +The ```alarm_entry``` channel is of type ```alarm_entry``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -88,7 +104,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Alarm (emergency) Indicates Police, Fire, or Medical services should be contacted. -The ```alarm_emergency``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_emergency``` channel is of type ```alarm_emergency``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -100,7 +116,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Alarm (burglar) Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -112,13 +128,13 @@ The following state translation is provided for this channel to the ```Switch``` ### Alarm (raw) Provides alarm parameters as json string. -The ```alarm_raw``` channel supports the ```String``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_raw``` channel is of type ```alarm_raw``` and supports the ```String``` item. This is a read only channel so will only be updated following state changes from the device. This channel sets, and provides the alarm state as a JSON string. It is designed for use in rules. ### Battery Level 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/idlock/idl150new_1_6.md b/_addons_bindings/zwave/doc/idlock/idl150new_1_6.md new file mode 100644 index 000000000..bf10637e2 --- /dev/null +++ b/_addons_bindings/zwave/doc/idlock/idl150new_1_6.md @@ -0,0 +1,311 @@ +--- +layout: documentation +title: ID-150 - ZWave +--- + +{% include base.html %} + +# ID-150 Z wave module for ID Lock 150 and 101 +This describes the Z-Wave device *ID-150*, manufactured by *ID Lock AS* with the thing type UID of ```idlock_idl150new_01_006```. +This version of the device is limited to firmware versions above 1.6 + +The device is in the category of *Lock*, defining Devices whose primary pupose is locking something. + +![ID-150 product image](https://www.cd-jackson.com/zwave_device_uploads/1106/1106_default.png) + + +The ID-150 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. + +## Overview + +The ID Lock Z-wave module is a security enabled Z-wave Plus product that is able to use encrypted Z-wave Plus messages in order to communicate to other Z-wave Plus products enabled security. + +The module is proprietary for the ID Lock 150 and also backwards compatible with the ID Lock 101. The ID Lock Z-wave module must be used in conjunction with a Security Enabled Z-wave Controller in order to fully utilize their full capability. + +The ID Lock Z-wave module can be included and operated in any Z-wave network containing certified other Z-wave products regardless of manufacturer. The ID Lock Z-wave module does not support the Basic Set Command Class. + +### Inclusion Information + + 1. Bring the controller as close as possible to the lock unit + 2. Set the controller to inclusion mode + 3. Push and hold KEY button on the inside panel on the lock until all keys on the outside light up and a audible signal is given. + 4. Release the KEY button on the inside panel + 5. Enter your Master PIN and press *  + 6. Click 2 and then * + 7. Click 5, don't press * + 8. The LED flashes blue when inclusion is in progress + 9. The inclusion may take some time as security is required + +### Exclusion Information + + 1. Set the controller to Exclusion mode + 2. Push and hold KEY button on the inside panel on the lock until all keys on the outside light up and a audible signal is given. + 3. Release the KEY button on the inside panel + 4. Enter your Master PIN and press *  + 5. Click 2 and then * + 6. Click 5, don't press * + 7. The LED flashes blue when exclusion is in progress + +### General Usage Information + +Configuration parameters 2 RFID Registration Configuration and 10 Retrieve RFID Information have not been added since they are only valid for the 101 model.  + +## Channels + +The following table summarises the channels available for the ID-150 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Door Lock | lock_door | lock_door | Door | Switch | +| Door State | sensor_door | sensor_door | Door | Contact | +| Alarm (access) | alarm_access | alarm_access | Door | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | + +### Door Lock +Lock and unlock the door. + +The ```lock_door``` channel is of type ```lock_door``` and supports the ```Switch``` item and is in the ```Door``` category. +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| ON | Locked | +| OFF | Unlocked | + +### Door State +Indicates if the door/window is open or closed. + +The ```sensor_door``` channel is of type ```sensor_door``` and supports the ```Contact``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Contact``` item type -: + +| Value | Label | +|-------|-----------| +| OPEN | Open | +| CLOSED | Closed | + +### Alarm (access) +Indicates if the access control alarm is triggered. + +The ```alarm_access``` channel is of type ```alarm_access``` and 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. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + +### Battery Level +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 is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. + + +## Device Configuration + +The following table provides a summary of the 7 configuration parameters available in the ID-150. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Door lock mode | Set if the lock is in away mode and if automatic locking should be enabled | +| 2 | RFID Mode | RFID Mode | +| 3 | Door Hinge Position Mode | Tell the lock which side your hinges are on seen from the outside | +| 4 | Door Audio Volume Level | Set the Audio Volume Level of the Lock | +| 5 | Door ReLock Mode | Sets if the door should relock or not | +| 6 | Service PIN Mode | Sets the validity of the service PIN | +| 7 | Door Lock Model Type | Sends information if the model of the lock is 101 or 150 | +| | Lock Timeout | Sets the time after which the door will auto lock | + +### Parameter 1: Door lock mode + +Set if the lock is in away mode and if automatic locking should be enabled +Auto lock Mode, Manual lock mode, Activate Away Mode, Deactivate Away Mode. + +If value is 0x02 (Enable Away, Manual lock) and the door is unlocked value will be set to 0x00. + +If value is 0x03 (Enable Away, Auto lock) and the door is unlocked value will be set to 0x01. + + Default Value: 1 (Disable Away/Auto Lock Mode) +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disable Away Manual Lock | +| 1 | Disable Away Auto Lock | +| 2 | Enable Away Manual Lock | +| 3 | Enable Away Auto Lock | + +The manufacturer defined default value is ```1``` (Disable Away Auto Lock). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: RFID Mode + +RFID Mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 5 | RFID activated | +| 9 | RFID deactivated | + +The manufacturer defined default value is ```5``` (RFID activated). + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Door Hinge Position Mode + +Tell the lock which side your hinges are on seen from the outside + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Right hinged operation | +| 1 | Left hinged operation | + +The manufacturer defined default value is ```0``` (Right hinged operation). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Door Audio Volume Level + +Set the Audio Volume Level of the Lock + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | No sound | +| 1 | Level 1 | +| 2 | Level 2 | +| 3 | Level 3 | +| 4 | Level 4 | +| 5 | Level 5 (Default) | +| 6 | Max. sound level | + +The manufacturer defined default value is ```5``` (Level 5 (Default)). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 5: Door ReLock Mode + +Sets if the door should relock or not +With this configuration ID Lock can automatically relock the door if an already locked door gets unlocked, but remains unopened. This is avoided by deactivating relocking. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Enabled | + +The manufacturer defined default value is ```1``` (Enabled). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 6: Service PIN Mode + +Sets the validity of the service PIN +A configuration get command on this parameter returns the latest set parameter value (set by Z-wave). + +This is a set only value, if changed locally on keypad these values are not changed on Z-wave module. Value 5 and 6 are for future use on door lock. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Deactivated | +| 1 | Valid 1 time | +| 2 | Valid 2 times | +| 3 | Valid 5 times | +| 4 | Valid 10 times | +| 7 | Always Valid | +| 8 | Valid for 12h | +| 9 | Valid for 24h | +| 254 | Disabled | + +The manufacturer defined default value is ```0``` (Deactivated). + +This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```. + + +### Parameter 7: Door Lock Model Type + +Sends information if the model of the lock is 101 or 150 +This configuration is only accepted by configuration get command + +It is a read only parameter. Default value depends on the door lock model type. + +101 = ID Lock 101 + +150 = ID Lock 150 +Values in the range 0 to 0 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. +This is a read only parameter. + +### Lock Timeout + +Sets the time after which the door will auto lock. + +This parameter has the configuration ID ```doorlock_timeout``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The ID-150 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. +Notification Reports are sent out unsolicated to device included in the association group. + +Association group 1 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_DOOR_LOCK_V1| | +| COMMAND_CLASS_USER_CODE_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V4| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_BATTERY_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_SECURITY_V1| | + +### Documentation Links + +* [Firmware Release Notes](https://www.cd-jackson.com/zwave_device_uploads/1106/Versjonshistorikk-----ID-Lock.pdf) +* [ID Lock 150 installation and user manual](https://www.cd-jackson.com/zwave_device_uploads/1106/ID-Lock-150-installation-and-user-manual.pdf) +* [ID Lock 150 Z wave manual](https://www.cd-jackson.com/zwave_device_uploads/1106/IDLock150-ZWave-UserManual-v2-1.pdf) +* [ZWave user manual v3.02 (FW 1.6)](https://www.cd-jackson.com/zwave_device_uploads/1106/IDLock150-ZWave-UserManual-v3-02.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1106). diff --git a/_addons_bindings/zwave/doc/ingersollecolink/dwzwave1_0_0.md b/_addons_bindings/zwave/doc/ingersollecolink/dwzwave1_0_0.md index 266e1aa05..0e72bed1c 100644 --- a/_addons_bindings/zwave/doc/ingersollecolink/dwzwave1_0_0.md +++ b/_addons_bindings/zwave/doc/ingersollecolink/dwzwave1_0_0.md @@ -8,33 +8,52 @@ title: DWZWAVE1 - ZWave # DWZWAVE1 Z-Wave Door/Window Sensor This describes the Z-Wave device *DWZWAVE1*, manufactured by *Ingersoll Rand (was Ecolink)* with the thing type UID of ```ingersollecolink_dwzwave1_00_000```. +The device is in the category of *Door*, defining Door sensors. + +![DWZWAVE1 product image](https://www.cd-jackson.com/zwave_device_uploads/135/135_default.png) + + The DWZWAVE1 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 DWZWAVE1 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. Refer to the *Wakeup Information* section below for further information. ## Overview +Monitor activities at your home with this Z-Wave Door and Window Sensor.  Choose to receive mobile or email alerts when a door or window is opened.  Use the Door/Window sensor to trigger video recording or turn on the lights.  View the status of the sensor from your smartphone, tablet, or computer. + +### Inclusion Information + +Remove the battery for 10 seconds and replace the battery to restart enrollment mode. + +### Exclusion Information + + 1. Remove the battery from the Sensor. + 2. Leave the battery out for at least ten (10) seconds. + 3. Reinstall the battery into the Sensor. + ### Wakeup Information The DWZWAVE1 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. + +Press the "+" button once. + ## Channels The following table summarises the channels available for the DWZWAVE1 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Alarm (burglar) | alarm_burglar | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -44,10 +63,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Alarm (burglar) - Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -57,22 +75,72 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 1 configuration parameters available in the DWZWAVE1. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 99 | Fault Restore Report | Fault Restore Report | +| | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | +| | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | + +### Parameter 99: Fault Restore Report + +Fault Restore Report +Enable or disable Basic Sets of 0x00 on a fault restore to nodes in Group 2. Default = Enabled. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 255 | Enabled | + +The manufacturer defined default value is ```255``` (Enabled). + +This parameter has the configuration ID ```config_99_1``` and is of type ```INTEGER```. + +### Wakeup Interval + +The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications. + +This setting is defined in *seconds*. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances. + +Note that this setting does not affect the devices ability to send sensor data, or notification events. + +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_node``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The DWZWAVE1 supports 2 association groups. + +### Group 1: Group 1 + + +Association group 1 supports 5 nodes. + +### Group 2: Group 2 + + +Association group 2 supports 5 nodes. + ## Technical Information ### Endpoints @@ -92,6 +160,10 @@ The device does not support associations. | COMMAND_CLASS_ASSOCIATION_V2| | | COMMAND_CLASS_VERSION_V1| | +### Documentation Links + +* [Installation Instructions](https://www.cd-jackson.com/zwave_device_uploads/135/D-W-Sensor-Installation-Instructions.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/ingersollecolink/rs200_0_0.md b/_addons_bindings/zwave/doc/ingersollecolink/rs200_0_0.md index 9c670a228..ef05e5590 100644 --- a/_addons_bindings/zwave/doc/ingersollecolink/rs200_0_0.md +++ b/_addons_bindings/zwave/doc/ingersollecolink/rs200_0_0.md @@ -8,12 +8,32 @@ title: RS200 - ZWave # RS200 Schlage PIR Motion Sensor This describes the Z-Wave device *RS200*, manufactured by *Ingersoll Rand (was Ecolink)* with the thing type UID of ```ingersollecolink_rs200_00_000```. +The device is in the category of *Sensor*, defining Device used to measure something. + +![RS200 product image](https://www.cd-jackson.com/zwave_device_uploads/695/695_default.png) + + The RS200 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 RS200 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. Refer to the *Wakeup Information* section below for further information. ## Overview + * Wireless Z-Wave™ enabled motion sensor + * Detection area is approximately 30 x 39’ area (9 x 12 meters) + +### Inclusion Information + + * Use a pin or paper clip to press the program button on the back of the Sensor case. + * During enrollment, the Bridge’s LED will change from slow to rapid blinking. + * When enrollment is successful, the Bridge’s orange LED will light solid, and the Sensor’s LED will turn off. + +### Exclusion Information + + * Use a pin or paper clip to press the program button on the back of the Sensor case. + * Observe lights on the Bridge. The orange light will blink while exclusion is taking place. Exclusion is complete when the orange light becomes solid. + * Remove the battery from the Sensor after exclusion is complete. + ### Wakeup Information The RS200 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. @@ -24,17 +44,16 @@ The wakeup period does not impact the devices ability to report events or sensor The following table summarises the channels available for the RS200 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Alarm (burglar) | alarm_burglar | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -44,10 +63,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Alarm (burglar) - Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -57,11 +75,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -92,6 +109,10 @@ The device does not support associations. | COMMAND_CLASS_ASSOCIATION_V2| | | COMMAND_CLASS_VERSION_V1| | +### Documentation Links + +* [User Guide](https://www.cd-jackson.com/zwave_device_uploads/695/Download-the-Schlage-Motion-Sensor-User-Guide-Here-1.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/ingersollecolink/tiltzwave1_0_0.md b/_addons_bindings/zwave/doc/ingersollecolink/tiltzwave1_0_0.md new file mode 100644 index 000000000..2434b96c4 --- /dev/null +++ b/_addons_bindings/zwave/doc/ingersollecolink/tiltzwave1_0_0.md @@ -0,0 +1,83 @@ +--- +layout: documentation +title: TILTZWAVE1 - ZWave +--- + +{% include base.html %} + +# TILTZWAVE1 Z-Wave Garage Door Sensor +This describes the Z-Wave device *TILTZWAVE1*, manufactured by *Ingersoll Rand (was Ecolink)* with the thing type UID of ```ingersollecolink_tiltzwave1_00_000```. + +The device is in the category of *Garage Door*, defining Garage Door. + +![TILTZWAVE1 product image](https://www.cd-jackson.com/zwave_device_uploads/136/136_default.png) + + +The TILTZWAVE1 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. Refer to the *Wakeup Information* section below for further information. + +## Overview + + * Z-Wave PlusTM enabled device which transmits when a garage door is opened or closed + * Uses a tilt sensor to detect the angle of a door and transmits open/closed status + * Reports tamper condition if cover is removed + +### Inclusion Information + + * Activate inclusion mode for the sensor by inserting the battery. + * When the inclusion process is complete the red LED will turn on for approximately 10 seconds and then it will go out. + * If the LED continues to flash, repeat the inclusion process. + +### Exclusion Information + + * Activate exclusion mode for the sensor by inserting the battery. + * When the exclusion process is complete the red LED will flash continuously. + +### Wakeup Information + +The TILTZWAVE1 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. + +## Channels + +The following table summarises the channels available for the TILTZWAVE1 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| + + + +## Device Configuration + +The device has no configuration parameters defined. + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The TILTZWAVE1 supports 2 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +### Group 2: Group 2 + + +Association group 2 supports 5 nodes. + +## Technical Information + +### Endpoints + + +### Documentation Links + +* [User Guide](https://www.cd-jackson.com/zwave_device_uploads/136/Eco-Link-Tilt-ZWave-Plus-Manual-R1-04-021816kgs.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/136). diff --git a/_addons_bindings/zwave/doc/innovus/00110001_1_0.md b/_addons_bindings/zwave/doc/innovus/00110001_1_0.md index 1faf74769..e4674742c 100644 --- a/_addons_bindings/zwave/doc/innovus/00110001_1_0.md +++ b/_addons_bindings/zwave/doc/innovus/00110001_1_0.md @@ -9,47 +9,58 @@ title: SmartDimmer - ZWave This describes the Z-Wave device *SmartDimmer*, manufactured by *INNOVUS* with the thing type UID of ```innovus_00110001_01_000```. This version of the device is limited to firmware versions above 1.0 +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![SmartDimmer product image](https://www.cd-jackson.com/zwave_device_uploads/62/62_default.png) + + The SmartDimmer 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 between other devices in the mesh network. ## 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/62) to improve the documentation. +The "RAone Smart Dimmer" offers extensive application possibilities. Equipped with a fingertip panel, many lighting scenarios can be covered and also reduce the energy consumption caused by the lamps. Some application examples are the time-controlled, gradual reduction of the light intensity, eg in the children's bedroom or hallways etc. + +The Smart Dimmer can be controlled via various remote controls, such as Bang & Olufsen, Logitech 895 or the INNOVUS "SmoothRemote". The dimmers are also equipped with an integrated "power meter", which determines the energy consumption of the lamps. Connected to the House Control system, the power consumption of all devices connected to the dimmer can be measured. + +### Inclusion Information + + The device is put into learn mode by touching the touchplate.  + +### Exclusion Information + + The device is put into learn mode by touching the touchplate. ## Channels The following table summarises the channels available for the SmartDimmer -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Sensor (Power in watts) | sensor_power | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Sensor (Power in watts) | sensor_power | sensor_power | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Sensor (Power in watts) - Indicates the energy consumption (kWh). -The ```sensor_power``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_power``` channel is of type ```sensor_power``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. diff --git a/_addons_bindings/zwave/doc/innovus/smartpower_0_0.md b/_addons_bindings/zwave/doc/innovus/smartpower_0_0.md index 0867c3ddd..318fd7181 100644 --- a/_addons_bindings/zwave/doc/innovus/smartpower_0_0.md +++ b/_addons_bindings/zwave/doc/innovus/smartpower_0_0.md @@ -8,39 +8,49 @@ title: SmartPower - ZWave # SmartPower RAone SmartPower This describes the Z-Wave device *SmartPower*, manufactured by *INNOVUS* with the thing type UID of ```innovus_smartpower_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![SmartPower product image](https://www.cd-jackson.com/zwave_device_uploads/61/61_default.png) + + The SmartPower 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 between other devices in the mesh network. ## 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/61) to improve the documentation. +For the further reduction of energy consumption INNOVUS offers "RAone SmartPower". This module is an on / off module, which is used in particular to reduce the energy consumption of devices that unnecessarily consume power in "stand-by mode". This module also has a fingertip panel and is also equipped with an internal power meter.  + +### Inclusion Information + +The device is put into learn mode by touching the touchplate. + +### Exclusion Information + +The device is put into learn mode by touching the touchplate. ## Channels The following table summarises the channels available for the SmartPower -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Sensor (power) | sensor_power | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Sensor (power) | sensor_power | sensor_power | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Sensor (power) - Indicates the energy consumption (kWh). -The ```sensor_power``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_power``` channel is of type ```sensor_power``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. @@ -124,6 +134,7 @@ Association group 1 supports 5 nodes. | COMMAND_CLASS_SWITCH_TOGGLE_BINARY_V1| | | COMMAND_CLASS_SENSOR_MULTILEVEL_V2| | | COMMAND_CLASS_METER_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_POWERLEVEL_V1| | | COMMAND_CLASS_PROTECTION_V1| | diff --git a/_addons_bindings/zwave/doc/innovus/smoothremote_0_0.md b/_addons_bindings/zwave/doc/innovus/smoothremote_0_0.md index 705a70070..0eb040d24 100644 --- a/_addons_bindings/zwave/doc/innovus/smoothremote_0_0.md +++ b/_addons_bindings/zwave/doc/innovus/smoothremote_0_0.md @@ -8,30 +8,49 @@ title: SmoothRemote - ZWave # SmoothRemote SmoothRemote This describes the Z-Wave device *SmoothRemote*, manufactured by *INNOVUS* with the thing type UID of ```innovus_smoothremote_00_000```. +The device is in the category of *Remote Control*, defining Any portable or hand-held device that controls the status of something, e.g. remote control, keyfob etc.. + +![SmoothRemote product image](https://www.cd-jackson.com/zwave_device_uploads/440/440_default.png) + + The SmoothRemote 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. Refer to the *Wakeup Information* section below for further information. ## Overview +The company's Z-Wave product portfolio is rounded off with the "SmoothRemote" remote control. This allows all INNOVUS devices as well as other third-party Z-Wave devices to be conveniently controlled from the sofa.  + +The application fields are virtually unlimited. For example, the lights in the entire house can be switched on or off from the living room, unnecessary consumers switched off, or the room temperature in other rooms lowered or increased. All processes can be conveniently and easily set up via the House Control System + +### Inclusion Information + +The remote can be added to or removed from a Z-Wave network by triple clicking the Shift button + +### Exclusion Information + +The remote can be added to or removed from a Z-Wave network by triple clicking the Shift button + ### Wakeup Information The SmoothRemote 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. + +It is possible to make the device send a Wake Up Notification clicking VIII button 4 times + ## Channels The following table summarises the channels available for the SmoothRemote -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -41,17 +60,21 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 0 | Button Press Time | Button Press Time, time for presses on a single button to register as seperate and not part of a sequence, measured in 0.01s. 0 is interpreted as a 1. | -| 1 | Button Multiple Press Time | Button Multiple Press Time, time for presses on multiple buttons to register as seperate and not part of a sequence, measured in 0.01 s. 0 is interpreted as a 1. | -| 2 | Button Hold Time | Button Hold Time, time for presses to register as being held down in 0.01s. 0 is interpreted as a 1. | -| 3 | Network Update Interval | Network Update Interval, time between network updates in 256 seconds. Disabled if 0. | +| 0 | Button Press Time | Button Press Time | +| 1 | Button Multiple Press Time | Button Multiple Press Time | +| 2 | Button Hold Time | Button Hold Time | +| 3 | Network Update Interval | Network Update Interval | | | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | | | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | ### Parameter 0: Button Press Time -Button Press Time, time for presses on a single button to register as seperate and not part of a sequence, measured in 0.01s. 0 is interpreted as a 1. -Warning: All Configuration values have serious effects on the functioning of the device and as such shouldn't be changed unless one is certain of the consequences. +Button Press Time + Time for presses on a single button to register as seperate and not part of a sequence, measured in 0.01s. + +0 is interpreted as a 1. + +**Warning**: All Configuration values have serious effects on the functioning of the device and as such shouldn't be changed unless one is certain of the consequences. Values in the range 0 to 255 may be set. The manufacturer defined default value is ```50```. @@ -61,8 +84,12 @@ This parameter has the configuration ID ```config_0_1``` and is of type ```INTEG ### Parameter 1: Button Multiple Press Time -Button Multiple Press Time, time for presses on multiple buttons to register as seperate and not part of a sequence, measured in 0.01 s. 0 is interpreted as a 1. -Warning: All Configuration values have serious effects on the functioning of the device and as such shouldn't be changed unless one is certain of the consequences. +Button Multiple Press Time +Time for presses on multiple buttons to register as seperate and not part of a sequence, measured in 0.01 s. + +0 is interpreted as a 1. + +**Warning**: All Configuration values have serious effects on the functioning of the device and as such shouldn't be changed unless one is certain of the consequences. Values in the range 0 to 255 may be set. The manufacturer defined default value is ```100```. @@ -72,8 +99,12 @@ This parameter has the configuration ID ```config_1_1``` and is of type ```INTEG ### Parameter 2: Button Hold Time -Button Hold Time, time for presses to register as being held down in 0.01s. 0 is interpreted as a 1. -Warning: All Configuration values have serious effects on the functioning of the device and as such shouldn't be changed unless one is certain of the consequences.  +Button Hold Time +Time for presses to register as being held down in 0.01s. + +0 is interpreted as a 1. + +**Warning:** All Configuration values have serious effects on the functioning of the device and as such shouldn't be changed unless one is certain of the consequences.  Values in the range 0 to 255 may be set. The manufacturer defined default value is ```40```. @@ -83,8 +114,10 @@ This parameter has the configuration ID ```config_2_1``` and is of type ```INTEG ### Parameter 3: Network Update Interval -Network Update Interval, time between network updates in 256 seconds. Disabled if 0. -Warning: All Configuration values have serious effects on the functioning of the device and as such shouldn't be changed unless one is certain of the consequences.  +Network Update Interval +Time between network updates in 256 seconds. Disabled if 0. + +**Warning:** All Configuration values have serious effects on the functioning of the device and as such shouldn't be changed unless one is certain of the consequences.  Values in the range 0 to 65535 may be set. The manufacturer defined default value is ```168```. @@ -113,7 +146,348 @@ This parameter has the configuration ID ```wakeup_node``` and is of type ```INTE Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The SmoothRemote supports 68 association groups. + +### Group 1: BASIC SET + + +Association group 1 supports 30 nodes. + +### Group 2: BASIC SET + + +Association group 2 supports 30 nodes. + +### Group 3: BASIC SET + + +Association group 3 supports 30 nodes. + +### Group 4: BASIC SET + + +Association group 4 supports 30 nodes. + +### Group 5: BASIC SET + + +Association group 5 supports 30 nodes. + +### Group 6: BASIC SET + + +Association group 6 supports 30 nodes. + +### Group 7: BASIC SET + + +Association group 7 supports 30 nodes. + +### Group 8: SWITCH ALL ON + + +Association group 8 supports 30 nodes. + +### Group 9: HAIL + + +Association group 9 supports 30 nodes. + +### Group 10: BASIC SET + + +Association group 10 supports 30 nodes. + +### Group 11: BASIC SET + + +Association group 11 supports 30 nodes. + +### Group 12: BASIC SET + + +Association group 12 supports 30 nodes. + +### Group 13: BASIC SET + + +Association group 13 supports 30 nodes. + +### Group 14: BASIC SET + + +Association group 14 supports 30 nodes. + +### Group 15: BASIC SET + + +Association group 15 supports 30 nodes. + +### Group 16: BASIC SET + + +Association group 16 supports 30 nodes. + +### Group 17: SWITCH ALL OFF + + +Association group 17 supports 30 nodes. + +### Group 18: HAIL + + +Association group 18 supports 30 nodes. + +### Group 19: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 19 supports 30 nodes. + +### Group 20: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 20 supports 30 nodes. + +### Group 21: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 21 supports 30 nodes. + +### Group 22: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 22 supports 30 nodes. + +### Group 23: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 23 supports 30 nodes. + +### Group 24: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 24 supports 30 nodes. + +### Group 25: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 25 supports 30 nodes. + +### Group 26: HAIL + + +Association group 26 supports 30 nodes. + +### Group 27: HAIL + + +Association group 27 supports 30 nodes. + +### Group 28: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 28 supports 30 nodes. + +### Group 29: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 29 supports 30 nodes. + +### Group 30: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 30 supports 30 nodes. + +### Group 31: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 31 supports 30 nodes. + +### Group 32: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 32 supports 30 nodes. + +### Group 33: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 33 supports 30 nodes. + +### Group 34: SWITCH MULTILEVEL START LEVEL CHANGE + + +Association group 34 supports 30 nodes. + +### Group 35: HAIL + + +Association group 35 supports 30 nodes. + +### Group 36: HAIL + + +Association group 36 supports 30 nodes. + +### Group 37: SWITCH MULTILEVEL STOP LEVEL CHANGE + + +Association group 37 supports 30 nodes. + +### Group 38: SWITCH MULTILEVEL STOP LEVEL CHANGE + + +Association group 38 supports 30 nodes. + +### Group 39: SWITCH MULTILEVEL STOP LEVEL CHANGE + + +Association group 39 supports 30 nodes. + +### Group 40: SWITCH MULTILEVEL STOP LEVEL CHANGE + + +Association group 40 supports 30 nodes. + +### Group 41: SWITCH MULTILEVEL STOP LEVEL CHANGE + + +Association group 41 supports 30 nodes. + +### Group 42: SWITCH MULTILEVEL STOP LEVEL CHANGE + + +Association group 42 supports 30 nodes. + +### Group 43: SWITCH MULTILEVEL STOP LEVEL CHANGE + + +Association group 43 supports 30 nodes. + +### Group 44: HAIL + + +Association group 44 supports 30 nodes. + +### Group 45: HAIL + + +Association group 45 supports 30 nodes. + +### Group 46: HAIL + + +Association group 46 supports 30 nodes. + +### Group 47: HAIL + + +Association group 47 supports 30 nodes. + +### Group 48: HAIL + + +Association group 48 supports 30 nodes. + +### Group 49: HAIL + + +Association group 49 supports 30 nodes. + +### Group 50: HAIL + + +Association group 50 supports 30 nodes. + +### Group 51: HAIL + + +Association group 51 supports 30 nodes. + +### Group 52: HAIL + + +Association group 52 supports 30 nodes. + +### Group 53: HAIL + + +Association group 53 supports 30 nodes. + +### Group 54: HAIL + + +Association group 54 supports 30 nodes. + +### Group 55: HAIL + + +Association group 55 supports 30 nodes. + +### Group 56: HAIL + + +Association group 56 supports 30 nodes. + +### Group 57: HAIL + + +Association group 57 supports 30 nodes. + +### Group 58: HAIL + + +Association group 58 supports 30 nodes. + +### Group 59: HAIL + + +Association group 59 supports 30 nodes. + +### Group 60: HAIL + + +Association group 60 supports 30 nodes. + +### Group 61: HAIL + + +Association group 61 supports 30 nodes. + +### Group 62: HAIL + + +Association group 62 supports 30 nodes. + +### Group 63: HAIL + + +Association group 63 supports 30 nodes. + +### Group 64: HAIL + + +Association group 64 supports 30 nodes. + +### Group 65: HAIL + + +Association group 65 supports 30 nodes. + +### Group 66: HAIL + + +Association group 66 supports 30 nodes. + +### Group 67: HAIL + + +Association group 67 supports 30 nodes. + +### Group 68: HAIL + + +Association group 68 supports 30 nodes. + ## Technical Information ### Endpoints @@ -124,6 +498,7 @@ The device does not support associations. |---------------|---------| | COMMAND_CLASS_NO_OPERATION_V1| | | COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_BATTERY_V1| | | COMMAND_CLASS_WAKE_UP_V1| | diff --git a/_addons_bindings/zwave/doc/inovelli/nzw36_0_0.md b/_addons_bindings/zwave/doc/inovelli/nzw36_0_0.md index 7e340b97c..0cfa10ed8 100644 --- a/_addons_bindings/zwave/doc/inovelli/nzw36_0_0.md +++ b/_addons_bindings/zwave/doc/inovelli/nzw36_0_0.md @@ -53,23 +53,21 @@ Your smart plug should now be removed from your HUB/Gateway. The following table summarises the channels available for the NZW36 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Scene Number | scene_number | | Number | -| Alarm | alarm_general | Door | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | +| Alarm | alarm_general | alarm_general | Alarm | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: | Event ID | Event Description | @@ -83,10 +81,9 @@ This channel provides the scene, and the event as a decimal value in the form `` | 6 | 5 x keypress | ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -99,7 +96,58 @@ The following state translation is provided for this channel to the ```Switch``` ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 2 configuration parameters available in the NZW36. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | LED Indicator | | +| 2 | Countdown | Plug Auto Shut Off | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 1: LED Indicator + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Plug On / LED On | +| 1 | Plug On / LED Off | +| 2 | LED Disabled | + +The manufacturer defined default value is ```0``` (Plug On / LED On). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Countdown + +Plug Auto Shut Off +Plug auto shutoff + +0 - 36000 seconds +Values in the range 0 to 36000 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_2_2``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups @@ -142,6 +190,7 @@ Association group 1 supports 5 nodes. ### Documentation Links * [User Manual](https://www.cd-jackson.com/zwave_device_uploads/831/NZW36-Manual-1.pdf) +* [Another Manual](https://www.cd-jackson.com/zwave_device_uploads/831/NZW36-Manual.pdf) --- diff --git a/_addons_bindings/zwave/doc/inovelli/nzw96_0_0.md b/_addons_bindings/zwave/doc/inovelli/nzw96_0_0.md index 4ede8d382..2b5ebad48 100644 --- a/_addons_bindings/zwave/doc/inovelli/nzw96_0_0.md +++ b/_addons_bindings/zwave/doc/inovelli/nzw96_0_0.md @@ -53,22 +53,20 @@ Your smart plug should now be removed from your HUB/Gateway. The following table summarises the channels available for the NZW96 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Alarm (heat) | alarm_heat | | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Alarm (heat) | alarm_heat | alarm_heat | Fire | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Alarm (heat) - Indicates if a heat alarm is triggered. -The ```alarm_heat``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_heat``` channel is of type ```alarm_heat``` and supports the ```Switch``` item and is in the ```Fire``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -81,13 +79,56 @@ The following state translation is provided for this channel to the ```Switch``` ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 2 configuration parameters available in the NZW96. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | LED Invert/Off | LED Invert/Off | +| 2 | Countdown | Plug Auto Shutoff | + +### Parameter 1: LED Invert/Off + +LED Invert/Off + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Plug On / LED On | +| 1 | Plug On / LED Off | +| 2 | LED Disabled | + +The manufacturer defined default value is ```0``` (Plug On / LED On). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Countdown + +Plug Auto Shutoff +Plug Auto Shutoff + +0 - 36000 seconds +Values in the range 0 to 36000 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_2_2``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The NZW96 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/inovelli/zw37_0_0.md b/_addons_bindings/zwave/doc/inovelli/zw37_0_0.md index fe6c5af27..83b3c477b 100644 --- a/_addons_bindings/zwave/doc/inovelli/zw37_0_0.md +++ b/_addons_bindings/zwave/doc/inovelli/zw37_0_0.md @@ -8,6 +8,8 @@ title: ZW37 - ZWave # ZW37 Show Home, 2 channel smart plug, ZWave Plus This describes the Z-Wave device *ZW37*, manufactured by *Inovelli* with the thing type UID of ```inovelli_zw37_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + ![ZW37 product image](https://www.cd-jackson.com/zwave_device_uploads/745/745_default.jpg) @@ -15,30 +17,38 @@ The ZW37 supports routing. This allows the device to communicate using other rou ## 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/745) to improve the documentation. +Inovelli's Dual Smart Plug-In On/Off Module + Repeater has the ability to turn on and off appliances, lights, and more from anywhere in the world from two different outlets! In addition to the dual smart outlets, the smart plug acts as a Z-Wave signal repeater, which amplifies your Z-Wave signal, growing the capabilities of your network.  + +This smart plug is one of the smallest plugs on the market (3.5"x2.5"x1.5") and has two (2) Z-Wave Outlets on the side of the device allowing for easy fit in compact places. You can control each outlet individually (and simultaneously*) with all HUB's that support multi-channel Z-Wave devices. Simplifying lives, one smart home product at a time... that's Inovelli.  + +### Inclusion Information + +Press the center button 3-5 times within 3 seconds. + +### Exclusion Information + +Press the center button 3-5 times within 3 seconds to exclude it from the network.  ## Channels The following table summarises the channels available for the ZW37 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Scene Number | scene_number | | Number | -| Switch 1 | switch_binary1 | Switch | Switch | -| Switch 2 | switch_binary2 | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Switch 2 | switch_binary2 | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: | Event ID | Event Description | @@ -52,16 +62,14 @@ This channel provides the scene, and the event as a decimal value in the form `` | 6 | 5 x keypress | ### Switch 1 - Switch the power on and off. -The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 2 - Switch the power on and off. -The ```switch_binary2``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -73,7 +81,14 @@ The device has no configuration parameters defined. Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The ZW37 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 2 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/intermatic/ca3000_0_0.md b/_addons_bindings/zwave/doc/intermatic/ca3000_0_0.md new file mode 100644 index 000000000..c3d6edd07 --- /dev/null +++ b/_addons_bindings/zwave/doc/intermatic/ca3000_0_0.md @@ -0,0 +1,79 @@ +--- +layout: documentation +title: CA3000 - ZWave +--- + +{% include base.html %} + +# CA3000 Wall Switch +This describes the Z-Wave device *CA3000*, manufactured by *Intermatic* with the thing type UID of ```intermatic_ca3000_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![CA3000 product image](https://www.cd-jackson.com/zwave_device_uploads/468/468_default.png) + + +The CA3000 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 between other devices in the mesh network. + +## Overview + +In-wall switch, 15A + +### Inclusion Information + +Press rocker switch up or down. + +### Exclusion Information + +Press rocker switch up or down. + +## Channels + +The following table summarises the channels available for the CA3000 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + + + +## Device Configuration + +The device has no configuration parameters defined. + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The device does not support associations. +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| +| COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_ASSOCIATION_V1| | +| COMMAND_CLASS_VERSION_V1| | +| COMMAND_CLASS_MANUFACTURER_PROPRIETARY_V1| | + +### Documentation Links + +* [Intermatic CA3000 Manual](https://www.cd-jackson.com/zwave_device_uploads/468/Intermatic-CA3000-Manual.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/468). diff --git a/_addons_bindings/zwave/doc/intermatic/ca3500_0_0.md b/_addons_bindings/zwave/doc/intermatic/ca3500_0_0.md index 190e47c48..322dc325a 100644 --- a/_addons_bindings/zwave/doc/intermatic/ca3500_0_0.md +++ b/_addons_bindings/zwave/doc/intermatic/ca3500_0_0.md @@ -8,25 +8,37 @@ title: CA3500 - ZWave # CA3500 15 Amp Split-Duplex Receptacle This describes the Z-Wave device *CA3500*, manufactured by *Intermatic* with the thing type UID of ```intermatic_ca3500_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![CA3500 product image](https://www.cd-jackson.com/zwave_device_uploads/417/417_default.png) + + The CA3500 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 between other devices in the mesh network. ## 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/417) to improve the documentation. +In-Wall receptacle (dual, one switched); 15A + +### Inclusion Information + +Press the Activator button. + +### Exclusion Information + +Press the Activator button. ## Channels The following table summarises the channels available for the CA3500 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. diff --git a/_addons_bindings/zwave/doc/intermatic/ca3750_0_0.md b/_addons_bindings/zwave/doc/intermatic/ca3750_0_0.md index 8aa9d141c..547dd4369 100644 --- a/_addons_bindings/zwave/doc/intermatic/ca3750_0_0.md +++ b/_addons_bindings/zwave/doc/intermatic/ca3750_0_0.md @@ -8,6 +8,8 @@ title: CA3750 - ZWave # CA3750 Contactor/Switch This describes the Z-Wave device *CA3750*, manufactured by *Intermatic* with the thing type UID of ```intermatic_ca3750_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + ![CA3750 product image](https://www.cd-jackson.com/zwave_device_uploads/426/426_default.jpg) @@ -15,21 +17,28 @@ The CA3750 supports routing. This allows the device to communicate using other r ## 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/426) to improve the documentation. +Contractor/switch; 30A (heavy duty wall box) + +### Inclusion Information + +Press the Program button. + +### Exclusion Information + +Press the Program button. ## Channels The following table summarises the channels available for the CA3750 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. diff --git a/_addons_bindings/zwave/doc/intermatic/ca8900_0_0.md b/_addons_bindings/zwave/doc/intermatic/ca8900_0_0.md index cca3e8c52..d571b08f3 100644 --- a/_addons_bindings/zwave/doc/intermatic/ca8900_0_0.md +++ b/_addons_bindings/zwave/doc/intermatic/ca8900_0_0.md @@ -8,35 +8,53 @@ title: CA8900 - ZWave # CA8900 Z-Wave Thermostat This describes the Z-Wave device *CA8900*, manufactured by *Intermatic* with the thing type UID of ```intermatic_ca8900_00_000```. +The device is in the category of *HVAC*, defining Air condition devices, Fans. + +![CA8900 product image](https://www.cd-jackson.com/zwave_device_uploads/388/388_default.png) + + The CA8900 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 between other devices in the mesh network. ## 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/388) to improve the documentation. +ThermostatEasy energy saving buttons (NORM / SAVE) + + * Easy Mode Switching Buttons (HEAT/OFF/COOL) + *  Can be used with all 24VAC heating and cooling systems. It cannot be used with line voltage systems. + *  Is Digital and your desired heat or cool temperatures can easily be set on the large screen with the TEMP UP (+) and TEMP DOWN (-) buttons on the front. + *  A minimum 4-minute off time protects heating and cooling systems from damage. + *  Uses a new technique called sequential staging for more comfort with faster reaction to requested temperature changes. + * Battery Backup with 2 x "AA" batteries (included) + +### Inclusion Information + +Press and release the BIND button. + +### Exclusion Information + +Press and release the BIND button. ## Channels The following table summarises the channels available for the CA8900 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Operating State | thermostat_state | Temperature | Number | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (cooling) | thermostat_setpoint | Temperature | Number:Temperature | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -57,10 +75,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State - Sets the thermostat operating state. -The ```thermostat_state``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -74,16 +91,14 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (cooling) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. diff --git a/_addons_bindings/zwave/doc/intermatic/ha01c_0_0.md b/_addons_bindings/zwave/doc/intermatic/ha01c_0_0.md index f4564da28..2c5538bd0 100644 --- a/_addons_bindings/zwave/doc/intermatic/ha01c_0_0.md +++ b/_addons_bindings/zwave/doc/intermatic/ha01c_0_0.md @@ -8,6 +8,11 @@ title: HA-01C - ZWave # HA-01C In-Wall Dual Receptacle This describes the Z-Wave device *HA-01C*, manufactured by *Intermatic* with the thing type UID of ```intermatic_ha01c_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![HA-01C product image](https://www.cd-jackson.com/zwave_device_uploads/304/304_default.png) + + The HA-01C 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 between other devices in the mesh network. ## Overview @@ -28,15 +33,14 @@ If necessary, you can delete the HA01 In-Wall Receptacle from your Z-Wave™ net The following table summarises the channels available for the HA-01C -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. diff --git a/_addons_bindings/zwave/doc/intermatic/ha02_0_0.md b/_addons_bindings/zwave/doc/intermatic/ha02_0_0.md index 253797442..9061988cf 100644 --- a/_addons_bindings/zwave/doc/intermatic/ha02_0_0.md +++ b/_addons_bindings/zwave/doc/intermatic/ha02_0_0.md @@ -8,6 +8,8 @@ title: HA02 - ZWave # HA02 Appliance Module This describes the Z-Wave device *HA02*, manufactured by *Intermatic* with the thing type UID of ```intermatic_ha02_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + ![HA02 product image](https://www.cd-jackson.com/zwave_device_uploads/471/471_default.jpg) @@ -15,21 +17,28 @@ The HA02 supports routing. This allows the device to communicate using other rou ## 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/471) to improve the documentation. +Plug-in switch; 15A + +### Inclusion Information + +Press the Program button. + +### Exclusion Information + +Press the Program button. ## Channels The following table summarises the channels available for the HA02 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. diff --git a/_addons_bindings/zwave/doc/intermatic/ha03_0_0.md b/_addons_bindings/zwave/doc/intermatic/ha03_0_0.md index 460663143..bf02f88e4 100644 --- a/_addons_bindings/zwave/doc/intermatic/ha03_0_0.md +++ b/_addons_bindings/zwave/doc/intermatic/ha03_0_0.md @@ -8,26 +8,38 @@ title: HA03 - ZWave # HA03 Lamp Module This describes the Z-Wave device *HA03*, manufactured by *Intermatic* with the thing type UID of ```intermatic_ha03_00_000```. +The device is in the category of *Light Bulb*, defining Devices that illuminate something, such as bulbs, etc.. + +![HA03 product image](https://www.cd-jackson.com/zwave_device_uploads/506/506_default.png) + + The HA03 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 between other devices in the mesh network. ## 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/506) to improve the documentation. +Plug-in dimmer; 300W + +### Inclusion Information + +Press the Program button. + +### Exclusion Information + +Press the Program button. ## Channels The following table summarises the channels available for the HA03 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. diff --git a/_addons_bindings/zwave/doc/intermatic/ha04_0_0.md b/_addons_bindings/zwave/doc/intermatic/ha04_0_0.md index 21880ce8b..82baa8fe7 100644 --- a/_addons_bindings/zwave/doc/intermatic/ha04_0_0.md +++ b/_addons_bindings/zwave/doc/intermatic/ha04_0_0.md @@ -8,6 +8,8 @@ title: HA04 - ZWave # HA04 Outdoor Module This describes the Z-Wave device *HA04*, manufactured by *Intermatic* with the thing type UID of ```intermatic_ha04_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + ![HA04 product image](https://www.cd-jackson.com/zwave_device_uploads/297/297_default.jpg) @@ -15,21 +17,20 @@ The HA04 supports routing. This allows the device to communicate using other rou ## 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/297) to improve the documentation. +Plug-in outdoor lighting module; switch; 15A ## Channels The following table summarises the channels available for the HA04 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -57,6 +58,10 @@ The device does not support associations. | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_VERSION_V1| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/297/Intermatic-HA04C.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/intermatic/ha05_0_0.md b/_addons_bindings/zwave/doc/intermatic/ha05_0_0.md index db9e66b4b..23bf690b1 100644 --- a/_addons_bindings/zwave/doc/intermatic/ha05_0_0.md +++ b/_addons_bindings/zwave/doc/intermatic/ha05_0_0.md @@ -8,25 +8,37 @@ title: HA05 - ZWave # HA05 Screw in lamp module This describes the Z-Wave device *HA05*, manufactured by *Intermatic* with the thing type UID of ```intermatic_ha05_00_000```. +The device is in the category of *Light Bulb*, defining Devices that illuminate something, such as bulbs, etc.. + +![HA05 product image](https://www.cd-jackson.com/zwave_device_uploads/441/441_default.png) + + The HA05 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 between other devices in the mesh network. ## 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/441) to improve the documentation. +Screw-in lamp module + +### Inclusion Information + +Press the Program button. + +### Exclusion Information + +Press the Program button. ## Channels The following table summarises the channels available for the HA05 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -54,6 +66,10 @@ The device does not support associations. | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_VERSION_V1| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/441/Intermatic-HA05C.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/intermatic/ha14wd_0_0.md b/_addons_bindings/zwave/doc/intermatic/ha14wd_0_0.md index dbad8b122..057cee865 100644 --- a/_addons_bindings/zwave/doc/intermatic/ha14wd_0_0.md +++ b/_addons_bindings/zwave/doc/intermatic/ha14wd_0_0.md @@ -10,26 +10,36 @@ This describes the Z-Wave device *HA14WD*, manufactured by *Intermatic* with the The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. +![HA14WD product image](https://www.cd-jackson.com/zwave_device_uploads/772/772_default.png) + + The HA14WD 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 between other devices in the mesh network. ## 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/772) to improve the documentation. +Rocker-style dimmer switch + +### Inclusion Information + +Press and release bottom rocker switch. + +### Exclusion Information + +Press and release bottom rocker switch. ## Channels The following table summarises the channels available for the HA14WD -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. diff --git a/_addons_bindings/zwave/doc/isurpass/dl9101v_0_0.md b/_addons_bindings/zwave/doc/isurpass/dl9101v_0_0.md index 1c7c31be4..2f8f4702a 100644 --- a/_addons_bindings/zwave/doc/isurpass/dl9101v_0_0.md +++ b/_addons_bindings/zwave/doc/isurpass/dl9101v_0_0.md @@ -17,31 +17,41 @@ The DL9101V supports routing. This allows the device to communicate using other ## 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/666) to improve the documentation. +The iSurpass Smart Door Lock provides more convenience to secure your home. It supports passwords, key and remote lock/unlock. It's a Z-Wave product and compatible with all Z-Wave networks. Any third party manufacturer controller can include/exclude this lock. Use in conjunction with a Security Enabled Z-Wave Controller to fully utilize all implemented functions. + +### Inclusion Information + +Set door lock in learn mode.  + +press reset button -> input admin password + # -> press 0 + +### Exclusion Information + +Set door lock in learn mode.  + +press reset button -> input admin password + # -> press 0 ## Channels The following table summarises the channels available for the DL9101V -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Door Lock | lock_door | Door | Switch | -| Alarm | alarm_general | Door | Switch | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset | time_offset | Temperature | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Door Lock | lock_door | lock_door | Door | Switch | +| Alarm | alarm_general | alarm_general | Alarm | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Door Lock - Lock and unlock the door. -The ```lock_door``` channel supports the ```Switch``` item and is in the ```Door``` category. +The ```lock_door``` channel is of type ```lock_door``` and supports the ```Switch``` item and is in the ```Door``` category. The following state translation is provided for this channel to the ```Switch``` item type -: | Value | Label | @@ -50,10 +60,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Unlocked | ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -63,16 +72,14 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset - Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. diff --git a/_addons_bindings/zwave/doc/isurpass/j1504_0_0.md b/_addons_bindings/zwave/doc/isurpass/j1504_0_0.md new file mode 100644 index 000000000..d086335ab --- /dev/null +++ b/_addons_bindings/zwave/doc/isurpass/j1504_0_0.md @@ -0,0 +1,124 @@ +--- +layout: documentation +title: J1504 - ZWave +--- + +{% include base.html %} + +# J1504 Door Sensor +This describes the Z-Wave device *J1504*, manufactured by *Shenzhen iSurpass Technology Co. ,Ltd* with the thing type UID of ```isurpass_j1504_00_000```. + +The device is in the category of *Sensor*, defining Device used to measure something. + +![J1504 product image](https://www.cd-jackson.com/zwave_device_uploads/966/966_default.jpg) + + +The J1504 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 J1504 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. Refer to the *Wakeup Information* section below for further information. + +## Overview + +The Door/Window sensor JWZH-O-2015-4 is a wireless, battery powered binary sensor which designed for use in home automation systems and place where information related to opening /closing. + +### Inclusion Information + +Press the tamper switch of the sensor three times within 1.5 seconds. + +### Exclusion Information + +Press the tamper switch of the sensor three times within 1.5 seconds. + +### Wakeup Information + +The J1504 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. + + +Pressing the tamper switch one time within 1.5 seconds, the sensor will wake up + +## Channels + +The following table summarises the channels available for the J1504 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Alarm (general) | alarm_general | alarm_general | Alarm | Switch | + +### Binary Sensor +Indicates if a sensor has triggered. + +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| ON | Triggered | +| OFF | Untriggered | + +### Battery Level +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 is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. +### Alarm (general) +Indicates if an alarm is triggered. + +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + + + +## Device Configuration + +The device has no configuration parameters defined. + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The J1504 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 1 node. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SENSOR_BINARY_V2| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_BATTERY_V1| | +| COMMAND_CLASS_WAKE_UP_V1| | +| COMMAND_CLASS_ASSOCIATION_V1| | +| COMMAND_CLASS_VERSION_V1| | +| COMMAND_CLASS_SENSOR_ALARM_V1| | + +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/966/CEF18904-operating-manual-20151126.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/966). diff --git a/_addons_bindings/zwave/doc/jintaobao/curtainmotor_0_0.md b/_addons_bindings/zwave/doc/jintaobao/curtainmotor_0_0.md index 1ecd7d507..dfa12c44f 100644 --- a/_addons_bindings/zwave/doc/jintaobao/curtainmotor_0_0.md +++ b/_addons_bindings/zwave/doc/jintaobao/curtainmotor_0_0.md @@ -17,42 +17,278 @@ The Curtain Motor supports routing. This allows the device to communicate using ## 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/654) to improve the documentation. +JTB-1007 is a Z-Wave enabled curtain motor support scene setting. + +### Inclusion Information + +Click the PB-button once, located near by motor power socket. + +### Exclusion Information + +Click the PB-button once, located near by motor power socket. ## Channels The following table summarises the channels available for the Curtain Motor -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Blinds Control | blinds_control | blinds_control | Blinds | Rollershutter | +| Scene Number | scene_number | scene_number | | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. -### Dimmer +### Blinds Control +Provides start / stop control of blinds. -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. +The ```blinds_control``` channel is of type ```blinds_control``` and supports the ```Rollershutter``` item and is in the ```Blinds``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 9 configuration parameters available in the Curtain Motor. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 17 | Motor Open, Go to Direction B | Motor Open, Go to Direction B | +| 18 | Motor Stop | Motor Stop | +| 19 | Motor Close, Go to Direction A | Motor Close, Go to Direction A | +| 20 | Motor Position | Return motor current position | +| 22 | Motor revert direction | Motor revert direction | +| 23 | Clear motor lead tail endpoint setting | Clear motor lead tail endpoint setting | +| 32 | Return motor status flag | Return motor status flag | +| 33 | Enable manual pulling function | Enable manual pulling function | +| 34 | Disable manual pulling function | Disable manual pulling function | + +### Parameter 17: Motor Open, Go to Direction B + +Motor Open, Go to Direction B +Set only, any value possible +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_17_4_wo``` and is of type ```INTEGER```. +This is a write only parameter. + + +### Parameter 18: Motor Stop + +Motor Stop + +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_18_4_wo``` and is of type ```INTEGER```. +This is a write only parameter. + + +### Parameter 19: Motor Close, Go to Direction A + +Motor Close, Go to Direction A + +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_19_4_wo``` and is of type ```INTEGER```. +This is a write only parameter. + + +### Parameter 20: Motor Position + +Return motor current position + +Values in the range 0 to 99 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_20_2``` and is of type ```INTEGER```. +This is a read only parameter. + + +### Parameter 22: Motor revert direction + +Motor revert direction + +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_22_4_wo``` and is of type ```INTEGER```. +This is a write only parameter. + + +### Parameter 23: Clear motor lead tail endpoint setting + +Clear motor lead tail endpoint setting + +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_23_1_wo``` and is of type ```INTEGER```. +This is a write only parameter. + + +### Parameter 32: Return motor status flag + +Return motor status flag +<table> + <tr> + <td> + </td> + + <td> +   ->   + </td> + + <td> + motor is closing, go to direction A + </td> + </tr> + + <tr> + <td> + 1 + </td> + + <td> +   ->   + </td> + + <td> + motor is opening, go to direction B + </td> + </tr> + + <tr> + <td> + 2 + </td> + + <td> +   ->   + </td> + + <td> + motor endpoint A has setting + </td> + </tr> + + <tr> + <td> + 3 + </td> + + <td> +   ->   + </td> + + <td> + motor endpoint B has setting + </td> + </tr> + + <tr> + <td> + 4 + </td> + + <td> +   ->   + </td> + + <td> + (Reserved) + </td> + </tr> + + <tr> + <td> + 5 + </td> + + <td> +   ->   + </td> + + <td> + (Reserved) + </td> + </tr> + + <tr> + <td> + 6 + </td> + + <td> +   ->   + </td> + + <td> + (Reserved) + </td> + </tr> + + <tr> + <td> + 7 + </td> + + <td> +   ->   + </td> + + <td> + direction revert + </td> + </tr> +</table>This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_32_1``` and is of type ```INTEGER```. +This is a read only parameter. + + +### Parameter 33: Enable manual pulling function + +Enable manual pulling function + +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_33_4_wo``` and is of type ```INTEGER```. +This is a write only parameter. + + +### Parameter 34: Disable manual pulling function + +Disable manual pulling function + +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_34_4_wo``` and is of type ```INTEGER```. +This is a write only parameter. + ## Association Groups diff --git a/_addons_bindings/zwave/doc/kaipule/es61_0_0.md b/_addons_bindings/zwave/doc/kaipule/es61_0_0.md index 652e58581..3f5e94772 100644 --- a/_addons_bindings/zwave/doc/kaipule/es61_0_0.md +++ b/_addons_bindings/zwave/doc/kaipule/es61_0_0.md @@ -47,18 +47,17 @@ b) Automatic Wake-up - Default time of automatic wake-up is 24 hours, and there The following table summarises the channels available for the ES-61 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Alarm (smoke) | alarm_smoke | Smoke | Switch | -| Alarm (tamper) | alarm_tamper | | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Alarm (smoke) | alarm_smoke | alarm_smoke | Smoke | Switch | +| Alarm (tamper) | alarm_tamper | alarm_tamper | | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -68,10 +67,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Alarm (smoke) - Indicates if a smoke is triggered. -The ```alarm_smoke``` channel supports the ```Switch``` item and is in the ```Smoke``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_smoke``` channel is of type ```alarm_smoke``` and supports the ```Switch``` item and is in the ```Smoke``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -81,10 +79,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Alarm (tamper) - Indicates if the tamper alarm is triggered. -The ```alarm_tamper``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_tamper``` channel is of type ```alarm_tamper``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -94,11 +91,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -203,6 +199,7 @@ Association group 2 supports 5 nodes. | COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | | COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | | COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_ALARM_V4| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_POWERLEVEL_V1| | diff --git a/_addons_bindings/zwave/doc/kaipule/ix32_6_0.md b/_addons_bindings/zwave/doc/kaipule/ix32_6_0.md index 32acaa6d1..9719b0f3d 100644 --- a/_addons_bindings/zwave/doc/kaipule/ix32_6_0.md +++ b/_addons_bindings/zwave/doc/kaipule/ix32_6_0.md @@ -9,6 +9,8 @@ title: DP-32 / IX-30 / IX-32 - ZWave This describes the Z-Wave device * DP-32 / IX-30 / IX-32*, manufactured by *Kaipule Technology Co., Ltd.* with the thing type UID of ```kaipule_ix32_06_000```. This version of the device is limited to firmware versions above 6.0 +The device is in the category of *Motion Detector*, defining Motion sensors/detectors. + ![ DP-32 / IX-30 / IX-32 product image](https://www.cd-jackson.com/zwave_device_uploads/667/667_default.jpg) @@ -20,28 +22,38 @@ The DP-32 / IX-30 / IX-32 does not permanently listen for messages sent from th The hardware board for the IX30 (wall) and IX32 (ceiling) is the same thing and reports the same Type and ID. +### Inclusion Information + +Enter the Inclusion Mode of gateway, and press the tamper switch 3 times within 1.5s, then the PIR sensor will stay in enrollment state until successfully enrolled into network or enrollment time out after 30s. + +### Exclusion Information + +Enter the Exclusion Mode of gateway, and press the tamper switch 3 times within 1.5s, then the PIR sensor will be removed after a period of time. + ### Wakeup Information The DP-32 / IX-30 / IX-32 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. + +Quickly press tamper switch once, the PIR sensor will automatically send wake-up information, and there will be 10s after wake-up to receive gateway setting information. + ## Channels The following table summarises the channels available for the DP-32 / IX-30 / IX-32 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Motion Alarm | alarm_motion | Door | Switch | -| Tamper Alarm | alarm_tamper | | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Motion Alarm | alarm_motion | alarm_motion | Motion | Switch | +| Tamper Alarm | alarm_tamper | alarm_tamper | | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -51,10 +63,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Motion Alarm - Indicates if a motion alarm is triggered. -The ```alarm_motion``` 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. +The ```alarm_motion``` channel is of type ```alarm_motion``` and supports the ```Switch``` item and is in the ```Motion``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -64,10 +75,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Tamper Alarm - Indicates if the tamper alarm is triggered. -The ```alarm_tamper``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_tamper``` channel is of type ```alarm_tamper``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -77,11 +87,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -91,15 +100,15 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 1 | Basic Set | If there is any device in Association Group 2 the PIR Sensor will send BASIC Set = Value command to control that deivce when the PIR is triggered. | -| 2 | Turn Off Light Time Configuration | If there is any device in Association Group 2 the PIR Sensor will send BASIC Set = Value command to Group 2 and send Basic Set = 0x00 to turn of light after 5 x t seconds- Set value t means to send the BAsic Set command after t seconds. | -| 3 | PIR Sensor Alarm Elemination Time Configuration | Min time is 5s. Eg If the config is 1, this means it will eliminate alarm after 1 * 5s = 5 seconds | +| 1 | Basic Set | Basic Set | +| 2 | Turn Off Light Time Configuration | Turn Off Light Time Configuration | +| 3 | PIR Sensor Alarm Elimination Time Configuration | PIR Sensor Alarm Elimination Time Configuration | | | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | | | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | ### Parameter 1: Basic Set -If there is any device in Association Group 2 the PIR Sensor will send BASIC Set = Value command to control that deivce when the PIR is triggered. +Basic Set If there is any device in Association Group 2 the PIR Sensor will send BASIC Set = Value command to control that deivce when the PIR is triggered. Values in the range 1 to 100 may be set. @@ -110,7 +119,7 @@ This parameter has the configuration ID ```config_1_1``` and is of type ```INTEG ### Parameter 2: Turn Off Light Time Configuration -If there is any device in Association Group 2 the PIR Sensor will send BASIC Set = Value command to Group 2 and send Basic Set = 0x00 to turn of light after 5 x t seconds- Set value t means to send the BAsic Set command after t seconds. +Turn Off Light Time Configuration If there is any device in Association Group 2 the PIR Sensor will send BASIC Set = Value command to Group 2 and send Basic Set = 0x00 to turn of light after 5 x t seconds- Set value t means to send the BAsic Set command after t seconds. Values in the range 1 to 120 may be set. @@ -119,9 +128,11 @@ The manufacturer defined default value is ```20```. This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. -### Parameter 3: PIR Sensor Alarm Elemination Time Configuration +### Parameter 3: PIR Sensor Alarm Elimination Time Configuration +PIR Sensor Alarm Elimination Time Configuration Min time is 5s. Eg If the config is 1, this means it will eliminate alarm after 1 * 5s = 5 seconds + The selected value is multiplied with 5. After this time the sensor will report PIR OFF. E.g. If you select value --> 3 * 5s = 15 seconds. diff --git a/_addons_bindings/zwave/doc/kichler/12387_0_0.md b/_addons_bindings/zwave/doc/kichler/12387_0_0.md index 923987ded..95fb0ff8c 100644 --- a/_addons_bindings/zwave/doc/kichler/12387_0_0.md +++ b/_addons_bindings/zwave/doc/kichler/12387_0_0.md @@ -8,24 +8,42 @@ title: 12387 - ZWave # 12387 Design Pro LED Z Wave Dimmer Module This describes the Z-Wave device *12387*, manufactured by *Kichler* with the thing type UID of ```kichler_12387_00_000```. +The device is in the category of *Light Bulb*, defining Devices that illuminate something, such as bulbs, etc.. + +![12387 product image](https://www.cd-jackson.com/zwave_device_uploads/668/668_default.png) + + ## 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/668) to improve the documentation. +The Kichler Z-Wave® full range dimmer is designed to allow your Kichler Design Pro LED fixtures to communicate with one another as well as to be added to an already existing Z-Wave network. + +### Inclusion Information + +**NOTE: There is a time limit of approx. 20 seconds to complete Step 1. If light fixture(s) blink 10 times while performing Step 1, this means that the time has expired and it will be necessary to repeat the process from the beginning.** + + 1. Press & release recessed RESET button. (The secondary dimmer light fixture will blink 2 times) + 2. Press & hold both (+) button and (-) button until both the primary dimmer light fixture and secondary dimmer light fixture blink 2 times. (Hold for approx. 2 seconds) + +### Exclusion Information + +**NOTE: There is a time limit of approx. 20 seconds to complete Step 1. If light fixture(s) blink 10 times while performing Step 1, this means that the time has expired and it will be necessary to repeat the process from the beginning.** + + 1. Press & release recessed RESET button. (Secondary dimmer light fixture will blink 2 times) + 2. Press & hold both (+) and (-) until both the primary and secondary dimmer light fixtures blink 2 times (Hold approx. 2 seconds) ## Channels The following table summarises the channels available for the 12387 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. @@ -37,7 +55,13 @@ The device has no configuration parameters defined. Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The 12387 supports 1 association group. + +### Group 1: Group 1 + + +Association group 1 supports 5 nodes. + ## Technical Information ### Endpoints @@ -52,6 +76,10 @@ The device does not support associations. | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_ASSOCIATION_V1| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/668/12387-Z-Wave-Dimmer-Module.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/kichler/15dc200_0_0.md b/_addons_bindings/zwave/doc/kichler/15dc200_0_0.md index a42bb0979..0eb29bae0 100644 --- a/_addons_bindings/zwave/doc/kichler/15dc200_0_0.md +++ b/_addons_bindings/zwave/doc/kichler/15dc200_0_0.md @@ -17,56 +17,64 @@ The 15DC200 supports routing. This allows the device to communicate using other ## 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/391) to improve the documentation. + Design Pro LED Controller + +### Inclusion Information + +On the Controller intended to be the subservient press: **Home>Network>Join Network**. Then press Enter + +### Exclusion Information + +On the Controller to be removed press: **Home>Network>Leave Network**. Then press Enter ## Channels The following table summarises the channels available for the 15DC200 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Clock Time Offset | time_offset | Temperature | Number | -| Switch 1 | switch_binary1 | Switch | Switch | -| Switch 2 | switch_binary2 | Switch | Switch | -| Switch 3 | switch_binary3 | Switch | Switch | -| Switch 4 | switch_binary4 | Switch | Switch | -| Switch 5 | switch_binary5 | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Switch 2 | switch_binary2 | switch_binary | Switch | Switch | +| Switch 3 | switch_binary3 | switch_binary | Switch | Switch | +| Switch 4 | switch_binary4 | switch_binary | Switch | Switch | +| Switch 5 | switch_binary5 | switch_binary | Switch | Switch | ### Switch Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Clock Time Offset Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ### Switch 1 Switch the power on and off. -The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 2 Switch the power on and off. -The ```switch_binary2``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 3 Switch the power on and off. -The ```switch_binary3``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary3``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 4 Switch the power on and off. -The ```switch_binary4``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary4``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Switch 5 Switch the power on and off. -The ```switch_binary5``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary5``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. diff --git a/_addons_bindings/zwave/doc/leviton/dzpa1_0_0.md b/_addons_bindings/zwave/doc/leviton/dzpa1_0_0.md index 0f0c85251..77dc5c428 100644 --- a/_addons_bindings/zwave/doc/leviton/dzpa1_0_0.md +++ b/_addons_bindings/zwave/doc/leviton/dzpa1_0_0.md @@ -73,15 +73,14 @@ When removing a device from a Z-Wave® network best practice is to use the exclu The following table summarises the channels available for the DZPA1 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -161,8 +160,11 @@ Association group 1 supports 5 nodes. | COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_SWITCH_ALL_V1| | | COMMAND_CLASS_SCENE_ACTIVATION_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_NODE_NAMING_V1| | +| COMMAND_CLASS_ASSOCIATION_V1| | | COMMAND_CLASS_VERSION_V1| | ### Documentation Links diff --git a/_addons_bindings/zwave/doc/leviton/dzpd3_0_0.md b/_addons_bindings/zwave/doc/leviton/dzpd3_0_0.md index 0a499eea7..1acae875f 100644 --- a/_addons_bindings/zwave/doc/leviton/dzpd3_0_0.md +++ b/_addons_bindings/zwave/doc/leviton/dzpd3_0_0.md @@ -67,23 +67,21 @@ When removing a device from a network it is best practice to use the Exclusion p The following table summarises the channels available for the DZPD3 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. @@ -221,9 +219,12 @@ Association group 1 supports 5 nodes. | COMMAND_CLASS_SWITCH_ALL_V1| | | COMMAND_CLASS_SCENE_ACTIVATION_V1| | | COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V3| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_POWERLEVEL_V1| | | COMMAND_CLASS_NODE_NAMING_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_MANUFACTURER_PROPRIETARY_V1| | diff --git a/_addons_bindings/zwave/doc/leviton/vrcs1_0_0.md b/_addons_bindings/zwave/doc/leviton/vrcs1_0_0.md new file mode 100644 index 000000000..ebb7780ec --- /dev/null +++ b/_addons_bindings/zwave/doc/leviton/vrcs1_0_0.md @@ -0,0 +1,83 @@ +--- +layout: documentation +title: VRCS1 - ZWave +--- + +{% include base.html %} + +# VRCS1 1-Scene Controller +This describes the Z-Wave device *VRCS1*, manufactured by *Leviton* with the thing type UID of ```leviton_vrcs1_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![VRCS1 product image](https://www.cd-jackson.com/zwave_device_uploads/1092/1092_default.jpg) + + +The VRCS1 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 between other devices in the mesh network. + +## Overview + +Leviton VRCS1 Vizia RF+ 1-Button Scene Controller Switch for Multi-Location Scene Control - no local load control + +### Inclusion Information + + 1. To access Program mode, engage the air-gap switch by gently pressing the top of the push pad until the bottom lifts completely out of the frame and a click is heard (refer to figure). Wait 5 seconds and then press the push pad back into the frame and hold push pad until the LED turns Amber. Release the push pad and the LED should blink Amber. You are now in Programming mode. **NOTE:** If the LED on the 1-scene controller turns solid Red while including, there has been a communication error. + 2. While standing close to the 1-scene controller (approximately 2-5 ft.), press the center button on the Programmer/Remote to device in the network. NOTE: Only one device may be included at any time + +### Exclusion Information + + 1. To access Program mode, engage the air-gap switch by gently pressing the top of the push pad until the bottom lifts completely out of the frame and a click is heard (refer to figure). Wait 5 seconds and then press the push pad back into the frame and hold push pad until the LED turns Amber. Release the push pad and the LED should blink Amber. You are now in Programming mode. **NOTE:** If the LED on the 1-scene controller turns solid Red while excluding, there has been a communication error. + 2. While standing close to the 1-scene controller (approximately 2-5 ft.), press the center button to device from the network. + +## Channels + +The following table summarises the channels available for the VRCS1 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Scene Number [Deprecated]| scene_number | scene_number | | Number | + +### Scene Number [Deprecated] +Triggers when a scene button is pressed. + +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. + +**Note:** This channel is marked as deprecated so should not be used. + + + +## Device Configuration + +The device has no configuration parameters defined. + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The VRCS1 supports 1 association group. + +### Group 1: Group1 + + +Association group 1 supports 32 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_SCENE_ACTIVATION_V1| Linked to BASIC| +| COMMAND_CLASS_ASSOCIATION_V1| | + +### Documentation Links + +* [Product Specifications](https://www.cd-jackson.com/zwave_device_uploads/1092/Vizia-RF---Controllers-Spec-Sheet.pdf) +* [Instruction Sheet VRCS1](https://www.cd-jackson.com/zwave_device_uploads/1092/Instruction-Sheet-VRCS1.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1092). diff --git a/_addons_bindings/zwave/doc/leviton/vrcs4m0_0_0.md b/_addons_bindings/zwave/doc/leviton/vrcs4m0_0_0.md index 8d9065a23..c086edd79 100644 --- a/_addons_bindings/zwave/doc/leviton/vrcs4m0_0_0.md +++ b/_addons_bindings/zwave/doc/leviton/vrcs4m0_0_0.md @@ -5,7 +5,7 @@ title: VRCS4-M0 - ZWave {% include base.html %} -# VRCS4-M0 4 scene controller with load control +# VRCS4-M0 4-Scene controller with load control This describes the Z-Wave device *VRCS4-M0*, manufactured by *Leviton* with the thing type UID of ```leviton_vrcs4m0_00_000```. The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. @@ -45,15 +45,14 @@ If the LEDs on the 4-Zone controller turn red while excluding, there has been a The following table summarises the channels available for the VRCS4-M0 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Scene Number | scene_number | scene_number | | Number | ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. diff --git a/_addons_bindings/zwave/doc/leviton/vre06_0_0.md b/_addons_bindings/zwave/doc/leviton/vre06_0_0.md index 8bac5777e..92320ea39 100644 --- a/_addons_bindings/zwave/doc/leviton/vre06_0_0.md +++ b/_addons_bindings/zwave/doc/leviton/vre06_0_0.md @@ -17,44 +17,46 @@ The VRE06 supports routing. This allows the device to communicate using other ro ## Overview -Leviton’s Vizia RF +TM components are designed to communicate with each other via Radio Frequency (RF) to provide remote control of your lighting. Using RF technology allows Leviton to provide the greatest signal integrity possible. Each module in Leviton’s Vizia RF +TM component line is a Z-Wave® enabled device. In a Z-Wave® network, each device is designed to act as a router. These routers will re-transmit the RF signal from one device to another until the intended device is reached. This ensures that the signal is received by its intended device by routing the signal around obstacles and radio dead spots. The Electronic Low Voltage Dimmer is compatible with any Z-Wave® enabled network, regardless of the manufacturer and can also be used with other devices displaying the Z-Wave® logo. - - - * This is a Z-Wave® controller - - * Controls dimming of load - - * ON/OFF LED and Brightness LED - - * Two way communication - - * RF reliability - - * Ease of installation - No new wiring +Leviton’s Vizia RF +TM components are designed to communicate with each other via Radio Frequency (RF) to provide remote control of your lighting. Using RF technology allows Leviton to provide the greatest signal integrity possible. Each module in Leviton’s Vizia RF +TM component line is a Z-Wave® enabled device. In a Z-Wave® network, each device is designed to act as a router. These routers will re-transmit the RF signal from one device to another until the intended device is reached. This ensures that the signal is received by its intended device by routing the signal around obstacles and radio dead spots. The Electronic Low Voltage Dimmer is compatible with any Z-Wave® enabled network, regardless of the manufacturer and can also be used with other devices displaying the Z-Wave® logo. + * This is a Z-Wave® controller + * Controls dimming of load + * ON/OFF LED and Brightness LED + * Two way communication + * RF reliability + * Ease of installation - No new wiring * Compatible with other Z-Wave® enabled devices +### Inclusion Information + +)While the Programmer/Controller is in the Inclusion mode and the Locator LED is ON on the dimmer, push the push pad to turn ON the dimmer. The Programmer/Controller will verify inclusion and the locator LED will turn OFF on the dimmer. +If the dimmer is flashing Amber while in the Inclusion mode, the Programmer/Controller is still trying to communicate with the dimmer. Wait until the device stops flashing,then press push pad. + +**NOTE:** If the locator LED on the dimmer turns solid Red while including, there has been a communication error. Refer to Troubleshooting section + +### Exclusion Information + +While the Programmer/Controller is in the Exclusion mode and the locator LED is ON on the dimmer, press the push pad on the dimmer. The Programmer/Controller will verify Exclusion and the locator LED will turn OFF on the dimmer. If the dimmer is flashing Amber while in the Exclusion mode, the Programmer/Controller is still trying to communicate with the dimmer. Wait until the device stops flashing, then press the push pad. + ## Channels The following table summarises the channels available for the VRE06 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. diff --git a/_addons_bindings/zwave/doc/linear/gctbz48_0_0.md b/_addons_bindings/zwave/doc/linear/gctbz48_0_0.md index 37aa9765e..9eb0b9cbb 100644 --- a/_addons_bindings/zwave/doc/linear/gctbz48_0_0.md +++ b/_addons_bindings/zwave/doc/linear/gctbz48_0_0.md @@ -46,33 +46,33 @@ The Z-Wave Thermostat (GC-TBZ48) is a programmable, Z-Wave communications thermo The following table summarises the channels available for the GoControl GC-TBZ48 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Scene Number | scene_number | | Number | -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Operating State | thermostat_state | Temperature | Number | -| Setpoint (cooling) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Thermostat fan mode | thermostat_fanmode | | | -| Thermostat fan state | thermostat_fanstate | | | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset | time_offset | Temperature | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Scene Number | scene_number | scene_number | | Number | +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode | thermostat_fanmode | thermostat_fanmode | | | +| Thermostat fan state | thermostat_fanstate | thermostat_fanstate | | | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | ### Scene Number Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Sensor (temperature) Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -95,7 +95,7 @@ The following state translation is provided for this channel to the ```Number``` ### Operating State Sets the thermostat operating state. -The ```thermostat_state``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -111,12 +111,12 @@ The following state translation is provided for this channel to the ```Number``` ### Setpoint (cooling) Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode Channel type information on this channel is not found. @@ -127,18 +127,551 @@ Channel type information on this channel is not found. ### Battery Level 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 38 configuration parameters available in the GoControl GC-TBZ48. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | System Type | System Type | +| 2 | Fan Type | Fan Type | +| 3 | Change Over Type | Change Over Type | +| 4 | 2nd Stage Heat Enable | 2nd Stage Heat Enable | +| 5 | Aux Heat Enable | Aux Heat Enable | +| 6 | 2nd Stage Cool Enable | 2nd Stage Cool Enable | +| 7 | Temperature Unit | Temperature Unit | +| 8 | Minimum Off Time | Minimum Off Time | +| 9 | Minimum Run Time | Minimum Run Time | +| 10 | Setpoint H/C Delta | Setpoint H/C Delta | +| 11 | H Delta Stage 1 ON | H Delta Stage 1 ON | +| 12 | H Delta Stage 1 OFF | H Delta Stage 1 OFF | +| 13 | H Delta Stage 2 ON | H Delta Stage 2 ON | +| 14 | H Delta Stage 2 OFF | H Delta Stage 2 OFF | +| 15 | H Delta Aux ON | H Delta Aux ON | +| 16 | H Delta Stage 2 OFF | H Delta Stage 2 OFF | +| 17 | C Delta Stage 1 ON | C Delta Stage 1 ON | +| 18 | C Delta Stage 1 OFF | C Delta Stage 1 OFF | +| 19 | C Delta Stage 2 ON | C Delta Stage 2 ON | +| 20 | C Delta Stage 2 OFF | C Delta Stage 2 OFF | +| 23 | Lifeline Association Group Report To Send | Lifeline Association Group Report To Send | +| 24 | Display Lock | Display Lock | +| 26 | Backlight Timer | Backlight Timer | +| 33 | Max Heat Setpoint | Max Heat Setpoint | +| 34 | Min Cool Setpoint | Min Cool Setpoint | +| 38 | Schedule Enable | Schedule Enable | +| 39 | Run/Hold Mode | Run/Hold Mode | +| 40 | Setback Mode | Setback Mode | +| 41 | Un-Occupied HSP | Un-Occupied HSP | +| 42 | Un-Occupied CSP | Un-Occupied CSP | +| 43 | Remote Sensor 1 Node Number | Remote Sensor 1 Node Number | +| 46 | Remote Sensor 1 Temperature | Remote Sensor 1 Temperature | +| 48 | Internal Sensor Temp Offset | Internal Sensor Temp Offset | +| 49 | R1 Sensor Temp Offset | R1 Sensor Temp Offset | +| 54 | Heat Timer | Heat Timer | +| 55 | Cool Timer | Cool Timer | +| 61 | Fan Purge Heat | Fan Purge Heat | +| 62 | Fan Purge Cool | Fan Purge Cool | + +### Parameter 1: System Type + +System Type + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Standard | +| 1 | Heat Pump | + +The manufacturer defined default value is ```0``` (Standard). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Fan Type + +Fan Type + * 0 = Gas (no fan w/Heat) + * 1 = Electric (Fan w/Heat) +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Gas | +| 1 | Electric | + +The manufacturer defined default value is ```0``` (Gas). + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Change Over Type + +Change Over Type + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | w/Cool | +| 1 | w/Heat | + +The manufacturer defined default value is ```0``` (w/Cool). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: 2nd Stage Heat Enable + +2nd Stage Heat Enable + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Enabled | + +The manufacturer defined default value is ```0``` (Disabled). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 5: Aux Heat Enable + +Aux Heat Enable + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Enabled | + +The manufacturer defined default value is ```0``` (Disabled). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 6: 2nd Stage Cool Enable + +2nd Stage Cool Enable + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Enabled | + +The manufacturer defined default value is ```0``` (Disabled). + +This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```. + + +### Parameter 7: Temperature Unit + +Temperature Unit + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Celsius | +| 1 | Fahrenheit | + +The manufacturer defined default value is ```1``` (Fahrenheit). + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 8: Minimum Off Time + +Minimum Off Time +Sets the Minimum Off Time (MOT) delay before another heating/cooling cycle can begin +Values in the range 5 to 9 may be set. + +The manufacturer defined default value is ```5```. + +This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```. + + +### Parameter 9: Minimum Run Time + +Minimum Run Time +Sets the Minimum Run Time (MRT) delay before a heating/cooling cycle can turn off +Values in the range 3 to 9 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: Setpoint H/C Delta + +Setpoint H/C Delta +Sets the minimum separation between heating and cooling setpoints +Values in the range 3 to 15 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```. + + +### Parameter 11: H Delta Stage 1 ON + +H Delta Stage 1 ON +Sets the delta from setpoint that stage 1 heating starts +Values in the range 1 to 6 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + + +### Parameter 12: H Delta Stage 1 OFF + +H Delta Stage 1 OFF +Sets the delta from setpoint that stage 1 heating stops +Values in the range 0 to 5 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```. + + +### Parameter 13: H Delta Stage 2 ON + +H Delta Stage 2 ON +Sets the delta from setpoint that stage 2 heating starts +Values in the range 2 to 7 may be set. + +The manufacturer defined default value is ```2```. + +This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```. + + +### Parameter 14: H Delta Stage 2 OFF + +H Delta Stage 2 OFF +Sets the delta from setpoint that stage 2 heating stops +Values in the range 0 to 6 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_14_1``` and is of type ```INTEGER```. + + +### Parameter 15: H Delta Aux ON + +H Delta Aux ON +Sets the delta from setpoint that stage 3 heating starts +Values in the range 3 to 8 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_15_1``` and is of type ```INTEGER```. + + +### Parameter 16: H Delta Stage 2 OFF + +H Delta Stage 2 OFF +Sets the delta from setpoint that stage 3 heating stops +Values in the range 0 to 7 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_16_1``` and is of type ```INTEGER```. + + +### Parameter 17: C Delta Stage 1 ON + +C Delta Stage 1 ON +Sets the delta from setpoint that stage 1 cooling starts +Values in the range 1 to 6 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_17_1``` and is of type ```INTEGER```. + + +### Parameter 18: C Delta Stage 1 OFF + +C Delta Stage 1 OFF +Sets the delta from setpoint that stage 1 cooling stops +Values in the range 0 to 5 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_18_1``` and is of type ```INTEGER```. + + +### Parameter 19: C Delta Stage 2 ON + +C Delta Stage 2 ON +Sets the delta from setpoint that stage 2 cooling starts +Values in the range 2 to 7 may be set. + +The manufacturer defined default value is ```2```. + +This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```. + + +### Parameter 20: C Delta Stage 2 OFF + +C Delta Stage 2 OFF +Sets the delta from setpoint that stage 2 cooling stops +Values in the range 0 to 6 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_20_1``` and is of type ```INTEGER```. + + +### Parameter 23: Lifeline Association Group Report To Send + +Lifeline Association Group Report To Send +Report to send to the Lifeline Association Group upon change in thermostat state.  + +Bitmask values: + + * 1 = Temperature + * 2 = Heat Setpoint + * 4 = Cool Setpoint + * 8 = Thermostat Heat/Cooling Mode + * 16 = Fan Mode + * 32 = Fan State + * 64 = Operating State + * 128 = Schedule (send CC parameter 38) + * 256 = Setback (send CC parameter 40) + * 512 = Run Hold (send CC parameter 39) + * 1024 = Display Lock (send CC parameter 24) + * 8192 = Battery Level + * 16834 = Mechanical Relay State (send CC parameter 21) + * 32768 = Thermostat State Config (send CC parameter 22)    This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 65535 may be set. + +The manufacturer defined default value is ```8319```. + +This parameter has the configuration ID ```config_23_4``` and is of type ```INTEGER```. + + +### Parameter 24: Display Lock + +Display Lock + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Unlocked | +| 1 | Locked | + +The manufacturer defined default value is ```0``` (Unlocked). + +This parameter has the configuration ID ```config_24_1``` and is of type ```INTEGER```. + + +### Parameter 26: Backlight Timer + +Backlight Timer +Sets the time from last button press that the backlight will turn OFF +Values in the range 10 to 30 may be set. + +The manufacturer defined default value is ```20```. + +This parameter has the configuration ID ```config_26_1``` and is of type ```INTEGER```. + + +### Parameter 33: Max Heat Setpoint + +Max Heat Setpoint +Sets the maximum heating setpoint value +Values in the range 30 to 109 may be set. + +The manufacturer defined default value is ```90```. + +This parameter has the configuration ID ```config_33_1``` and is of type ```INTEGER```. + + +### Parameter 34: Min Cool Setpoint + +Min Cool Setpoint +Sets the minimum cooling setpoint value +Values in the range 33 to 112 may be set. + +The manufacturer defined default value is ```61```. + +This parameter has the configuration ID ```config_34_1``` and is of type ```INTEGER```. + + +### Parameter 38: Schedule Enable + +Schedule Enable +Enable or disable thermostat's local scheduler +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Enabled | + +The manufacturer defined default value is ```0``` (Disabled). + +This parameter has the configuration ID ```config_38_1``` and is of type ```INTEGER```. + + +### Parameter 39: Run/Hold Mode + +Run/Hold Mode +0 = Hold, 1 = Run +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Hold | +| 1 | Run | + +The manufacturer defined default value is ```0``` (Hold). + +This parameter has the configuration ID ```config_39_1``` and is of type ```INTEGER```. + + +### Parameter 40: Setback Mode + +Setback Mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | No Setback | +| 2 | Unoccupied Mode | + +The manufacturer defined default value is ```0``` (No Setback). + +This parameter has the configuration ID ```config_40_1``` and is of type ```INTEGER```. + + +### Parameter 41: Un-Occupied HSP + +Un-Occupied HSP +Heat Setpoint for Unoccupied mode +Values in the range 30 to 109 may be set. + +The manufacturer defined default value is ```62```. + +This parameter has the configuration ID ```config_41_1``` and is of type ```INTEGER```. + + +### Parameter 42: Un-Occupied CSP + +Un-Occupied CSP +Cool Setpoint for Unoccupied mode +Values in the range 33 to 112 may be set. + +The manufacturer defined default value is ```80```. + +This parameter has the configuration ID ```config_42_1``` and is of type ```INTEGER```. + + +### Parameter 43: Remote Sensor 1 Node Number + +Remote Sensor 1 Node Number +Node number for Remote Sensor 1 +Values in the range 0 to 252 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_43_1``` and is of type ```INTEGER```. + + +### Parameter 46: Remote Sensor 1 Temperature + +Remote Sensor 1 Temperature +Temperature of Remote Sensor 1 +Values in the range 0 to 112 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_46_1``` and is of type ```INTEGER```. + + +### Parameter 48: Internal Sensor Temp Offset + +Internal Sensor Temp Offset +Internal Sensor Temperature Offset +Values in the range -7 to 7 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_48_1``` and is of type ```INTEGER```. + + +### Parameter 49: R1 Sensor Temp Offset + +R1 Sensor Temp Offset +R1 Sensor Temperature Offset +Values in the range -7 to 7 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_49_1``` and is of type ```INTEGER```. + + +### Parameter 54: Heat Timer + +Heat Timer +Heat Timer in hours +Values in the range 0 to 4000 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_54_2``` and is of type ```INTEGER```. + + +### Parameter 55: Cool Timer + +Cool Timer +Cool Timer in hours +Values in the range 0 to 4000 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_55_2``` and is of type ```INTEGER```. + + +### Parameter 61: Fan Purge Heat + +Fan Purge Heat +Fan purge period for Heat modeThis is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 90 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_61_1``` and is of type ```INTEGER```. + + +### Parameter 62: Fan Purge Cool + +Fan Purge Cool +Fan purge period for Cool modeThis is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 90 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_62_1``` and is of type ```INTEGER```. + ## Association Groups diff --git a/_addons_bindings/zwave/doc/logic/zdb5100_0_0.md b/_addons_bindings/zwave/doc/logic/zdb5100_0_0.md index 17a12bf58..662560284 100644 --- a/_addons_bindings/zwave/doc/logic/zdb5100_0_0.md +++ b/_addons_bindings/zwave/doc/logic/zdb5100_0_0.md @@ -46,14 +46,18 @@ The following table summarises the channels available for the ZDB5100 -: | Channel Name | Channel ID | Channel Type | Category | Item Type | |--------------|------------|--------------|----------|-----------| | Scene Number | scene_number | scene_number | | Number | -| Switch | switch_binary1 | switch_binary | Switch | Switch | -| Color | color_color1 | color_color | ColorLight | Color | -| Switch | switch_binary2 | switch_binary | Switch | Switch | -| Color | color_color2 | color_color | ColorLight | Color | -| Switch | switch_binary3 | switch_binary | Switch | Switch | -| Color | color_color3 | color_color | ColorLight | Color | -| Switch | switch_binary4 | switch_binary | Switch | Switch | -| Color | color_color4 | color_color | ColorLight | Color | +| Colour commands for LED indication, pushbutton 1 | config_decimal | config_decimal | | Number | +| Colour commands for LED indication, pushbutton 2 | config_decimal | config_decimal | | Number | +| Colour commands for LED indication, pushbutton 3 | config_decimal | config_decimal | | Number | +| Colour commands for LED indication, pushbutton 4 | config_decimal | config_decimal | | Number | +| State, pushbutton 1 | switch_binary1 | switch_binary | Switch | Switch | +| Color, pushbutton 1 | color_color1 | color_color | ColorLight | Color | +| State, pushbutton 2 | switch_binary2 | switch_binary | Switch | Switch | +| Color, pushbutton 2 | color_color2 | color_color | ColorLight | Color | +| State, pushbutton 3 | switch_binary3 | switch_binary | Switch | Switch | +| Color, pushbutton 3 | color_color3 | color_color | ColorLight | Color | +| State, pushbutton 4 | switch_binary4 | switch_binary | Switch | Switch | +| Color, pushbutton 4 | color_color4 | color_color | ColorLight | Color | | Dimmer | switch_dimmer5 | switch_dimmer | DimmableLight | Dimmer | ### Scene Number @@ -72,12 +76,32 @@ This channel provides the scene, and the event as a decimal value in the form `` | 5 | 4 x keypress | | 6 | 5 x keypress | -### Switch +### Colour commands for LED indication, pushbutton 1 +Generic class for configuration parameter. + +The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. + +### Colour commands for LED indication, pushbutton 2 +Generic class for configuration parameter. + +The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. + +### Colour commands for LED indication, pushbutton 3 +Generic class for configuration parameter. + +The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. + +### Colour commands for LED indication, pushbutton 4 +Generic class for configuration parameter. + +The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. + +### State, pushbutton 1 Switch the power on and off. The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. -### Color +### Color, pushbutton 1 Button 1, Color The color channel allows to control the color of a light. @@ -85,46 +109,34 @@ The color channel allows to control the color of a light. The ```color_color1``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category. -### Switch -Button 2, switch - +### State, pushbutton 2 Switch the power on and off. The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. -### Color -Button 2, Color - +### Color, pushbutton 2 The color channel allows to control the color of a light. It is also possible to dim values and switch the light on and off. The ```color_color2``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category. -### Switch -Button 3, switch - +### State, pushbutton 3 Switch the power on and off. The ```switch_binary3``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. -### Color -Button 3, color - +### Color, pushbutton 3 The color channel allows to control the color of a light. It is also possible to dim values and switch the light on and off. The ```color_color3``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category. -### Switch -Button 4, Switch  - +### State, pushbutton 4 Switch the power on and off. The ```switch_binary4``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. -### Color -Button 4, Color - +### Color, pushbutton 4 The color channel allows to control the color of a light. It is also possible to dim values and switch the light on and off. @@ -140,7 +152,7 @@ The ```switch_dimmer5``` channel is of type ```switch_dimmer``` and supports the ## Device Configuration -The following table provides a summary of the 15 configuration parameters available in the ZDB5100. +The following table provides a summary of the 41 configuration parameters available in the ZDB5100. Detailed information on each parameter can be found in the sections below. | Param | Name | Description | @@ -160,6 +172,32 @@ Detailed information on each parameter can be found in the sections below. | 13 | Pushbutton held threshold time. | Time that a button must be activated before it is accepted as “held-down". | | 20 | Pushbutton 1 LED indication | This parameter specifies how the LED indication is controlled. | | 21 | Colour commands for pushbutton 1 LED indication | | +| 22 | ON indication RGB-saturation for pushbutton 1 | ON indication RGB-saturation for pushbutton 1 | +| 23 | OFF indication RGB-saturation for pushbutton 1 | OFF indication RGB-saturation for pushbutton 1 | +| 24 | Pushbutton 2 functionality | Pushbutton 2 functionality | +| 25 | Timer value for pushbutton 2 | Timer value for pushbutton 2 | +| 26 | Multi-Level Switch Set values for pushbutton 2. | Multi-Level Switch Set values for pushbutton 2. | +| 27 | Binary Switch Set support for pushbutton 2 | Binary Switch Set support for pushbutton 2 | +| 28 | Pushbutton 2 LED indication. | Pushbutton 2 LED indication. | +| 29 | Colour commands for pushbutton 2 LED indication. | Colour commands for pushbutton 2 LED indication. | +| 30 | ON indication RGB-saturation for pushbutton 2 | ON indication RGB-saturation for pushbutton 2 | +| 31 | OFF indication RGB-saturation for pushbutton 2. | OFF indication RGB-saturation for pushbutton 2. | +| 32 | Pushbutton 3 functionality | Pushbutton 3 functionality | +| 33 | Timer value for pushbutton 3 | Timer value for pushbutton 3 | +| 34 | Multi-Level Switch Set values for pushbutton 3 | Multi-Level Switch Set values for pushbutton 3 | +| 35 | Binary Switch Set support for pushbutton 3 | Binary Switch Set support for pushbutton 3 | +| 36 | Pushbutton 3 LED indication | Pushbutton 3 LED indication | +| 37 | Colour commands for pushbutton 3 LED indication. | Colour commands for pushbutton 3 LED indication. | +| 38 | ON indication RGB-saturation for pushbutton 3 | ON indication RGB-saturation for pushbutton 3 | +| 39 | OFF indication RGB-saturation for pushbutton 3 | OFF indication RGB-saturation for pushbutton 3 | +| 40 | Pushbutton 4 functionality. | Pushbutton 4 functionality. | +| 41 | Timer value for pushbutton 4 | Timer value for pushbutton 4 | +| 42 | Multi-Level Switch Set values for pushbutton 4. | Multi-Level Switch Set values for pushbutton 4. | +| 43 | Binary Switch Set support for pushbutton 4. | Binary Switch Set support for pushbutton 4. | +| 44 | Pushbutton 4 LED indication | Pushbutton 4 LED indication | +| 45 | Colour commands for pushbutton 4 LED indication | Colour commands for pushbutton 4 LED indication | +| 46 | ON indication RGB-saturation for pushbutton 4. | ON indication RGB-saturation for pushbutton 4. | +| 47 | OFF indication RGB-saturation for pushbutton 4. | OFF indication RGB-saturation for pushbutton 4. | ### Parameter 1: Operating pushbutton(s) for dimmer @@ -483,6 +521,1369 @@ The manufacturer defined default value is ```0``` (Direct control). This parameter has the configuration ID ```config_21_1``` and is of type ```INTEGER```. +### Parameter 22: ON indication RGB-saturation for pushbutton 1 + +ON indication RGB-saturation for pushbutton 1 +This parameter specifies the saturation levels for the red, green and blue LEDs, when ON status is indicated. (Default is the ON-state indicated by a 50% blue colour). + +<table> + <tr> + <td> + <strong>Byte 1</strong> + </td> + + <td> + <strong>Colour saturation, red.</strong> + </td> + </tr> + + <tr> + <td> + <p> + 0-255 + </p> + </td> + + <td> + <p> + Specifies the saturation for the red LEDs. (Default is 0) + </p> + </td> + </tr> + + <tr> + <td> + <strong>Byte 2</strong> + </td> + + <td> + <strong>Colour saturation, green.</strong> + </td> + </tr> + + <tr> + <td> + <p> + 0 – 255 + </p> + </td> + + <td> + <p> + Specifies the saturation for the green LEDs. (Default is 0) + </p> + </td> + </tr> + + <tr> + <td> + <strong>Byte 3</strong> + </td> + + <td> + <strong>Colour saturation, blue</strong> + </td> + </tr> + + <tr> + <td> + 0 - 255 + </td> + + <td> + <p> + Specifies the saturation for the blue LEDs. (Default is 127) + </p> + </td> + </tr> + + <tr> + <td> + <strong>Byte 4</strong> + </td> + + <td> + <strong>Led Control.</strong> + </td> + </tr> + + <tr> + <td> + 0 - 255 + </td> + + <td> + <p> + LED indicator control; see the application note about this parameter. (Default is 0) + </p> + </td> + </tr> +</table>This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```32512```. + +This parameter has the configuration ID ```config_22_4``` and is of type ```INTEGER```. + + +### Parameter 23: OFF indication RGB-saturation for pushbutton 1 + +OFF indication RGB-saturation for pushbutton 1 +This parameter specifies the saturation levels for the red, green and blue LEDs, when OFF status is indicated. (Default is the OFF-state indicated as a low white light on 5%). + +<table> + <tr> + <td> + <strong>Byte 1</strong> + </td> + + <td> + <strong>Colour saturation, red.</strong> + </td> + </tr> + + <tr> + <td> + 0 - 255 + </td> + + <td> + Specifies the saturation for the red LEDs. (Default is 47). + </td> + </tr> + + <tr> + <td> + <strong>Byte 2</strong> + </td> + + <td> + <strong>Colour saturation, green. </strong> + </td> + </tr> + + <tr> + <td> + 0 – 255  + </td> + + <td> + Specifies the saturation for the green LEDs. (Default is 47)  + </td> + </tr> + + <tr> + <td> + <strong>Byte 3</strong> + </td> + + <td> + <strong>Colour saturation, blue. </strong> + </td> + </tr> + + <tr> + <td> + 0 - 255 + </td> + + <td> + Specifies the saturation for the blue LEDs. (Default is 47) + </td> + </tr> + + <tr> + <td> + <strong>Byte 4</strong> + </td> + + <td> + <strong>LED control.</strong> + </td> + </tr> + + <tr> + <td> + 0 - 255  + </td> + + <td> + LED indicator control; see the application note about this parameter. (Default is 0) + </td> + </tr> +</table>This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 65535 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_23_4``` and is of type ```INTEGER```. + + +### Parameter 24: Pushbutton 2 functionality + +Pushbutton 2 functionality + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Standard toggle-function | +| 1 | Automatic turn off after the time has expired | +| 2 | Automatic turn on after the time has expired | +| 3 | Always turn off or dim down | +| 4 | Always turn on or dim up | + +The manufacturer defined default value is ```0``` (Standard toggle-function). + +This parameter has the configuration ID ```config_24_1``` and is of type ```INTEGER```. + + +### Parameter 25: Timer value for pushbutton 2 + +Timer value for pushbutton 2 +This parameter specifies the time used by the previous configuration parameter. + +<table> + <tr> + <td> + 0 – 43200  + </td> + + <td> + Specifies the time in seconds. Default is 300 = 5 minutes. + </td> + </tr> +</table>This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 43200 may be set. + +The manufacturer defined default value is ```300```. + +This parameter has the configuration ID ```config_25_2``` and is of type ```INTEGER```. + + +### Parameter 26: Multi-Level Switch Set values for pushbutton 2. + +Multi-Level Switch Set values for pushbutton 2. +<table> + <tr> + <td> + <strong>Byte 1</strong> + </td> + + <td> + <strong>Enable / Disable</strong> + </td> + </tr> + + <tr> + <td> + </td> + + <td> + <p> + Disabled – A single activation of the pushbutton will not send commands to devices in association group 4. + </p> + </td> + </tr> + + <tr> + <td> + 1 + </td> + + <td> + <p> + Enabled – A single activation will send commands to devices in association group 4. Devices will receive commands with the values set in Byte 2 and 3 (Default). + </p> + </td> + </tr> + + <tr> + <td> + <strong>Byte 2</strong> + </td> + + <td> + <strong>Upper switch value</strong> + </td> + </tr> + + <tr> + <td> + <p> + 0 - 99, 255 + </p> + </td> + + <td> + <p> + When single pressing the pushbutton for ON, a Multilevel Switch Set with this value will be send to devices in association group 4. (Default = 255) + </p> + </td> + </tr> + + <tr> + <td> + <strong>Byte 3</strong> + </td> + + <td> + <strong>Lower switch value</strong> + </td> + </tr> + + <tr> + <td> + 0 - 99 + </td> + + <td> + <p> + hen single pressing the pushbutton for OFF, a Multilevel Switch Set with this value will be send to devices in association group 4. (Default = 0) + </p> + </td> + </tr> + + <tr> + <td> + <strong>Byte 4</strong> + </td> + + <td> + <strong>Not used</strong> + </td> + </tr> + + <tr> + <td> + </td> + + <td> + must be set to 0. + </td> + </tr> +</table>This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 65535 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_26_4``` and is of type ```INTEGER```. + + +### Parameter 27: Binary Switch Set support for pushbutton 2 + +Binary Switch Set support for pushbutton 2 +This parameter specifies how received Binary Switch Set commands are handled. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | control pushbutton indicator LEDs | +| 1 | Controls LED's and state | +| 2 | As activated the pushbutton | + +The manufacturer defined default value is ```0``` ( control pushbutton indicator LEDs). + +This parameter has the configuration ID ```config_27_1``` and is of type ```INTEGER```. + + +### Parameter 28: Pushbutton 2 LED indication. + +Pushbutton 2 LED indication. +This parameter specifies how the LED indication is controlled. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED control is disabled | +| 1 | The LED indication follows the switch status. | +| 2 | follows the switch status , inverse | +| 3 | Same as 1 | +| 4 | Same as 2 | +| 5 | Follow internal dimmer | +| 6 | Follow internal dimmer inverse | +| 7 | ON for 5 seconds when the pushbutton is activated | + +The manufacturer defined default value is ```7``` (ON for 5 seconds when the pushbutton is activated). + +This parameter has the configuration ID ```config_28_1``` and is of type ```INTEGER```. + + +### Parameter 29: Colour commands for pushbutton 2 LED indication. + +Colour commands for pushbutton 2 LED indication. +This parameter specifies how Command Class Switch Color commands is handled. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Direct control | +| 1 | Colour for OFF indication | +| 2 | Colour for ON indication | + +The manufacturer defined default value is ```1``` (Colour for OFF indication). + +This parameter has the configuration ID ```config_29_1``` and is of type ```INTEGER```. + + +### Parameter 30: ON indication RGB-saturation for pushbutton 2 + +ON indication RGB-saturation for pushbutton 2 +This parameter specifies the saturation levels for the red, green and blue LEDs, when ON status is indicated. (Default is the ON-state indicated by a 50% blue colour). + +<table> + <tr> + <td> + <strong>Byte 1</strong> + </td> + + <td> + <strong>Colour saturation, red.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the red LEDs. (Default is 0) + </td> + </tr> + + <tr> + <td> + <strong>Byte 2</strong> + </td> + + <td> + <strong>Colour saturation, green.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the green LEDs. (Default is 0) + </td> + </tr> + + <tr> + <td> + <strong>Byte 3</strong> + </td> + + <td> + <strong>Colour saturation, blue.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the blue LEDs. (Default is 127) + </td> + </tr> + + <tr> + <td> + <strong>Byte 4</strong> + </td> + + <td> + <strong>LED control</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + LED indicator control; see the application note about this parameter. (Default is 0) + </td> + </tr> +</table> +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```32512```. + +This parameter has the configuration ID ```config_30_4``` and is of type ```INTEGER```. + + +### Parameter 31: OFF indication RGB-saturation for pushbutton 2. + +OFF indication RGB-saturation for pushbutton 2. +This parameter specifies the saturation levels for the red, green and blue LEDs, when OFF status is indicated. (Default is the OFF-state indicated as a low white light on 5%). + +<table> + <tr> + <td> + <strong>Byte 1</strong> + </td> + + <td> + <strong>Colour saturation, red</strong> + </td> + </tr> + + <tr> + <td> + 0 - 255 + </td> + + <td> + Specifies the saturation for the red LEDs. (Default is 47) + </td> + </tr> + + <tr> + <td> + <strong>Byte 2</strong> + </td> + + <td> + <strong>Colour saturation, green</strong> + </td> + </tr> + + <tr> + <td> + 0 - 255 + </td> + + <td> + Specifies the saturation for the green LEDs. (Default is 47) + </td> + </tr> + + <tr> + <td> + <strong>Byte 3</strong> + </td> + + <td> + <strong>Colour saturation, blue</strong> + </td> + </tr> + + <tr> + <td> + 0 - 255 + </td> + + <td> + Specifies the saturation for the blue LEDs. (Default is 47) + </td> + </tr> + + <tr> + <td> + <strong>Byte 4</strong> + </td> + + <td> + <strong>LED control</strong> + </td> + </tr> + + <tr> + <td> + 0 - 255 + </td> + + <td> + LED indicator control; see the application note about this parameter. (Default is 0) + </td> + </tr> +</table> +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```791621376```. + +This parameter has the configuration ID ```config_31_4``` and is of type ```INTEGER```. + + +### Parameter 32: Pushbutton 3 functionality + +Pushbutton 3 functionality + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Standard toggle-function | +| 1 | Automatic turn off after the time has expired | +| 2 | Automatic turn on after the time has expired | +| 3 | Always turn off or dim down | +| 4 | Always turn on or dim up | + +The manufacturer defined default value is ```0``` (Standard toggle-function). + +This parameter has the configuration ID ```config_32_1``` and is of type ```INTEGER```. + + +### Parameter 33: Timer value for pushbutton 3 + +Timer value for pushbutton 3 +This parameter specifies the time used by the previous configuration parameter. + +<table> + <tr> + <td> + 0 – 43200 + </td> + + <td> + Specifies the time in seconds. Default is 300 = 5 minutes. + </td> + </tr> +</table> +Values in the range 0 to 43200 may be set. + +The manufacturer defined default value is ```300```. + +This parameter has the configuration ID ```config_33_2``` and is of type ```INTEGER```. + + +### Parameter 34: Multi-Level Switch Set values for pushbutton 3 + +Multi-Level Switch Set values for pushbutton 3 +<table> + <tr> + <td> + Byte 1 + </td> + + <td> + Enable / Disable + </td> + </tr> + + <tr> + <td> + </td> + + <td> + <p> + Disabled – A single activation of the pushbutton will not send commands to devices in association group 4 + </p> + </td> + </tr> + + <tr> + <td> + 1 + </td> + + <td> + <p> + Enabled – A single activation will send commands to devices in association group 4. Devices will receive commands with the values set in Byte 2 and 3 (Default) + </p> + </td> + </tr> + + <tr> + <td> + Byte 2 + </td> + + <td> + Upper switch value + </td> + </tr> + + <tr> + <td> + 0-99, 255 + </td> + + <td> + <p> + When single pressing the pushbutton for ON, a Multilevel Switch Set with this value will be send to devices in association group 4. (Default = 255) + </p> + </td> + </tr> + + <tr> + <td> + Byte 3 + </td> + + <td> + Lower switch value + </td> + </tr> + + <tr> + <td> + 0-99 + </td> + + <td> + <p> + When single pressing the pushbutton for OFF, a Multilevel Switch Set with this value will be send to devices in association group 4. (Default = 0) + </p> + </td> + </tr> + + <tr> + <td> + Byte 4 + </td> + + <td> + Not used + </td> + </tr> + + <tr> + <td> + </td> + + <td> + must be set to 0 + </td> + </tr> +</table> +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```33488896```. + +This parameter has the configuration ID ```config_34_4``` and is of type ```INTEGER```. + + +### Parameter 35: Binary Switch Set support for pushbutton 3 + +Binary Switch Set support for pushbutton 3 +This parameter specifies how received Binary Switch Set commands are handled. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | controls the pushbutton indicator LED | +| 1 | controls the internal switch status | +| 2 | As if user had activated the pushbutton | + +The manufacturer defined default value is ```0``` (controls the pushbutton indicator LED). + +This parameter has the configuration ID ```config_35_1``` and is of type ```INTEGER```. + + +### Parameter 36: Pushbutton 3 LED indication + +Pushbutton 3 LED indication +This parameter specifies how the LED indication is controlled +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Internal LED control is disabled | +| 1 | follows the switch status | +| 2 | follows the switch status , inverse | +| 3 | Same as 1 | +| 4 | Same as 2 | +| 5 | Follow internal dimmer | +| 6 | Follow internal dimmer inverse | +| 7 | ON for 5 seconds when the pushbutton is activated | + +The manufacturer defined default value is ```7``` (ON for 5 seconds when the pushbutton is activated). + +This parameter has the configuration ID ```config_36_1``` and is of type ```INTEGER```. + + +### Parameter 37: Colour commands for pushbutton 3 LED indication. + +Colour commands for pushbutton 3 LED indication. +This parameter specifies how Command Class Switch Color commands are handled. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Direct control | +| 1 | Color for OFF state | +| 2 | Color for ON state | + +The manufacturer defined default value is ```1``` (Color for OFF state). + +This parameter has the configuration ID ```config_37_1``` and is of type ```INTEGER```. + + +### Parameter 38: ON indication RGB-saturation for pushbutton 3 + +ON indication RGB-saturation for pushbutton 3 +This parameter specifies the saturation levels for the red, green and blue LEDs, when ON status is indicated. (Default is the ON-state indicated by a 50% blue colour). + +<table> + <tr> + <td> + <strong>Byte 1</strong> + </td> + + <td> + <strong>Colour saturation, red.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the red LEDs. (Default is 0) + </td> + </tr> + + <tr> + <td> + <strong>Byte 2</strong> + </td> + + <td> + <strong>Colour saturation, green.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the green LEDs. (Default is 0) + </td> + </tr> + + <tr> + <td> + <strong>Byte 3</strong> + </td> + + <td> + <strong>Colour saturation, blue.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the blue LEDs. (Default is 127) + </td> + </tr> + + <tr> + <td> + <strong>Byte 4</strong> + </td> + + <td> + <strong>LED Control</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + LED indicator control; see the application note about this parameter. (Default is 0) + </td> + </tr> +</table> +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```32512```. + +This parameter has the configuration ID ```config_38_4``` and is of type ```INTEGER```. + + +### Parameter 39: OFF indication RGB-saturation for pushbutton 3 + +OFF indication RGB-saturation for pushbutton 3 +This parameter specifies the saturation levels for the red, green and blue LEDs, when OFF status is indicated. (Default is the OFF-state indicated as a low white light on 5%). + +<table> + <tr> + <td> + <strong>Byte 1</strong> + </td> + + <td> + <strong>Colour saturation, red.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the red LEDs. (Default is 47) + </td> + </tr> + + <tr> + <td> + <strong>Byte 2</strong> + </td> + + <td> + <strong>Colour saturation, green.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the green LEDs. (Default is 47) + </td> + </tr> + + <tr> + <td> + <strong>Byte 3</strong> + </td> + + <td> + <strong>Colour saturation, blue.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the blue LEDs. (Default is 47) + </td> + </tr> + + <tr> + <td> + <strong>Byte 4</strong> + </td> + + <td> + <strong>LED Control</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + LED indicator control; see the application note about this parameter. (Default is 0)<br /><br /> + </td> + </tr> +</table> +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```791621376```. + +This parameter has the configuration ID ```config_39_4``` and is of type ```INTEGER```. + + +### Parameter 40: Pushbutton 4 functionality. + +Pushbutton 4 functionality. +This parameter specifies the functionality of pushbutton 4. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Toggle-function | +| 1 | Automatic turn off after the time has expired | +| 2 | Automatic turn on after the time has expired | +| 3 | Always turn off or dim down | +| 4 | Always turn on or dim up | + +The manufacturer defined default value is ```0``` (Toggle-function). + +This parameter has the configuration ID ```config_40_1``` and is of type ```INTEGER```. + + +### Parameter 41: Timer value for pushbutton 4 + +Timer value for pushbutton 4 +This parameter specifies the time used be the previous configuration parameter + +Specifies the time in seconds. Default is 300 = 5 minutes. +Values in the range 0 to 43200 may be set. + +The manufacturer defined default value is ```300```. + +This parameter has the configuration ID ```config_41_2``` and is of type ```INTEGER```. + + +### Parameter 42: Multi-Level Switch Set values for pushbutton 4. + +Multi-Level Switch Set values for pushbutton 4. +<table> + <tr> + <td> + <strong>Byte 1</strong> + </td> + + <td> + <strong>Enable / Disable</strong> + </td> + </tr> + + <tr> + <td> + </td> + + <td> + <p> + Disabled – A single activation of the pushbutton will not send commands to devices in association group 4. + </p> + </td> + </tr> + + <tr> + <td> + 1 + </td> + + <td> + <p> + Enabled – A single activation will send commands to devices in association group 4. Devices will receive commands with the values set in Byte 2 and 3 (Default). + </p> + </td> + </tr> + + <tr> + <td> + <strong>Byte 2</strong> + </td> + + <td> + <strong>Upper switch value</strong> + </td> + </tr> + + <tr> + <td> + 0-99, 255 + </td> + + <td> + <p> + When single pressing the pushbutton for ON, a Multilevel Switch Set with this value will be send to devices in association group 4. (Default = 255) + </p> + </td> + </tr> + + <tr> + <td> + <strong>Byte 3</strong> + </td> + + <td> + <strong>Lower switch value</strong> + </td> + </tr> + + <tr> + <td> + 0-99 + </td> + + <td> + <p> + When single pressing the pushbutton for OFF, a Multilevel Switch Set with this value will be send to devices in association group 4. (Default = 0) + </p> + </td> + </tr> + + <tr> + <td> + <strong>Byte 4</strong> + </td> + + <td> + <strong>Not used</strong> + </td> + </tr> + + <tr> + <td> + </td> + + <td> + must be set to 0. + </td> + </tr> +</table> +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```33488896```. + +This parameter has the configuration ID ```config_42_4``` and is of type ```INTEGER```. + + +### Parameter 43: Binary Switch Set support for pushbutton 4. + +Binary Switch Set support for pushbutton 4. +This parameter specifies how received Binary Switch Set commands are handled. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Pushbutton LED indication | +| 1 | controls the internal switch status | +| 2 | As activated the pushbutton | + +The manufacturer defined default value is ```0``` (Pushbutton LED indication). + +This parameter has the configuration ID ```config_43_1``` and is of type ```INTEGER```. + + +### Parameter 44: Pushbutton 4 LED indication + +Pushbutton 4 LED indication +This parameter specifies how the LED indication is controlled. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED control is disabled | +| 1 | follows the switch status | +| 2 | follows the switch status , inverse | +| 3 | Same as 1 | +| 4 | Same as 2 | +| 5 | Follow internal dimmer | +| 6 | Follow internal dimmer inverse | +| 7 | ON for 5 seconds when the pushbutton is activated | + +The manufacturer defined default value is ```7``` (ON for 5 seconds when the pushbutton is activated). + +This parameter has the configuration ID ```config_44_1``` and is of type ```INTEGER```. + + +### Parameter 45: Colour commands for pushbutton 4 LED indication + +Colour commands for pushbutton 4 LED indication +This parameter specifies how Command Class Switch Color commands are handled. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Direct control | +| 1 | Color for OFF state | +| 2 | Color for ON state | + +The manufacturer defined default value is ```1``` (Color for OFF state). + +This parameter has the configuration ID ```config_45_1``` and is of type ```INTEGER```. + + +### Parameter 46: ON indication RGB-saturation for pushbutton 4. + +ON indication RGB-saturation for pushbutton 4. +This parameter specifies the saturation levels for the red, green and blue LEDs, when ON status is indicated. (Default is the ON-state indicated by a 50% blue colour). + +<table> + <tr> + <td> + <strong>Byte 1</strong> + </td> + + <td> + <strong>Colour saturation, red.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the red LEDs. (Default is 0) + </td> + </tr> + + <tr> + <td> + <strong>Byte 2</strong> + </td> + + <td> + <strong>Colour saturation, green.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the green LEDs. (Default is 0) + </td> + </tr> + + <tr> + <td> + <strong>Byte 3</strong> + </td> + + <td> + <strong>Colour saturation, blue.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the blue LEDs. (Default is 127) + </td> + </tr> + + <tr> + <td> + <strong>Byte 4</strong> + </td> + + <td> + <strong>LED Control</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + LED indicator control; see the application note about this parameter. (Default is 0) + </td> + </tr> +</table> +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```32512```. + +This parameter has the configuration ID ```config_46_4``` and is of type ```INTEGER```. + + +### Parameter 47: OFF indication RGB-saturation for pushbutton 4. + +OFF indication RGB-saturation for pushbutton 4. +This parameter specifies the saturation levels for the red, green and blue LEDs, when OFF status is indicated. (Default is the OFF-state indicated as a low white light on 5%). + +<table> + <tr> + <td> + <strong>Byte 1</strong> + </td> + + <td> + <strong>Colour saturation, red.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the red LEDs. (Default is 47) + </td> + </tr> + + <tr> + <td> + <strong>Byte 2</strong> + </td> + + <td> + <strong>Colour saturation, green.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the green LEDs. (Default is 47) + </td> + </tr> + + <tr> + <td> + <strong>Byte 3</strong> + </td> + + <td> + <strong>Colour saturation, blue.</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + Specifies the saturation for the blue LEDs. (Default is 47) + </td> + </tr> + + <tr> + <td> + <strong>Byte 4</strong> + </td> + + <td> + <strong>LED Control</strong> + </td> + </tr> + + <tr> + <td> + 0-255 + </td> + + <td> + LED indicator control; see the application note about this parameter. (Default is 0)<br /><br /> + </td> + </tr> +</table> +Values in the range 0 to 4294967295 may be set. + +The manufacturer defined default value is ```791621376```. + +This parameter has the configuration ID ```config_47_4``` and is of type ```INTEGER```. + + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. diff --git a/_addons_bindings/zwave/doc/nodon/asp31_0_0.md b/_addons_bindings/zwave/doc/nodon/asp31_0_0.md index be0f1c6ba..1bc0f655a 100644 --- a/_addons_bindings/zwave/doc/nodon/asp31_0_0.md +++ b/_addons_bindings/zwave/doc/nodon/asp31_0_0.md @@ -8,6 +8,11 @@ title: ASP-3-1 - ZWave # ASP-3-1 Smart Plug This describes the Z-Wave device *ASP-3-1*, manufactured by *[ID-RF](http://www.nodon.fr/)* with the thing type UID of ```nodon_asp31_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![ASP-3-1 product image](https://www.cd-jackson.com/zwave_device_uploads/425/425_default.png) + + The ASP-3-1 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 between other devices in the mesh network. ## Overview @@ -46,25 +51,23 @@ To remove the Smart Plug from a Z-Wave network: The following table summarises the channels available for the ASP-3-1 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Alarm (system) | alarm_system | | Switch | -| Alarm (power) | alarm_power | Door | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Alarm (system) | alarm_system | alarm_system | | Switch | +| Alarm (power) | alarm_power | alarm_power | Energy | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Alarm (system) - DELETE ME (alarm_system seems to be unsupported) Indicates if a system alarm is triggered. -The ```alarm_system``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_system``` channel is of type ```alarm_system``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -74,10 +77,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Alarm (power) - Indicates if a power alarm is triggered. -The ```alarm_power``` 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. +The ```alarm_power``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -95,15 +97,15 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 1 | Default State | | -| 2 | Power Failure | | +| 1 | Default State | Default State | +| 2 | Power Failure | Power Failure | | 3 | Follow State | | | 4 | Always On | | | | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | ### Parameter 1: Default State - +Default State Status of the Smart Plug after a Power Failure or after being plugged The following option values may be configured, in addition to values in the range 0 to 63 -: @@ -120,7 +122,7 @@ This parameter has the configuration ID ```config_1_1``` and is of type ```INTEG ### Parameter 2: Power Failure - +Power Failure This parameter is to set-up the Power Failure / Recover notification and the associated group (Groups 4, 5, 6, 7, 8). The value may be a sum of available values. For example, if you want to activate Power Failure and enable group 4 & 5, the parameter value should be 1+2+4=7. diff --git a/_addons_bindings/zwave/doc/nodon/crc3100_0_0.md b/_addons_bindings/zwave/doc/nodon/crc3100_0_0.md index 352e06b2a..45672035b 100644 --- a/_addons_bindings/zwave/doc/nodon/crc3100_0_0.md +++ b/_addons_bindings/zwave/doc/nodon/crc3100_0_0.md @@ -49,6 +49,9 @@ The CRC-3100 does not permanently listen for messages sent from the controller - 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. + +When the product in ""Gateway"" mode, any action on button will send a wake up notification to the gateway. + ## Channels The following table summarises the channels available for the CRC-3100 -: @@ -56,12 +59,12 @@ The following table summarises the channels available for the CRC-3100 -: | Channel Name | Channel ID | Channel Type | Category | Item Type | |--------------|------------|--------------|----------|-----------| | Scene Number | scene_number | scene_number | | Number | -| Battery Level | battery-level | Battery | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Scene Number Triggers when a scene button is pressed. -The ```scene_number``` channel and is of type ```scene_number``` and supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: | Event ID | Event Description | @@ -75,8 +78,10 @@ This channel provides the scene, and the event as a decimal value in the form `` | 6 | 5 x keypress | ### Battery Level -Channel type information on this channel is not found. +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 is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -226,7 +231,7 @@ The following option values may be configured -: | 0 | No LED | | 1 | Flash Blue after button press | | 2 | Blink to confirm command | -| 3 | Flash Blue after button press and blink to confirm command | +| 3 | Flash Blue and blink to confirm command | The manufacturer defined default value is ```0``` (No LED). diff --git a/_addons_bindings/zwave/doc/nodon/cws3101_0_0.md b/_addons_bindings/zwave/doc/nodon/cws3101_0_0.md index 4fd669f60..b32db8d96 100644 --- a/_addons_bindings/zwave/doc/nodon/cws3101_0_0.md +++ b/_addons_bindings/zwave/doc/nodon/cws3101_0_0.md @@ -17,26 +17,40 @@ The CWS-3101 does not permanently listen for messages sent from the controller - ## Overview +The NodOn® wall switch controls any compatible receivers Z-Wave® or Z-Wave Plus®, such as the Smart Plug NodOn®. It can address, directly, up to 4 groups of 8 devices and sent up to 16 different scenes to a Home Automation Gateway. This controller can operate on its own (“Standalone” Mode) or as gateway’s assistant (“Gateway” Mode). The product integrates a LED, which give an intuitive feedback for each operation you perform.  + +### Inclusion Information + + 1. Simultaneously push on 1 and 2, during 1sec. The LED glows in pink to confirm the selection + 2. Push on 1, within 10 seconds. The LED blinks in pink to confirm your choice The LED blinks in green to confirm the procedure + +### Exclusion Information + + 1. Simultaneously push on 1 and 2, during 1sec. The LED glows in pink to confirm the selection + 2. Push on 1, within 10 seconds. The LED blinks in pink to confirm your choice The LED blinks in green to confirm the procedure + ### Wakeup Information The CWS-3101 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. + + When the product in ""Gateway"" mode, any action on button will send a wake up notification to the gateway.  + ## Channels The following table summarises the channels available for the CWS-3101 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Scene Number | scene_number | | Number | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Scene Number | scene_number | scene_number | | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: | Event ID | Event Description | @@ -50,11 +64,10 @@ This channel provides the scene, and the event as a decimal value in the form `` | 6 | 5 x keypress | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -204,7 +217,7 @@ The following option values may be configured -: | 0 | No LED | | 1 | Flash Blue after button press | | 2 | Blink to confirm command | -| 3 | Flash Blue after button press and blink to confirm command | +| 3 | Flash Blue and blink to confirm command | The manufacturer defined default value is ```0``` (No LED). diff --git a/_addons_bindings/zwave/doc/nodon/msp31x1_0_0.md b/_addons_bindings/zwave/doc/nodon/msp31x1_0_0.md index 80215bbe9..aafb03de6 100644 --- a/_addons_bindings/zwave/doc/nodon/msp31x1_0_0.md +++ b/_addons_bindings/zwave/doc/nodon/msp31x1_0_0.md @@ -8,54 +8,65 @@ title: MSP-3-1-X1 - ZWave # MSP-3-1-X1 Z-Wave Plus Micro Smart Plug ON/OFF This describes the Z-Wave device *MSP-3-1-X1*, manufactured by *[ID-RF](http://www.nodon.fr/)* with the thing type UID of ```nodon_msp31x1_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![MSP-3-1-X1 product image](https://www.cd-jackson.com/zwave_device_uploads/435/435_default.png) + + The MSP-3-1-X1 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 between other devices in the mesh network. ## 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/435) to improve the documentation. +The NodOn Micro Smart Plug can be controlled by any kind of Z-Wave® (or Z-Wave Plus®) gateway or other Z-Wave® controller (standalone mode) such as the NodOn® Soft Remote or Octan Remote.  +It existed in both standard, Type E (French) or Schuko (German). Its very small design and volume allow easy integration, without obstructing nearby power holes on a power strip. Furthermore, it can perform Power and Energy Metering.  +The NodOn Smart Plug is based on brand new 500 series Z-Wave® module from Sigma Designs®, and support all the new features of Z-Wave Plus® standard:  +Longer range (up to 40m), lower power consumption, higher data rate transmission, and many more new features. + +### Inclusion Information + +To include/add to the Z-Wave network, long press during 2 seconds to send several NIF during 30 seconds or a triple press to send a single NIF  + +### Exclusion Information + +To exclude/remove from the Z-Wave network, long press during 2 seconds to send several NIF during 30 seconds or a triple press to send a single NIF  ## Channels The following table summarises the channels available for the MSP-3-1-X1 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Reset Meter | meter_reset | Energy | Switch | -| Alarm (power) | alarm_power | Door | Switch | -| Alarm (system) | alarm_system | | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Reset Meter | meter_reset | meter_reset | Energy | Switch | +| Alarm (power) | alarm_power | alarm_power | Energy | Switch | +| Alarm (system) | alarm_system | alarm_system | | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Reset Meter - Reset the meter. -The ```meter_reset``` channel supports the ```Switch``` item and is in the ```Energy``` category. +The ```meter_reset``` channel is of type ```meter_reset``` and supports the ```Switch``` item and is in the ```Energy``` category. ### Alarm (power) - Indicates if a power alarm is triggered. -The ```alarm_power``` 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. +The ```alarm_power``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -65,10 +76,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Alarm (system) - Indicates if a system alarm is triggered. -The ```alarm_system``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_system``` channel is of type ```alarm_system``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -191,11 +201,11 @@ The following option values may be configured, in addition to values in the rang | 200 | Overload Report enable with a upper limit of 200 W | | 250 | Overload Report enable with a upper limit of 250 W | | 500 | Overload Report enable with a upper limit of 500 W | -| 1000 | Overload Report enable with a upper limit of 1000 W | -| 1500 | Overload Report enable with a upper limit of 1500 W | -| 2000 | Overload Report enable with a upper limit of 2000 W | +| 1000 | Upper limit of 1000 W | +| 1500 | Upper limit of 1500 W | +| 2000 | Upper limit of 2000 W | -The manufacturer defined default value is ```2000``` (Overload Report enable with a upper limit of 2000 W). +The manufacturer defined default value is ```2000``` (Upper limit of 2000 W). This parameter has the configuration ID ```config_22_2``` and is of type ```INTEGER```. @@ -209,20 +219,20 @@ The following option values may be configured, in addition to values in the rang | Value | Description | |--------|-------------| | 0 | Energy Auto-Polling Report Disable | -| 1000 | Energy Auto-Polling Report enable if 1000 Wh variation | -| 2000 | Energy Auto-Polling Report enable if 2000 Wh variation | -| 3000 | Energy Auto-Polling Report enable if 3000 Wh variation | -| 4000 | Energy Auto-Polling Report enable if 4000 Wh variation | -| 5000 | Energy Auto-Polling Report enable if 5000 Wh variation | -| 10000 | Energy Auto-Polling Report enable if 10.000 Wh variation | -| 20000 | Energy Auto-Polling Report enable if 20.000 Wh variation | -| 30000 | Energy Auto-Polling Report enable if 30.000 Wh variation | -| 40000 | Energy Auto-Polling Report enable if 40.000 Wh variation | -| 50000 | Energy Auto-Polling Report enable if 50.000 Wh variation | -| 60000 | Energy Auto-Polling Report enable if 60.000 Wh variation | -| 65535 | Energy Auto-Polling Report enable if 65.535 Wh variation | +| 1000 | Enable if 1000 Wh variation | +| 2000 | Enable if 2000 Wh variation | +| 3000 | Enable if 3000 Wh variation | +| 4000 | Enable if 4000 Wh variation | +| 5000 | Enable if 5000 Wh variation | +| 10000 | Enable if 10.000 Wh variation | +| 20000 | Enable if 20.000 Wh variation | +| 30000 | Enable if 30.000 Wh variation | +| 40000 | Enable if 40.000 Wh variation | +| 50000 | Enable if 50.000 Wh variation | +| 60000 | Enable if 60.000 Wh variation | +| 65535 | Enable if 65.535 Wh variation | -The manufacturer defined default value is ```1000``` (Energy Auto-Polling Report enable if 1000 Wh variation). +The manufacturer defined default value is ```1000``` (Enable if 1000 Wh variation). This parameter has the configuration ID ```config_23_2``` and is of type ```INTEGER```. @@ -237,8 +247,8 @@ The following option values may be configured, in addition to values in the rang |--------|-------------| | 0 | Metering Pulse disable | | 3600 | Metering Pulse enable and send report every hour | -| 21600 | Metering Pulse enable and send report every 6 hours | -| 43200 | Metering Pulse enable and send report every 12 hours | +| 21600 | Enable and send report every 6 hours | +| 43200 | Enable and send report every 12 hours | The manufacturer defined default value is ```3600``` (Metering Pulse enable and send report every hour). @@ -254,21 +264,21 @@ The following option values may be configured, in addition to values in the rang | Value | Description | |--------|-------------| | 0 | Power High Threshold disable | -| 10 | Power High Threshold enable with the value from 10 W | -| 20 | Power High Threshold enable with the value from 20 W | -| 30 | Power High Threshold enable with the value from 30 W | -| 40 | Power High Threshold enable with the value from 40 W | -| 50 | Power High Threshold enable with the value from 50 W | -| 100 | Power High Threshold enable with the value from 100 W | -| 200 | Power High Threshold enable with the value from 200 W | -| 300 | Power High Threshold enable with the value from 300 W | -| 400 | Power High Threshold enable with the value from 400 W | -| 500 | Power High Threshold enable with the value from 500 W | -| 1000 | Power High Threshold enable with the value from 1000 W | -| 1500 | Power High Threshold enable with the value from 1500 W | -| 2000 | Power High Threshold enable with the value from 2000 W | +| 10 | Power High Threshold enable 10 W | +| 20 | Power High Threshold enable 20 W | +| 30 | Power High Threshold enable 30 W | +| 40 | Power High Threshold enable 40 W | +| 50 | Power High Threshold enable 50 W | +| 100 | Power High Threshold enable 100 W | +| 200 | Power High Threshold enable 200 W | +| 300 | Power High Threshold enable 300 W | +| 400 | Power High Threshold enable 400 W | +| 500 | Power High Threshold enable 500 W | +| 1000 | Power High Threshold enable 1000 W | +| 1500 | Power High Threshold enable 1500 W | +| 2000 | Power High Threshold enable 2000 W | -The manufacturer defined default value is ```20``` (Power High Threshold enable with the value from 20 W). +The manufacturer defined default value is ```20``` (Power High Threshold enable 20 W). This parameter has the configuration ID ```config_25_2``` and is of type ```INTEGER```. @@ -282,22 +292,22 @@ The following option values may be configured, in addition to values in the rang | Value | Description | |--------|-------------| | 0 | Power Low Threshold disable | -| 5 | Power Low Threshold enable with the value from 5 W | -| 10 | Power Low Threshold enable with the value from 10 W | -| 20 | Power Low Threshold enable with the value from 20 W | -| 30 | Power Low Threshold enable with the value from 30 W | -| 40 | Power Low Threshold enable with the value from 40 W | -| 50 | Power Low Threshold enable with the value from 50 W | -| 100 | Power Low Threshold enable with the value from 100 W | -| 200 | Power Low Threshold enable with the value from 200 W | -| 300 | Power Low Threshold enable with the value from 300 W | -| 400 | Power Low Threshold enable with the value from 400 W | -| 500 | Power Low Threshold enable with the value from 500 W | -| 1000 | Power Low Threshold enable with the value from 1000 W | -| 1500 | Power Low Threshold enable with the value from 1500 W | -| 2000 | Power Low Threshold enable with the value from 2000 W | +| 5 | Power Low Threshold enable 5 W | +| 10 | Power Low Threshold enable 10 W | +| 20 | Power Low Threshold enable 20 W | +| 30 | Power Low Threshold enable 30 W | +| 40 | Power Low Threshold enable 40 W | +| 50 | Power Low Threshold enable 50 W | +| 100 | Power Low Threshold enable 100 W | +| 200 | Power Low Threshold enable 200 W | +| 300 | Power Low Threshold enable 300 W | +| 400 | Power Low Threshold enable 400 W | +| 500 | Power Low Threshold enable 500 W | +| 1000 | Power Low Threshold enable 1000 W | +| 1500 | Power Low Threshold enable 1500 W | +| 2000 | Power Low Threshold enable 2000 W | -The manufacturer defined default value is ```5``` (Power Low Threshold enable with the value from 5 W). +The manufacturer defined default value is ```5``` (Power Low Threshold enable 5 W). This parameter has the configuration ID ```config_26_2``` and is of type ```INTEGER```. diff --git a/_addons_bindings/zwave/doc/nodon/softremote_0_0.md b/_addons_bindings/zwave/doc/nodon/softremote_0_0.md index fc23e008f..85deaca91 100644 --- a/_addons_bindings/zwave/doc/nodon/softremote_0_0.md +++ b/_addons_bindings/zwave/doc/nodon/softremote_0_0.md @@ -1,37 +1,56 @@ --- layout: documentation -title: Soft Remote - ZWave +title: Soft Remote - ZWave --- {% include base.html %} # Soft Remote Remote Control -This describes the Z-Wave device *Soft Remote*, manufactured by *[ID-RF](http://www.nodon.fr/)* with the thing type UID of ```nodon_softremote_00_000```. +This describes the Z-Wave device *Soft Remote *, manufactured by *[ID-RF](http://www.nodon.fr/)* with the thing type UID of ```nodon_softremote_00_000```. -The Soft Remote 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. Refer to the *Wakeup Information* section below for further information. +The device is in the category of *Remote Control*, defining Any portable or hand-held device that controls the status of something, e.g. remote control, keyfob etc.. + +![Soft Remote product image](https://www.cd-jackson.com/zwave_device_uploads/250/250_default.png) + + +The Soft Remote 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. Refer to the *Wakeup Information* section below for further information. ## Overview +The NodOn® Soft Remote controls any compatible receivers Z-Wave® or Z-Wave Plus®, such as the Smart Plug NodOn®. It can address, directly, up to 4 groups of 8 devices and sent up to 16 different scenes to a Home Automation Gateway. This controller can operate on its own (“Standalone” Mode) or as gateway’s assistant (“Gateway” Mode). The product integrates a LED, which give an intuitive feedback for each operation you perform. + +### Inclusion Information + + 1. Simultaneously push on I and P, during 1sec. The LED glows in pink to confirm the selection + 2. Push on I, within 10 seconds. The LED blinks in pink to confirm your choice The LED blinks in green to confirm the procedure + +### Exclusion Information + + 1. Simultaneously push on I and P, during 1sec. The LED glows in pink to confirm the selection + 2. Push on I, within 10 seconds. The LED blinks in pink to confirm your choice The LED blinks in green to confirm the procedure + ### Wakeup Information -The Soft Remote 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 Soft Remote 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. + +Press on any button of the Soft Remote. + ## Channels -The following table summarises the channels available for the Soft Remote -: +The following table summarises the channels available for the Soft Remote -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Scene Number | scene_number | | Number | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Scene Number | scene_number | scene_number | | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: | Event ID | Event Description | @@ -45,16 +64,15 @@ This channel provides the scene, and the event as a decimal value in the form `` | 6 | 5 x keypress | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration -The following table provides a summary of the 8 configuration parameters available in the Soft Remote. +The following table provides a summary of the 8 configuration parameters available in the Soft Remote . Detailed information on each parameter can be found in the sections below. | Param | Name | Description | @@ -199,7 +217,7 @@ The following option values may be configured -: | 0 | No LED | | 1 | Flash Blue after button press | | 2 | Blink to confirm command | -| 3 | Flash Blue after button press and blink to confirm command | +| 3 | Flash Blue and blink to confirm command | The manufacturer defined default value is ```0``` (No LED). @@ -227,7 +245,7 @@ This parameter has the configuration ID ```wakeup_node``` and is of type ```INTE Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The Soft Remote supports 7 association groups. +The Soft Remote supports 7 association groups. ### Group 1: Lifeline @@ -287,6 +305,10 @@ Association group 7 supports 8 nodes. | COMMAND_CLASS_ASSOCIATION_V1| | | COMMAND_CLASS_VERSION_V1| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/250/nodon-crc-3-6-xx-userguide-150707-en-interactive.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/northq/nq9021_0_0.md b/_addons_bindings/zwave/doc/northq/nq9021_0_0.md index 8dc39812c..07a9c8c0f 100644 --- a/_addons_bindings/zwave/doc/northq/nq9021_0_0.md +++ b/_addons_bindings/zwave/doc/northq/nq9021_0_0.md @@ -8,6 +8,8 @@ title: NQ-9021 - ZWave # NQ-9021 Electrical Meter This describes the Z-Wave device *NQ-9021*, manufactured by *NorthQ* with the thing type UID of ```northq_nq9021_00_000```. +The device is in the category of *Sensor*, defining Device used to measure something. + ![NQ-9021 product image](https://www.cd-jackson.com/zwave_device_uploads/180/180_default.jpg) @@ -17,39 +19,49 @@ The NQ-9021 does not permanently listen for messages sent from the controller - ## Overview +The Z-Wave Smart Meter Sensor is a compact sensor designed to read meter values from traditional electromechanical and electronic meters with optical port. The sensor is easy to install and ideal for precise meter reading down to 0,1kwh. Its compact size and external wireless transmitter makes it easy to install in any distribution board. The device is battery powered (will last about 1 year) and reports the meter value once in 15 minutes. If there won't be a Z-Wave network, the device will store values up to 3 month. This ensures, that the system can even be used in a minimal configuration with a simple Z-Wave USB Stick (Not part of delivery!) connected to a PC. + +### Inclusion Information + +Press the sensor button 3 times + +### Exclusion Information + +Press the sensor button 3 times + ### Wakeup Information The NQ-9021 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. + +A single click on the Z-Wave button will wake up the device + ## Channels The following table summarises the channels available for the NQ-9021 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset | time_offset | Temperature | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset - Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. @@ -63,17 +75,17 @@ Detailed information on each parameter can be found in the sections below. | 1 | Pulse factor | Impulse or Rotation factor per KWh * 10 | | 2 | Sensor type | | | 3 | IR Listen period | Additional time for feedback measurement. Should always be 0. | -| 4 | IR Pulse Width | Adjusts transmit signal so received signal will in average be equal to this values. | -| 5 | Poll / Wake up frequency | Wake device up this many times per second. This value also controls number of measurements per second on mechanical meters | +| 4 | IR Pulse Width | IR Pulse Width | +| 5 | Poll / Wake up frequency | Poll / Wake up frequency | | 6 | Pulse Threshold Low | Low detection threshold for wheel meters | | 7 | Pulse Threshold High | High detection threshold for wheel meters | | 8 | Wakeup Interval | like WAKEUP command class | | 9 | Pulse count | Total pulse count (Meter reading / impulse factor) | | 10 | Keep alive period | How many seconds before going back to sleep in normal wakeup mode. | -| 11 | Real-time mode | Set this to enter real-time mode from remote. Contains seconds * poll frequency before going back to sleep. If you press the button once this value will be set. | +| 11 | Real-time mode | Real-time mode | | 12 | Serial number | Read-only serial number in decimal | | 13 | Debug mode | | -| 15 | Calibration status | The calibration progress is calculated as (value[1] - 65 + value[2] / value[3]) * 25. The calibration is finished successfully when value[0] = 2 and value[2] = value[3]. The calibration has failed if value[0] != 1 OR (value[0] = 2 AND value[2] != value[ | +| 15 | Calibration status | Calibration status | | | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | | | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | @@ -117,8 +129,8 @@ This parameter has the configuration ID ```config_3_1``` and is of type ```INTEG ### Parameter 4: IR Pulse Width +IR Pulse Width Adjusts transmit signal so received signal will in average be equal to this values. - Values in the range 0 to 255 may be set. The manufacturer defined default value is ```0```. @@ -128,8 +140,8 @@ This parameter has the configuration ID ```config_4_1``` and is of type ```INTEG ### Parameter 5: Poll / Wake up frequency +Poll / Wake up frequency Wake device up this many times per second. This value also controls number of measurements per second on mechanical meters - Values in the range 1 to 50 may be set. The manufacturer defined default value is ```20```. @@ -194,8 +206,10 @@ This parameter has the configuration ID ```config_10_2``` and is of type ```INTE ### Parameter 11: Real-time mode -Set this to enter real-time mode from remote. Contains seconds * poll frequency before going back to sleep. If you press the button once this value will be set. +Real-time mode +Set this to enter real-time mode from remote. Contains seconds * poll frequency before going back to sleep. +If you press the button once this value will be set. Values in the range 0 to 65535 may be set. The manufacturer defined default value is ```0```. @@ -232,8 +246,12 @@ This parameter has the configuration ID ```config_13_1``` and is of type ```INTE ### Parameter 15: Calibration status -The calibration progress is calculated as (value[1] - 65 + value[2] / value[3]) * 25. The calibration is finished successfully when value[0] = 2 and value[2] = value[3]. The calibration has failed if value[0] != 1 OR (value[0] = 2 AND value[2] != value[ +Calibration status +The calibration progress is calculated as (value[1] - 65 + value[2] / value[3]) * 25. +The calibration is finished successfully when value[0]  =  2 and value[2] = value[3]. + +The calibration has failed if value[0] != 1 OR (value[0] = 2 AND value[2] != value[This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range 0 to 65535 may be set. The manufacturer defined default value is ```0```. diff --git a/_addons_bindings/zwave/doc/oomi/ft098_0_0.md b/_addons_bindings/zwave/doc/oomi/ft098_0_0.md index c3decc4d4..43fe0c3d0 100644 --- a/_addons_bindings/zwave/doc/oomi/ft098_0_0.md +++ b/_addons_bindings/zwave/doc/oomi/ft098_0_0.md @@ -53,32 +53,29 @@ To check if LED Bulb is already paired to an existing network, toggle the wall s The following table summarises the channels available for the FT098 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Color Control | color_color | | Color | -| Color Temperature | color_temperature | ColorLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Color Control | color_color | color_color | ColorLight | Color | +| Color Temperature | color_temperature | color_temperature | ColorLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Color Control - The color channel allows to control the color of a light. It is also possible to dim values and switch the light on and off. -The ```color_color``` channel supports the ```Color``` item. +The ```color_color``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category. ### Color Temperature - The color temperature channel allows to set the color temperature of a light from 0 (cold) to 100 (warm). -The ```color_temperature``` channel supports the ```Dimmer``` item and is in the ```ColorLight``` category. +The ```color_temperature``` channel is of type ```color_temperature``` and supports the ```Dimmer``` item and is in the ```ColorLight``` category. @@ -590,7 +587,7 @@ This parameter has the configuration ID ```config_112_1``` and is of type ```INT -The following option values may be configured -: +The following option values may be configured, in addition to values in the range 0 to 0 -: | Value | Description | |--------|-------------| @@ -671,6 +668,7 @@ Association group 2 supports 5 nodes. | COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V1| | ### Documentation Links diff --git a/_addons_bindings/zwave/doc/oomi/ft121_0_0.md b/_addons_bindings/zwave/doc/oomi/ft121_0_0.md index 4a0c49328..aad9ad01c 100644 --- a/_addons_bindings/zwave/doc/oomi/ft121_0_0.md +++ b/_addons_bindings/zwave/doc/oomi/ft121_0_0.md @@ -31,38 +31,305 @@ Set your Z-Wave controller into device removal mode. Press the Action Button loc The following table summarises the channels available for the FT121 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Color Control | color_color | | Color | -| Color Temperature | color_temperature | ColorLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Color Control | color_color | color_color | ColorLight | Color | +| Color Temperature | color_temperature | color_temperature | ColorLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Color Control - The color channel allows to control the color of a light. It is also possible to dim values and switch the light on and off. -The ```color_color``` channel supports the ```Color``` item. +The ```color_color``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category. ### Color Temperature - The color temperature channel allows to set the color temperature of a light from 0 (cold) to 100 (warm). -The ```color_temperature``` channel supports the ```Dimmer``` item and is in the ```ColorLight``` category. +The ```color_temperature``` channel is of type ```color_temperature``` and supports the ```Dimmer``` item and is in the ```ColorLight``` category. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 16 configuration parameters available in the FT121. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 20 | LED Strip state at Power ON | LED Strip state at Power ON | +| 32 | Enable/Disable Report on color change. | Enable/Disable Report on color change. | +| 34 | Brightness Level Control | Brightness Level Control | +| 35 | Display mode of Cold/warm white | Display mode of Cold/warm white | +| 37 | Colour Change Speed Level | Colour Change Speed Level | +| 37 | Time Base of Colour Change Speed | Time Base of Colour Change Speed | +| 37 | Cycle Count | Cycle Count | +| 37 | Brightness | Brightness | +| 37 | Colour Display Cycle | Colour Display Cycle | +| 37 | Colour Change Speed Option | Colour Change Speed Option | +| 37 | Colour Transition Style | Colour Transition Style | +| 40 | Colorful mode configuration | Colorful mode configuration | +| 80 | Notification (Group 1) when state changes | Notification (Group 1) when state changes | +| 112 | Dimmer mode | Dimmer mode | +| 252 | Configuration lock | Configuration lock | +| 255 | Reset to defaults | Reset to defaults | + +### Parameter 20: LED Strip state at Power ON + +LED Strip state at Power ON + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Last State (default) | +| 0 | Remove Me | +| 1 | Always On | +| 2 | Always Off | + +The manufacturer defined default value is ```0``` (Remove Me). + +This parameter has the configuration ID ```config_20_1``` and is of type ```INTEGER```. + + +### Parameter 32: Enable/Disable Report on color change. + +Enable/Disable Report on color change. + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disable (default) | +| 1 | Hail CC | + +The manufacturer defined default value is ```0``` (Disable (default)). + +This parameter has the configuration ID ```config_32_1``` and is of type ```INTEGER```. + + +### Parameter 34: Brightness Level Control + +Brightness Level Control +Enable/disable to turn on the last brightness level of the LED Strip when using the Color Switch Set CC to change its color. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disable (default) | +| 1 | Enable | + +The manufacturer defined default value is ```0``` (Disable (default)). + +This parameter has the configuration ID ```config_34_1``` and is of type ```INTEGER```. + + +### Parameter 35: Display mode of Cold/warm white + +Display mode of Cold/warm white + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Arbitrary combination (default) | +| 1 | Complementary combination | + +The manufacturer defined default value is ```0``` (Arbitrary combination (default)). + +This parameter has the configuration ID ```config_35_1``` and is of type ```INTEGER```. + + +### Parameter 37: Colour Change Speed Level + +Colour Change Speed Level + * 0 = Constant speed + * 1 - 30 = Accelerate/decelerate speed from level 1 to 30 + * 31 = Inactive (keep the current configuration values) +Values in the range 0 to 31 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_37_4_0000001F``` and is of type ```INTEGER```. + + +### Parameter 37: Time Base of Colour Change Speed + +Time Base of Colour Change Speed +Time Base of Colour Change Speed +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Time base is 1s. | +| 1 | Time base is 10ms. | +| 2 | Time base is 100ms. | + +The manufacturer defined default value is ```0``` (Time base is 1s.). + +This parameter has the configuration ID ```config_37_4_000000E0``` and is of type ```INTEGER```. + + +### Parameter 37: Cycle Count + +Cycle Count + * 0 = Unlimited + * 1 - 254 = Total number of cycles before stopping + * 255 = Inactive (keep the current configuration values) +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_37_4_0000FF00``` and is of type ```INTEGER```. + + +### Parameter 37: Brightness + +Brightness + *  1 = Min level. + * 99 = Max level +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```99```. + +This parameter has the configuration ID ```config_37_4_00FF0000``` and is of type ```INTEGER```. + + +### Parameter 37: Colour Display Cycle + +Colour Display Cycle + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Inactive | +| 1 | Rainbow Mode | +| 2 | Multi Colour Mode | +| 3 | Random Mode | +| 4 | Single Colour Mode. | + +The manufacturer defined default value is ```0``` (Inactive). + +This parameter has the configuration ID ```config_37_4_07000000``` and is of type ```INTEGER```. + + +### Parameter 37: Colour Change Speed Option + +Colour Change Speed Option +Colour Change Speed Option +Values in the range 0 to 15 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_37_4_38000000``` and is of type ```INTEGER```. + + +### Parameter 37: Colour Transition Style + +Colour Transition Style + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Smooth Colour Transition | +| 1 | Fade Out Fade In Transition | + +The manufacturer defined default value is ```0``` (Smooth Colour Transition). + +This parameter has the configuration ID ```config_37_4_40000000``` and is of type ```INTEGER```. + + +### Parameter 40: Colorful mode configuration + +Colorful mode configuration +Set-only parameter +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Default | +| 1 | Rainbow mode | +| 2 | Multi color mode | +| 3 | Fade out and fade in (Red) | +| 4 | Fade out and fade in (Green) | +| 5 | Fade out and fade in (Blue) | + +The manufacturer defined default value is ```0``` (Default). + +This parameter has the configuration ID ```config_40_1_wo``` and is of type ```INTEGER```. +This is a write only parameter. + + +### Parameter 80: Notification (Group 1) when state changes + +Notification (Group 1) when state changes + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Nothing | +| 1 | Hail CC (default) | +| 2 | Basic CC report | + +The manufacturer defined default value is ```1``` (Hail CC (default)). + +This parameter has the configuration ID ```config_80_1``` and is of type ```INTEGER```. + + +### Parameter 112: Dimmer mode + +Dimmer mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Parabolic curve | +| 1 | Index curve | +| 2 | (Parabolic * Index)/2 | +| 3 | Linear | + +The manufacturer defined default value is ```2``` ((Parabolic * Index)/2). + +This parameter has the configuration ID ```config_112_1``` and is of type ```INTEGER```. + + +### Parameter 252: Configuration lock + +Configuration lock +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Configuration allowed (default) | +| 1 | Configuration locked | + +The manufacturer defined default value is ```0``` (Configuration allowed (default)). + +This parameter has the configuration ID ```config_252_1``` and is of type ```INTEGER```. + + +### Parameter 255: Reset to defaults + +Reset to defaults +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 0 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_255_0``` and is of type ```INTEGER```. + ## Association Groups diff --git a/_addons_bindings/zwave/doc/oomi/ft132_0_0.md b/_addons_bindings/zwave/doc/oomi/ft132_0_0.md index af0f9f0f5..f5a724733 100644 --- a/_addons_bindings/zwave/doc/oomi/ft132_0_0.md +++ b/_addons_bindings/zwave/doc/oomi/ft132_0_0.md @@ -34,62 +34,62 @@ If at some stage, your primary controller is missing or inoperable, you may wish The following table summarises the channels available for the FT132 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Scene Number | scene_number | | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (amps) | meter_current | Energy | Number | -| Alarm (power) | alarm_power | Energy | Switch | -| Alarm (heat) | alarm_heat | Fire | Switch | -| Clock Time Offset | time_offset | Temperature | Number | -| Switch 1 | switch_binary1 | Switch | Switch | -| Electric meter (watts) 1 | meter_watts1 | Energy | Number | -| Electric meter (volts) 1 | meter_voltage1 | Energy | Number | -| Electric meter (kWh) 1 | meter_kwh1 | Energy | Number | -| Electric meter (amps) 1 | meter_current1 | Energy | Number | -| Switch 2 | switch_binary2 | Switch | Switch | -| Electric meter (watts) 2 | meter_watts2 | Energy | Number | -| Electric meter (volts) 2 | meter_voltage2 | Energy | Number | -| Electric meter (kWh) 2 | meter_kwh2 | Energy | Number | -| Electric meter (amps) 2 | meter_current2 | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Alarm (power) | alarm_power | alarm_power | Energy | Switch | +| Alarm (heat) | alarm_heat | alarm_heat | Fire | Switch | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Electric meter (watts) 1 | meter_watts1 | meter_watts | Energy | Number | +| Electric meter (volts) 1 | meter_voltage1 | meter_voltage | Energy | Number | +| Electric meter (kWh) 1 | meter_kwh1 | meter_kwh | Energy | Number | +| Electric meter (amps) 1 | meter_current1 | meter_current | Energy | Number | +| Switch 2 | switch_binary2 | switch_binary | Switch | Switch | +| Electric meter (watts) 2 | meter_watts2 | meter_watts | Energy | Number | +| Electric meter (volts) 2 | meter_voltage2 | meter_voltage | Energy | Number | +| Electric meter (kWh) 2 | meter_kwh2 | meter_kwh | Energy | Number | +| Electric meter (amps) 2 | meter_current2 | meter_current | Energy | Number | ### Switch Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Electric meter (watts) Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Alarm (power) Indicates if a power alarm is triggered. -The ```alarm_power``` channel supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_power``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -101,7 +101,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Alarm (heat) Indicates if a heat alarm is triggered. -The ```alarm_heat``` channel supports the ```Switch``` item and is in the ```Fire``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_heat``` channel is of type ```alarm_heat``` and supports the ```Switch``` item and is in the ```Fire``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -113,57 +113,57 @@ The following state translation is provided for this channel to the ```Switch``` ### Clock Time Offset Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ### Switch 1 Switch the power on and off. -The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (watts) 1 Indicates the instantaneous power consumption. -The ```meter_watts1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts1``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) 1 Indicates the instantaneous voltage. -The ```meter_voltage1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage1``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 1 Indicates the energy consumption (kWh). -The ```meter_kwh1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh1``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) 1 Indicates the instantaneous current consumption. -The ```meter_current1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current1``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Switch 2 Switch the power on and off. -The ```switch_binary2``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (watts) 2 Indicates the instantaneous power consumption. -The ```meter_watts2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts2``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) 2 Indicates the instantaneous voltage. -The ```meter_voltage2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage2``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 2 Indicates the energy consumption (kWh). -The ```meter_kwh2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh2``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) 2 Indicates the instantaneous current consumption. -The ```meter_current2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current2``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. @@ -185,12 +185,12 @@ Detailed information on each parameter can be found in the sections below. | 92 | Set the threshold value of wattage. | Set the threshold value of wattage. | | 100 | Set parameter 101-103 to default value | Reset the parameter 101-103 | | 101 | Set group 1 reports | To set which reports need to be sent in Report group 1 | -| 102 | To set which reports need to be sent in Report group 2. | To set which reports need to be sent in Report group 2. | -| 103 | To set which reports need to be sent in Report group 3 | To set which reports need to be sent in Report group 3. | +| 102 | Reports sent to Report group 2. | Reports sent to Report group 2. | +| 103 | Reports sent to Report group 3 | Reports sent to Report group 3 | | 110 | Set parameter 111-113 to default value. | Set parameter 111-113 to default value. | -| 111 | Set the interval of automatic report for Report group 1. | Set the interval of automatic report for Report group 1. | -| 112 | Set the interval of automatic report for Report group 2 | Set the interval of automatic report for Report group 2. | -| 113 | Set the interval of automatic report for Report group 2. | Set the interval of automatic report for Report group 2. | +| 111 | Automatic report interval for Report group 1. | Automatic report interval for Report group 1. | +| 112 | Automatic report interval for Report group 2 | Automatic report interval for Report group 2 | +| 113 | Automatic report interval for Report group 2 | Automatic report interval for Report group 2 | | 120 | Configure the external switch mode for S1 | Configure the external switch mode for S1 | | 121 | Configure the external switch mode for S2. | Configure the external switch mode for S2. | | 122 | Set the control destination for external switch | Set the control destination for external switch | @@ -359,23 +359,23 @@ The following option values may be configured -: | 2 | Send Meter Report of wattage (W) | | 4 | Send Meter Report of voltage (V) | | 8 | Send Meter Report of current (A) | -| 256 | Send Multi Channel Meter Report of wattage (W) on Channel 1 | -| 512 | Send Multi Channel Meter Report of wattage (W) on Channel 2 | -| 2048 | Send Multi Channel Meter Report of energy (kWh) on Channel 1 | -| 4096 | Send Multi Channel Meter Report of energy (kWh) on Channel 2 | -| 65536 | Send Multi Channel Meter Report of voltage (V) on Channel 1 | -| 131072 | Send Multi Channel Meter Report of voltage (V) on Channel 2 | -| 524288 | Send Multi Channel Meter Report of current (A) on Channel 1 | -| 1048576 | Send Multi Channel Meter Report of current (A) on Channel 2 | +| 256 | Meter Report of wattage (W) on Channel 1 | +| 512 | Meter Report of wattage (W) on Channel 2 | +| 2048 | Meter Report of energy (kWh) on Channel 1 | +| 4096 | Meter Report of energy (kWh) on Channel 2 | +| 65536 | Meter Report of voltage (V) on Channel 1 | +| 131072 | Meter Report of voltage (V) on Channel 2 | +| 524288 | Meter Report of current (A) on Channel 1 | +| 1048576 | Meter Report of current (A) on Channel 2 | The manufacturer defined default value is ```0```. This parameter has the configuration ID ```config_101_4``` and is of type ```INTEGER```. -### Parameter 102: To set which reports need to be sent in Report group 2. +### Parameter 102: Reports sent to Report group 2. -To set which reports need to be sent in Report group 2. +Reports sent to Report group 2. The following option values may be configured -: @@ -385,23 +385,23 @@ The following option values may be configured -: | 2 | Send Meter Report of wattage (W) | | 4 | Send Meter Report of voltage (V) | | 8 | Send Meter Report of current (A) | -| 256 | Send Multi Channel Meter Report of wattage (W) on Channel 1 | -| 512 | Send Multi Channel Meter Report of wattage (W) on Channel 2 | -| 2048 | Send Multi Channel Meter Report of energy (kWh) on Channel 1 | -| 4096 | Send Multi Channel Meter Report of energy (kWh) on Channel 2 | -| 65536 | Send Multi Channel Meter Report of voltage (V) on Channel 1 | -| 131072 | Send Multi Channel Meter Report of voltage (V) on Channel 2 | -| 524288 | Send Multi Channel Meter Report of current (A) on Channel 1 | -| 1048576 | Send Multi Channel Meter Report of current (A) on Channel 2 | +| 256 | Meter Report of wattage (W) on Channel 1 | +| 512 | Meter Report of wattage (W) on Channel 2 | +| 2048 | Meter Report of energy (kWh) on Channel 1 | +| 4096 | Meter Report of energy (kWh) on Channel 2 | +| 65536 | Meter Report of voltage (V) on Channel 1 | +| 131072 | Meter Report of voltage (V) on Channel 2 | +| 524288 | Meter Report of current (A) on Channel 1 | +| 1048576 | Meter Report of current (A) on Channel 2 | The manufacturer defined default value is ```0```. This parameter has the configuration ID ```config_102_1``` and is of type ```INTEGER```. -### Parameter 103: To set which reports need to be sent in Report group 3 +### Parameter 103: Reports sent to Report group 3 -To set which reports need to be sent in Report group 3. +Reports sent to Report group 3 The following option values may be configured -: @@ -411,14 +411,14 @@ The following option values may be configured -: | 2 | Send Meter Report of current (A) | | 4 | Send Meter Report of wattage (W) | | 8 | Send Meter Report of energy (kWh) | -| 256 | Send Multi Channel Meter Report of wattage (W) on Channel 1 | -| 512 | Send Multi Channel Meter Report of wattage (W) on Channel 2 | -| 2048 | Send Multi Channel Meter Report of energy (kWh) on Channel 1 | -| 4096 | Send Multi Channel Meter Report of energy (kWh) on Channel 2 | -| 65536 | Send Multi Channel Meter Report of voltage (V) on Channel 1 | -| 131072 | Send Multi Channel Meter Report of voltage (V) on Channel 2 | -| 524288 | Send Multi Channel Meter Report of current (A) on Channel 1 | -| 1048576 | Send Multi Channel Meter Report of current (A) on Channel 2 | +| 256 | Meter Report of wattage (W) on Channel 1 | +| 512 | Meter Report of wattage (W) on Channel 2 | +| 2048 | Meter Report of energy (kWh) on Channel 1 | +| 4096 | Meter Report of energy (kWh) on Channel 2 | +| 65536 | Meter Report of voltage (V) on Channel 1 | +| 131072 | Meter Report of voltage (V) on Channel 2 | +| 524288 | Meter Report of current (A) on Channel 1 | +| 1048576 | Meter Report of current (A) on Channel 2 | The manufacturer defined default value is ```0```. @@ -428,7 +428,7 @@ This parameter has the configuration ID ```config_103_1``` and is of type ```INT ### Parameter 110: Set parameter 111-113 to default value. Set parameter 111-113 to default value. - +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range 0 to 0 may be set. The manufacturer defined default value is ```0```. @@ -437,10 +437,10 @@ This parameter has the configuration ID ```config_110_1_wo``` and is of type ``` This is a write only parameter. -### Parameter 111: Set the interval of automatic report for Report group 1. +### Parameter 111: Automatic report interval for Report group 1. +Automatic report interval for Report group 1. Set the interval of automatic report for Report group 1. - Values in the range 1 to 2147483647 may be set. The manufacturer defined default value is ```10```. @@ -448,10 +448,10 @@ The manufacturer defined default value is ```10```. This parameter has the configuration ID ```config_111_4``` and is of type ```INTEGER```. -### Parameter 112: Set the interval of automatic report for Report group 2 - -Set the interval of automatic report for Report group 2. +### Parameter 112: Automatic report interval for Report group 2 +Automatic report interval for Report group 2 +Set the interval of automatic report for Report group 2 Values in the range 1 to 2147483647 may be set. The manufacturer defined default value is ```600```. @@ -459,10 +459,10 @@ The manufacturer defined default value is ```600```. This parameter has the configuration ID ```config_112_4``` and is of type ```INTEGER```. -### Parameter 113: Set the interval of automatic report for Report group 2. +### Parameter 113: Automatic report interval for Report group 2 +Automatic report interval for Report group 2 Set the interval of automatic report for Report group 2. - Values in the range 1 to 2147483647 may be set. The manufacturer defined default value is ```600```. @@ -516,9 +516,9 @@ The following option values may be configured -: |--------|-------------| | 1 | control the output loads of itself. | | 2 | control the other nodes | -| 3 | control the output loads of itself and other nodes. | +| 3 | control the output of itself and others | -The manufacturer defined default value is ```3``` (control the output loads of itself and other nodes.). +The manufacturer defined default value is ```3``` (control the output of itself and others). This parameter has the configuration ID ```config_122_1``` and is of type ```INTEGER```. @@ -526,7 +526,7 @@ This parameter has the configuration ID ```config_122_1``` and is of type ```INT ### Parameter 252: Lock/unlock configuration parameters Lock/unlock configuration parameters - +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. The following option values may be configured -: | Value | Description | @@ -548,6 +548,7 @@ The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | (Default) Reset all configuration parameters | +| 1431655765 | Reset & Remove from Network | The manufacturer defined default value is ```0``` ((Default) Reset all configuration parameters). diff --git a/_addons_bindings/zwave/doc/philio/pab01_0_0.md b/_addons_bindings/zwave/doc/philio/pab01_0_0.md index f3600001d..dbe761105 100644 --- a/_addons_bindings/zwave/doc/philio/pab01_0_0.md +++ b/_addons_bindings/zwave/doc/philio/pab01_0_0.md @@ -17,6 +17,16 @@ The ZIP-PAB01 does not permanently listen for messages sent from the controller ## Overview +Zipato Energy Meter monitors total electricity consumption of connected appliances and reports it to Zipato or any other Z-Wave enabled controller in real time. Small and compact size allows easy installation in majority of electricity distribution boxes. It supports two loads up to 6000W each (@ 120V) + +### Inclusion Information + +Pressing On/Off (Include) button three times within 2 seconds will enter inclusion mode. + +### Exclusion Information + +Pressing On/Off (Include) button three times within 2 seconds will enter exclusion mode. + ### Wakeup Information The ZIP-PAB01 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. @@ -27,148 +37,128 @@ The wakeup period does not impact the devices ability to report events or sensor The following table summarises the channels available for the ZIP-PAB01 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Intensty meter 0 (amps) | meter_current | Energy | Number | -| Power factor 0 | meter_powerfactor | Energy | Number | -| Power meter 0 (watts) | meter_watts | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Line voltage (volts) | meter_voltage | Energy | Number | -| Intensity meter 1 (amps) | meter_current1 | Energy | Number | -| Power factor meter 1 | meter_powerfactor1 | Energy | Number | -| Power meter 1 (watts) | meter_watts1 | Energy | Number | -| Energy meter 1 (kWh) | meter_kwh1 | Energy | Number | -| Line voltage (volts) | meter_voltage1 | Energy | Number | -| Intensity meter 2 (amps) | meter_current2 | Energy | Number | -| power factor 2 | meter_powerfactor2 | Energy | Number | -| Power meter 2 (watts) | meter_watts2 | Energy | Number | -| Energy meter 2 (kWh) | meter_kwh2 | Energy | Number | -| Line voltage 2 (volts) | meter_voltage2 | Energy | Number | -| Intensity meter 3 (amps) | meter_current3 | Energy | Number | -| Power factor 3 | meter_powerfactor3 | Energy | Number | -| Power meter 3 (watts) | meter_watts3 | Energy | Number | -| Energy meter 3 (kWh) | meter_kwh3 | Energy | Number | -| Voltage 3 (volts) | meter_voltage3 | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Intensty meter 0 (amps) | meter_current | meter_current | Energy | Number | +| Power factor 0 | meter_powerfactor | meter_powerfactor | Energy | Number | +| Power meter 0 (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Line voltage (volts) | meter_voltage | meter_voltage | Energy | Number | +| Intensity meter 1 (amps) | meter_current1 | meter_current | Energy | Number | +| Power factor meter 1 | meter_powerfactor1 | meter_powerfactor | Energy | Number | +| Power meter 1 (watts) | meter_watts1 | meter_watts | Energy | Number | +| Energy meter 1 (kWh) | meter_kwh1 | meter_kwh | Energy | Number | +| Line voltage (volts) | meter_voltage1 | meter_voltage | Energy | Number | +| Intensity meter 2 (amps) | meter_current2 | meter_current | Energy | Number | +| power factor 2 | meter_powerfactor2 | meter_powerfactor | Energy | Number | +| Power meter 2 (watts) | meter_watts2 | meter_watts | Energy | Number | +| Energy meter 2 (kWh) | meter_kwh2 | meter_kwh | Energy | Number | +| Line voltage 2 (volts) | meter_voltage2 | meter_voltage | Energy | Number | +| Intensity meter 3 (amps) | meter_current3 | meter_current | Energy | Number | +| Power factor 3 | meter_powerfactor3 | meter_powerfactor | Energy | Number | +| Power meter 3 (watts) | meter_watts3 | meter_watts | Energy | Number | +| Energy meter 3 (kWh) | meter_kwh3 | meter_kwh | Energy | Number | +| Voltage 3 (volts) | meter_voltage3 | meter_voltage | Energy | Number | ### Intensty meter 0 (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Power factor 0 - Indicates the instantaneous power factor. -The ```meter_powerfactor``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Power meter 0 (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Line voltage (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Intensity meter 1 (amps) - Indicates the instantaneous current consumption. -The ```meter_current1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current1``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Power factor meter 1 - Indicates the instantaneous power factor. -The ```meter_powerfactor1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor1``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Power meter 1 (watts) - Indicates the instantaneous power consumption. -The ```meter_watts1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts1``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Energy meter 1 (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh1``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Line voltage (volts) - Indicates the instantaneous voltage. -The ```meter_voltage1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage1``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Intensity meter 2 (amps) - Indicates the instantaneous current consumption. -The ```meter_current2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current2``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### power factor 2 - Indicates the instantaneous power factor. -The ```meter_powerfactor2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor2``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Power meter 2 (watts) - Indicates the instantaneous power consumption. -The ```meter_watts2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts2``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Energy meter 2 (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh2``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Line voltage 2 (volts) - Indicates the instantaneous voltage. -The ```meter_voltage2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage2``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Intensity meter 3 (amps) - Indicates the instantaneous current consumption. -The ```meter_current3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current3``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Power factor 3 - Indicates the instantaneous power factor. -The ```meter_powerfactor3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor3``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Power meter 3 (watts) - Indicates the instantaneous power consumption. -The ```meter_watts3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts3``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Energy meter 3 (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh3``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Voltage 3 (volts) - Indicates the instantaneous voltage. -The ```meter_voltage3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage3``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. diff --git a/_addons_bindings/zwave/doc/philio/pad02_0_0.md b/_addons_bindings/zwave/doc/philio/pad02_0_0.md index 67ee4c0f8..913909498 100644 --- a/_addons_bindings/zwave/doc/philio/pad02_0_0.md +++ b/_addons_bindings/zwave/doc/philio/pad02_0_0.md @@ -8,6 +8,8 @@ title: PAD02 - ZWave # PAD02 Dimmer Socket This describes the Z-Wave device *PAD02*, manufactured by *[Philio Technology Corp](http://www.philio-tech.com/)* with the thing type UID of ```philio_pad02_00_000```. +The device is in the category of *Light Bulb*, defining Devices that illuminate something, such as bulbs, etc.. + ![PAD02 product image](https://www.cd-jackson.com/zwave_device_uploads/579/579_default.jpg) @@ -57,30 +59,27 @@ Result: Node ID has been excluded. 0.5s On, 0.5s Off (Enter auto inclusion). The following table summarises the channels available for the PAD02 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | -| Alarm | alarm_general | Door | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | +| Alarm | alarm_general | alarm_general | Alarm | Switch | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: diff --git a/_addons_bindings/zwave/doc/philio/pan05_0_0.md b/_addons_bindings/zwave/doc/philio/pan05_0_0.md index ceac5636c..94e7639bb 100644 --- a/_addons_bindings/zwave/doc/philio/pan05_0_0.md +++ b/_addons_bindings/zwave/doc/philio/pan05_0_0.md @@ -17,28 +17,34 @@ The PAN05-1B supports routing. This allows the device to communicate using other ## 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/819) to improve the documentation. +This in-wall switch module is a transceiver which is a security enabled device which based on Z-Wave Plus technology, and it is fully compatible with any Z-WaveTM enabled network. Mini size design let the module can easily hide itself into the wall box and that will be good for the house decoration. Since PAN05 supports Security Command Class, it can learn with Secured controller. Its functionality and supported command classes is identical when included as a secure and non-secure device.   + +### Inclusion Information + +Pressing Include button of PAN05 three times within 2 seconds will enter inclusion mode + +### Exclusion Information + +Pressing Include button of PAN05 three times within 2 seconds will enter exclusion mode.  ## Channels The following table summarises the channels available for the PAN05-1B -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Alarm | alarm_general | Door | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Alarm | alarm_general | alarm_general | Alarm | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -51,7 +57,137 @@ The following state translation is provided for this channel to the ```Switch``` ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 6 configuration parameters available in the PAN05-1B. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Mode | Mode | +| 2 | Restore switch state mode | Restore switch state mode | +| 3 | Manual On/Off mode | Manual On/Off mode | +| 4 | LED indication mode | LED indication mode | +| 5 | Auto off timer | Auto off timer | +| 6 | RF Off command mode | RF Off command mode | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 1: Mode + +Mode +Edge or Pulse mode or Edge-Toggle mode +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Edge mode | +| 2 | Pulse mode | +| 3 | Edge-Toggle mode | + +The manufacturer defined default value is ```1``` (Edge mode). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Restore switch state mode + +Restore switch state mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Switch Off | +| 1 | Last Switch State | +| 2 | Switch On | + +The manufacturer defined default value is ```1``` ( Last Switch State ). + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Manual On/Off mode + +Manual On/Off mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disable manual On/Off | +| 1 | Enable manual On/Off | + +The manufacturer defined default value is ```1``` (Enable manual On/Off). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: LED indication mode + +LED indication mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Show switch state | +| 2 | Show night mode | +| 3 | One flash mode | + +The manufacturer defined default value is ```1``` (Show switch state ). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 5: Auto off timer + +Auto off timer +0：Disable auto off function + +1-32767：1 ~ 32767 seconds +Values in the range 0 to 32767 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_5_2``` and is of type ```INTEGER```. + + +### Parameter 6: RF Off command mode + +RF Off command mode +Whenever a RF Off command is received, BASIC\_SET、BINARY\_SWITCH\_SET、 SWITCH\_ALL_OFF, it could be interpreted as + + * Switch Off、 + * Switch On、 + * Switch Toggle, or + * it would be ignored. + +The default value is Switch Off.  +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Switch off | +| 1 | Ignore | +| 2 | Switch toggle | +| 3 | Switch on | + +The manufacturer defined default value is ```0``` (Switch off). + +This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups diff --git a/_addons_bindings/zwave/doc/philio/pan071a_0_0.md b/_addons_bindings/zwave/doc/philio/pan071a_0_0.md index 2368ac093..f08a42087 100644 --- a/_addons_bindings/zwave/doc/philio/pan071a_0_0.md +++ b/_addons_bindings/zwave/doc/philio/pan071a_0_0.md @@ -8,85 +8,91 @@ title: Philio PAN07-1A - ZWave # Philio PAN07-1A TWO SPDT Switch module with meter This describes the Z-Wave device *Philio PAN07-1A*, manufactured by *[Philio Technology Corp](http://www.philio-tech.com/)* with the thing type UID of ```philio_pan071a_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![Philio PAN07-1A product image](https://www.cd-jackson.com/zwave_device_uploads/629/629_default.png) + + The Philio PAN07-1A 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 between other devices in the mesh network. ## 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/629) to improve the documentation. +This in-wall switch module is able to detect Instant power wattage and overload current (6A) of connected light or appliances. When detecting overload state, the Module will be disabled and its On/Off button will be lockout of which LED will flash quickly. However, disconnect and re-connect the Module will reset its overload condition to normal status.  + +### Inclusion Information + +Pressing INCLUDE_BUTTON three times within 2 seconds will enter inclusion mode. + +### Exclusion Information + +Pressing INCLUDE_BUTTON three times within 2 seconds will enter exclusion mode.  ## Channels The following table summarises the channels available for the Philio PAN07-1A -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Electric meter (power factor) | meter_powerfactor | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (amps) | meter_current | Energy | Number | -| Alarm | alarm_general | Door | Switch | -| Switch 1 | switch_binary1 | Switch | Switch | -| Electric meter (power factor) 1 | meter_powerfactor1 | Energy | Number | -| Electric meter (volts) 1 | meter_voltage1 | Energy | Number | -| Electric meter (kWh) 1 | meter_kwh1 | Energy | Number | -| Electric meter (watts) 1 | meter_watts1 | Energy | Number | -| Electric meter (amps) 1 | meter_current1 | Energy | Number | -| Switch 2 | switch_binary2 | Switch | Switch | -| Electric meter (power factor) 2 | meter_powerfactor2 | Energy | Number | -| Electric meter (volts) 2 | meter_voltage2 | Energy | Number | -| Electric meter (kWh) 2 | meter_kwh2 | Energy | Number | -| Electric meter (watts) 2 | meter_watts2 | Energy | Number | -| Electric meter (amps) 2 | meter_current2 | Energy | Number | -| Switch 3 | switch_binary3 | Switch | Switch | -| Electric meter (power factor) 3 | meter_powerfactor3 | Energy | Number | -| Electric meter (volts) 3 | meter_voltage3 | Energy | Number | -| Electric meter (kWh) 3 | meter_kwh3 | Energy | Number | -| Electric meter (watts) 3 | meter_watts3 | Energy | Number | -| Electric meter (amps) 3 | meter_current3 | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (power factor) | meter_powerfactor | meter_powerfactor | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Alarm | alarm_general | alarm_general | Alarm | Switch | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Electric meter (power factor) 1 | meter_powerfactor1 | meter_powerfactor | Energy | Number | +| Electric meter (volts) 1 | meter_voltage1 | meter_voltage | Energy | Number | +| Electric meter (kWh) 1 | meter_kwh1 | meter_kwh | Energy | Number | +| Electric meter (watts) 1 | meter_watts1 | meter_watts | Energy | Number | +| Electric meter (amps) 1 | meter_current1 | meter_current | Energy | Number | +| Switch 2 | switch_binary2 | switch_binary | Switch | Switch | +| Electric meter (power factor) 2 | meter_powerfactor2 | meter_powerfactor | Energy | Number | +| Electric meter (volts) 2 | meter_voltage2 | meter_voltage | Energy | Number | +| Electric meter (kWh) 2 | meter_kwh2 | meter_kwh | Energy | Number | +| Electric meter (watts) 2 | meter_watts2 | meter_watts | Energy | Number | +| Electric meter (amps) 2 | meter_current2 | meter_current | Energy | Number | +| Switch 3 | switch_binary3 | switch_binary | Switch | Switch | +| Electric meter (power factor) 3 | meter_powerfactor3 | meter_powerfactor | Energy | Number | +| Electric meter (volts) 3 | meter_voltage3 | meter_voltage | Energy | Number | +| Electric meter (kWh) 3 | meter_kwh3 | meter_kwh | Energy | Number | +| Electric meter (watts) 3 | meter_watts3 | meter_watts | Energy | Number | +| Electric meter (amps) 3 | meter_current3 | meter_current | Energy | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (power factor) - Indicates the instantaneous power factor. -The ```meter_powerfactor``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -96,124 +102,292 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Switch 1 - Switch the power on and off. -The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (power factor) 1 - Indicates the instantaneous power factor. -The ```meter_powerfactor1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor1``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) 1 - Indicates the instantaneous voltage. -The ```meter_voltage1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage1``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 1 - Indicates the energy consumption (kWh). -The ```meter_kwh1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh1``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) 1 - Indicates the instantaneous power consumption. -The ```meter_watts1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts1``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) 1 - Indicates the instantaneous current consumption. -The ```meter_current1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current1``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Switch 2 - Switch the power on and off. -The ```switch_binary2``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary2``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (power factor) 2 - Indicates the instantaneous power factor. -The ```meter_powerfactor2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor2``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) 2 - Indicates the instantaneous voltage. -The ```meter_voltage2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage2``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 2 - Indicates the energy consumption (kWh). -The ```meter_kwh2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh2``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) 2 - Indicates the instantaneous power consumption. -The ```meter_watts2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts2``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) 2 - Indicates the instantaneous current consumption. -The ```meter_current2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current2``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Switch 3 - Switch the power on and off. -The ```switch_binary3``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary3``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (power factor) 3 - Indicates the instantaneous power factor. -The ```meter_powerfactor3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor3``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) 3 - Indicates the instantaneous voltage. -The ```meter_voltage3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage3``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 3 - Indicates the energy consumption (kWh). -The ```meter_kwh3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh3``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) 3 - Indicates the instantaneous power consumption. -The ```meter_watts3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts3``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) 3 - Indicates the instantaneous current consumption. -The ```meter_current3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current3``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 9 configuration parameters available in the Philio PAN07-1A. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Watt Meter Report Period | Watt Meter Report Period | +| 2 | KWH Meter Report | KWH Meter Report | +| 3 | Selected Relay | Selected Relay | +| 4 | Mode | Mode | +| 5 | Threshold of current for Load Caution | Threshold of current for Load Caution | +| 6 | Threshold of KWH for Load Caution | Threshold of KWH for Load Caution | +| 7 | Relay control mode | Relay control mode | +| 8 | Restore Relay state mode | Restore Relay state mode | +| 9 | Existence of Endpoint3 | Existence of Endpoint3 | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 1: Watt Meter Report Period + +Watt Meter Report Period +#  5 second units + +Default: 720*5s=3600s=1 hour + +If the setting is configured for 1hour (set value =720), the PAN07/PAN09 will report its instant power consumption every 1 hour to the node of correspond Group. The maximum interval to report its instant power consumption is 45 hours (5s*32767/3600=45hr).  +Values in the range 1 to 32767 may be set. + +The manufacturer defined default value is ```720```. + +This parameter has the configuration ID ```config_1_2``` and is of type ```INTEGER```. + + +### Parameter 2: KWH Meter Report + +KWH Meter Report +# 10 minute units + +default: 6*10min= 1 hour + +If the setting is configured for 1hour (set value =6), the PAN07/PAN09 will report its Accumulated Power Consumption (KW/h) every 1 hour to the node of correspond Group. The maximum interval to report its Accumulated Power Consumption (KW/h) is 227.55 days (10min*32767/1440=227.55 days) +Values in the range 1 to 32767 may be set. + +The manufacturer defined default value is ```6```. + +This parameter has the configuration ID ```config_2_2``` and is of type ```INTEGER```. + + +### Parameter 3: Selected Relay + +Selected Relay +If Controller not using Multi_Channel command class to access the relay of PAN07/PAN09, you may configure the value of relay to react the Basic Command Class 、Binary Switch Command Class or Meter Command Class V3  +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Relay1 | +| 2 | Relay2 | +| 3 | Relay1 & Relay2 | + +The manufacturer defined default value is ```3``` (Relay1 & Relay2 ). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Mode + +Mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Edge mode | +| 2 | Pulse mode | +| 3 | Edge-Toggle mode | + +The manufacturer defined default value is ```1``` (Edge mode ). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 5: Threshold of current for Load Caution + +Threshold of current for Load Caution +# 0.01A units + +default 600*0.01A = 6.0A + +This is a warning when the current of load over the preset threshold value, if the setting value is 600 (6A), when the load current of Relay1 over this value, PAN07/PAN09 will send current meter report to the node of correspond Group, the Range of the setting value is from 10 to 600, and the default value is 600 (6A).  +Values in the range 10 to 600 may be set. + +The manufacturer defined default value is ```600```. + +This parameter has the configuration ID ```config_5_2``` and is of type ```INTEGER```. + + +### Parameter 6: Threshold of KWH for Load Caution + +Threshold of KWH for Load Caution +This is a warning when the KWh of load over the preset threshold value, If the setting value is 10000, when the Accumulated Power Consumption of Relay1 or Relay2 over this value, PAN07/PAN09 will send KWh Meter Report command to the node of correspond Group, minimum value is 1KWh and default value is 10000 kWh +Values in the range 1 to 10000 may be set. + +The manufacturer defined default value is ```10000```. + +This parameter has the configuration ID ```config_6_2``` and is of type ```INTEGER```. + + +### Parameter 7: Relay control mode + +Relay control mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Control relay refer to meter wattage | +| 2 | Control relay directly | + +The manufacturer defined default value is ```1``` (Control relay refer to meter wattage ). + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 8: Restore Relay state mode + +Restore Relay state mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | All relay stay NC terminal | +| 1 | Last relay switch state | +| 2 | All relay stay NO terminal | + +The manufacturer defined default value is ```1``` (Last relay switch state ). + +This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```. + + +### Parameter 9: Existence of Endpoint3 + +Existence of Endpoint3 +The endpoint3 of Multi-Channel Command Class is related to relay1 and relay2. It may be redundant for the need to control relay1 or relay2 individually. When the Existence of Endpoint3 is set as 0, the endpoint3 of Multi-Channel Command Class will be disabled. The default value is 1 +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Endpoint3 exist | +| 2 | No Endpoint3 | + +The manufacturer defined default value is ```1``` ( Endpoint3 exist). + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The Philio PAN07-1A supports 3 association groups. + +### Group 1: Group 1 + +For group 1, the Switch will report (1) ON/OFF status of Relay1 and Relay2 (2) Instant Power Consumption (Watt) of Relay1 and Relay2 (3) Accumulated Power Consumption (KWh) of Relay1 and Relay2 to Z-Wave Controller.   + +Association group 1 supports 1 node. + +### Group 2: Group 2 + +For group 2, the Switch will report (1) ON/OFF status of Relay1 (2) Instant Power Consumption (Watt) of Relay1 (3) Accumulated Power Consumption (KWh) of Relay1 to Z-Wave Controller.  + +Association group 2 supports 1 node. + +### Group 3: Group 3 + +For group 3, the Switch will report (1) ON/OFF status of Relay2 (2) Instant Power Consumption (Watt) of Relay2 (3) Accumulated Power Consumption (KWh) of Relay2 to Z-Wave Controller.  + +Association group 3 supports 1 node. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/philio/pan08_0_0.md b/_addons_bindings/zwave/doc/philio/pan08_0_0.md index 755a96a1e..11f020c47 100644 --- a/_addons_bindings/zwave/doc/philio/pan08_0_0.md +++ b/_addons_bindings/zwave/doc/philio/pan08_0_0.md @@ -17,70 +17,70 @@ The PAN08 supports routing. This allows the device to communicate using other ro ## 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/175) to improve the documentation. +The in-wall MicroModule Motor Controller is designed to switch rise/lower roller shutter connected to its terminals using radio waves, controllers and a push button directly connected to this Roller Controller + +### Inclusion Information + +Pressing Include button three times within 2 seconds will enter inclusion mode. + +### Exclusion Information + +Pressing Include button three times within 2 seconds will enter exclusion mode. ## Channels The following table summarises the channels available for the PAN08 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Blinds Control | blinds_control | Blinds | Rollershutter | -| Scene Number | scene_number | | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (power factor) | meter_powerfactor | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Electric meter (amps) | meter_current | Energy | Number | -| Alarm | alarm_general | Door | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Blinds Control | blinds_control | blinds_control | Blinds | Rollershutter | +| Scene Number | scene_number | scene_number | | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (power factor) | meter_powerfactor | meter_powerfactor | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Alarm | alarm_general | alarm_general | Alarm | Switch | ### Blinds Control - Provides start / stop control of blinds. -The ```blinds_control``` channel supports the ```Rollershutter``` item and is in the ```Blinds``` category. +The ```blinds_control``` channel is of type ```blinds_control``` and supports the ```Rollershutter``` item and is in the ```Blinds``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (power factor) - Indicates the instantaneous power factor. -The ```meter_powerfactor``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: diff --git a/_addons_bindings/zwave/doc/philio/pan11_0_0.md b/_addons_bindings/zwave/doc/philio/pan11_0_0.md index 903c3e60b..157016c47 100644 --- a/_addons_bindings/zwave/doc/philio/pan11_0_0.md +++ b/_addons_bindings/zwave/doc/philio/pan11_0_0.md @@ -17,70 +17,72 @@ The PAN11 supports routing. This allows the device to communicate using other ro ## 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/177) to improve the documentation. +This smart energy plug-in switch is able to detect voltage, current, power factor, Instant power wattage (5~3150W) and overload wattage (3010~3300W) of connected light or appliances. When detecting overload state, the Module will be disabled and its On/Off button will be lockout of which LED will flash quickly for 30 seconds. However, unplug and re-connect the Module will reset its overload condition to normal status. + +This plug-in switch can active sent out instant power wattage when variation over 5% or active sent out state change when manually push the ON/OFF button , this allows the controller to avoid polling the reading wattage value and state of the switch and can increase the efficiency of controlle + +### Inclusion Information + +Tripple Click the button on the device confirms inclusion and exclusion. + +### Exclusion Information + +Tripple Click the button on the device confirms inclusion and exclusion. ## Channels The following table summarises the channels available for the PAN11 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Electric meter (power factor) | meter_powerfactor | Energy | Number | -| Electric meter (amps) | meter_current | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Reset the total power consumption | meter_reset | Energy | Switch | -| Alarm | alarm_general | Door | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (power factor) | meter_powerfactor | meter_powerfactor | Energy | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Reset the total power consumption | meter_reset | meter_reset | Energy | Switch | +| Alarm | alarm_general | alarm_general | Alarm | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (power factor) - Indicates the instantaneous power factor. -The ```meter_powerfactor``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Reset the total power consumption - Reset the meter. -The ```meter_reset``` channel supports the ```Switch``` item and is in the ```Energy``` category. +The ```meter_reset``` channel is of type ```meter_reset``` and supports the ```Switch``` item and is in the ```Energy``` category. ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: diff --git a/_addons_bindings/zwave/doc/philio/pan16_1_2.md b/_addons_bindings/zwave/doc/philio/pan16_1_2.md index 60131b1b9..33fd13e7b 100644 --- a/_addons_bindings/zwave/doc/philio/pan16_1_2.md +++ b/_addons_bindings/zwave/doc/philio/pan16_1_2.md @@ -9,6 +9,11 @@ title: PAN16 - ZWave This describes the Z-Wave device *PAN16*, manufactured by *[Philio Technology Corp](http://www.philio-tech.com/)* with the thing type UID of ```philio_pan16_01_002```. This version of the device is limited to firmware versions above 1.2 +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![PAN16 product image](https://www.cd-jackson.com/zwave_device_uploads/642/642_default.png) + + The PAN16 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 between other devices in the mesh network. ## Overview @@ -21,61 +26,62 @@ Auto Inclusion  The function of auto inclusion will be executed as long as the switch does not have Node ID and just plug the switch into a wall outlet.  Note: Auto inclusion timeout is 2 minute during which the node information of explorer frame will be emitted once several seconds. Unlike “inclusion” function as shown in the table below, the execution of auto inclusion is free from pressing the On/Off button on the Switch.  +### Inclusion Information + +Pressing On/Off button three times within 2 seconds will enter inclusion mode.  + +### Exclusion Information + +Pressing On/Off button three times within 2 seconds will enter exclusion mode. + ## Channels The following table summarises the channels available for the PAN16 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Electric meter (amps) | meter_current | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (power factor) | meter_powerfactor | Energy | Number | -| Alarm | alarm_general | Door | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (power factor) | meter_powerfactor | meter_powerfactor | Energy | Number | +| Alarm | alarm_general | alarm_general | Alarm | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (power factor) - Indicates the instantaneous power factor. -The ```meter_powerfactor``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Alarm - 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. +The ```alarm_general``` channel is of type ```alarm_general``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -88,7 +94,178 @@ The following state translation is provided for this channel to the ```Switch``` ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 9 configuration parameters available in the PAN16. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Watt Meter Report Period | Watt Meter Report Period | +| 2 | KWH Meter Report Period | KWH Meter Report Period | +| 3 | Threshold of current for Load caution | Threshold of current for Load caution | +| 4 | Threshold of KWh for Load caution | Threshold of KWh for Load caution | +| 5 | Restore switch state mode | Restore switch state mode | +| 6 | Mode of Switch Off function | Mode of Switch Off function | +| 7 | LED indication mode | LED indication mode | +| 8 | Auto off timer | Auto off timer | +| 9 | RF off command mode | RF off command mode | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 1: Watt Meter Report Period + +Watt Meter Report Period +# 720*5s = 3600s = 1 hour + +If the setting is configured for 1hour (set value =720), the PAN16 will report its instant power consumption every 1 hour to Group1 node. + +The maximum interval to report its instant power consumption is 45 hours (5s*32767/3600=45hr). +Values in the range 1 to 32767 may be set. + +The manufacturer defined default value is ```720```. + +This parameter has the configuration ID ```config_1_2``` and is of type ```INTEGER```. + + +### Parameter 2: KWH Meter Report Period + +KWH Meter Report Period +# 6*10min=1 hour + +If the setting is configured for 1hour (set value =6), the PAN16 will report its Accumulated Power Consumption (KW/h) every 1 hour to Group1 node.  + +The maximum interval to report its Accumulated Power Consumption (KW/h) is 227.55 days (10min*32767/1440=227.55 days).  +Values in the range 1 to 32767 may be set. + +The manufacturer defined default value is ```6```. + +This parameter has the configuration ID ```config_2_2``` and is of type ```INTEGER```. + + +### Parameter 3: Threshold of current for Load caution + +Threshold of current for Load caution +# 1300*0.01A = 13A  + +This is a warning when the current of load over the preset threshold value, if the setting value is 1300, when the load current of Relay1 over this value, PAN16 will send current meter report to warn the Group1 node.  + +The Range of the setting value is from 10 to 1300,and the default value is 1300.  +Values in the range 10 to 1300 may be set. + +The manufacturer defined default value is ```1300```. + +This parameter has the configuration ID ```config_3_2``` and is of type ```INTEGER```. + + +### Parameter 4: Threshold of KWh for Load caution + +Threshold of KWh for Load caution +This is a warning when the KWh of load over the preset threshold value, If the setting value is 10000, when the Accumulated Power Consumption of Relay1 over this value, PAN16 will send KWH meter report to warn the Group1 node, + +minimum value is 1KWh and default value is 10000 kWh.  +Values in the range 1 to 10000 may be set. + +The manufacturer defined default value is ```10000```. + +This parameter has the configuration ID ```config_4_2``` and is of type ```INTEGER```. + + +### Parameter 5: Restore switch state mode + +Restore switch state mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Switch off | +| 1 | Last switch state | +| 2 | Switch on | + +The manufacturer defined default value is ```1``` ( Last switch state). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 6: Mode of Switch Off function + +Mode of Switch Off function + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disable | +| 1 | Enable | + +The manufacturer defined default value is ```1``` (Enable). + +This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```. + + +### Parameter 7: LED indication mode + +LED indication mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Show switch state | +| 2 | Show night mode | +| 3 | One flash mode | + +The manufacturer defined default value is ```1``` ( Show switch state ). + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 8: Auto off timer + +Auto off timer + * 0 : Disable auto off function + * 1-32767 : 1s ~32767s +Values in the range 0 to 32767 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_8_2``` and is of type ```INTEGER```. + + +### Parameter 9: RF off command mode + +RF off command mode +Whenever a switch off command, BASIC\_SET、BINARY\_SWITCH\_SET、SWITCH\_ALL_OFF, is received, it could be interpreted as 4 variety of commands. + + * Switch Off：It switches to OFF state. The default setting is Switch Off. + * Ignore：The switch off command will be ignored. + * Switch Toggle：It switches to the inverse of current state. + * Switch On：It switches to ON state.  +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Switch off | +| 1 | Ignore | +| 2 | Switch toggle | +| 3 | Switch on | + +The manufacturer defined default value is ```0``` ( Switch off). + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups diff --git a/_addons_bindings/zwave/doc/philio/pat02b_0_0.md b/_addons_bindings/zwave/doc/philio/pat02b_0_0.md index 3e9a56849..d89660cca 100644 --- a/_addons_bindings/zwave/doc/philio/pat02b_0_0.md +++ b/_addons_bindings/zwave/doc/philio/pat02b_0_0.md @@ -19,29 +19,41 @@ The PAT02-B does not permanently listen for messages sent from the controller - ## Overview +The flood multisensor PAT02 has flood, temperature and humidity, 3 sensors function in one, based on Z-WaveTM technology + +### Inclusion Information + +Pressing the tamper key three times within 1.5 seconds to enter the inclusion mode. + +### Exclusion Information + +Pressing tamper key three times within 1.5 seconds to enter the exclusion mode + ### Wakeup Information The PAT02-B 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. + +Press the tamper key once. The device will wake-up 10 seconds. + ## Channels The following table summarises the channels available for the PAT02-B -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Sensor (relative humidity) | sensor_relhumidity | Humidity | Number | -| Alarm (burglar) | alarm_burglar | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -51,22 +63,19 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) - Indicates the current relative humidity. -The ```sensor_relhumidity``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Alarm (burglar) - Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -76,11 +85,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/philio/pat02c_0_0.md b/_addons_bindings/zwave/doc/philio/pat02c_0_0.md index 00a94b6d3..3986a8e8f 100644 --- a/_addons_bindings/zwave/doc/philio/pat02c_0_0.md +++ b/_addons_bindings/zwave/doc/philio/pat02c_0_0.md @@ -19,28 +19,40 @@ The PAT02-C does not permanently listen for messages sent from the controller - ## Overview +The flood multisensor PAT02 has flood sensor, based on Z-WaveTM technology. + +### Inclusion Information + +Pressing the tamper key three times within 1.5 seconds to enter the inclusion mode + +### Exclusion Information + +Pressing tamper key three times within 1.5 seconds to enter the exclusion mode + ### Wakeup Information The PAT02-C 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. + +Press the tamper key once. The device will wake-up 10 seconds + ## Channels The following table summarises the channels available for the PAT02-C -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Alarm (flood) | alarm_flood | Door | Switch | -| Alarm (burglar) | alarm_burglar | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Alarm (flood) | alarm_flood | alarm_flood | Water | Switch | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -50,10 +62,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Alarm (flood) - Indicates if the flood alarm is triggered. -The ```alarm_flood``` 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. +The ```alarm_flood``` channel is of type ```alarm_flood``` and supports the ```Switch``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -63,10 +74,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Alarm (burglar) - Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -76,11 +86,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/philio/phpsr03_0_0.md b/_addons_bindings/zwave/doc/philio/phpsr03_0_0.md new file mode 100644 index 000000000..105062581 --- /dev/null +++ b/_addons_bindings/zwave/doc/philio/phpsr03_0_0.md @@ -0,0 +1,251 @@ +--- +layout: documentation +title: PH-PSR03 - ZWave +--- + +{% include base.html %} + +# PH-PSR03 Z-WAVE Remote +This describes the Z-Wave device *PH-PSR03*, manufactured by *[Philio Technology Corp](http://www.philio-tech.com/)* with the thing type UID of ```philio_phpsr03_00_000```. + +The device is in the category of *Remote Control*, defining Any portable or hand-held device that controls the status of something, e.g. remote control, keyfob etc.. + +![PH-PSR03 product image](https://www.cd-jackson.com/zwave_device_uploads/985/985_default.jpg) + + +The PH-PSR03 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 PH-PSR03 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. Refer to the *Wakeup Information* section below for further information. + +## Overview + +Zipato Z-Wave Remote is a simple controller for controlling AV device through Z-Wave-to-IR extender, and it can also control 8 ON/OFF lighting groups via basic set, based on Z-Wave technology. It is the Z-Wave plus product, it support the security, OTA... all the newest features of the Z-Wave technology.  +Z-Wave is a wireless communication protocol designed for home automation, specifically to remotely control applications in residential and light commercial environments. The technology uses a low-power RF radio embedded or retrofitted into home electronics devices and systems, such as lighting, home access control, entertainment systems and household appliances.  +This product can be included and operated in any Z-Wave network with other Z-Wave certified devices from other manufacturers and/or other applications. All non-battery operated nodes within the network will act as repeaters regardless of vendor to increase reliability of the network. + +The device adopts the Z-Wave 500 series chip. When your Z-Wave network system is all made by Z-Wave 500 series devices, the network system will have the advantages as below. + + * Concurrent multi-channel support reduces external interference + * Better RF range, about 10 meters improvement indoors. + * Supports 100 Kbps transmission speed + +# POWER UP PROCEDURE + +The device can not work normally in the first time. Please activate the battery through micro USB before the first use. After the device is activated by connecting to micro USB, the device will start charging and LED will light on with red color. If the battery is full charged, LED will light on with green color. When device is charging, it will send Wake Up Notification to controller minutely. + +## BATTERY POWER CHECK + +When any keys around the central key is pressed, the device will check the battery power. If the power level is too low, the red LED will flash once after pressing. Please charge the device through micro USB immediately. + +## NWI + +When it poweres up, the device will check if it is already added to the network. If it isn’t, it will automatically start the NWI mode. The LED will flash in every second and continue for about 30 seconds, until timeout or successful inclusion by controller. You can hold down the central key and then press the top-right key 3 times within 1.5 seconds to abort the NWI mode. + +### Inclusion Information + + 1. Put the Z-Wave Controller in inclusion mode. + 2. Hold down the central key, then press the top-right key 3 times + 3. within 1.5 seconds to enter inclusion mode. + 4. After successful inclusion, the device will wake to receive the + 5. setting command from Z-Wave Controller in about 20 seconds. + +### Exclusion Information + + 1. Put the Z-Wave Controller in exclusion mode. + 2. Hold down the central key, then press the top-right key 3 times within 1.5 seconds to enter exclusion mode. Node ID has been excluded. + +### Wakeup Information + +The PH-PSR03 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. + + +After the device is added to the network, it will wake-up once per day in default. When it wakes up it will broadcast the “Wake Up Notification” message to the network, and wake-up 10 seconds to receive the setting commands. To wake-up the device immediately, please hold down the central key, then press the top-right key once within. The device will wake-up for 10 seconds. + +When device is charging, it will send Wake Up Notification to controller minutely. + +## Channels + +The following table summarises the channels available for the PH-PSR03 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Alarm (emergency) | alarm_emergency | alarm_emergency | Alarm | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | + +### Alarm (emergency) +Indicates Police, Fire, or Medical services should be contacted. + +The ```alarm_emergency``` channel is of type ```alarm_emergency``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| ON | EMERGENCY | +| OFF | OK | + +### Battery Level +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 is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. + + +## Device Configuration + +The following table provides a summary of the 3 configuration parameters available in the PH-PSR03. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 2 | Basic Set Level | Basic Set Level | +| 7 | Customer Function | Customer Function | +| 10 | Auto Report Battery Time | Auto Report Battery Time | +| | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | +| | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | + +### Parameter 2: Basic Set Level + +Basic Set Level +Setting the BASIC command value to turn on the light. + + * The 255 means turn on the light. + * For dimmer equipment 1 to 100 means the light strength. 0 means turn off the light. +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```255```. + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 7: Customer Function + +Customer Function +Customer function switch, using bit control. + +Bit0: Switch AV control/ Lighting group control. (0: AV control, 1: lighting group control) +Values in the range 0 to 255 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 10: Auto Report Battery Time + +Auto Report Battery Time +The interval time for auto report the battery level. + + * 0 means turn off auto report battery. + * Each tick means 30 minutes. + * The default value is 12(6 hours). +Values in the range 0 to 127 may be set. + +The manufacturer defined default value is ```12```. + +This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```. + +### Wakeup Interval + +The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications. + +This setting is defined in *seconds*. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances. + +Note that this setting does not affect the devices ability to send sensor data, or notification events. + +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_node``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The PH-PSR03 supports 9 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 4 nodes. + +### Group 2: Lighting Group 1 + + +Association group 2 supports 4 nodes. + +### Group 3: Lighting Group 2 + + +Association group 3 supports 4 nodes. + +### Group 4: Lighting Group 3 + + +Association group 4 supports 4 nodes. + +### Group 5: Lighting Group 4 + + +Association group 5 supports 4 nodes. + +### Group 6: Lighting Group 5 + + +Association group 6 supports 4 nodes. + +### Group 7: Lighting Group 6 + + +Association group 7 supports 4 nodes. + +### Group 8: Lighting Group 7 + + +Association group 8 supports 4 nodes. + +### Group 9: Lighting Group 8 + + +Association group 9 supports 4 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V4| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_BATTERY_V1| | +| COMMAND_CLASS_WAKE_UP_V2| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_SECURITY_V1| | + +### Documentation Links + +* [Device Manual](https://www.cd-jackson.com/zwave_device_uploads/985/ph-psr03-Zipato-Z-Wave-Remote-User-Manual-v1-0.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/985). diff --git a/_addons_bindings/zwave/doc/philio/pse02_0_0.md b/_addons_bindings/zwave/doc/philio/pse02_0_0.md index dcb6c540b..abac3eff9 100644 --- a/_addons_bindings/zwave/doc/philio/pse02_0_0.md +++ b/_addons_bindings/zwave/doc/philio/pse02_0_0.md @@ -31,22 +31,20 @@ Put controller into exclusion mode. Press tamper key three times within 1.5 seco The following table summarises the channels available for the PSE02 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Start sound | notification_send | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Start sound | notification_send | notification_send | | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Start sound - Sends a notification. -The ```notification_send``` channel supports the ```Number``` item. +The ```notification_send``` channel is of type ```notification_send``` and supports the ```Number``` item. @@ -113,6 +111,7 @@ The device does not support associations. | COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | | COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | | COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_ALARM_V3| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_POWERLEVEL_V1| | diff --git a/_addons_bindings/zwave/doc/philio/psg01_0_0.md b/_addons_bindings/zwave/doc/philio/psg01_0_0.md new file mode 100644 index 000000000..e93cba60f --- /dev/null +++ b/_addons_bindings/zwave/doc/philio/psg01_0_0.md @@ -0,0 +1,196 @@ +--- +layout: documentation +title: ZIPATO ZIP-PSG01 - ZWave +--- + +{% include base.html %} + +# ZIPATO ZIP-PSG01 Daaf Zipato Smoke Sensor +This describes the Z-Wave device *ZIPATO ZIP-PSG01*, manufactured by *[Philio Technology Corp](http://www.philio-tech.com/)* with the thing type UID of ```philio_psg01_00_000```. + +The device is in the category of *Smoke Detector*, defining Smoke detectors. + +![ZIPATO ZIP-PSG01 product image](https://www.cd-jackson.com/zwave_device_uploads/1097/1097_default.png) + + +The ZIPATO ZIP-PSG01 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 ZIPATO ZIP-PSG01 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. Refer to the *Wakeup Information* section below for further information. + +## Overview + +Zipato Smoke Sensor (Z-Wave) is designed to give early warning of developing fires by giving off the alarm sounds from its build-in alarm horn, based on Z-Wave technology. Zipato Smoke Sensor is Z-Wave Plus product, it supports security, OTA and all other new features of 500 Series Z-Wave chipset. + +### Inclusion Information + +Press test button three times within 1.5 seconds to enter the inclusion mode. + +### Exclusion Information + +Pressing test button three times within 1.5 seconds to enter the exclusion mode. + +### Wakeup Information + +The ZIPATO ZIP-PSG01 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. + + +If you want to wake-up device immediately, please press the button once. The device will wake-up for 10 seconds. + +## Channels + +The following table summarises the channels available for the ZIPATO ZIP-PSG01 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | +| Alarm (smoke) | alarm_smoke | alarm_smoke | Smoke | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | + +### Binary Sensor +Indicates if a sensor has triggered. + +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| ON | Triggered | +| OFF | Untriggered | + +### Alarm (burglar) +Indicates if the burglar alarm is triggered. + +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + +### Alarm (smoke) +Indicates if a smoke is triggered. + +The ```alarm_smoke``` channel is of type ```alarm_smoke``` and supports the ```Switch``` item and is in the ```Smoke``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + +### Battery Level +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 is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. + + +## Device Configuration + +The following table provides a summary of the 2 configuration parameters available in the ZIPATO ZIP-PSG01. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 7 | Customer Function | Customer Function | +| 10 | Auto Report Battery Time | Auto Report Battery Time | +| | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | +| | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | + +### Parameter 7: Customer Function + +Customer Function + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Notification Type, Using Notification Report. | +| 16 | Notification Type, Using Sensor Binary Report. | + +The manufacturer defined default value is ```0``` (Notification Type, Using Notification Report.). + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 10: Auto Report Battery Time + +Auto Report Battery Time +The interval time for auto report the battery level. +Values in the range 0 to 127 may be set. + +The manufacturer defined default value is ```127```. + +This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```. + +### Wakeup Interval + +The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications. + +This setting is defined in *seconds*. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances. + +Note that this setting does not affect the devices ability to send sensor data, or notification events. + +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_node``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The ZIPATO ZIP-PSG01 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 1 node. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SENSOR_BINARY_V2| | +| COMMAND_CLASS_METER_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V4| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_BATTERY_V1| | +| COMMAND_CLASS_WAKE_UP_V2| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_SECURITY_V1| | + +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/1097/ph-psg01-Zipato-Smoke-Sensor-User-Manual-v1-0.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1097). diff --git a/_addons_bindings/zwave/doc/philio/psm02_0_0.md b/_addons_bindings/zwave/doc/philio/psm02_0_0.md index 3f26ac458..5917cc7eb 100644 --- a/_addons_bindings/zwave/doc/philio/psm02_0_0.md +++ b/_addons_bindings/zwave/doc/philio/psm02_0_0.md @@ -19,30 +19,42 @@ The PSM02 does not permanently listen for messages sent from the controller - it ## Overview +The slim multi-sensor PSM02 has PIR, door/window, temperature and illumination, 4 sensors function in one, based on Z-WaveTM technology. Z-WaveTM is a wireless communication protocol designed for home automation, specifically to remotely control applications in residential and light commercial environments + +### Inclusion Information + +Pressing tamper key three times within 1.5 seconds will enter inclusion mode. + +### Exclusion Information + +Pressing tamper key three times within 1.5 seconds will enter exclusion mode. + ### Wakeup Information The PSM02 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. + +Remove the front cover, and press the tamper key once. The device will wake-up 10 seconds.  + ## Channels The following table summarises the channels available for the PSM02 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Motion Sensor | alarm_motion | Door | Switch | -| Tamper Alarm | alarm_tamper | | Switch | -| Door/Window Sensor | sensor_door | Door | Contact | -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Sensor (luminance) | sensor_luminance | | Number | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Motion Sensor | alarm_motion | alarm_motion | Motion | Switch | +| Tamper Alarm | alarm_tamper | alarm_tamper | | Switch | +| Door/Window Sensor | sensor_door | sensor_door | Door | Contact | +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Sensor (luminance) | sensor_luminance | sensor_luminance | | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Motion Sensor - Indicates if a motion alarm is triggered. -The ```alarm_motion``` 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. +The ```alarm_motion``` channel is of type ```alarm_motion``` and supports the ```Switch``` item and is in the ```Motion``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -52,10 +64,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Tamper Alarm - Indicates if the tamper alarm is triggered. -The ```alarm_tamper``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_tamper``` channel is of type ```alarm_tamper``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -65,10 +76,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Door/Window Sensor - Indicates if the door/window is open or closed. -The ```sensor_door``` channel supports the ```Contact``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_door``` channel is of type ```sensor_door``` and supports the ```Contact``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Contact``` item type -: @@ -78,23 +88,20 @@ The following state translation is provided for this channel to the ```Contact`` | CLOSED | Closed | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (luminance) - Indicates the current light reading. -The ```sensor_luminance``` channel supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_luminance``` channel is of type ```sensor_luminance``` and supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -104,24 +111,26 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 2 | Basic Set Level | -1 -> 0xFF(-1) turns on the light. 1 - 100 -> For dimmers 1 to 100 means the light strength | -| 3 | PIR Sensitivity | parameter to set the Sensitivity for the PIR (Passiv Infrared Sensor) 0 -> 0 means disable the PIR motion; 1 - 99 -> 1 means the lowest sensitivity, 99 means the highest sensitivity | -| 4 | Light Threshold | Setting the illumination threshold to turn on the light. When the event triggered and the environment illumination lower then the threshold, the device will turn on the light 0 -> 0 means turn off illumination detected function And never turn on the | -| 5 | Operation Mode | Bit 0: 1 means security mode; 0 means home automation mode. Bit 1: 1 means enable test mode; 0 means disable test mode. Notice: Bit0 and Bit1 will effect when the DIP Switch setting to program mode. If Bit1 is enabled, the Bit0 is useless. Bit 2: Disable | -| 6 | Multi-Sensor Function Switch | | -| 8 | PIR Re-Detect Interval Time | In the security mode, after the PIR motion detected, setting the re-detect time 3 8 sec - 127 8 sec -> 8 seconds per tick, and minimum time is 24 seconds, default tick is 3 (24 seconds). | -| 9 | Turn Off Light Time | After turn on the light, setting the delay time to turn off the light when the PIR motion is not detected 4 8 sec - 127 8 sec -> 8 seconds per tick, and minimum time is 32 seconds, default tick is 4 (32 seconds) | -| 10 | Auto Report Battery Time | interval time for auto report the battery level 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours) | -| 11 | Auto Report Door/Window State Time | interval time for auto report the door/window state 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours) | -| 12 | Auto Report Illumination Time | interval time for auto report the illumination state 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours) | -| 13 | Auto Report Temperature Time | Interval time for auto report the temperature state 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours) | +| 2 | Basic Set Level | Basic Set Level | +| 3 | PIR Sensitivity | PIR Sensitivity | +| 4 | Light Threshold | Light Threshold | +| 5 | Operation Mode | Operation Mode | +| 6 | Multi-Sensor Function Switch | Multi-Sensor Function Switch | +| 8 | PIR Re-Detect Interval Time | PIR Re-Detect Interval Time | +| 9 | Turn Off Light Time | Turn Off Light Time | +| 10 | Auto Report Battery Time | Auto Report Battery Time | +| 11 | Auto Report Door/Window State Time | Auto Report Door/Window State Time | +| 12 | Auto Report Illumination Time | Auto Report Illumination Time | +| 13 | Auto Report Temperature Time | Auto Report Temperature Time | | | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | | | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | ### Parameter 2: Basic Set Level --1 -> 0xFF(-1) turns on the light. 1 - 100 -> For dimmers 1 to 100 means the light strength +Basic Set Level +-1    ->  0xFF(-1) turns on the light +.1 - 100    ->  For dimmers 1 to 100 means the light strength Values in the range -1 to 100 may be set. The manufacturer defined default value is ```-1```. @@ -131,8 +140,12 @@ This parameter has the configuration ID ```config_2_1``` and is of type ```INTEG ### Parameter 3: PIR Sensitivity -parameter to set the Sensitivity for the PIR (Passiv Infrared Sensor) 0 -> 0 means disable the PIR motion; 1 - 99 -> 1 means the lowest sensitivity, 99 means the highest sensitivity +PIR Sensitivity +parameter to set the Sensitivity for the PIR (Passive Infrared Sensor) +0    ->  0 means disable the PIR motion; + +1 - 99    ->  1 means the lowest sensitivity, 99 means the highest sensitivity Values in the range 0 to 99 may be set. The manufacturer defined default value is ```70```. @@ -142,8 +155,13 @@ This parameter has the configuration ID ```config_3_1``` and is of type ```INTEG ### Parameter 4: Light Threshold -Setting the illumination threshold to turn on the light. When the event triggered and the environment illumination lower then the threshold, the device will turn on the light 0 -> 0 means turn off illumination detected function And never turn on the +Light Threshold +Setting the illumination threshold to turn on the light. When the event triggered and the environment illumination lower then the threshold, the device will turn on the light + * 0 means turn off illumination detected function And never turn on the light. + * 1 means darkest. + * 99 means brightest. + * 100 means turn off illumination detected function. And always turn on the light.  Values in the range 0 to 100 may be set. The manufacturer defined default value is ```100```. @@ -153,8 +171,24 @@ This parameter has the configuration ID ```config_4_1``` and is of type ```INTEG ### Parameter 5: Operation Mode -Bit 0: 1 means security mode; 0 means home automation mode. Bit 1: 1 means enable test mode; 0 means disable test mode. Notice: Bit0 and Bit1 will effect when the DIP Switch setting to program mode. If Bit1 is enabled, the Bit0 is useless. Bit 2: Disable +Operation Mode +Operation mode. Using bit to control. + * Bit0: + * 1 means security mode, + * 0 means home automation mode. + * Bit1: + * 1 means enable test mode, + * 0 means disable test mode + +**Notice:** Bit0 and bit1 will effect when the DIP Switch setting to program mode. If bit1 is enabled, the bit0 is useless. + + * Bit2: Disable the door/window function. + * Bit3: Setting the temperature scale. + * 0: Fahrenheit, + * 1:Celsius + * Bit4: Disable illumination report after event triggered. + * Bit5: Disable temperature report after event triggered Values in the range 0 to 127 may be set. The manufacturer defined default value is ```0```. @@ -164,14 +198,16 @@ This parameter has the configuration ID ```config_5_1``` and is of type ```INTEG ### Parameter 6: Multi-Sensor Function Switch - -Bit 0: Disable magnetic integrate illumination. - -Bit 1: Disable PIR integrate Illumination. - -Bit 2: Disable magnetic integrate PIR (Default is Disable) - -Bit 3: When Bit2 is 0 (Enable), the device is install in the same room with the light? 0: +Multi-Sensor Function Switch + * Bit 0: Disable magnetic integrate illumination. + * Bit 1: Disable PIR integrate Illumination. + * Bit 2: Disable magnetic integrate PIR (Default is Disable) + * Bit3: When Bit2 is 0 (Enable), the device is install in the same room with the light? + * 0: In the same room(Default), + * 1: In the different room. + * Bit4: Disable delay 5 seconds to turn off the light, when door/window closed. + * Bit5: Disable auto turn off the light, after door/window opened to turn on the light. + * Bit6:Enable temperature monitoring. When this bit enable, the temperature changed 3 degree Fahrenheit, it will report. And also the temperature over 1 40 degree Fahrenheit, it will report every 64 seconds. Values in the range 0 to 127 may be set. The manufacturer defined default value is ```4```. @@ -181,8 +217,12 @@ This parameter has the configuration ID ```config_6_1``` and is of type ```INTEG ### Parameter 8: PIR Re-Detect Interval Time -In the security mode, after the PIR motion detected, setting the re-detect time 3 8 sec - 127 8 sec -> 8 seconds per tick, and minimum time is 24 seconds, default tick is 3 (24 seconds). +PIR Re-Detect Interval Time +In the security mode, after the PIR motion detected, setting the re-detect time. 8 seconds per tick, and minimum time is 24 seconds, default tick is 3 (24 seconds). +Setting the suitable value to prevent received the trigger signal too frequency. Also can save the battery energy. + +**Notice:** If this value bigger than the configuration setting NO. 9. There is a period after the light turned off and the PIR not detecting. Values in the range 3 to 127 may be set. The manufacturer defined default value is ```3```. @@ -192,8 +232,12 @@ This parameter has the configuration ID ```config_8_1``` and is of type ```INTEG ### Parameter 9: Turn Off Light Time -After turn on the light, setting the delay time to turn off the light when the PIR motion is not detected 4 8 sec - 127 8 sec -> 8 seconds per tick, and minimum time is 32 seconds, default tick is 4 (32 seconds) +Turn Off Light Time +After turn on the light, setting the delay time to turn off the light when the PIR motion is not detected. +8 seconds per tick, and minimum time is 32 seconds, + +default tick is 4 (32 seconds). Values in the range 4 to 127 may be set. The manufacturer defined default value is ```4```. @@ -203,8 +247,12 @@ This parameter has the configuration ID ```config_9_1``` and is of type ```INTEG ### Parameter 10: Auto Report Battery Time -interval time for auto report the battery level 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours) +Auto Report Battery Time +The interval time for auto report the battery level. +30 minutes per tick and minimum time is 30 minutes, + +default tick is 12 (6 hours).  Values in the range 1 to 127 may be set. The manufacturer defined default value is ```12```. @@ -214,8 +262,12 @@ This parameter has the configuration ID ```config_10_1``` and is of type ```INTE ### Parameter 11: Auto Report Door/Window State Time -interval time for auto report the door/window state 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours) +Auto Report Door/Window State Time +The interval time for auto report the door/window state. +30 minutes per tick and minimum time is 30 minutes, + +default tick is 12 (6 hours). Values in the range 1 to 127 may be set. The manufacturer defined default value is ```12```. @@ -225,8 +277,12 @@ This parameter has the configuration ID ```config_11_1``` and is of type ```INTE ### Parameter 12: Auto Report Illumination Time -interval time for auto report the illumination state 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours) +Auto Report Illumination Time +The interval time for auto report the illumination. +30 minutes per tick and minimum time is 30 minutes, + +default tick is 12 (6 hours). Values in the range 1 to 127 may be set. The manufacturer defined default value is ```12```. @@ -236,8 +292,12 @@ This parameter has the configuration ID ```config_12_1``` and is of type ```INTE ### Parameter 13: Auto Report Temperature Time -Interval time for auto report the temperature state 1 30 min - 127 30 min -> 30 minutes per tick and minimum time is 30 minutes, default tick is 12 (6 hours) +Auto Report Temperature Time +Interval time for auto report the temperature. +30 minutes per tick and minimum time is 30 minutes, + +default tick is 12 (6 hours). Values in the range 1 to 127 may be set. The manufacturer defined default value is ```12```. diff --git a/_addons_bindings/zwave/doc/philio/psr04_0_0.md b/_addons_bindings/zwave/doc/philio/psr04_0_0.md index ec8ceefc7..150e43c27 100644 --- a/_addons_bindings/zwave/doc/philio/psr04_0_0.md +++ b/_addons_bindings/zwave/doc/philio/psr04_0_0.md @@ -8,12 +8,33 @@ title: PSR04 - ZWave # PSR04 Smart Color Button This describes the Z-Wave device *PSR04*, manufactured by *[Philio Technology Corp](http://www.philio-tech.com/)* with the thing type UID of ```philio_psr04_00_000```. +The device is in the category of *Remote Control*, defining Any portable or hand-held device that controls the status of something, e.g. remote control, keyfob etc.. + +![PSR04 product image](https://www.cd-jackson.com/zwave_device_uploads/291/291_default.png) + + The PSR04 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 PSR04 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. Refer to the *Wakeup Information* section below for further information. ## Overview +This device is a multiple functions button switch. It is able to switch the appliances on/off or adjust the percentage of dimmer. +It can also work as a timer. The well designed wall bracket and magnetic back let the switch can be fixed on the wall. This product +can be included and operated in any Z-Wave™ network with other Z-Wave™ certified devices from other manufacturers and/or other applications. + +### Inclusion Information + +**See manual for details.** + +Pointing the arrowhead to area A first (shown in Fig. 2). Pressing the button three times within 1.5 seconds. The red LED will light up for 1 second if succeed.   + +### Exclusion Information + +**See manual for details.** + + Pointing the arrowhead to area A first (shown in Fig. 2). Pressing the button three times within 1.5 seconds.  + ### Wakeup Information The PSR04 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. @@ -35,24 +56,22 @@ This activates the wakeup for 10 seconds, during which time you will be able to The following table summarises the channels available for the PSR04 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: | Event ID | Event Description | @@ -66,11 +85,10 @@ This channel provides the scene, and the event as a decimal value in the form `` | 6 | 5 x keypress | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/philio/pst02b_0_0.md b/_addons_bindings/zwave/doc/philio/pst02b_0_0.md index 211ebfcba..0d88bb164 100644 --- a/_addons_bindings/zwave/doc/philio/pst02b_0_0.md +++ b/_addons_bindings/zwave/doc/philio/pst02b_0_0.md @@ -19,29 +19,42 @@ The PST02B does not permanently listen for messages sent from the controller - i ## Overview +The slim multisensor PST02 has PIR, temperature and illumination, 3 sensors function in one, based on Z-WaveTM technology. + +### Inclusion Information + +Pressing tamper key three times within 1.5 seconds to enter the inclusion mode. + +### Exclusion Information + +Pressing tamper key three times within 1.5 seconds to enter the exclusion mode. + ### Wakeup Information The PST02B 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. + +If the user want to wake-up the device immediately, please remove the front cover, and press the tamper key once. The device will wake-up 10 seconds.  + ## Channels The following table summarises the channels available for the PST02B -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor [Deprecated]| sensor_binary | Door | Switch | -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Sensor (luminance) | sensor_luminance | | Number | -| Motion Alarm | alarm_motion | Door | Switch | -| Tamper Alarm [Deprecated]| alarm_tamper | | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor [Deprecated]| sensor_binary | sensor_binary | | Switch | +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Sensor (luminance) | sensor_luminance | sensor_luminance | | Number | +| Motion Alarm | alarm_motion | alarm_motion | Motion | Switch | +| Tamper Alarm [Deprecated]| alarm_tamper | alarm_tamper | | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor [Deprecated] 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -55,17 +68,17 @@ The following state translation is provided for this channel to the ```Switch``` ### Sensor (temperature) Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (luminance) Indicates the current light reading. -The ```sensor_luminance``` channel supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_luminance``` channel is of type ```sensor_luminance``` and supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. ### Motion Alarm Indicates if a motion alarm is triggered. -The ```alarm_motion``` 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. +The ```alarm_motion``` channel is of type ```alarm_motion``` and supports the ```Switch``` item and is in the ```Motion``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -77,7 +90,7 @@ The following state translation is provided for this channel to the ```Switch``` ### Tamper Alarm [Deprecated] Indicates if the tamper alarm is triggered. -The ```alarm_tamper``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_tamper``` channel is of type ```alarm_tamper``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -91,8 +104,8 @@ The following state translation is provided for this channel to the ```Switch``` ### Battery Level 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/philio/pst02c_0_0.md b/_addons_bindings/zwave/doc/philio/pst02c_0_0.md index 545ebc8e0..1f3c3f114 100644 --- a/_addons_bindings/zwave/doc/philio/pst02c_0_0.md +++ b/_addons_bindings/zwave/doc/philio/pst02c_0_0.md @@ -61,19 +61,18 @@ If the user want to wake-up the device immediately, please remove the front cove The following table summarises the channels available for the PST02C -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor (door) | sensor_binary | Door | Switch | -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Sensor (luminance) | sensor_luminance | | Number | -| Door sensor | sensor_door | Door | Contact | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor (door) | sensor_binary | sensor_binary | | Switch | +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Sensor (luminance) | sensor_luminance | sensor_luminance | | Number | +| Door sensor | sensor_door | sensor_door | Door | Contact | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor (door) - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -83,22 +82,19 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (luminance) - Indicates the current light reading. -The ```sensor_luminance``` channel supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_luminance``` channel is of type ```sensor_luminance``` and supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. ### Door sensor - Indicates if the door/window is open or closed. -The ```sensor_door``` channel supports the ```Contact``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_door``` channel is of type ```sensor_door``` and supports the ```Contact``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Contact``` item type -: @@ -108,11 +104,10 @@ The following state translation is provided for this channel to the ```Contact`` | CLOSED | Closed | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -127,10 +122,10 @@ Detailed information on each parameter can be found in the sections below. | 5 | Operation Mode | Parameter to set the Operation Mode. | | 6 | Multi-Sensor Function Switch | Parameter to set the sensor functions. | | 7 | Customer Function | Parameter to set the Customer Function. | -| 8 | PIR Re-Detect Interval Time | | -| 9 | Turn Off Light Time | | -| 10 | Auto Report Battery Time | | -| 11 | Auto Report Door/Window State Time | | +| 8 | PIR Re-Detect Interval Time | PIR Re-Detect Interval Time | +| 9 | Turn Off Light Time | Turn Off Light Time | +| 10 | Auto Report Battery Time | Auto Report Battery Time | +| 11 | Auto Report Door/Window State Time | Auto Report Door/Window State Time | | 12 | Auto Report Illumination Time | The Interval time for auto reporting the illumination state. | | 13 | Auto Report Temperature Time | The interval time for auto reporting the temperature state. | | 20 | Auto Report Tick Interval | The interval time for each auto report tick. | @@ -241,7 +236,7 @@ This parameter has the configuration ID ```config_7_1``` and is of type ```INTEG ### Parameter 8: PIR Re-Detect Interval Time - +PIR Re-Detect Interval Time In the normal mode, after the PIR motion detected, setting the re-detect time. 8 seconds per tick, default is 3 (24 seconds). * 1 - 127 = Number of ticks. 8 seconds per tick, default value is 3 (24 seconds). @@ -254,7 +249,7 @@ This parameter has the configuration ID ```config_8_1``` and is of type ```INTEG ### Parameter 9: Turn Off Light Time - +Turn Off Light Time After turn on the light, setting the delay time to turn off the light when the PIR motion is not detected. * 0 = Never send turn off light command. @@ -268,7 +263,7 @@ This parameter has the configuration ID ```config_9_1``` and is of type ```INTEG ### Parameter 10: Auto Report Battery Time - +Auto Report Battery Time The interval time for auto reporting the battery level. * 0 = Turn off auto report battery. @@ -282,7 +277,7 @@ This parameter has the configuration ID ```config_10_1``` and is of type ```INTE ### Parameter 11: Auto Report Door/Window State Time - +Auto Report Door/Window State Time The interval time for auto reporting the door/window state. * 0 = Turn off auto report door/window state. diff --git a/_addons_bindings/zwave/doc/polycontrol/btzeumv1_0_0.md b/_addons_bindings/zwave/doc/polycontrol/btzeumv1_0_0.md new file mode 100644 index 000000000..4b2c2c932 --- /dev/null +++ b/_addons_bindings/zwave/doc/polycontrol/btzeumv1_0_0.md @@ -0,0 +1,136 @@ +--- +layout: documentation +title: BTZEUMV1 - ZWave +--- + +{% include base.html %} + +# BTZEUMV1 Danalock Universal Module V1 +This describes the Z-Wave device *BTZEUMV1*, manufactured by *[Poly-control](https://www.danalock.com/)* with the thing type UID of ```polycontrol_btzeumv1_00_000```. + +The device is in the category of *Lock*, defining Devices whose primary pupose is locking something. + +![BTZEUMV1 product image](https://www.cd-jackson.com/zwave_device_uploads/868/868_default.jpg) + + +The BTZEUMV1 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. + +## Overview + +The universal module enables the control of existing electrical locking systems via smartphone. It is a circuit board with a relay to switch potential-free contacts. The module is connected near the lock system and actuates engine locks, garage doors, digital cylinders or the door number. + +### Inclusion Information + +To add or include the Danalock into a Z-Wave network + + 1. Set the controller in inclusion mode + 2. Push the switch once until you hear two beeps. + +### Exclusion Information + +To remove or exclude the Danalock from a Z-Wave network + + 1. Set the controller in inclusion mode + 2. Push the switch once until you hear two beeps. + +## Channels + +The following table summarises the channels available for the BTZEUMV1 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Door Lock | lock_door | lock_door | Door | Switch | +| Alarm (access) | alarm_access | alarm_access | Door | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | + +### Door Lock +Lock and unlock the door. + +The ```lock_door``` channel is of type ```lock_door``` and supports the ```Switch``` item and is in the ```Door``` category. +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| ON | Locked | +| OFF | Unlocked | + +### Alarm (access) +Indicates if the access control alarm is triggered. + +The ```alarm_access``` channel is of type ```alarm_access``` and 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. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + +### Battery Level +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 is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. +### Clock Time Offset +Provides the current time difference for the devices time. + +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. + + + +## Device Configuration + +The device has no configuration parameters defined. + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The BTZEUMV1 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. +Z-Wave Plus Lifeline + +Association group 1 supports 1 node. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_APPLICATION_STATUS_V1| | +| COMMAND_CLASS_SCHEDULE_ENTRY_LOCK_V1| | +| COMMAND_CLASS_SCHEDULE_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_DOOR_LOCK_V1| | +| COMMAND_CLASS_USER_CODE_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V3| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_BATTERY_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_TIME_V1| | +| COMMAND_CLASS_TIME_PARAMETERS_V1| | +| COMMAND_CLASS_SECURITY_V1| | + +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/868/danalock-universalmodul-v1.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/868). diff --git a/_addons_bindings/zwave/doc/polycontrol/btzu125_0_0.md b/_addons_bindings/zwave/doc/polycontrol/btzu125_0_0.md index ea8c1c15e..ef4cda1d6 100644 --- a/_addons_bindings/zwave/doc/polycontrol/btzu125_0_0.md +++ b/_addons_bindings/zwave/doc/polycontrol/btzu125_0_0.md @@ -41,15 +41,15 @@ Push the switch once until you hear two beeps. The following table summarises the channels available for the BTZW125 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Door Lock | lock_door | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Door Lock | lock_door | lock_door | Door | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Door Lock Lock and unlock the door. -The ```lock_door``` channel supports the ```Switch``` item and is in the ```Door``` category. +The ```lock_door``` channel is of type ```lock_door``` and supports the ```Switch``` item and is in the ```Door``` category. The following state translation is provided for this channel to the ```Switch``` item type -: | Value | Label | @@ -60,8 +60,8 @@ The following state translation is provided for this channel to the ```Switch``` ### Battery Level 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -248,7 +248,7 @@ The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | Disabled | -| 1 | 1 second | +| 1 | Brake for 1 second | | 2 | Brake for 2 seconds | | 3 | Brake for 3 seconds | | 4 | Brake for 4 seconds | diff --git a/_addons_bindings/zwave/doc/popp/005206_0_0.md b/_addons_bindings/zwave/doc/popp/005206_0_0.md index 049992467..9d624c0bc 100644 --- a/_addons_bindings/zwave/doc/popp/005206_0_0.md +++ b/_addons_bindings/zwave/doc/popp/005206_0_0.md @@ -8,40 +8,57 @@ title: 005206 - ZWave # 005206 Z-Weather This describes the Z-Wave device *005206*, manufactured by *Popp & Co* with the thing type UID of ```popp_005206_00_000```. +The device is in the category of *Sensor*, defining Device used to measure something. + +![005206 product image](https://www.cd-jackson.com/zwave_device_uploads/512/512_default.png) + + The 005206 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 005206 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. Refer to the *Wakeup Information* section below for further information. ## Overview +Z-Weather is a cup anemometer for Z-Wave installations. It continually measures the wind speed and can, for example, trigger closing of the awning and blinds if it is too windy. It also measures the amount of rotation, enabling calculation of the wind yield per day or per year. In addition, Z-Weather includes sensors for humidity, temperature, pressure and dew point, essentially providing the core sensors of a weather station.  + +### Inclusion Information + +Push the button 3 times within 1.5 seconds + +### Exclusion Information + +Push the button 3 times within 1.5 seconds + ### Wakeup Information The 005206 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. + +Push the button once within 1.5 seconds + ## Channels The following table summarises the channels available for the 005206 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Sensor (relative humidity) | sensor_relhumidity | Humidity | Number | -| Sensor (barometric pressure) | sensor_barpressure | | Number | -| Sensor (velocity) | sensor_velocity | | Number | -| Sensor (dew point) | sensor_dewpoint | Temperature | Number | -| Sensor (luminance) | sensor_luminance | | Number | -| Electric meter (pulses) | meter_pulse | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number | +| Sensor (barometric pressure) | sensor_barpressure | sensor_barpressure | Pressure | Number | +| Sensor (velocity) | sensor_velocity | sensor_velocity | | Number | +| Sensor (dew point) | sensor_dewpoint | sensor_dewpoint | Temperature | Number | +| Sensor (luminance) | sensor_luminance | sensor_luminance | | Number | +| Electric meter (pulses) | meter_pulse | meter_pulse | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -51,59 +68,50 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) - Indicates the current relative humidity. -The ```sensor_relhumidity``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Sensor (barometric pressure) - Indicates the barometric pressure. -The ```sensor_barpressure``` channel supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_barpressure``` channel is of type ```sensor_barpressure``` and supports the ```Number``` item and is in the ```Pressure``` category. This is a read only channel so will only be updated following state changes from the device. ### Sensor (velocity) - Indicates the current velocity. -The ```sensor_velocity``` channel supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_velocity``` channel is of type ```sensor_velocity``` and supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. ### Sensor (dew point) - Indicates the dewpoint. -The ```sensor_dewpoint``` channel supports the ```Number``` item and is in the ```Temperature``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_dewpoint``` channel is of type ```sensor_dewpoint``` and supports the ```Number``` item and is in the ```Temperature``` category. This is a read only channel so will only be updated following state changes from the device. ### Sensor (luminance) - Indicates the current light reading. -The ```sensor_luminance``` channel supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_luminance``` channel is of type ```sensor_luminance``` and supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (pulses) - Indicates the pulse count. -The ```meter_pulse``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_pulse``` channel is of type ```meter_pulse``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -163,10 +171,11 @@ Association groups allow the device to send unsolicited reports to the controlle The 005206 supports 4 association groups. -### Group 1: Life Line +### Group 1: Lifeline +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. -Association group 1 supports 1 node. +Association group 1 supports 5 nodes. ### Group 2: Wind Speed diff --git a/_addons_bindings/zwave/doc/popp/009204_0_0.md b/_addons_bindings/zwave/doc/popp/009204_0_0.md index 042af3564..d28c8a7fd 100644 --- a/_addons_bindings/zwave/doc/popp/009204_0_0.md +++ b/_addons_bindings/zwave/doc/popp/009204_0_0.md @@ -8,30 +8,51 @@ title: 009204 - ZWave # 009204 KFOB-C Remote-Control This describes the Z-Wave device *009204*, manufactured by *Popp & Co* with the thing type UID of ```popp_009204_00_000```. +The device is in the category of *Remote Control*, defining Any portable or hand-held device that controls the status of something, e.g. remote control, keyfob etc.. + +![009204 product image](https://www.cd-jackson.com/zwave_device_uploads/415/415_default.png) + + The 009204 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. Refer to the *Wakeup Information* section below for further information. ## Overview +The Secure Key Fob Controller is a 4 button Z-Wave device capable to act both as primary or secondary controller. The four buttons can control other Z-Wave devices such as switches, dimmer and even door locks directly. Various options - configurable by Z-Wave configuration commands - define the actions and the commands used for this control. It is possible to use two sets of buttons (one of on/open/up and one for off/closed/down) or 4 single buttons to control 4 different groups of devices. + +The controller also allows triggering scenes in a central controller. Again different modes can be configured to adapt to the various implementations of scenes in different central controllers in the market. + +Control options also include special modes like "all on/off" or always controlling the Z-Wave device in proximity to the fob. + +### Inclusion Information + +When in factory default push Button 3 (secure) or Button 4 (normal) for one second to enter inclusion mode. The inclusion mode is indicated by a blinking green LED. From second device on you need to enter management mode  push all four buttons together for one second - green led blinks slowly), hit button 3 ( enter primary controller functions - green led blinks faster) and then button 1 (secure) or button 2 (normal). + +### Exclusion Information + +Enter management mode  by push all four buttons together for one second - green led blinks slowly), hit button 3 ( enter primary controller functions - green led blinks faster) and then button 3 again. + ### Wakeup Information The 009204 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. + +Enter management mode  by push all four buttons together for one second - green led blinks slowly), then hit button 2 . + ## Channels The following table summarises the channels available for the 009204 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Scene Number | scene_number | | Number | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Scene Number | scene_number | scene_number | | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: | Event ID | Event Description | @@ -45,11 +66,10 @@ This channel provides the scene, and the event as a decimal value in the form `` | 6 | 5 x keypress | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -67,8 +87,8 @@ Detailed information on each parameter can be found in the sections below. | 14 | Command to control Group D | This parameter defines the command to be sent to devices of control group D | | 21 | Send the following Switch All commands | | | 22 | Invert buttons | | -| 25 | Blocks wake up even when Wake Up Interval is set | | -| 30 | Send unsolicited Battery Report on Wake Up | | +| 25 | Blocks wake up even when Wake Up Interval is set | Blocks wake up even when Wake Up Interval is set | +| 30 | Send unsolicited Battery Report on Wake Up | Send unsolicited Battery Report on Wake Up | | | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | | | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | @@ -115,7 +135,7 @@ The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | Disabled | -| 1 | Switch On/Off and Dim (send Basic Set and Switch Multilevel) | +| 1 | Switch On/Off and Dim | | 2 | Switch On/Off only (send Basic Set) | | 3 | Switch all | | 4 | Send Scenes | @@ -138,7 +158,7 @@ The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | Disabled | -| 1 | Switch On/Off and Dim (send Basic Set and Switch Multilevel) | +| 1 | Switch On/Off and Dim | | 2 | Switch On/Off only (send Basic Set) | | 3 | Switch all | | 4 | Send Scenes | @@ -161,7 +181,7 @@ The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | Disabled | -| 1 | Switch On/Off and Dim (send Basic Set and Switch Multilevel) | +| 1 | Switch On/Off and Dim | | 2 | Switch On/Off only (send Basic Set) | | 3 | Switch all | | 4 | Send Scenes | @@ -184,7 +204,7 @@ The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | Disabled | -| 1 | Switch On/Off and Dim (send Basic Set and Switch Multilevel) | +| 1 | Switch On/Off and Dim | | 2 | Switch On/Off only (send Basic Set) | | 3 | Switch all | | 4 | Send Scenes | @@ -233,7 +253,7 @@ This parameter has the configuration ID ```config_22_1``` and is of type ```INTE ### Parameter 25: Blocks wake up even when Wake Up Interval is set - +Blocks wake up even when Wake Up Interval is set If the KFOB wakes up and there is no controller nearby, several unsuccessful communication attempts will drain battery. The following option values may be configured -: @@ -249,7 +269,7 @@ This parameter has the configuration ID ```config_25_1``` and is of type ```INTE ### Parameter 30: Send unsolicited Battery Report on Wake Up - +Send unsolicited Battery Report on Wake Up If the KFOB wakes up and there is no controller nearby, several unsuccessful communication attempts will drain battery. Value The following option values may be configured -: @@ -285,27 +305,37 @@ This parameter has the configuration ID ```wakeup_node``` and is of type ```INTE Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The 009204 supports 4 association groups. +The 009204 supports 5 association groups. -### Group 1: Controlled by button 1 or single clicks of buttons 1 and 3 +### Group 1: Lifeline +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. -Association group 1 supports 8 nodes. +Association group 1 supports 10 nodes. -### Group 2: Controlled by button 3 or double clicks of buttons 1 and 3 +### Group 2: Control Group A +controlled by button 1 or single clicks of buttons 1 and 3  -Association group 2 supports 8 nodes. +Association group 2 supports 10 nodes. -### Group 3: Controlled by button 2 or single clicks of buttons 2 and 4 +### Group 3: Control Group B + controlled by button 2 or single clicks of buttons 2 and 4  -Association group 3 supports 8 nodes. +Association group 3 supports 10 nodes. -### Group 4: Controlled by button 4 or double clicks of buttons 2 and 4 +### Group 4: Control Group C + controlled by button 3 or double clicks of buttons 1 and 3 -Association group 4 supports 8 nodes. +Association group 4 supports 10 nodes. + +### Group 5: Control Group D + +controlled by button 4 or double clicks of buttons 2 and 4 + +Association group 5 supports 10 nodes. ## Technical Information diff --git a/_addons_bindings/zwave/doc/popp/009303_0_0.md b/_addons_bindings/zwave/doc/popp/009303_0_0.md index a308d03a1..27ff22c17 100644 --- a/_addons_bindings/zwave/doc/popp/009303_0_0.md +++ b/_addons_bindings/zwave/doc/popp/009303_0_0.md @@ -17,6 +17,10 @@ The 009303 does not permanently listen for messages sent from the controller - i ## Overview +The Wall Controller is a 4 button Z-Wave device capable to act both as primary or secondary controller. The four buttons can control other Z-Wave devices such as switches, dimmer and even door locks directly. Various options – configurable by Z-Wave configuration commands – define the actions and the commands used for this control. It is possible to use two sets of buttons (one for on/open/up and one for off/closed/down) or four single buttons to control four different groups of devices. + +The controller also allows triggering scenes in a central controller. Again different modes can be configured to adapt to the various implementations of scenes in different central controllers in the market. Control options also include special modes like „all on/off“ or always controlling the Z-Wave device in proximity to the controller.  + ### Inclusion Information see attached file "Popp 009303 Battery Wall Controller Manual" (section Reference Documents) @@ -38,24 +42,22 @@ see attached file "Popp 009303 Battery Wall Controller Manual" (section Referenc The following table summarises the channels available for the 009303 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: | Event ID | Event Description | @@ -69,11 +71,10 @@ This channel provides the scene, and the event as a decimal value in the form `` | 6 | 5 x keypress | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -85,10 +86,10 @@ Detailed information on each parameter can be found in the sections below. |-------|-------|-------------| | 1 | Button 1 and 3 pair mode | Button 1 and 3 pair mode. | | 2 | Button 2 and 4 pair mode | Button 2 and 4 pair mode. | -| 11 | Command to control Group A | Defines the command to be sent to devices of control group A when the related button is pressed. | -| 12 | Command to control Group B | Defines the command to be sent to devices of control group B when the related button is pressed. | -| 13 | Command to control Group C | Defines the command to be sent to devices of control group C when the related button is pressed. | -| 14 | Command to control Group D | Defines the command to be sent to devices of control group D when the related button is pressed. | +| 11 | Command to control Group A | Command to control Group A | +| 12 | Command to control Group B | Command to control Group B | +| 13 | Command to control Group C | Command to control Group C | +| 14 | Command to control Group D | Command to control Group D | | 21 | Send the following switch all commands | | | 22 | Invert buttons | | | 25 | Block wake up even when Wake Up Interval is set | | @@ -132,14 +133,14 @@ This parameter has the configuration ID ```config_2_1``` and is of type ```INTEG ### Parameter 11: Command to control Group A +Command to control Group A Defines the command to be sent to devices of control group A when the related button is pressed. - The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | Disable | -| 1 | Switch on/off and Dim (send Basic Set and Switch Multilevel) | +| 1 | Switch on/off and Dim | | 2 | Switch on/off only (send Basic Set) | | 3 | Switch all | | 4 | Send scenes | @@ -155,14 +156,14 @@ This parameter has the configuration ID ```config_11_1``` and is of type ```INTE ### Parameter 12: Command to control Group B +Command to control Group B Defines the command to be sent to devices of control group B when the related button is pressed. - The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | Disable | -| 1 | Switch on/off and Dim (send Basic Set and Switch Multilevel) | +| 1 | Switch on/off and Dim | | 2 | Switch on/off only (send Basic Set) | | 3 | Switch all | | 4 | Send scenes | @@ -178,14 +179,14 @@ This parameter has the configuration ID ```config_12_1``` and is of type ```INTE ### Parameter 13: Command to control Group C +Command to control Group C Defines the command to be sent to devices of control group C when the related button is pressed. - The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | Disable | -| 1 | Switch on/off and Dim (send Basic Set and Switch Multilevel) | +| 1 | Switch on/off and Dim | | 2 | Switch on/off only (send Basic Set) | | 3 | Switch all | | 4 | Send scenes | @@ -201,14 +202,14 @@ This parameter has the configuration ID ```config_13_1``` and is of type ```INTE ### Parameter 14: Command to control Group D +Command to control Group D Defines the command to be sent to devices of control group D when the related button is pressed. - The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | Disable | -| 1 | Switch on/off and Dim (send Basic Set and Switch Multilevel) | +| 1 | Switch on/off and Dim | | 2 | Switch on/off only (send Basic Set) | | 3 | Switch all | | 4 | Send scenes | @@ -264,7 +265,7 @@ The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | Wake up is blocked (default) | -| 1 | Wake up is possible if configured accordingly | +| 1 | Wake up is possible | The manufacturer defined default value is ```0``` (Wake up is blocked (default)). @@ -280,7 +281,7 @@ The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | No | -| 1 | To same node as Wake Up Notification (default) | +| 1 | To same node as Wake Up Notification | | 2 | Broadcast to neighbors | The manufacturer defined default value is ```0``` (No). diff --git a/_addons_bindings/zwave/doc/popp/009402_0_0.md b/_addons_bindings/zwave/doc/popp/009402_0_0.md index 0c5c88a90..df5a6d256 100644 --- a/_addons_bindings/zwave/doc/popp/009402_0_0.md +++ b/_addons_bindings/zwave/doc/popp/009402_0_0.md @@ -18,30 +18,41 @@ The 009402 supports routing. This allows the device to communicate using other r ## 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/424) to improve the documentation. +This product combines a certified '10 year' stand-alone smoke detector with a plug-in Z-Wave module to form a wirelessly reporting automatically meshing smoke sensor plus wirelessly controllable indoor siren. The smoke detector is certified by the VdS for Q quality and DIN EN 14604 and satisfies all contemporary legal requirements. + +The High-End 10 years smoke detector offers a test button conveniently accessible even with a broomstick when mounted on the sealing. The smoke chamber is monitored electronically to avoid any malfunction and wrong alerts. The device will also report its end of life to make sure it is getting replaced on time. + +According to the VdS 3515 (smoke sensors with radio communication) this device will relay all alarms to all other smoke sensors in the Z-Wave network to create a house-wide alarm. This connection of the smoke sensors is fully automated and needs no further configuration. The smoke sensors and the controller communicate via a secure protocol to prevent manipulation.  + +### Inclusion Information + + * Pressing the button 'Inclusion Button' for one second includes the device. + * If the button is pressed for at least 2 seconds the inclusion will be done without the Security Command Class + +### Exclusion Information + + A single click on the button 'Inclusion Button' will exclude the device.  ## Channels The following table summarises the channels available for the 009402 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Binary Sensor | sensor_binary | Door | Switch | -| Smoke Alarm | alarm_smoke | Smoke | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Smoke Alarm | alarm_smoke | alarm_smoke | Smoke | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -51,10 +62,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Smoke Alarm - Indicates if a smoke is triggered. -The ```alarm_smoke``` channel supports the ```Switch``` item and is in the ```Smoke``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_smoke``` channel is of type ```alarm_smoke``` and supports the ```Switch``` item and is in the ```Smoke``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -64,11 +74,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -78,15 +87,17 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 1 | Siren alarm sequence interval | The additional siren is creating a different acoustic signal differentiate from the smoke alarm. This sound is partly on and partly off. This parameter defines the total length of the interval in seconds. | -| 2 | Siren alarm tone length | The additional siren is creating a different acoustic signal differentiate from the smoke alarm. This sound is partly on and partly off. This parameter defines the total length of the sound versus silence within this interval. | +| 1 | Siren alarm sequence interval | Siren alarm sequence interval | +| 2 | Siren alarm tone length | Siren alarm tone length | | 3 | Value of On-Command | | | 4 | Value of Off-Command | | ### Parameter 1: Siren alarm sequence interval -The additional siren is creating a different acoustic signal differentiate from the smoke alarm. This sound is partly on and partly off. This parameter defines the total length of the interval in seconds. +Siren alarm sequence interval +The additional siren is creating a different acoustic signal differentiate from the smoke alarm. This sound is partly on and partly  off. +This parameter defines the total length of the interval in seconds. Values in the range 3 to 129 may be set. The manufacturer defined default value is ```10```. @@ -96,8 +107,10 @@ This parameter has the configuration ID ```config_1_1``` and is of type ```INTEG ### Parameter 2: Siren alarm tone length -The additional siren is creating a different acoustic signal differentiate from the smoke alarm. This sound is partly on and partly off. This parameter defines the total length of the sound versus silence within this interval. +Siren alarm tone length +The  additional siren is creating a different acoustic signal differentiate from the smoke alarm. This sound is partly on and partly  off. +This parameter defines the total  length of the sound versus silence within this interval. Values in the range 1 to 99 may be set. The manufacturer defined default value is ```8```. diff --git a/_addons_bindings/zwave/doc/popp/009402_1_14.md b/_addons_bindings/zwave/doc/popp/009402_1_14.md index 87145ffbe..76ba825c3 100644 --- a/_addons_bindings/zwave/doc/popp/009402_1_14.md +++ b/_addons_bindings/zwave/doc/popp/009402_1_14.md @@ -18,32 +18,45 @@ The 009402 supports routing. This allows the device to communicate using other r ## 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/532) to improve the documentation. +This product combines a certified '10 year' stand-alone smoke detector with a plug-in Z-Wave module to form a wirelessly reporting automatically meshing smoke sensor plus wirelessly controllable indoor siren. The smoke detector’s sensor head is certified with the Q quality label, conforms DIN EN 14604 and satisfies all contemporary legal requirements. + +The High-End 10-years smoke detector offers a large test button conveniently accessible even with a broomstick when mounted on the sealing. The smoke chamber is monitored electronically to avoid any malfunction and wrong alerts. The device will also report its end of life to make sure it is getting replaced on time. + +Furthermore, the device can be used as an independent indoor siren within the Z-Wave network, which can alarm in case of detected flood or burglary. Please consider that the additional siren function will influence battery lifetime! + +The smoke sensor and the Z-Wave controller communicate via a secure protocol to prevent manipulation. + +### Inclusion Information + + * Pressing the Z-Wave button includes the device. + * If the button is pressed for at least 3 seconds, the inclusion will be done without the Security Command Class. + +### Exclusion Information + + A single click on the  Z-Wave button will exclude the device.  ## Channels The following table summarises the channels available for the 009402 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Binary Sensor | sensor_binary | Door | Switch | -| Alarm (system) | alarm_system | | Switch | -| Alarm (smoke) | alarm_smoke | Smoke | Switch | -| Alarm (burglar) | alarm_burglar | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Alarm (system) | alarm_system | alarm_system | | Switch | +| Alarm (smoke) | alarm_smoke | alarm_smoke | Smoke | Switch | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -53,10 +66,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Alarm (system) - Indicates if a system alarm is triggered. -The ```alarm_system``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_system``` channel is of type ```alarm_system``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -66,10 +78,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Alarm (smoke) - Indicates if a smoke is triggered. -The ```alarm_smoke``` channel supports the ```Switch``` item and is in the ```Smoke``` category. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_smoke``` channel is of type ```alarm_smoke``` and supports the ```Switch``` item and is in the ```Smoke``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -79,10 +90,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Alarm (burglar) - Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -92,11 +102,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -106,16 +115,18 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 1 | Siren alarm sequence interval | The additional siren is creating a different acoustic signal differentiate from the smoke alarm. This sound is partly on and partly off. This parameter defines the total length of the interval in seconds. | -| 2 | Siren alarm tone length | The additional siren is creating a different acoustic signal differentiate from the smoke alarm. This sound is partly on and partly off. This parameter defines the total length of the sound versus silence within this interval. | +| 1 | Siren alarm sequence interval | Siren alarm sequence interval | +| 2 | Siren alarm tone length | Siren alarm tone length | | 3 | Value of On-Command | | | 4 | Value of Off-Command | | -| 10 | Auto Report Battery Time | | +| 10 | Auto Report Battery Time | Auto Report Battery Time | ### Parameter 1: Siren alarm sequence interval -The additional siren is creating a different acoustic signal differentiate from the smoke alarm. This sound is partly on and partly off. This parameter defines the total length of the interval in seconds. +Siren alarm sequence interval +The additional siren is creating a different acoustic signal differentiate from the smoke alarm. This sound is partly on and partly  off. +This parameter defines the total length of the interval in seconds. Values in the range 3 to 129 may be set. The manufacturer defined default value is ```10```. @@ -125,8 +136,10 @@ This parameter has the configuration ID ```config_1_1``` and is of type ```INTEG ### Parameter 2: Siren alarm tone length -The additional siren is creating a different acoustic signal differentiate from the smoke alarm. This sound is partly on and partly off. This parameter defines the total length of the sound versus silence within this interval. +Siren alarm tone length +The  additional siren is creating a different acoustic signal differentiate from the smoke alarm. This sound is partly on and partly  off. +This parameter defines the total  length of the sound versus silence within this interval. Values in the range 1 to 99 may be set. The manufacturer defined default value is ```8```. @@ -158,7 +171,7 @@ This parameter has the configuration ID ```config_4_1``` and is of type ```INTEG ### Parameter 10: Auto Report Battery Time - +Auto Report Battery Time The interval time for auto report the battery level. Values in the range 0 to 127 may be set. diff --git a/_addons_bindings/zwave/doc/popp/05438_0_0.md b/_addons_bindings/zwave/doc/popp/05438_0_0.md index eeb113a8d..7ae97004b 100644 --- a/_addons_bindings/zwave/doc/popp/05438_0_0.md +++ b/_addons_bindings/zwave/doc/popp/05438_0_0.md @@ -17,35 +17,40 @@ The 05438 supports routing. This allows the device to communicate using other ro ## 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/230) to improve the documentation. +This is a plug switch that can be placed between a wall outlet for Schuko plugs (plug type F) and electric devices, plugged in by cord. It can switch all loads up to 3500 W. The device is IP 44 rated and can therefore be used both in dry environments as well as humid environments and outdoor. Switching is controlled wirelessly using Z-Wave or locally applying a button. A multi color LED indicates the switching status and the assignment of the colors to the switching status can be defined by the user. The device will report any change of the switching status to a central gateway regardless the origin of the switch (local or wireless). A built in virtual power meter will report the power consumption of the load attached. However the user must configure the assumed constant power draw of the load. The local button can control the local load but can also be used to control other functions in a Z-Wave network. The device is certified and tested against all important European Safety Regulations and fully complies with the Z-Wave Plus standard. The device supports secure communication and the firmware can be upgraded over the air (OTA). + +### Inclusion Information + + Inclusion and Exclusion are confirmed by a triple click of the button + +### Exclusion Information + + Inclusion and Exclusion are confirmed by a triple click of the button ## Channels The following table summarises the channels available for the 05438 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. diff --git a/_addons_bindings/zwave/doc/popp/123580_0_0.md b/_addons_bindings/zwave/doc/popp/123580_0_0.md index 191d7cdee..9eed57578 100644 --- a/_addons_bindings/zwave/doc/popp/123580_0_0.md +++ b/_addons_bindings/zwave/doc/popp/123580_0_0.md @@ -8,26 +8,38 @@ title: 123580 - ZWave # 123580 Wall Plug Dimmer This describes the Z-Wave device *123580*, manufactured by *Popp & Co* with the thing type UID of ```popp_123580_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![123580 product image](https://www.cd-jackson.com/zwave_device_uploads/232/232_default.png) + + The 123580 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 between other devices in the mesh network. ## 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/232) to improve the documentation. +This is a wall plug dimmer that can be placed between a schuko wall outlet and electric devices, plugged in by cord. It can dim all incandescent lights, high voltage halogen lamps and transformers operated low voltage lamps without any restriction. Special optimization functions support the dimming of the majority of dimmable LED lights and Compact Fluorescent Lights (CFLs). The device is IP20 rated and can therefore only be used in dry environments. The device offers a Baby-Dim Function which dims down a lamp from a defined level into another defined level in a longer but also definable period (e.g. 20 minutes). An automatic Light-Off function and programmable dimming and switching behavior makes the device a very flexible tool for inhouse lighting. + +### Inclusion Information + + Inclusion and Exclusion are confirmed by a tripple click of the button.  + +### Exclusion Information + + Inclusion and Exclusion are confirmed by a tripple click of the button.  ## Channels The following table summarises the channels available for the 123580 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. @@ -40,20 +52,20 @@ Detailed information on each parameter can be found in the sections below. |-------|-------|-------------| | 1 | Set LED indication mode | | | 2 | Automatic switch off time | If not zero, automatically switch off after a user defined time (in seconds) | -| 3 | RF Off command | Defines how to interpret RF Off command. Can be used in conjunction with Auto Off function: Ignore - to switch on the light by motion detectors and switch it off after some amount of time: in case of multiple motion detectors each would try to switch the | +| 3 | RF Off command | RF Off command | | 4 | Ignore start level | | -| 5 | Speed for fast dimming | Time to dim on button presses and Set command (if it has no duration specified). If not 0, dimming will be done smoothly to preserve bulb life. Set in 10ms steps. | -| 6 | Speed for slow dimming | Time to dim on button presses and Set command (if it has no duration specified). If not 0, dimming will be done smoothly to preserve bulb life. Set in 10ms steps. | -| 7 | Behavior when ON received | Defines the dim level on command 'ON'. On default he dimmer restores last dim level. This parameter allows configuring the maximum level on second On command (if already On) or to always switch on to maximum level. | -| 8 | Baby dimming time | Time to dim on double click Off button for Baby-Dim function. This function works only if the load is operated by single press and hold button action. If enabled, the device will wait for a click timeout to see if the second click would be pressed. This w | -| 9 | Baby target level | Target percentage level on which to stop while executing Baby Dimming. Can be 0 to completely switch off the light. | -| 10 | Baby target level | Typical time used to differentiate click, hold, double and triple clicks. Set in 10ms steps. | +| 5 | Speed for fast dimming | Speed for fast dimming | +| 6 | Speed for slow dimming | Speed for slow dimming | +| 7 | Behavior when ON received | Behavior when ON received | +| 8 | Baby dimming time | Baby dimming time | +| 9 | Baby target level | Baby target level | +| 10 | Baby target level | Baby target level | | 17 | Limit minimum light level | Minimum level should be greater than maximum. | | 18 | Limit maximum light level | Maximum level should be greater than minimum. Set to 0 to act as a switch. | -| 19 | Dim Level on 'Switch On' | defines how the dimmer hall react on a simple ON Command. Set to 0 to restore last level, otherwise sets dim level. | -| 51 | Pause before pulse | NB: Do not touch these settings if you are not sure what they mean! For dimmable LEDs and CFL with bypass use value 1. For other bulbs use default value. | -| 52 | Pause after pulse | NB: Do not touch these settings if you are not sure what they mean! For dimmable LEDs and CFL with bypass use value 40. For other bulbs use default value. | -| 53 | Pulse width | NB: Do not touch these settings if you are not sure what they mean! For dimmable LEDs and CFL with bypass use value 20. For other bulbs use default value. | +| 19 | Dim Level on 'Switch On' | Dim Level on 'Switch On' | +| 51 | Pause before pulse | Pause before pulse | +| 52 | Pause after pulse | Pause after pulse | +| 53 | Pulse width | Pulse width | | 54 | Pulse type | NB: Do not touch these settings if you are not sure what they mean! | | | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | @@ -88,8 +100,11 @@ This parameter has the configuration ID ```config_2_2``` and is of type ```INTEG ### Parameter 3: RF Off command -Defines how to interpret RF Off command. Can be used in conjunction with Auto Off function: Ignore - to switch on the light by motion detectors and switch it off after some amount of time: in case of multiple motion detectors each would try to switch the +RF Off command +Defines how to interpret RF Off command. Can be used in conjunction with Auto Off function: + * Ignore - to switch on the light by motion detectors and switch it off after some amount of time: in case of multiple motion detectors each would try to switch the light off that would break logics; + * Switch on - to switch on the light on both On and Off paddle press on the remote and switch it off after some amount of time. Button off click will still work (if button operations are not disabled). The following option values may be configured -: | Value | Description | @@ -122,8 +137,12 @@ This parameter has the configuration ID ```config_4_1``` and is of type ```INTEG ### Parameter 5: Speed for fast dimming -Time to dim on button presses and Set command (if it has no duration specified). If not 0, dimming will be done smoothly to preserve bulb life. Set in 10ms steps. +Speed for fast dimming +Time to dim on button presses and Set command (if it has no duration specified). +If not 0, dimming will be done smoothly to preserve bulb life. + +Set in 10ms steps. Values in the range 0 to 255 may be set. The manufacturer defined default value is ```30```. @@ -133,8 +152,12 @@ This parameter has the configuration ID ```config_5_1``` and is of type ```INTEG ### Parameter 6: Speed for slow dimming -Time to dim on button presses and Set command (if it has no duration specified). If not 0, dimming will be done smoothly to preserve bulb life. Set in 10ms steps. +Speed for slow dimming +Time to dim on button presses and Set command (if it has no duration specified). +If not 0, dimming will be done smoothly to preserve bulb life. + +Set in 10ms steps. Values in the range 0 to 255 may be set. The manufacturer defined default value is ```3```. @@ -144,8 +167,10 @@ This parameter has the configuration ID ```config_6_1``` and is of type ```INTEG ### Parameter 7: Behavior when ON received -Defines the dim level on command 'ON'. On default he dimmer restores last dim level. This parameter allows configuring the maximum level on second On command (if already On) or to always switch on to maximum level. +Behavior when ON received +Defines the dim level on command 'ON'. On default he dimmer restores last dim level. +This parameter allows configuring the maximum level on second On command (if already On) or to always switch on to maximum level. The following option values may be configured -: | Value | Description | @@ -161,8 +186,10 @@ This parameter has the configuration ID ```config_7_1``` and is of type ```INTEG ### Parameter 8: Baby dimming time -Time to dim on double click Off button for Baby-Dim function. This function works only if the load is operated by single press and hold button action. If enabled, the device will wait for a click timeout to see if the second click would be pressed. This w +Baby dimming time +Time to dim on double click Off button for Baby-Dim function. This function works only if the load is operated by single press and hold button action. +**If enabled, the device will wait for a click timeout to see if the second click would be pressed. This will introduce a small delay for single click commands** Values in the range 0 to 99 may be set. The manufacturer defined default value is ```0```. @@ -172,8 +199,8 @@ This parameter has the configuration ID ```config_8_1``` and is of type ```INTEG ### Parameter 9: Baby target level +Baby target level Target percentage level on which to stop while executing Baby Dimming. Can be 0 to completely switch off the light. - Values in the range 0 to 100 may be set. The manufacturer defined default value is ```0```. @@ -183,8 +210,10 @@ This parameter has the configuration ID ```config_9_1``` and is of type ```INTEG ### Parameter 10: Baby target level -Typical time used to differentiate click, hold, double and triple clicks. Set in 10ms steps. +Baby target level +Typical time used to differentiate click, hold, double and triple clicks. +Set in 10ms steps. Values in the range 0 to 100 may be set. The manufacturer defined default value is ```50```. @@ -216,8 +245,10 @@ This parameter has the configuration ID ```config_18_1``` and is of type ```INTE ### Parameter 19: Dim Level on 'Switch On' -defines how the dimmer hall react on a simple ON Command. Set to 0 to restore last level, otherwise sets dim level. +Dim Level on 'Switch On' +defines how the dimmer hall react on a simple ON Command. +Set to 0 to restore last level, otherwise sets dim level. Values in the range 0 to 99 may be set. The manufacturer defined default value is ```1```. @@ -227,8 +258,12 @@ This parameter has the configuration ID ```config_19_1``` and is of type ```INTE ### Parameter 51: Pause before pulse -NB: Do not touch these settings if you are not sure what they mean! For dimmable LEDs and CFL with bypass use value 1. For other bulbs use default value. +Pause before pulse +**NB: Do not touch these settings if you are not sure what they mean!** +For dimmable LEDs and CFL with bypass use value 1. + +For other bulbs use default value.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range 5 to 60 may be set. The manufacturer defined default value is ```28```. @@ -238,8 +273,12 @@ This parameter has the configuration ID ```config_51_1``` and is of type ```INTE ### Parameter 52: Pause after pulse -NB: Do not touch these settings if you are not sure what they mean! For dimmable LEDs and CFL with bypass use value 40. For other bulbs use default value. +Pause after pulse +**NB: Do not touch these settings if you are not sure what they mean!** +For dimmable LEDs and CFL with bypass use value 40. + +For other bulbs use default value.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range 5 to 60 may be set. The manufacturer defined default value is ```28```. @@ -249,8 +288,12 @@ This parameter has the configuration ID ```config_52_1``` and is of type ```INTE ### Parameter 53: Pulse width -NB: Do not touch these settings if you are not sure what they mean! For dimmable LEDs and CFL with bypass use value 20. For other bulbs use default value. +Pulse width +**NB: Do not touch these settings if you are not sure what they mean!** +For dimmable LEDs and CFL with bypass use value 20. + +For other bulbs use default value.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range 3 to 20 may be set. The manufacturer defined default value is ```10```. @@ -261,7 +304,7 @@ This parameter has the configuration ID ```config_53_1``` and is of type ```INTE ### Parameter 54: Pulse type NB: Do not touch these settings if you are not sure what they mean! - +**NB: Do not touch these settings if you are not sure what they mean!**This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. The following option values may be configured -: | Value | Description | @@ -319,6 +362,10 @@ Association group 1 supports 5 nodes. | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_INDICATOR_V1| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/232/POP-123580.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/popp/123610_0_0.md b/_addons_bindings/zwave/doc/popp/123610_0_0.md index 50e0798ac..a4a66d71e 100644 --- a/_addons_bindings/zwave/doc/popp/123610_0_0.md +++ b/_addons_bindings/zwave/doc/popp/123610_0_0.md @@ -8,25 +8,37 @@ title: 123610 - ZWave # 123610 Wall Plug Switch This describes the Z-Wave device *123610*, manufactured by *Popp & Co* with the thing type UID of ```popp_123610_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![123610 product image](https://www.cd-jackson.com/zwave_device_uploads/231/231_default.png) + + The 123610 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 between other devices in the mesh network. ## 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/231) to improve the documentation. +This is a switch plug that can be placed between a standard Schuko (Type F) wall outlet and electric devices, plugged in by cord. It can switch all electrical loads up to 3500 W. The device is IP 20 rated and can therefore only be used on dry environments. Switching is controlled wirelessly using Z-Wave or locally using a toggleing button. A blue LED indicates the switching status. An automatic 'Off' function and programmable switching behavior make the device a very flexible tool for the inhouse lighting + +### Inclusion Information + + Inclusion and Exclusion are confirmed by a tripple click of the button.  + +### Exclusion Information + + Inclusion and Exclusion are confirmed by a tripple click of the button.  ## Channels The following table summarises the channels available for the 123610 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -39,8 +51,8 @@ Detailed information on each parameter can be found in the sections below. |-------|-------|-------------| | 1 | Set LED indication mode | | | 2 | Automatic switch off time | If not zero, automatically switch off after a user defined time (in seconds) | -| 3 | RF Off command | Defines how to interpret RF Off command. Can be used in conjunction with Auto Off function: Ignore - to switch on the light by motion detectors and switch it off after some amount of time: in case of multiple motion detectors each would try to switch the | -| 5 | Restore switch state after power cycle | Defines if the switch should restore switch state to the last state prior to device power off (power cycle). | +| 3 | RF Off command | RF Off command | +| 5 | Restore switch state after power cycle | Restore switch state after power cycle | | | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | ### Parameter 1: Set LED indication mode @@ -74,8 +86,11 @@ This parameter has the configuration ID ```config_2_2``` and is of type ```INTEG ### Parameter 3: RF Off command -Defines how to interpret RF Off command. Can be used in conjunction with Auto Off function: Ignore - to switch on the light by motion detectors and switch it off after some amount of time: in case of multiple motion detectors each would try to switch the +RF Off command +Defines how to interpret RF Off command. Can be used in conjunction with Auto Off function: + * Ignore - to switch on the light by motion detectors and switch it off after some amount of time: in case of multiple motion detectors each would try to switch the light off that would break logics; + * Switch on - to switch on the light on both On and Off paddle press on the remote and switch it off after some amount of time. Button off click will still work (if button operations are not disabled). The following option values may be configured -: | Value | Description | @@ -92,8 +107,8 @@ This parameter has the configuration ID ```config_3_1``` and is of type ```INTEG ### Parameter 5: Restore switch state after power cycle +Restore switch state after power cycle Defines if the switch should restore switch state to the last state prior to device power off (power cycle). - The following option values may be configured -: | Value | Description | @@ -151,6 +166,10 @@ Association group 1 supports 5 nodes. | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_INDICATOR_V1| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/231/pop123610.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/popp/pope700052_0_0.md b/_addons_bindings/zwave/doc/popp/pope700052_0_0.md index be3ef1783..2f3da9115 100644 --- a/_addons_bindings/zwave/doc/popp/pope700052_0_0.md +++ b/_addons_bindings/zwave/doc/popp/pope700052_0_0.md @@ -8,33 +8,50 @@ title: POPE700052 - ZWave # POPE700052 Water Leakage Sensor This describes the Z-Wave device *POPE700052*, manufactured by *Popp & Co* with the thing type UID of ```popp_pope700052_00_000```. +The device is in the category of *Sensor*, defining Device used to measure something. + +![POPE700052 product image](https://www.cd-jackson.com/zwave_device_uploads/748/748_default.png) + + The POPE700052 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 POPE700052 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. Refer to the *Wakeup Information* section below for further information. ## Overview +The Flood Sensor is a universal Z-Wave compatible flood sensor indicating water leakage in Smart Homes. In case of a detected incident the device will send an alarm message to a central controller and can in parallel directly control a group of devices, e.g. to shut off water supply. On the device it self the water event will be indicated using a red LED and a buzzer. This behavior can be configured. The device can be mounted on a wall for easy maintenance and the water is detected using a cabled detector head. The cable is 90 cm long. The device can also be used without the mounting base and will then flow on the water surface + +### Inclusion Information + + A single click on the Z-Wave button inside the device includes and excludes the device. + +### Exclusion Information + + A single click on the Z-Wave button inside the device includes and excludes the device. + ### Wakeup Information The POPE700052 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. + +To wakeup the device please perform the following action: Double click the internal Button. The red LED will light up to confirm the action. + ## Channels The following table summarises the channels available for the POPE700052 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Alarm (flood) | alarm_flood | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Alarm (flood) | alarm_flood | alarm_flood | Water | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -44,10 +61,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Alarm (flood) - Indicates if the flood alarm is triggered. -The ```alarm_flood``` 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. +The ```alarm_flood``` channel is of type ```alarm_flood``` and supports the ```Switch``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -57,11 +73,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/popp/pope700168_0_0.md b/_addons_bindings/zwave/doc/popp/pope700168_0_0.md index 4b34a16c8..a4e808b7a 100644 --- a/_addons_bindings/zwave/doc/popp/pope700168_0_0.md +++ b/_addons_bindings/zwave/doc/popp/pope700168_0_0.md @@ -42,42 +42,37 @@ Push the Z-Wave button once The following table summarises the channels available for the POPE700168 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Basic value | basic_number | | | -| Sensor (general) | sensor_general | | Number | -| Sensor (rain rate) | sensor_rainrate | Humidity | Number | -| Water meter (amps) | meter_water_cubic_meters | Energy | Number | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Basic value | basic_number | basic_number | | | +| Sensor (general) | sensor_general | sensor_general | | Number | +| Sensor (rain rate) | sensor_rainrate | sensor_rainrate | Humidity | Number | +| Water meter (amps) | meter_water_cubic_meters | meter_water_cubic_meters | Water | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Basic value - Channel type information on this channel is not found. ### Sensor (general) - -The ```sensor_general``` channel supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_general``` channel is of type ```sensor_general``` and supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. ### Sensor (rain rate) - Indicates the current relative humidity. -The ```sensor_rainrate``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_rainrate``` channel is of type ```sensor_rainrate``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Water meter (amps) - Indicates the instantaneous water consumption. -The ```meter_water_cubic_meters``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_water_cubic_meters``` channel is of type ```meter_water_cubic_meters``` and supports the ```Number``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/prodrive/ed20_0_0.md b/_addons_bindings/zwave/doc/prodrive/ed20_0_0.md index 44d56cb83..8bb55d00b 100644 --- a/_addons_bindings/zwave/doc/prodrive/ed20_0_0.md +++ b/_addons_bindings/zwave/doc/prodrive/ed20_0_0.md @@ -8,6 +8,11 @@ title: ED2.0 - ZWave # ED2.0 Eneco Meter Adapter This describes the Z-Wave device *ED2.0*, manufactured by *[Prodrive Technologies](http://prodrive-technologies.com/)* with the thing type UID of ```prodrive_ed20_00_000```. +The device is in the category of *Sensor*, defining Device used to measure something. + +![ED2.0 product image](https://www.cd-jackson.com/zwave_device_uploads/345/345_default.png) + + The ED2.0 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 between other devices in the mesh network. ## Overview @@ -16,52 +21,51 @@ The meter adapter measures gas and electricity usage of analog and digital meter ### Inclusion Information -Press Button +Triple click the button. + +### Exclusion Information + +Triple click the button. ## Channels The following table summarises the channels available for the ED2.0 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Clock Time Offset | time_offset | Temperature | Number | -| Gas meter (cubic meters) | meter_gas_cubic_meters1 | Energy | Number | -| Electric meter (kWh) | meter_kwh2 | Energy | Number | -| Electric meter (kWh) | meter_kwh3 | Energy | Number | -| Electric meter (kWh) | meter_kwh4 | Energy | Number | -| Electric meter (kWh) | meter_kwh5 | Energy | Number | -| Electric meter (kWh) | meter_kwh6 | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Clock Time Offset | time_offset | time_offset | Temperature | Number | +| Gas meter (cubic meters) | meter_gas_cubic_meters1 | meter_gas_cubic_meters | Energy | Number | +| Electric meter (kWh) | meter_kwh2 | meter_kwh | Energy | Number | +| Electric meter (kWh) | meter_kwh3 | meter_kwh | Energy | Number | +| Electric meter (kWh) | meter_kwh4 | meter_kwh | Energy | Number | +| Electric meter (kWh) | meter_kwh5 | meter_kwh | Energy | Number | +| Electric meter (kWh) | meter_kwh6 | meter_kwh | Energy | Number | ### Clock Time Offset - Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ### Gas meter (cubic meters) - Indicates the gas use in cubic meters. -The ```meter_gas_cubic_meters1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_gas_cubic_meters1``` channel is of type ```meter_gas_cubic_meters``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Single-E import Indicates the energy consumption (kWh). -The ```meter_kwh2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh2``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Twin-E day import Indicates the energy consumption (kWh). -The ```meter_kwh3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh3``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - <table> <tr> <td> @@ -76,10 +80,9 @@ The ```meter_kwh3``` channel supports the ```Number``` item and is in the ```Ene Indicates the energy consumption (kWh). -The ```meter_kwh4``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh4``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - <table> <tr> <td> @@ -94,10 +97,9 @@ The ```meter_kwh4``` channel supports the ```Number``` item and is in the ```Ene Indicates the energy consumption (kWh). -The ```meter_kwh5``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh5``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - <table> <tr> <td> @@ -112,81 +114,107 @@ The ```meter_kwh5``` channel supports the ```Number``` item and is in the ```Ene Indicates the energy consumption (kWh). -The ```meter_kwh6``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh6``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ## Device Configuration -The following table provides a summary of the 4 configuration parameters available in the ED2.0. +The following table provides a summary of the 5 configuration parameters available in the ED2.0. Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 0 | Gas Metering | Enable and disable gas metering | -| 1 | Gas Meter resolution | The resolution of the analog gas meter | -| 2 | Electricity metering | Enable and disable Electricity metering | -| 3 | Electricity meter resolution | The resolution of the analog electricity meter | +| 1 | Analog gas/heat port mode | Analog gas/heat port mode | +| 2 | Analog gas/heat port resolution | Analog gas/heat port resolution | +| 3 | Analog electricity port mode | Analog electricity port mode | +| 4 | Analog electricity port resolution | Analog electricity port resolution | +| 255 | Restart device | Restart device or metering chip | -### Parameter 0: Gas Metering +### Parameter 1: Analog gas/heat port mode -Enable and disable gas metering +Analog gas/heat port mode + +The following option values may be configured, in addition to values in the range 0 to 2 -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Gas enabled | +| 2 | Heat enabled | + +The manufacturer defined default value is ```1``` (Gas enabled). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Analog gas/heat port resolution + +Analog gas/heat port resolution +pulses per cubic meter / pulses per MJ; in Q14.2 notation +Values in the range 0 to 65535 may be set. + +The manufacturer defined default value is ```400```. + +This parameter has the configuration ID ```config_2_4``` and is of type ```INTEGER```. + + +### Parameter 3: Analog electricity port mode + +Analog electricity port mode + +The following option values may be configured, in addition to values in the range 0 to 3 -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Electricity import enabled | +| 2 | Electricity export enabled | + +The manufacturer defined default value is ```1``` (Electricity import enabled). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Analog electricity port resolution + +Analog electricity port resolution +pulses per kWh; in Q14.2 notation +Values in the range 0 to 65535 may be set. + +The manufacturer defined default value is ```400```. + +This parameter has the configuration ID ```config_4_4``` and is of type ```INTEGER```. + + +### Parameter 255: Restart device + +Restart device or metering chip The following option values may be configured -: | Value | Description | |--------|-------------| -| 0 | disable gas metering | -| 1 | enable gas metering | +| 1 | Restart entire device | +| 2 | Restart metering chip | -The manufacturer defined default value is ```1``` (enable gas metering). +The manufacturer defined default value is ```0```. -This parameter has the configuration ID ```config_0_1``` and is of type ```INTEGER```. - - -### Parameter 1: Gas Meter resolution - -The resolution of the analog gas meter -The resolution of the analog gas meter (revolutions per m³) in unsigned Q14.2 notation. -Values in the range 0 to 0 may be set. - -The manufacturer defined default value is ```400```. - -This parameter has the configuration ID ```config_1_2``` and is of type ```INTEGER```. - - -### Parameter 2: Electricity metering - -Enable and disable Electricity metering - -The following option values may be configured -: - -| Value | Description | -|--------|-------------| -| 0 | disable electricity metering | -| 1 | enable electricity metering | - -The manufacturer defined default value is ```1``` (enable electricity metering). - -This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. - - -### Parameter 3: Electricity meter resolution - -The resolution of the analog electricity meter -The resolution of the analog electricity meter (revolutions per kWh) in unsigned Q14.2 notation. -Values in the range 0 to 0 may be set. - -The manufacturer defined default value is ```400```. - -This parameter has the configuration ID ```config_3_2``` and is of type ```INTEGER```. +This parameter has the configuration ID ```config_255_1``` and is of type ```INTEGER```. ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The ED2.0 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 1 node. + ## Technical Information ### Endpoints @@ -207,6 +235,7 @@ The device does not support associations. | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_POWERLEVEL_V1| | | COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V1| | | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_TIME_PARAMETERS_V1| | #### Endpoint 1 @@ -258,6 +287,10 @@ The device does not support associations. | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_VERSION_V1| | +### Documentation Links + +* [Manual NL/EN](https://www.cd-jackson.com/zwave_device_uploads/345/Manual-meteradapter.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/qees/p313a_0_0.md b/_addons_bindings/zwave/doc/qees/p313a_0_0.md index e98afe1fb..b947332de 100644 --- a/_addons_bindings/zwave/doc/qees/p313a_0_0.md +++ b/_addons_bindings/zwave/doc/qees/p313a_0_0.md @@ -8,82 +8,93 @@ title: P313A - ZWave # P313A Plug-in Socket Dimmer This describes the Z-Wave device *P313A*, manufactured by *Qees* with the thing type UID of ```qees_p313a_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![P313A product image](https://www.cd-jackson.com/zwave_device_uploads/500/500_default.png) + + The P313A 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 between other devices in the mesh network. ## 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/500) to improve the documentation. +QEES RETO Plug-in Dimmer Plus brings along comfort and elegance with an extremely easy setup and a unique design. With its help you can now wirelessly control all the dimmable loads you have inside your home. + +QEES RETO Plug-in Dimmer Plus is a Z-Wave-controlled 400W universal dimmer (US frequency) with schuko plug-in socket outlet, built-in power meter, multi-color LED feedback and one programmable group for retrofit installation. + +### Inclusion Information + +To manually put your slave device in Network Wide Inclusion mode press three times on its shell + +### Exclusion Information + +You can reset the device by + + 1. pressing 4 times quickly (the LED flashes blue). + 2. Then press 3 times quickly + +(the LED flashes yellow, red, green for 5 seconds). ## Channels The following table summarises the channels available for the P313A -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | -| Electric meter (kVAh) | meter_kvah | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Electric meter (amps) | meter_current | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (power factor) | meter_powerfactor | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | +| Electric meter (kVAh) | meter_kvah | meter_kvah | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (power factor) | meter_powerfactor | meter_powerfactor | Energy | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Electric meter (kVAh) - Indicates the energy consumption (kVAh). -The ```meter_kvah``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kvah``` channel is of type ```meter_kvah``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (power factor) - Indicates the instantaneous power factor. -The ```meter_powerfactor``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. @@ -95,7 +106,14 @@ The device has no configuration parameters defined. Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The P313A supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 232 nodes. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/qubino/minidimmer_0_0.md b/_addons_bindings/zwave/doc/qubino/minidimmer_0_0.md new file mode 100644 index 000000000..ed323d011 --- /dev/null +++ b/_addons_bindings/zwave/doc/qubino/minidimmer_0_0.md @@ -0,0 +1,621 @@ +--- +layout: documentation +title: ZMNHHD - ZWave +--- + +{% include base.html %} + +# ZMNHHD Mini Dimmer +This describes the Z-Wave device *ZMNHHD*, manufactured by *[Goap](http://www.qubino.com/)* with the thing type UID of ```qubino_minidimmer_00_000```. + +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![ZMNHHD product image](https://www.cd-jackson.com/zwave_device_uploads/1100/1100_default.png) + + +The ZMNHHD 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 between other devices in the mesh network. + +## Overview + +Mini Dimmer is a MOSFET-switching light device that also supports control of low-voltage halogen lamps with electronic transformers, dimmable compact fluorescent lights, and dimmable LED bulbs. It measures power consumption of the connected device. It supports push-button/momentary switches (default) and toggle switches. It can work with or without the neutral line. Qubino Mini Dimmer allows the easiest and quickest installation. It is designed to be mounted inside a “flush mounting box”, hidden behind a traditional wall switch. It acts as repeater in order to improve range and stability of Z-Wave network. + +### Inclusion Information + +Inclusion + +AUTOMATICALLY ADDING THE DEVICE TO A Z-WAVE NETWORK (AUTO INCLUSION) + + 1. Enable add/remove mode on your Z-Wave gateway (hub) + 2. Automatic selection of secure/unsecure inclusion. + 3. The device can be automatically added to a Z-Wave network during the first 2 minutes + 4. Connect the device to the power supply + 5. Auto-inclusion will be initiated within 5 seconds of connection to the power supply and the device will automatically enrol in your network.  + +(when the device is excluded and connected to the power supply it automatically eneters the LEARN MODE state.) + +**NOTE: LEARN MODE state allows the device to receive network infromation from the controller** + +**NOTE: Please wait at least 30 seconds between each inclusion and exclusion.** + +MANUALLY ADDING THE DEVICE TO A Z-WAVE NETWORK (MANUAL INCLUSION) + + 1. Connect the device to the power supply + 2. Enable add/remove mode on your Z-Wave gateway (hub) + 3. Toggle the switch connected to the I1 terminal 3 times within 3 seconds (this procedure put the device in LEARN MODE) + +OR + +Press and hold the S (Service) button between 2 and 6 seconds if connected to 24-30VDC (this procedure put the device in LEARN MODE) + +4. A new device will appear on your dashboard + +**NOTE: LEARN MODE state allows the device to receive network infromation from the conttoller ** + +**NOTE: Please wait at least 30 seconds between each inclusion and exclusion.** + +Mini Dimmer supports the latest Security 2 feature. When adding the Mini Dimmer to a Z-Wave network with a controller supporting Security 2 (S2), the PIN code of the Z-Wave Device Specific Key (DSK) is required. The unique DSK code is printed on the product label and a copy is inserted in the packaging, which must not be lost. Do not remove the DSK from the product. As a backup measure, use the label in the packaging. The first five digits of the key are highlighted or underlined to help the user identify the PIN code portion of the DSK text. + +### Exclusion Information + +Exclusion + +REMOVAL FROM A Z-WAVE NETWORK (Z-WAVE EXCLUSION) + + 1. Connect the device to the power supply + 2. Make sure the device is within direct range of your Z-Wave gateway (hub) or use a hand-held Z-Wave remote to perform exclusion + 3. Enable add/remove mode on your Z-Wave gateway (hub) + 4. Toggle the switch connected to the I1 terminal 3 times within 3 seconds (this procedure put the device in LEARN MODE) + +OR + +Press and hold the S (Service) button between 2 and 6 seconds if connected to 24-30VDC (this procedure put the device in LEARN MODE) + + 1. The device will be removed from your network, but any custom configuration parameters will not be erased + +**NOTE: LEARN MODE state allows the device to receive network infromation from the conttoller ** + +**NOTE: Please wait at least 30 seconds between each inclusion and exclusion.** + +## Channels + +The following table summarises the channels available for the ZMNHHD -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Alarm (power) | alarm_power | alarm_power | Energy | Switch | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and 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 is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. + +### Electric meter (kWh) +Indicates the energy consumption (kWh). + +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Electric meter (watts) +Indicates the instantaneous power consumption. + +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Alarm (power) +Indicates if a power alarm is triggered. + +The ```alarm_power``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + + + +## Device Configuration + +The following table provides a summary of the 19 configuration parameters available in the ZMNHHD. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | In-wall Switch Type for Load to control I1 | In-wall Switch Type for Load to control I1 | +| 5 | Working mode | Working mode | +| 11 | Turn Load 1 Off Automatically with Timer | Turn Load 1 Off Automatically with Timer | +| 12 | Turn Load 1 On Automatically with Timer | Turn Load 1 On Automatically with Timer | +| 21 | Enable/Disable the Double click function | Enable/Disable the Double click function | +| 30 | Restore on/off status for load after power failure | Restore on/off status for load after power failure | +| 40 | Power Consumption Threshold | Power Consumption Threshold | +| 42 | Power Consumption Threshold (time) | Power Consumption Threshold (time) | +| 60 | Minimum dimming value | Minimum dimming value | +| 61 | Maximum dimming value | Maximum dimming value | +| 65 | Dimming time when key pressed | Dimming time when key pressed | +| 66 | Dimming time when key hold | Dimming time when key hold | +| 67 | Ignore start level | Ignore start level | +| 68 | Dimming duration | Dimming duration | +| 70 | Overload safety switch | Overload safety switch | +| 71 | Calibration trigger | Calibration trigger | +| 72 | Calibration status (read only) | Calibration status (read only) | +| 73 | Alarm/Notification events | Alarm/Notification events | +| 74 | Alarm/Notification time interval | Alarm/Notification time interval | + +### Parameter 1: In-wall Switch Type for Load to control I1 + +In-wall Switch Type for Load to control I1 +With this parameter, you can select between push-button (momentary) and on/off toggle switch types.  + +Values:  + +• default value 0 +• 0 - push-button (momentary) +• 1 - on/off toggle switch +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | push-button (momentary) | +| 1 | on/off toggle switch | + +The manufacturer defined default value is ```0``` (push-button (momentary)). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 5: Working mode + +Working mode +With this parameter, you can change the device presentation on the user interface. + +Values: +• default value 0 +• 0 - Dimmer mode +• 1 - Switch mode (works only in 3 way wiring-connection with neutral line) + +**NOTE: After parameter change, first exclude the device (without setting parameters to default value) then wait at least 30s before reinclusion.** +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Dimmer mode | +| 1 | Switch mode | + +The manufacturer defined default value is ```0``` (Dimmer mode). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 11: Turn Load 1 Off Automatically with Timer + +Turn Load 1 Off Automatically with Timer +If Load is ON, you can schedule it to turn OFF automatically after a period of time defined in this parameter. The timer is reset to zero each time the device receives an ON or OFF command, either remotely (from the gateway (hub) or associated device) or locally from the switch. + + +Values: +• default value 0 +• 0 - Auto OFF Disabled +• 1 - 32536 = 1 - 32536 seconds - Auto OFF timer enabled for a given amount of seconds +Values in the range 0 to 32536 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_11_2``` and is of type ```INTEGER```. + + +### Parameter 12: Turn Load 1 On Automatically with Timer + +Turn Load 1 On Automatically with Timer +If Load is OFF, you can schedule it to turn ON automatically after a period of time defined in this parameter. The timer is reset to zero each time the device receives an OFF or ON command, either remotely (from the gateway (hub) or associated device) or locally from the switch. + + +Values: +• default value 0 +• 0 - Auto ON Disabled +• 1 - 32536 = 1 - 32536 seconds - Auto ON timer enabled for a given amount of seconds +Values in the range 0 to 32536 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_12_2``` and is of type ```INTEGER```. + + +### Parameter 21: Enable/Disable the Double click function + +Enable/Disable the Double click function +If the Double click function is enabled, a fast double click on the push-button will set the dimming level to the maximum dimming value. + + +Values: +• default value 0 +• 0 - double click disabled +• 1 - double click enabled +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Double click disabled | +| 1 | Double click enabled | + +The manufacturer defined default value is ```0``` (Double click disabled). + +This parameter has the configuration ID ```config_21_1``` and is of type ```INTEGER```. + + +### Parameter 30: Restore on/off status for load after power failure + +Restore on/off status for load after power failure +This parameter determines if on/off status is saved and restored for the load after power failure. + + +Values: +• default value 0 +• 0 - Device saves last on/off status and restores it after a power failure. +• 1 - Device does not save on/off status and does not restore it after a power failure, it remains off. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Save last on/off status | +| 1 | Don't save last on/off status | + +The manufacturer defined default value is ```0``` (Save last on/off status). + +This parameter has the configuration ID ```config_30_1``` and is of type ```INTEGER```. + + +### Parameter 40: Power Consumption Threshold + +Power Consumption Threshold +Watt Power Consumption Reporting Threshold for Load   + +Choose by how much the power consumption needs to increase or decrease to be reported. Values correspond to percentages so if 10 is set (by default), the device will report any power consumption changes of 10% or more compared to the last reading. + + +Values (size is 1 byte dec): +• default value 10 +• 0 - Power consumption reporting disabled +• 1 - 100 = 1% - 100% + +Power consumption reporting enabled. New value is reported only when Wattage in real time changes by more than the percentage value set in this parameter compared to the previous Wattage reading, starting at 1% (the lowest value possible). + +**NOTE: The power consumption needs to increase or decrease by at least 2 Watts to be reported, regardless of percentage set in this parameter.** +Values in the range 0 to 100 may be set. + +The manufacturer defined default value is ```10```. + +This parameter has the configuration ID ```config_40_1``` and is of type ```INTEGER```. + + +### Parameter 42: Power Consumption Threshold (time) + +Power Consumption Threshold (time) +Watt Power Consumption Reporting Time Threshold for Load   + +Set value refers to the time interval with which power consumption in Watts is reported (0 – 32767 seconds). If 300 is entered, energy consumption reports will be sent to the gateway (hub) every 300 seconds (or 5 minutes) if there was a change compared from the last report. + + +Values: +• default value 0 +• 0 - Power consumption reporting on time interval disabled +• 30 - 32767= 30 - 32767seconds. Power consumption reporting enabled. Report is sent according to time interval (value) set here. + + +**NOTE: Values from 1 to 29 are ignored by device due to standard recommendation.** +**NOTE: The report will be send only if there was a change compared to the last report** +Values in the range 0 to 32767 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_42_2``` and is of type ```INTEGER```. + + +### Parameter 60: Minimum dimming value + +Minimum dimming value +The value set in this parameter determines the minimum dimming value (the lowest value which can be set on the device, when, for example, dimming lights with wall switch or slider in the GUI (Gateway - hub)). + +Values: +• default value 0 = 0% (minimum dimming value) +• 0- 98 = 0% - 98%, step is 1%. Minimum dimming value is set by entering a value. + +**NOTE: The minimum level may not be higher than the maximum level!** +Values in the range 0 to 98 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_60_1``` and is of type ```INTEGER```. + + +### Parameter 61: Maximum dimming value + +Maximum dimming value +The value set in this parameter determines the maximum dimming value (the highest value which can be set on the device, when, for example, dimming lights with wall switch or slider in the GUI (Gateway - hub)) + +Values: +• default value 99 = 99% (Maximum dimming value) +• 1- 99 = 1% - 99%, step is 1%. Maximum dimming value is set by entering a value. + +**NOTE: The maximum level may not be lower than the minimum level!** +Values in the range 1 to 99 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_61_1``` and is of type ```INTEGER```. + + +### Parameter 65: Dimming time when key pressed + +Dimming time when key pressed +Choose the time during which the device will move between the min. and max. dimming values by a short press of the push-button I1. + + +Values: +• default value 1 = 1s +• 1 - 127 = 1 seconds- 127 seconds, step is 1 second +Values in the range 1 to 127 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_65_1``` and is of type ```INTEGER```. + + +### Parameter 66: Dimming time when key hold + +Dimming time when key hold +Choose the time during which the Dimmer will move between the min. and max. dimming values during a continuous press of the push-button I1, by an associated device or through the UI controls (BasicSet, SwitchMultilevelSet). + + +Values: +• default value 3 = 3s +• 1-127 = 1 second – 127 seconds +• 128 – 253 = 1 minute – 126 minutes +Values in the range 1 to 127 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_66_2``` and is of type ```INTEGER```. + + +### Parameter 67: Ignore start level + +Ignore start level +Choose whether the device should use (or disregard) the start dimming level value. If the device is configured to use the start level, it should start the dimming process from the currently set dimming level. This parameter is used with association group 3. + +Values: +• default value 0 +• 0 – use the start level value +• 1 - ignore the start level value + +**NOTE: Parameter is valid only in Dimmer mode. In Switch mode the parameter has no effect.** +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | use the start level value | +| 1 | ignore the start level value | + +The manufacturer defined default value is ```0``` (use the start level value). + +This parameter has the configuration ID ```config_67_1``` and is of type ```INTEGER```. + + +### Parameter 68: Dimming duration + +Dimming duration +Choose the time during which the device will transition from the current value to the new target value. This parameter applies to the association group 3. + + +Values: +• default value 0 (dimming duration according to parameter 66) +• 1 - 127 (from 1 to 127 seconds) + +**NOTE: Parameter is valid only in Dimmer mode. In Switch mode the parameter has no effect.** +Values in the range 0 to 127 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_68_1``` and is of type ```INTEGER```. + + +### Parameter 70: Overload safety switch + +Overload safety switch +The function allows for turning off the controlled device in case of exceeding the defined power for more than 5s. Controlled device can be turned back on by input I1 or sending a control frame. + + +Values: +• default value 200 +• 1 – 200 = 1 W – 200W +• 0 = function not active + +**NOTE: This functionality is not an overload safety protection, please check the technical specifications chapter for more details.** + +In case of overload the following message will be send towards the controller: +• COMMAND\_CLASS\_NOTIFICATION_V5 +• The Alarm V1 type field set to 0x00 +• Notification Type 0x08 and 0x08 (Overload detected) +Values in the range 1 to 200 may be set. + +The manufacturer defined default value is ```200```. + +This parameter has the configuration ID ```config_70_2``` and is of type ```INTEGER```. + + +### Parameter 71: Calibration trigger + +Calibration trigger +Choose when will be the calibration procedure triggered. + + +Values: +• default value 0 - calibration done after power cycle if module is excluded +• 1 – calibration done after power cycle regardless of inclusion status +• 2 – force calibration. Calibration will start immediately +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | calibration after exclusion | +| 1 | calibration after power cycle | +| 2 | force calibration | + +The manufacturer defined default value is ```1``` (calibration after power cycle). + +This parameter has the configuration ID ```config_71_1``` and is of type ```INTEGER```. + + +### Parameter 72: Calibration status (read only) + +Calibration status (read only) +Whit this parameter you can check the calibration status. + + +Values: +• default value 2 – calibration failed +• 1 – calibration was successful +• 2 – calibration failed +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | calibration was successful | +| 2 | calibration failed | + +The manufacturer defined default value is ```2``` (calibration failed). + +This parameter has the configuration ID ```config_72_1``` and is of type ```INTEGER```. +This is a read only parameter. + + +### Parameter 73: Alarm/Notification events + +Alarm/Notification events +This parameter defines the module behaviour in case it receives any Alarm/Notification events. + + +Values: +• default value 0 – function not active +• 1 – turn OFF +• 2 – turn ON +• 3 – start blinking (output turns 1s ON, and 1s OFF) + + +**NOTE: When value 3 is selected the default time interval of the blinking is 10 minutes. It can be stopped with a button press or sending a control frame. To adjust the time interval please refer to parameter 74 – Alarm/Notification time interval.** +Values in the range 0 to 3 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_73_1``` and is of type ```INTEGER```. + + +### Parameter 74: Alarm/Notification time interval + +Alarm/Notification time interval +Alarm/Notification time interval (dependant on parameter 73) + + +This parameter defines the time interval of the blinking state, once the module receives an alarm/notification event. Minimum step increase is 1 minute. + + +Values (size is 1 byte dec): +• default value 10 = 10 minutes +• 1 – 125 = 1 -125 minutes + + +**NOTE: This parameter does not have any effect if parameter 73 is not set to value 3** +Values in the range 1 to 125 may be set. + +The manufacturer defined default value is ```10```. + +This parameter has the configuration ID ```config_74_1``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The ZMNHHD supports 4 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. +Lifeline + + +Association group 1 supports 1 node. + +### Group 2: Basic OnOff + +Basic OnOff +Supports the following command classes: + +• Basic set: triggered at change of output and reflecting its state + +Association group 2 supports 16 nodes. + +### Group 3: StartStop level change + +StartStop level change +Supports the following command classes: + +• Start/Stop Level Change: triggered upon holding and releasing the switch connected to I1 + +**NOTE: Association 3 StartStop level change is switch type dependant. The switch must be a bi-stable switch type otherwise the association can not be trigered. To know how to change the switch type connected, please refer to chapter "Configuration parameters", in the official manual, for more information.** + +**NOTE: When the device is in switch mode (parameter 5 set to 1), this association group is**** not available. ** + +Association group 3 supports 16 nodes. + +### Group 4: Multilevel set + +Multilevel set +Supports the following command classes: + +• Switch Multilevel Set: triggered at change of output and reflecting its state + +**NOTE: When the device is in switch mode (parameter 5 set to 1), this association group is not available. ** + +Association group 4 supports 16 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| Linked to BASIC| +| COMMAND_CLASS_METER_V3| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V5| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_SECURITY_V1| | + +### Documentation Links + +* [MiniDimmer_product_manual](https://www.cd-jackson.com/zwave_device_uploads/1100/Qubino-Mini-Dimmer-extended-manual-eng-1-8.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1100). diff --git a/_addons_bindings/zwave/doc/qubino/onoffthermo2_0_0.md b/_addons_bindings/zwave/doc/qubino/onoffthermo2_0_0.md new file mode 100644 index 000000000..59597ec36 --- /dev/null +++ b/_addons_bindings/zwave/doc/qubino/onoffthermo2_0_0.md @@ -0,0 +1,585 @@ +--- +layout: documentation +title: ZMNKID - ZWave +--- + +{% include base.html %} + +# ZMNKID Flush OnOff Thermostat 2 +This describes the Z-Wave device *ZMNKID*, manufactured by *[Goap](http://www.qubino.com/)* with the thing type UID of ```qubino_onoffthermo2_00_000```. + +The device is in the category of *HVAC*, defining Air condition devices, Fans. + +![ZMNKID product image](https://www.cd-jackson.com/zwave_device_uploads/1101/1101_default.png) + + +The ZMNKID 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 between other devices in the mesh network. + +## Overview + +The Qubino Flush On/Off Thermostat 2 is ideal for remotely controlling electric or water-based underfloor heating systems, electric water heaters, hot water pumps, electric radiators and similar. + +### Inclusion Information + +Classic Inclusion + +AUTOMATICALLY ADDING THE DEVICE TO A Z-WAVE NETWORK (SMARTSTART INCLUSION) + + 1. Scan QR code on device label and add S2 DSK to Provisioning List in gateway (hub) + 2. Connect the device to the power supply (with the temperature sensor already connected). + 3. Inclusion will be initiated automatically within few seconds of connection to the power supply and the device will automatically enrol in your network (when the device is excluded and connected to the power supply it automatically enters the LEARN MODE state). + +**NOTE: LEARN MODE state allows the device to receive network information from the controller.** + +ⓘ SmartStart inclusion is a part of S2 security level, so if you want to use SmartStart, you need to include it as S2 Authenticated.  + +MANUALLY ADDING THE DEVICE TO A Z-WAVE NETWORK (MANUAL INCLUSION) + + 1. Enable add/remove mode on your Z-Wave gateway (hub)  + 2. Connect the device to the power supply (with the temperature sensor already connected*)  + 3. Toggle the switch connected to the I1 terminal 3 times within 3 seconds (The device has to get On/Off signal 3 times, meaning 3 times click on the push button or with the normal button 3 times On/Off.) (this procedure puts the device in LEARN MODE) in the first minute after power cycle. + +OR + +If the device is powered by 24 V SELV supply, press and hold the S (Service) button between 3 and 6 seconds (this procedure puts the device in LEARN MODE) + + 1. A new device will appear on your dashboard + 2. Inclusion with the switch connected to I1 terminal is not limited by time + +*If connecting the temperature sensor, switch off the power supply. + +**NOTE1: LEARN MODE state allows the device to receive network information from the controller.** + +### Exclusion Information + +Classic Exclusion + +REMOVAL FROM A ZWAVE NETWORK (Z-WAVE EXCLUSION) + + 1. Connect the device to the power supply + 2. Make sure the device is within direct range of your Z-Wave gateway (hub) or use a hand-held Z-Wave remote to perform exclusion  + 3. Enable add/remove mode on your Z-Wave gateway (hub) + 4. Toggle the switch connected to the I1 terminal 3 times within 3 seconds in the first minute after power cycle (The device has to get On/Off signal 3 times, meaning 3 times click on the push button or with the normal button 3 times On/Off).  + +OR + +If the device is powered by 24 V SELV supply, press and hold the S (Service) button between 3 and 6 seconds + + 1. Exclusion with the switch connected to I1 terminal is not limited by time  + 2. The device will be removed from your network, but any custom configuration parameters will not be erased + +**NOTE1: LEARN MODE state allows the device to receive network information from the controller.** + +**NOTE2: After device is excluded you should wait 30 seconds before performing re-inclusion.** + +## Channels + +The following table summarises the channels available for the ZMNKID -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Alarm (power) | alarm_power | alarm_power | Energy | Switch | + +### Sensor (temperature) +Indicates the current temperature. + +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. + +### Electric meter (kWh) +Indicates the energy consumption (kWh). + +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Electric meter (watts) +Indicates the instantaneous power consumption. + +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Thermostat mode +Sets the thermostat. + +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. +The following state translation is provided for this channel to the ```Number``` item type -: + +| Value | Label | +|-------|-----------| +| 0 | Off | +| 1 | Heat | +| 2 | Cool | +| 3 | Auto | +| 4 | Aux Heat | +| 5 | Resume | +| 6 | Fan Only | +| 7 | Furnace | +| 8 | Dry Air | +| 9 | Moist Air | +| 10 | Auto Changeover | +| 11 | Heat Economy | +| 12 | Cool Economy | +| 13 | Away | + +### Operating State +Sets the thermostat operating state. + +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. +The following state translation is provided for this channel to the ```Number``` item type -: + +| Value | Label | +|-------|-----------| +| 0 | Idle | +| 1 | Heating | +| 2 | Cooling | +| 3 | Fan Only | +| 4 | Pending Heat | +| 5 | Pending Cool | +| 6 | Vent / Economiser | + +### Setpoint (heating) +Sets the thermostat setpoint. + +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. + +### Alarm (power) +Indicates if a power alarm is triggered. + +The ```alarm_power``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + + + +## Device Configuration + +The following table provides a summary of the 14 configuration parameters available in the ZMNKID. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Input I1 switch type | Input I1 switch type | +| 4 | Input 1 contact type | Input 1 contact type | +| 40 | Power Consumption Reporting Threshold | Power Consumption Reporting Threshold | +| 42 | Power Consumption Reporting(Time) | Power Consumption Reporting(Time) | +| 43 | Hysteresis Upper temperature offset | Hysteresis Upper temperature offset | +| 44 | Hysteresis Lower temperature offset | Hysteresis Lower temperature offset | +| 45 | Antifreeze | Antifreeze | +| 59 | Thermostat mode | Thermostat mode | +| 60 | Too low temperature limit | Too low temperature limit | +| 61 | Too high temperature limit | Too high temperature limit | +| 63 | Output switch selection | Output switch selection | +| 78 | Scale Selection | Scale Selection | +| 110 | Temperature Sensor Offset Settings | Temperature Sensor Offset Settings | +| 120 | Temperature Sensor Reporting Threshold | Temperature Sensor Reporting Threshold | + +### Parameter 1: Input I1 switch type + +Input I1 switch type +With this parameter, you can select between push-button (momentary) and on/off toggle switch types. + + +Values: +• default value 1 +• 0 - push-button (momentary) +• 1 - on/off toggle switch +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | push-button (momentary) | +| 1 | on/off toggle switch | + +The manufacturer defined default value is ```1``` (on/off toggle switch). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 4: Input 1 contact type + +Input 1 contact type +This parameter determines how the switch or push-button is connected. + + +Values: +• default value 0 +• 0 - NO (normally open) input type +• 1 - NC (normally close) input type +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | NO (normally open) input type | +| 1 | NC (normally close) input type | + +The manufacturer defined default value is ```0``` (NO (normally open) input type). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 40: Power Consumption Reporting Threshold + +Power Consumption Reporting Threshold +Choose by how much power consumption needs to increase or decrease to be reported. Values correspond to percentages so if 10 is set, for example, the device will report any power consumption changes of 10% or more compared to the last reading. + + +Values: +• default value 10 +• 0 - Power consumption reporting +disabled +• 1 - 100 = 1% - 100% + +Power consumption reporting enabled. New value is reported only when Wattage in real time changes by more than the percentage value set in this parameter compared to the previous Wattage reading, starting at 1% (the lowest value possible). + + +**NOTE: Power consumption needs to increase or decrease by at least 1 Watt to be reported, REGARDLESS of percentage set in this parameter.** +Values in the range 0 to 100 may be set. + +The manufacturer defined default value is ```10```. + +This parameter has the configuration ID ```config_40_1``` and is of type ```INTEGER```. + + +### Parameter 42: Power Consumption Reporting(Time) + +Power Consumption Reporting(Time) +Set value refers to the time interval with which power consumption in Watts is reported (30 – 32767 seconds) starting from time of last Watts reported. If for example 300 is entered, energy consumption reports will be sent to the gateway (hub) every 300 seconds (or 5 minutes). + + +Values: +• default value 600 (600 seconds = 10 minutes) +• 0 - Power consumption reporting disabled +• 30 - 32767 = 30 - 32767 seconds. + +Power consumption reporting enabled. Report is sent according to time interval (value) set here. EXAMPLE: If we set value to 30 seconds and the device reports Watts because of percent change of power (parameter 40 - Watt Power Consumption Reporting Threshold) at time = 5 seconds, +then the device will send next meter report at time = 35 seconds (assuming the device has not sent report within interval 5 to 35 seconds). +Values in the range 0 to 32767 may be set. + +The manufacturer defined default value is ```600```. + +This parameter has the configuration ID ```config_42_2``` and is of type ```INTEGER```. + + +### Parameter 43: Hysteresis Upper temperature offset + +Hysteresis Upper temperature offset +This parameter defines minimum temperature difference between real measured temperature and set-point temperature to turn device on in heat mode or turn device off in cool mode.  + +Values: +• default value 5 (0.5 °C) +• 0 – 450 + +** +NOTE1: If configuration parameter 78 (Scale selection) is set to Celsius, then valid interval is 0 – 250 (0.0 °C – 25.0 °C, resolution 0.1 °C) +** + +**NOTE2: If configuration parameter 78 (Scale selection) is set to Fahrenheit, then valid interval is 0 – 450 (0.0 °F – 45.0 °F, resolution 0.1 °F) +** + +**NOTE3: If configuration parameter 78 (Scale selection) is set to Fahrenheit, note that Fahrenheit values will be converted to Celsius degrees. Due to conversion algorithm please be advised that configuration value could drift when converting values back and forth.** +Values in the range 0 to 450 may be set. + +The manufacturer defined default value is ```5```. + +This parameter has the configuration ID ```config_43_2``` and is of type ```INTEGER```. + + +### Parameter 44: Hysteresis Lower temperature offset + +Hysteresis Lower temperature offset +This parameter defines minimum temperature difference between real measured temperature and set-point temperature to turn device off in heat mode or turn device on in cool mode.  + +Values: +• default value 5 (0.5 °C) +• 0 - 450 + +** +NOTE1: If configuration parameter 78 (Scale selection) is set to Celsius, then valid interval is 0 – 250 (0.0 °C – 25.0 °C, resolution 0.1 °C) +NOTE2: If configuration parameter 78 (Scale selection) is set to Fahrenheit, then valid interval is 0 – 450 (0.0 °F – 45.0 °F, resolution 0.1 °F) +NOTE3: If configuration parameter 78 (Scale selection) is set to Fahrenheit, note that Fahrenheit values will be converted to Celsius degrees. Due to conversion algorithm please be advised that configuration value could drift when converting values back and forth.** +Values in the range 0 to 450 may be set. + +The manufacturer defined default value is ```5```. + +This parameter has the configuration ID ```config_44_2``` and is of type ```INTEGER```. + + +### Parameter 45: Antifreeze + +Antifreeze +Set value determines at which temperature the device will be turned on even (if the thermostat was manually set to off). + + +Values: +• default value 50 (5.0 °C) +• -125 - 545 +• 1000 - Antifreeze functionality disabled + +**NOTE1: Antifreeze is activated only in heating mode and it uses hysteresis of ±0.5°C. +NOTE2: If configuration parameter 78 (Scale selection) is set to Celsius, then valid interval is -125 – 125 (-12.5 °C – 12.5 °C, resolution 0.1 °C) +NOTE3: If configuration parameter 78 (Scale selection) is set to Fahrenheit, then valid interval is 95 – 545 (9.5 °F – 54.5 °F, resolution 0.1 °F) +NOTE4: If configuration parameter 78 (Scale selection) is set to Fahrenheit, note that Fahrenheit values will be converted to Celsius degrees. Due to conversion algorithm please be advised that configuration value could drift when converting values back and forth.** +Values in the range -125 to 1000 may be set. + +The manufacturer defined default value is ```50```. + +This parameter has the configuration ID ```config_45_2``` and is of type ```INTEGER```. + + +### Parameter 59: Thermostat mode + +Thermostat mode +This parameter determines how the device will operate if it will operate in the heating mode or in the cooling mode. The range of the hysteresis will remain the same, only operation will change from heating to cooling and vice versa + + +Values: +• default value 0 +• 0 - Heat mode +• 1 - Cool mode + + +**NOTE1: After parameter change, first exclude device (without setting parameters to default value) and then re include the device!** +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Heat mode | +| 1 | Cool mode | + +The manufacturer defined default value is ```0``` (Heat mode). + +This parameter has the configuration ID ```config_59_1``` and is of type ```INTEGER```. + + +### Parameter 60: Too low temperature limit + +Too low temperature limit +This parameter determines the temperature at which the device sends a command to the associated device - to turn ON device or to turn OFF device. + +Values: +• Default value 50 (Too low temperature limit is 5.0 °C) +• -150 - 2120 + + +**NOTE1: Too low temperature limit is used with Association Group 3.** +**NOTE2: If configuration parameter 78 (Scale selection) is set to Celsius, then valid interval is -150 – 1000 (-15.0 °C – 100.0 °C, resolution 0.1 °C)** +**NOTE3: If configuration parameter 78 (Scale selection) is set to Fahrenheit, then valid interval is 50 – 2120 (5.0 °F – 212.0 °F, resolution 0.1 °F)** +**NOTE4: If configuration parameter 78 (Scale selection) is set to Fahrenheit, note that Fahrenheit values will be converted to Celsius degrees. Due to conversion algorithm please be advised that configuration value could drift when converting values back and forth.** +Values in the range -150 to 2120 may be set. + +The manufacturer defined default value is ```50```. + +This parameter has the configuration ID ```config_60_2``` and is of type ```INTEGER```. + + +### Parameter 61: Too high temperature limit + +Too high temperature limit +This parameter determines the temperature at which the device sends a command to the associated device, to turn ON device or to turn OFF device. + +Values: +• default value 700 (too high temperature limit is 70.0 °C) +• 1 - 2120 + + +**NOTE1: Too high temperature limit is used with Association Group 3.** +**NOTE2: If configuration parameter 78 (Scale selection) is set to Celsius, then valid interval is 1 – 1000 (0.1 °C – 100.0 °C, resolution 0.1 °C)** +**NOTE3: If configuration parameter 78 (Scale selection) is set to Fahrenheit, then valid interval is 322 – 2120 (32.2 °F – 212.0 °F, resolution 0.1 °F)** +**NOTE4: If configuration parameter 78 (Scale selection) is set to Fahrenheit, note that Fahrenheit values will be converted to Celsius degrees. Due to conversion algorithm please be advised that configuration value could drift when converting values back and forth.** +Values in the range 1 to 2120 may be set. + +The manufacturer defined default value is ```700```. + +This parameter has the configuration ID ```config_61_2``` and is of type ```INTEGER```. + + +### Parameter 63: Output switch selection + +Output switch selection +Set value determines the type of the device connected to the on/off output. The output type can be normally open (NO) or normally closed (NC). + + +Value: +• default value 0 +• 0 - When switch/device is off the output is 0V (NC). +• 1 - When switch/device is off the output is 240V or 24V (NO) +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | NC | +| 1 | NO | + +The manufacturer defined default value is ```0``` (NC). + +This parameter has the configuration ID ```config_63_1``` and is of type ```INTEGER```. + + +### Parameter 78: Scale Selection + +Scale Selection +This parameter determines in which measurement unit the device will report temperature (Fahrenheit or Celsius) and determines the scale the configuration parameters (43, 44, 44, 45, 60, 61, 110, 120) are interpreted as. + + +Values: +• Default value 0 = degrees Celsius +• 0 = degrees Celsius +• 1 = degrees Fahrenheit + + +**NOTE1: This scale has influence on Temperature reporting. The device is capable of receiving a Setpoint in all supported scales.** +**NOTE2: This configuration parameter has impact on configuration parameters 43, 44, 44, 45, 60, 61, 110, 120. If scale is set to degrees Fahrenheit configuration values at parameters 43, 44, 44, 45, 60, 61, 110, 120 will be converted to degrees Celsius. Please note that converted values could drift when converting values back and forth.** +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | degrees Celsius | +| 1 | degrees Fahrenheit | + +The manufacturer defined default value is ```0``` (degrees Celsius). + +This parameter has the configuration ID ```config_78_1``` and is of type ```INTEGER```. + + +### Parameter 110: Temperature Sensor Offset Settings + +Temperature Sensor Offset Settings +Set value is added to or subtracted from the actually measured value to adjust the temperature report sent by an external sensor. + + +Values:  + +• default value 0 +• -270 - 270 + + +**NOTE1: If configuration parameter 78 (Scale selection) is set to Celsius, then valid interval is -150 – 150 (-15.0 °C – 15.0 °C, resolution 0.1 °C)** +**NOTE2: If configuration parameter 78 (Scale selection) is set to Fahrenheit, then valid interval is -270 - 270 (-27.0 °F – 27.0 °F, resolution 0.1 °F)** +**NOTE3: If configuration parameter 78 (Scale selection) is set to Fahrenheit, note that Fahrenheit values will be converted to Celsius degrees. Due to conversion algorithm please be advised that configuration value could drift when converting values back and forth** +Values in the range -270 to 270 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_110_2``` and is of type ```INTEGER```. + + +### Parameter 120: Temperature Sensor Reporting Threshold + +Temperature Sensor Reporting Threshold +This configuration parameters sets reporting threshold between reported temperature and actual temperature for reporting temperature at association group 4.  + +Values: +• Default value 5 = 0.5°C +• 0 – Reporting disabled +• 0 - 270 + +** +NOTE1: If configuration parameter 78 (Scale selection) is set to Celsius, then valid interval is 0 – 150 (0 °C – 15.0 °C, resolution 0.1 °C) +NOTE2: If configuration parameter 78 (Scale selection) is set to Fahrenheit, then valid interval is 0 - 270 (0 °F – 27.0 °F, resolution 0.1 °F) +NOTE3: If configuration parameter 78 (Scale selection) is set to Fahrenheit, note that Fahrenheit values will be converted to Celsius degrees. Due to conversion algorithm please be advised that configuration value could drift when converting values back and forth** +Values in the range 0 to 270 may be set. + +The manufacturer defined default value is ```5```. + +This parameter has the configuration ID ```config_120_2``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The ZMNKID supports 4 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. +Supports the following commands: + +• Device Reset Locally: triggered upon request, + +• Sensor multilevel report: triggered upon temperature change, + +• Meter report: triggered upon energy consumption change according to configuration parameters 40, 42, + +• Notification report: triggered upon current overload detection, + +• Thermostat mode: triggered upon thermostat mode change + +• Thermostat operating state: triggered upon thermostat operating state (Idle, Heating, Cooling) + +Association group 1 supports 5 nodes. + +### Group 2: Change of output Q + +Supports the following command: + +• Basic set: triggered by change of output Q + +Association group 2 supports 5 nodes. + +### Group 3: Basic on/off too high too low T + +Supports the following command: + +• Basic set: triggered when actual temperature reaches Too High or Too Low temperature limit; + +Heat mode: when temperature reaches Too High Temperature Limit reports OFF (0x00), when temperature reaches Too Low Temperature Limit reports ON (0xFF). + +Cool mode: when temperature reaches Too High Temperature Limit reports ON (0xFF), when temperature reaches Too Low Temperature Limit reports OFF (0x00). + +Thermostat off mode reports OFF (0x00) on both limits reached. + +Hysteresis is 1°C. + +Association group 3 supports 5 nodes. + +### Group 4: Sensor multilevel report + +Supports the following command: + +• Sensor multilevel report: triggered by change of temperature for threshold defined in configuration parameter 120 + +Association group 4 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SENSOR_MULTILEVEL_V7| | +| COMMAND_CLASS_METER_V3| | +| COMMAND_CLASS_THERMOSTAT_MODE_V1| Linked to BASIC| +| COMMAND_CLASS_THERMOSTAT_OPERATING_STATE_V1| | +| COMMAND_CLASS_THERMOSTAT_SETPOINT_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V8| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_SECURITY_V1| | + +### Documentation Links + +* [official product manual](https://www.cd-jackson.com/zwave_device_uploads/1101/Qubino-Flush-On-Off-Thermostat-2-PLUS-extended-manual-eng-1-0-certification.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1101). diff --git a/_addons_bindings/zwave/doc/qubino/smartplug_0_0.md b/_addons_bindings/zwave/doc/qubino/smartplug_0_0.md index f195f765b..d0c2fee55 100644 --- a/_addons_bindings/zwave/doc/qubino/smartplug_0_0.md +++ b/_addons_bindings/zwave/doc/qubino/smartplug_0_0.md @@ -51,50 +51,44 @@ Manual inclusion The following table summarises the channels available for the Smart Plug 16A -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Electric meter (amps) | meter_current | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Alarm (power) | alarm_power | Door | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Alarm (power) | alarm_power | alarm_power | Energy | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Alarm (power) - Indicates if a power alarm is triggered. -The ```alarm_power``` 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. +The ```alarm_power``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: diff --git a/_addons_bindings/zwave/doc/qubino/zmnhla_0_0.md b/_addons_bindings/zwave/doc/qubino/zmnhla_0_0.md index d41ff6f40..86f110369 100644 --- a/_addons_bindings/zwave/doc/qubino/zmnhla_0_0.md +++ b/_addons_bindings/zwave/doc/qubino/zmnhla_0_0.md @@ -17,43 +17,49 @@ The ZMNHLA supports routing. This allows the device to communicate using other r ## 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/212) to improve the documentation. +This Z-Wave module is used to regulate temperature. Regulation is done using full wave PWM technology. The module can be controlled either through Z-wave network or through the wall switch.  + +### Inclusion Information + + * press service button S for more than 2 seconds or + * press push button I1 three times within 3s (3 times change switch state within 3 seconds + +### Exclusion Information + + * press service button S for more than 6 seconds or + * press push button I1 five times within 3s (5 times change switch state within 3 seconds) in the first 60 seconds after the module is connected to the power supply. ## Channels The following table summarises the channels available for the ZMNHLA -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -74,10 +80,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. @@ -95,31 +100,31 @@ Detailed information on each parameter can be found in the sections below. | 5 | Input 2 contact type | Input 2 contact type | | 6 | Input 3 contact type | Input 3 contact type | | 10 | Activate / deactivate functions ALL ON/ALL OFF | Respond to ALL ON/ALL OFF | -| 11 | I1 Functionality Selection | Default Value = 1. 65535 – Input I1 does not influence on the heat/cool process. 1 - Input I1 changes the mode of the thermostat between OFF and AUTO. In this case function on flood sensor (if connected) is disabled. 2 - inpu | -| 12 | I2 Functionality Selection | Default = 65535, 65535 - I2 does not influence on the heat/cool process, From From 0 to 990 - Temperature set point from 0.0 C to 99.0 C. When I2 is pressed, the temperature set point is automatically set to value defined here. In | -| 13 | I3 Functionality Selection | Default Value = 65535. 65535 – Input I3 does not influence on the heat/cool process. 1 - Input I3 changes the mode of the thermostat between OFF and AUTO. In this case function on window sensor is disabled. 2 - input I3 influ | -| 40 | Power reporting in Watts on power change | Default Value = 0. 0 – Reporting Disabled 1 - 100 = 1% - 100% Reporting enabled. Power report is sent (pushed) only when actual power in Watts in real time changes for more than set percentage comparing to previous actual power in | -| 42 | Power reporting in Watts by timer interval | Default Value = 300. 0 – Reporting Disabled 1 - 32767 = 1 second - 32767 seconds Reporting enabled. Power report is sent with time interval set by entered value. | -| 45 | Antifreeze | Set value at which temperature the device will be turned on even if the termpearture was manually set to off. Parameter can be set from 0 to 255 where 0 to 127 means from 0.0 C to 12.7 C and from 128 to 254 means from -0.1 C to -12.6 C | -| 50 | PWM Maximum Value | 2 - 100 = 2% - 100%, step is 1% Max PWM set by entered value. Default = 100. The Maximum level may not be lower than the minimum level. | -| 51 | PWM Minimum Value | 1 - 99 = 1% - 99%, step is 1% Minimum PWM set by entered value. Default = 0. The Minimum level may exceed the maximum level. | -| 52 | PWM Cycle Duration | 1 - 127 = 1-127 seconds, step is 1s PWM Cycle Duration set by entered value. Default = 10. NOTE:PWM Cycle duration defines the summary of all ON plus OFF time periods. For example if Output is set to 70% with PWM cycle duration of 20s, | -| 53 | PID Value Inside Deadband | When value is set to ZERO PID inside deadband is forced to zero. LAST VALUE means PID remains on same level as was before entering into deadband. | -| 54 | PID Deadband | 0 - 127 = 0.0C - 12.7C step is 0.1 C This parameter defines the zone where PID is not active. If the temperature difference between actual and setpoint is bigger than PID deadband, then the PID will start to regulate the system, otherw | -| 55 | Integral Sampling Time | 0 - 127 = 0s -127s step is 1s Parameter defines the time between samples. On each sample the controller captures difference between SP-act. | +| 11 | I1 Functionality Selection | I1 Functionality Selection | +| 12 | I2 Functionality Selection | I2 Functionality Selection | +| 13 | I3 Functionality Selection | I3 Functionality Selection | +| 40 | Power reporting in Watts on power change | Power reporting in Watts on power change | +| 42 | Power reporting in Watts by timer interval | Power reporting in Watts by timer interval | +| 45 | Antifreeze | Antifreeze | +| 50 | PWM Maximum Value | PWM Maximum Value | +| 51 | PWM Minimum Value | PWM Minimum Value | +| 52 | PWM Cycle Duration | PWM Cycle Duration | +| 53 | PID Value Inside Deadband | PID Value Inside Deadband | +| 54 | PID Deadband | PID Deadband | +| 55 | Integral Sampling Time | Integral Sampling Time | | 56 | P Parameter | 0 - 1000 P value step is 1. Default = 100 | | 57 | I Parameter | 0 - 1000 - 0s I value step is 1. Default = 1 | | 58 | D Parameter | 0 - 1000 - 0s D value step is 1. Default = 1 | | 59 | Thermostat Mode | | -| 60 | Too low temperature limit | 1 - 1000 = 0.1 C - 100.0 C step is 0.1 C Too low temperature limit is set by entered value. In case measured temperature is below set value, module sends BasicSet value. Default = 50 | -| 61 | Too high temperature limit | 1 - 1000 = 0.1 C - 100.0 C step is 0.1 C Too high temperature limit is set by entered value. In case measured temperature is higher than set value, module sends BasicSet value. Default = 700 | +| 60 | Too low temperature limit | Too low temperature limit | +| 61 | Too high temperature limit | Too high temperature limit | | 63 | Output Switch Selection | | -| 70 | Input 1 Status on delay | 1 - 32000 seconds. If the value of the parameter is different to 0, means that the influence of this input to heating or cooling will react after inserted time. Parameter 11 must be set to 2! | -| 71 | Input 1 Status off delay | 1 - 32000 seconds. If the value of the parameter is different to 0, means that the influence of this input to heating or cooling will react after inserted time. Parameter 11 must be set to 2! | -| 72 | Input 2 Status on delay | 1 - 32000 seconds. If the value of the parameter is different to 0, means that the influence of this input to heating or cooling will react after inserted time. Parameter 12 must be set to 2000! | -| 73 | Input 2 Status off delay | 1 - 32000 seconds. If the value of the parameter is different to 0, means that the influence of this input to heating or cooling will react after inserted time. Parameter 12 must be set to 2000! | -| 74 | Input 3 Status on delay | 1 - 32000 seconds. If the value of the parameter is different to 0, means that the influence of this input to heating or cooling will react after inserted time. Parameter 13 must be set to 2! | -| 75 | Input 3 Status off delay | 1 - 32000 seconds. If the value of the parameter is different to 0, means that the influence of this input to heating or cooling will react after inserted time. Parameter 13 must be set to 2! | +| 70 | Input 1 Status on delay | Input 1 Status on delay | +| 71 | Input 1 Status off delay | Input 1 Status off delay | +| 72 | Input 2 Status on delay | Input 2 Status on delay | +| 73 | Input 2 Status off delay | Input 2 Status off delay | +| 74 | Input 3 Status on delay | Input 3 Status on delay | +| 75 | Input 3 Status off delay | Input 3 Status off delay | ### Parameter 1: Input 1 switch type @@ -237,8 +242,12 @@ This parameter has the configuration ID ```config_10_1``` and is of type ```INTE ### Parameter 11: I1 Functionality Selection -Default Value = 1. 65535 – Input I1 does not influence on the heat/cool process. 1 - Input I1 changes the mode of the thermostat between OFF and AUTO. In this case function on flood sensor (if connected) is disabled. 2 - inpu +I1 Functionality Selection +Default Value = 1. + * 65535 – Input I1 does not influence on the heat/cool process. + * 1 - Input I1 changes the mode ofthe thermostat between OFF and AUTO. In this case function on flood sensor (if connected) is disabled. + * 2 – input I1 influences on cooling and heating valves according to status of flood sensor. In this case function of Off and Auto selection by I1 is disabled Values in the range 1 to 65535 may be set. The manufacturer defined default value is ```1```. @@ -248,8 +257,12 @@ This parameter has the configuration ID ```config_11_2``` and is of type ```INTE ### Parameter 12: I2 Functionality Selection -Default = 65535, 65535 - I2 does not influence on the heat/cool process, From From 0 to 990 - Temperature set point from 0.0 C to 99.0 C. When I2 is pressed, the temperature set point is automatically set to value defined here. In - +I2 Functionality Selection + * default value 65535 + * 65535 – input I2 does not influence on the heat/ cool process + * From 0 to 990 – Temperature set point from 0.0 °C to 99.0 °C. When I2 is pressed, temperature set point is automatically set to value defined here. In this case function of condense sensor is disabled. + * From 1001 to 1150 – Temperature set point from -0.1 °C to -15.0 °C. When I2 is pressed, temperature setpoint is automatically set to value defined here. In this case function of condense sensor is disabled. + * 2000 – Input I2 influences on the cooling valve according to status of condense sensor, In this case function of setpoint selection with I2 is disabled. Values in the range 1 to 65535 may be set. The manufacturer defined default value is ```65535```. @@ -259,8 +272,11 @@ This parameter has the configuration ID ```config_12_2``` and is of type ```INTE ### Parameter 13: I3 Functionality Selection -Default Value = 65535. 65535 – Input I3 does not influence on the heat/cool process. 1 - Input I3 changes the mode of the thermostat between OFF and AUTO. In this case function on window sensor is disabled. 2 - input I3 influ - +I3 Functionality Selection + * default value 65535 + * 65535 – input I3 does not influence on the heat/ cool process + * 1 – input I3 changes the mode of the thermostat between Heat and Cool. In this case function on window sensor is disabled. + * 2 – input I3 influences on cooling and heating valves according to status of window sensor. In this case function of Heat and Cool selection by I3 is disabled.  Values in the range 1 to 65535 may be set. The manufacturer defined default value is ```65535```. @@ -270,8 +286,12 @@ This parameter has the configuration ID ```config_13_2``` and is of type ```INTE ### Parameter 40: Power reporting in Watts on power change -Default Value = 0. 0 – Reporting Disabled 1 - 100 = 1% - 100% Reporting enabled. Power report is sent (pushed) only when actual power in Watts in real time changes for more than set percentage comparing to previous actual power in +Power reporting in Watts on power change + *  default value 0 + * 0 – Reporting Disabled + * 1–100 = 1%-100% Reporting enabled. Power report is send (push) only when actual power in Watts in real time changes for more than set percentage comparing to previous actual power in Watts, step is 1%. +**NOTE**: If power changed is less than 1W, the report is not send (pushed), independent of percentage set Values in the range 0 to 100 may be set. The manufacturer defined default value is ```0```. @@ -281,8 +301,10 @@ This parameter has the configuration ID ```config_40_1``` and is of type ```INTE ### Parameter 42: Power reporting in Watts by timer interval -Default Value = 300. 0 – Reporting Disabled 1 - 32767 = 1 second - 32767 seconds Reporting enabled. Power report is sent with time interval set by entered value. - +Power reporting in Watts by timer interval + * default value 300 (power report in Watts is send each 300s) + * 0 – Reporting Disabled + *  1 – 32767 = 1 second – 32767 seconds. Reporting enabled. Power report is send with time interval set by entered value.   Values in the range 0 to 32767 may be set. The manufacturer defined default value is ```300```. @@ -292,8 +314,15 @@ This parameter has the configuration ID ```config_42_2``` and is of type ```INTE ### Parameter 45: Antifreeze -Set value at which temperature the device will be turned on even if the termpearture was manually set to off. Parameter can be set from 0 to 255 where 0 to 127 means from 0.0 C to 12.7 C and from 128 to 254 means from -0.1 C to -12.6 C +Antifreeze +Set value means at which temperature the device will be turned on even if the thermostat was manually set to off. Parameter can be set from 0 to 255 where 0 to 127 means from 0.0 °C to 12.7 °C and from 128 to 254 means from - 0.1 °C to -12.6 °C. +Available configuration parameters  + + * default value 50 (5,0 °C) + * 255 – Antifreeze functionality disabled + +**NOTE:** Antifreeze is activated only in heating mode Values in the range 0 to 255 may be set. The manufacturer defined default value is ```50```. @@ -303,8 +332,11 @@ This parameter has the configuration ID ```config_45_1``` and is of type ```INTE ### Parameter 50: PWM Maximum Value -2 - 100 = 2% - 100%, step is 1% Max PWM set by entered value. Default = 100. The Maximum level may not be lower than the minimum level. +PWM Maximum Value + * default value 100 (Maximum PWM value) + * 2–100 = 2%-100%, step is 1%. Max. PWM set by entered value. +**NOTE**: The maximum level may not be lower than the minimum level!  Values in the range 2 to 100 may be set. The manufacturer defined default value is ```100```. @@ -314,8 +346,11 @@ This parameter has the configuration ID ```config_50_1``` and is of type ```INTE ### Parameter 51: PWM Minimum Value -1 - 99 = 1% - 99%, step is 1% Minimum PWM set by entered value. Default = 0. The Minimum level may exceed the maximum level. +PWM Minimum Value + * Default value 0 (Minimum PWM value is 0%) + * 1- 99 = 1% – 99%, step is 1%. Minimum PWM set by entered value. +**NOTE:** The minimum level may not exceed maximum level!  Values in the range 0 to 99 may be set. The manufacturer defined default value is ```0```. @@ -325,8 +360,11 @@ This parameter has the configuration ID ```config_51_1``` and is of type ```INTE ### Parameter 52: PWM Cycle Duration -1 - 127 = 1-127 seconds, step is 1s PWM Cycle Duration set by entered value. Default = 10. NOTE:PWM Cycle duration defines the summary of all ON plus OFF time periods. For example if Output is set to 70% with PWM cycle duration of 20s, +PWM Cycle Duration + * Default value 10 (Cycle duration set to 10s) + *  1-127 = 1–127s, step is 1s. PWM cycle duration set by entered value. +**NOTE:** PWM cycle duration define the summary of all ON plus OFF time periods. For example if Output is set to 70% with PWM cycle duration of 20s, output will be ON for 14s then OFF 6s, again 14s ON, etc…  Values in the range 1 to 127 may be set. The manufacturer defined default value is ```10```. @@ -336,8 +374,11 @@ This parameter has the configuration ID ```config_52_1``` and is of type ```INTE ### Parameter 53: PID Value Inside Deadband -When value is set to ZERO PID inside deadband is forced to zero. LAST VALUE means PID remains on same level as was before entering into deadband. +PID Value Inside Deadband + * Default value 0 (PID value equal ZERO) + * 1 = PID value set to LAST VALUE +**NOTE**: When value is set to ZERO PID inside deadband is forced to zero. LASTVALUE means that PID remains on same level as was before entering into deadband  The following option values may be configured -: | Value | Description | @@ -352,8 +393,11 @@ This parameter has the configuration ID ```config_53_1``` and is of type ```INTE ### Parameter 54: PID Deadband -0 - 127 = 0.0C - 12.7C step is 0.1 C This parameter defines the zone where PID is not active. If the temperature difference between actual and setpoint is bigger than PID deadband, then the PID will start to regulate the system, otherw +PID Deadband + * default value 5 (0,5 °C) + * 0-127 – 0.0 °C to 12.7 °C, step is 0,1°C +**NOTE**: This parameter defines the zone where PID is not active. If the temperature difference between actual and setpoint is bigger than PID deadband, then the PID will start to regulate the system, otherwise the PID is zero or fixed. Values in the range 0 to 127 may be set. The manufacturer defined default value is ```5```. @@ -363,8 +407,11 @@ This parameter has the configuration ID ```config_54_1``` and is of type ```INTE ### Parameter 55: Integral Sampling Time -0 - 127 = 0s -127s step is 1s Parameter defines the time between samples. On each sample the controller captures difference between SP-act. +Integral Sampling Time + * default value 5 (5s) + * 0-127 – 0s to 127s, step is 1s +Parameter defines the time between samples. On each sample the controller capture difference between SP-act. Values in the range 0 to 127 may be set. The manufacturer defined default value is ```5```. @@ -423,8 +470,11 @@ This parameter has the configuration ID ```config_59_1``` and is of type ```INTE ### Parameter 60: Too low temperature limit -1 - 1000 = 0.1 C - 100.0 C step is 0.1 C Too low temperature limit is set by entered value. In case measured temperature is below set value, module sends BasicSet value. Default = 50 +Too low temperature limit + * Default value 50 (Too low temperature limit is 5.0°C) + * 1 - 1000 = 0.1°C – 100.0°C, step is 0.1°C. +Too low temperature limit is set by entered value. In case measured temperature is below set value, module sends BasicSet value. Look chapter associations. Values in the range 1 to 1000 may be set. The manufacturer defined default value is ```50```. @@ -434,8 +484,11 @@ This parameter has the configuration ID ```config_60_2``` and is of type ```INTE ### Parameter 61: Too high temperature limit -1 - 1000 = 0.1 C - 100.0 C step is 0.1 C Too high temperature limit is set by entered value. In case measured temperature is higher than set value, module sends BasicSet value. Default = 700 +Too high temperature limit + * Default value 700 (too high temperature limit is 70.0°C) + * 1 - 1000 = 0.1°C – 100.0°C, step is 0.1°C. +Too high temperature limit is set by entered value. In case measured temperature is higher than set value, module sends BasicSet value. Look chapter associations Values in the range 1 to 1000 may be set. The manufacturer defined default value is ```700```. @@ -451,19 +504,21 @@ The following option values may be configured -: | Value | Description | |--------|-------------| -| 0 | When system is turned off the output is 0V (NC) | -| 1 | When system is turned off the output is 230V (NO) | +| 0 | System OFF the output is 0V (NC) | +| 1 | System OFF the output is 230V (NO) | -The manufacturer defined default value is ```0``` (When system is turned off the output is 0V (NC) - ). +The manufacturer defined default value is ```0``` (System OFF the output is 0V (NC) ). This parameter has the configuration ID ```config_63_1``` and is of type ```INTEGER```. ### Parameter 70: Input 1 Status on delay -1 - 32000 seconds. If the value of the parameter is different to 0, means that the influence of this input to heating or cooling will react after inserted time. Parameter 11 must be set to 2! +Input 1 Status on delay + * default value 0 + * 1 – 32000 seconds +If the value of parameter is different to 0, means that the Influence of this input to heating or cooling will react after inserted time. Parameter 11 must be set to 2! Values in the range 0 to 32000 may be set. The manufacturer defined default value is ```0```. @@ -473,8 +528,11 @@ This parameter has the configuration ID ```config_70_2``` and is of type ```INTE ### Parameter 71: Input 1 Status off delay -1 - 32000 seconds. If the value of the parameter is different to 0, means that the influence of this input to heating or cooling will react after inserted time. Parameter 11 must be set to 2! +Input 1 Status off delay + * default value 0 + * 1 – 32000 seconds +If the value of parameter is different to 0, means that the Influence of this input to heating or cooling will react after inserted time. Parameter 11 must be set to 2! Values in the range 0 to 32000 may be set. The manufacturer defined default value is ```0```. @@ -484,8 +542,11 @@ This parameter has the configuration ID ```config_71_2``` and is of type ```INTE ### Parameter 72: Input 2 Status on delay -1 - 32000 seconds. If the value of the parameter is different to 0, means that the influence of this input to heating or cooling will react after inserted time. Parameter 12 must be set to 2000! +Input 2 Status on delay + * default value 0 + * 1 – 32000 seconds +If the value of parameter is different to 0, means that the Influence of this input to heating or cooling will react after inserted time. Parameter 12 must be set to 2000! Values in the range 0 to 32000 may be set. The manufacturer defined default value is ```0```. @@ -495,8 +556,11 @@ This parameter has the configuration ID ```config_72_2``` and is of type ```INTE ### Parameter 73: Input 2 Status off delay -1 - 32000 seconds. If the value of the parameter is different to 0, means that the influence of this input to heating or cooling will react after inserted time. Parameter 12 must be set to 2000! +Input 2 Status off delay + * default value 0 + * 1 – 32000 seconds +If the value of parameter is different to 0, means that the Influence of this input to heating or cooling will react after inserted time. Parameter 12 must be set to 2000!  Values in the range 0 to 32000 may be set. The manufacturer defined default value is ```0```. @@ -506,8 +570,11 @@ This parameter has the configuration ID ```config_73_2``` and is of type ```INTE ### Parameter 74: Input 3 Status on delay -1 - 32000 seconds. If the value of the parameter is different to 0, means that the influence of this input to heating or cooling will react after inserted time. Parameter 13 must be set to 2! +Input 3 Status on delay + * default value 0 + * 1 – 32000 seconds +If the value of parameter is different to 0, means that the Influence of this input to heating or cooling will react after inserted time. Parameter 13 must be set to 2! Values in the range 0 to 32000 may be set. The manufacturer defined default value is ```0```. @@ -517,8 +584,11 @@ This parameter has the configuration ID ```config_74_2``` and is of type ```INTE ### Parameter 75: Input 3 Status off delay -1 - 32000 seconds. If the value of the parameter is different to 0, means that the influence of this input to heating or cooling will react after inserted time. Parameter 13 must be set to 2! +Input 3 Status off delay + * default value 0 + * 1 – 32000 seconds +If the value of parameter is different to 0, means that the Influence of this input to heating or cooling will react after inserted time. Parameter 13 must be set to 2!  Values in the range 0 to 32000 may be set. The manufacturer defined default value is ```0```. diff --git a/_addons_bindings/zwave/doc/qubino/zmnhld_0_0.md b/_addons_bindings/zwave/doc/qubino/zmnhld_0_0.md index cad8fcf1d..cc8b16714 100644 --- a/_addons_bindings/zwave/doc/qubino/zmnhld_0_0.md +++ b/_addons_bindings/zwave/doc/qubino/zmnhld_0_0.md @@ -51,25 +51,23 @@ NOTE: If the module is included with parameters 100 or 101 with values different The following table summarises the channels available for the ZMNHLD -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Thermostat setpoint | thermostat_setpoint | Temperature | Number:Temperature | -| Temperature Sensor | sensor_temperature1 | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode1 | Temperature | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Thermostat setpoint | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Temperature Sensor | sensor_temperature1 | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode1 | thermostat_mode | Temperature | Number | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -90,22 +88,19 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Thermostat setpoint - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Temperature Sensor - Indicates the current temperature. -The ```sensor_temperature1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature1``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode1``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -166,10 +161,10 @@ Detailed information on each parameter can be found in the sections below. | 73 | Input I2 status off delay | Input I2 status off delay | | 74 | Input 3 status ON delay | Input 3 status ON delay | | 75 | Input I3 status off delay | Input I3 status off delay | -| 76 | Association group 2, 10 - reporting on time interval | Association group 2, 10 - reporting on time interval | -| 77 | Association group 10 - delay before sending Basic Set ON | Association group 10 - delay before sending Basic Set ON | +| 76 | Reporting on time interval | Reporting on time interval | +| 77 | Group 10 - delay before sending Basic Set ON | Group 10 - delay before sending Basic Set ON | | 78 | Scale Selection | Scale Selection | -| 100 | Enable/Disable Endpoint I1 or select the Type and Event | Enable/Disable Endpoint I1 or select the Notification Type and Event | +| 100 | Enable/Disable I1 or select Type and Event | Enable/Disable I1 or select Type and Event | | 101 | Enable/Disable Endpoint I2 or select type | Enable/Disable Endpoint I2 or select type | | 102 | Enable/Disable Endpoint I3 or select type | Enable/Disable Endpoint I3 or select type | | 110 | Temperature sensor offset settings | Temperature sensor offset settings | @@ -307,11 +302,11 @@ The following option values may be configured -: | Value | Description | |--------|-------------| -| 1 | Input I1 changes the mode between Off and Heat/Cool | +| 1 | Input I1 changes between Off and Heat/Cool | | 2 | Input I1 influences the heating/cooling valves | -| 32767 | Input I1 doesnt influence on the Heat/Cool process | +| 32767 | No influence on the Heat/Cool process | -The manufacturer defined default value is ```1``` (Input I1 changes the mode between Off and Heat/Cool ). +The manufacturer defined default value is ```1``` (Input I1 changes between Off and Heat/Cool ). This parameter has the configuration ID ```config_11_2``` and is of type ```INTEGER```. @@ -327,7 +322,7 @@ The following option values may be configured -: | Value | Description | |--------|-------------| -| 2000 | Input I2 influences the cooling value with condense sensor | +| 2000 | Input I2 influences the cooling value | | 32767 | Input I2 doesnt influence on the Heat/Cool process | The manufacturer defined default value is ```32767``` (Input I2 doesnt influence on the Heat/Cool process). @@ -350,9 +345,9 @@ The following option values may be configured -: |--------|-------------| | 1 | input I3 changes the mode of the thermostat | | 2 | input I3 influences on heating/cooling valves | -| 32767 | input I3 does not influence on the heat/cool process | +| 32767 | Does not influence on the heat/cool process | -The manufacturer defined default value is ```32767``` (input I3 does not influence on the heat/cool process). +The manufacturer defined default value is ```32767``` (Does not influence on the heat/cool process). This parameter has the configuration ID ```config_13_2``` and is of type ```INTEGER```. @@ -568,7 +563,7 @@ The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | When system is turned off the output is 0V(NC). | -| 1 | When system is turned off the output is 230V or 24V(NO). | +| 1 | System OFF the output is 230V or 24V(NO). | The manufacturer defined default value is ```0``` (When system is turned off the output is 0V(NC).). @@ -647,9 +642,11 @@ The manufacturer defined default value is ```0```. This parameter has the configuration ID ```config_75_2``` and is of type ```INTEGER```. -### Parameter 76: Association group 2, 10 - reporting on time interval +### Parameter 76: Reporting on time interval +Reporting on time interval Association group 2, 10 - reporting on time interval + Determinates the time interval of sending device status ON/OFF to the associated device. If the Association groups 2 or 10 are set, the device is reporting its state (Basic Set ON/ OFF) on change and on time interval (if this parameter is set). • Default value 30 = 30 minutes @@ -662,9 +659,11 @@ The manufacturer defined default value is ```30```. This parameter has the configuration ID ```config_76_1``` and is of type ```INTEGER```. -### Parameter 77: Association group 10 - delay before sending Basic Set ON +### Parameter 77: Group 10 - delay before sending Basic Set ON +Group 10 - delay before sending Basic Set ON Association group 10 - delay before sending Basic Set ON + Set a time delay before sent Basic set ON to the associated device. The same time frame also applies for the Basic set OFF. If this parameter is set, Basic Set ON/OFF Report is delayed for the time defined in this parameter. • Default value 180 = 3 minutes @@ -694,9 +693,9 @@ The manufacturer defined default value is ```0``` (degrees Celsius). This parameter has the configuration ID ```config_78_1``` and is of type ```INTEGER```. -### Parameter 100: Enable/Disable Endpoint I1 or select the Type and Event +### Parameter 100: Enable/Disable I1 or select Type and Event -Enable/Disable Endpoint I1 or select the Notification Type and Event +Enable/Disable I1 or select Type and Event Choose whether the Endpoint I1 is disabled (and not shown on the UI) or enabled (and displayed on the UI). By enabling this endpoint (setting it to be either a notification sensor or a binary sensor), the user also selects a Notification Type and a Notification Event for which notification reports will be sent (in case the endpoint is configured as a notification sensor). After changing the values of the parameter, first exclude the device (without setting the parameters to their default values), then wait at least 30s and then re-include the device! When the parameter is set to the value 9 the notifications are sent for the Home Security notification type. @@ -800,7 +799,7 @@ The following option values may be configured -: | 2 | temperature is grabbed from ext battery sensor | | 4 | setpoint is grabbed by sensor with assoc 5 | | 8 | setpoint is grabbed from ext battery sensor | -| 10 | temperature an setpoint are grabbed from ext batt sensor | +| 10 | temperature & setpoint from ext batt sensor | The manufacturer defined default value is ```0``` (internal sensor is mounted). diff --git a/_addons_bindings/zwave/doc/qubino/zmnhod_0_0.md b/_addons_bindings/zwave/doc/qubino/zmnhod_0_0.md index 2e646c978..77ab8a7e5 100644 --- a/_addons_bindings/zwave/doc/qubino/zmnhod_0_0.md +++ b/_addons_bindings/zwave/doc/qubino/zmnhod_0_0.md @@ -17,43 +17,50 @@ The ZMNHOD supports routing. This allows the device to communicate using other r ## 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/214) to improve the documentation. +This Z-Wave module is used to control the motor of blinds, rollers, shades, venetian blinds, etc.. The module can be controlled either through a Z-Wave network or through the wall switch. + +### Inclusion Information + + * press service button S for more than 2 second or + * press push button I1 three times within 3s (3 times change switch state within 3 seconds) + +### Exclusion Information + + * press service button S for more than 6 second or + * press push button I1 five times within 3s (5 times change switch state within 3 seconds) in the first 60 seconds after the module is connected to the power supply. ## Channels The following table summarises the channels available for the ZMNHOD -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Blinds control | blinds_control | Blinds | Rollershutter | -| Binary Sensor | sensor_binary | Door | Switch | -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Switch 1 | switch_binary1 | Switch | Switch | -| Blinds control 1 | blinds_control1 | Blinds | Rollershutter | -| Electric meter (watts) 1 | meter_watts1 | Energy | Number | -| Electric meter (kWh) 1 | meter_kwh1 | Energy | Number | -| Sensor (temperature) 2 | sensor_temperature2 | Temperature | Number:Temperature | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Blinds control | blinds_control | blinds_control | Blinds | Rollershutter | +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Switch 1 | switch_binary1 | switch_binary | Switch | Switch | +| Blinds control 1 | blinds_control1 | blinds_control | Blinds | Rollershutter | +| Electric meter (watts) 1 | meter_watts1 | meter_watts | Energy | Number | +| Electric meter (kWh) 1 | meter_kwh1 | meter_kwh | Energy | Number | +| Sensor (temperature) 2 | sensor_temperature2 | sensor_temperature | Temperature | Number:Temperature | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Blinds control - Provides start / stop control of blinds. -The ```blinds_control``` channel supports the ```Rollershutter``` item and is in the ```Blinds``` category. +The ```blinds_control``` channel is of type ```blinds_control``` and supports the ```Rollershutter``` item and is in the ```Blinds``` category. ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -63,52 +70,44 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Switch 1 - Switch the power on and off. -The ```switch_binary1``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary1``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Blinds control 1 - Provides start / stop control of blinds. -The ```blinds_control1``` channel supports the ```Rollershutter``` item and is in the ```Blinds``` category. +The ```blinds_control1``` channel is of type ```blinds_control``` and supports the ```Rollershutter``` item and is in the ```Blinds``` category. ### Electric meter (watts) 1 - Indicates the instantaneous power consumption. -The ```meter_watts1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts1``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 1 - Indicates the energy consumption (kWh). -The ```meter_kwh1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh1``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Sensor (temperature) 2 - Indicates the current temperature. -The ```sensor_temperature2``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature2``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. @@ -119,59 +118,26 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 10 | Activate/deactivate functions ALL ON / ALL OFF | Module responds to commands ALL ON / ALL OFF that may be sent by the main controller or by other controller belonging to the system. | -| 40 | Power reporting in Watts on power change for Q1 or Q2 | Set value 0 – 100 as percentage. -Available configuration parameters. - - - * 0 = Reporting Disabled - * 1–100 = 1% - 100% Reporting enabled Power report is sent only when actual power (in Watts) in real | -| 42 | Power reporting in Watts by time interval for Q1 or Q2 | Set value determines interval in seconds, when power report is send. -Available configuration parameters. - - - * default value 300 = 300s - * 0 – Reporting Disabled - * 1 – 32767 = 1 second – 32767 seconds | -| 71 | Operating modes | This parameter defines selection between two available operating modes. -NOTE: When setting parameter, module needs to be excluded and included again! Please check detailed description in this manual. | -| 72 | Slats tilting full turn time | This parameter defines the time necessary for slats to make full turn (180 degrees) -NOTE: If time set is too high, this will result that after full turn, shutter will start move up or down, for time remaining. - - * default value 15 | -| 73 | Slats position | This parameter defines slats position after up/down movement through Z-wave or push-buttons. | -| 74 | Motor moving up/down time | This parameter defines shutter motor moving time of complete opening or complete closing. -NOTE: If time set is too high, this will result that after full turn, shutter will start move up or down, for time remaining. - - * defau | -| 76 | Motor operation detection | Power threshold to be interpreted when motor reaches the limit switch. - - * default value 6 = 0,6W - * 5 - 100 (0,5W - 10W), step is 0,1W. - * The value 0 means reaching a limit switch will not be detected | -| 78 | Forced Shutter DC calibration | Setting value 0 or 1 a Shutter DC module enters the calibration mode. -When calibration process is finished, completing full cycle - up, down and up, set parameter 78 back to default of 0. | -| 85 | Power consumption max delay time | This parameter defines the max time before motor power consumption is read after one of the relays is switched ON. -If there is no power consumption during this max time (motor not connected, damaged or requires higher time to start, mo | -| 86 | Power consumption at limit switch delay time | This parameter defines the max time at limit switch, when power consumption is below power threshold. -If the power consumption during this time is below power threshold (par. 76), the active output will switch off, means that limit sw | -| 90 | Time delay for next motor movement | This parameter defines the minimum time delay between next motor movemen. -(minimum time between switching motor off and on again) - - * default value 5 = 500ms - * 1 – 30 = 0,1seconds – 3seconds (100ms resolution) | -| 110 | Temperature sensor offset settings | Set value is added or subtracted to actual measured value by sensor. default value 32536 32536 – offset is 0.0C From 1 to 100 – value from 0.1 °C to 10.0 °C is added to actual measured temperature. | -| 120 | Digital temperature sensor reporting | If digital temperature sensor is connected, module reports measured temperature on temperature change defined by this parameter. - - * Default value 5 = 0,5°C - * 32536 – offset is 0.0C - * 0 – Reporting disabled | +| 10 | Activate/deactivate functions ALL ON / ALL OFF | Activate/deactivate functions ALL ON / ALL OFF | +| 40 | Power report (Watts) on power change for Q1 or Q2 | Power report (Watts) on power change for Q1 or Q2 | +| 42 | Power report (Watts) by time interval for Q1 or Q2 | Power report (Watts) by time interval for Q1 or Q2 | +| 71 | Operating modes | Operating modes | +| 72 | Slats tilting full turn time | Slats tilting full turn time | +| 73 | Slats position | Slats position | +| 74 | Motor moving up/down time | Motor moving up/down time | +| 76 | Motor operation detection | Motor operation detection | +| 78 | Forced Shutter DC calibration | Forced Shutter DC calibration | +| 85 | Power consumption max delay time | Power consumption max delay time | +| 86 | Power consumption at limit switch delay time | Power consumption at limit switch delay time | +| 90 | Time delay for next motor movement | Time delay for next motor movement | +| 110 | Temperature sensor offset settings | Temperature sensor offset settings | +| 120 | Digital temperature sensor reporting | Digital temperature sensor reporting | | | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | ### Parameter 10: Activate/deactivate functions ALL ON / ALL OFF -Module responds to commands ALL ON / ALL OFF that may be sent by the main controller or by other controller belonging to the system. - +Activate/deactivate functions ALL ON / ALL OFF +Module responds to commands ALL ON / ALL OFF that may be sent by the main controller or by other controllerbelonging to the system. The following option values may be configured -: | Value | Description | @@ -186,15 +152,18 @@ The manufacturer defined default value is ```255``` (ALL ON active, ALL OFF acti This parameter has the configuration ID ```config_10_2``` and is of type ```INTEGER```. -### Parameter 40: Power reporting in Watts on power change for Q1 or Q2 +### Parameter 40: Power report (Watts) on power change for Q1 or Q2 -Set value 0 – 100 as percentage. -Available configuration parameters. +Power report (Watts) on power change for Q1 or Q2 +Set value means percentage, set value from 0 – 100 = 0% - 100%. +Available configuration parameters  - * 0 = Reporting Disabled - * 1–100 = 1% - 100% Reporting enabled Power report is sent only when actual power (in Watts) in real + * default value 1 + * 0 - reporting disabled + * 1 - 100 = 1% - 100% Reporting enabled. Power report is send (push) only when actual power (in Watts) in real time changes for more than set percentage comparing to previous actual power in Watts, step is 1%. +**NOTE**: if power changed is less than 1W, the report is not send (pushed), independent of percentage set.  Values in the range 0 to 100 may be set. The manufacturer defined default value is ```1```. @@ -202,16 +171,16 @@ The manufacturer defined default value is ```1```. This parameter has the configuration ID ```config_40_1``` and is of type ```INTEGER```. -### Parameter 42: Power reporting in Watts by time interval for Q1 or Q2 +### Parameter 42: Power report (Watts) by time interval for Q1 or Q2 -Set value determines interval in seconds, when power report is send. -Available configuration parameters. +Power report (Watts) by time interval for Q1 or Q2 +Set value means time interval (0 – 32767) in seconds, when power report is send. +Available configuration parameters * default value 300 = 300s - * 0 – Reporting Disabled - * 1 – 32767 = 1 second – 32767 seconds - + * 0 - Reporting Disabled + * 1 - 32767 = 1 second - 32767 seconds. Reporting enabled, power report is send with time interval set by entered value.  Values in the range 0 to 32767 may be set. The manufacturer defined default value is ```300```. @@ -221,9 +190,16 @@ This parameter has the configuration ID ```config_42_2``` and is of type ```INTE ### Parameter 71: Operating modes -This parameter defines selection between two available operating modes. -NOTE: When setting parameter, module needs to be excluded and included again! Please check detailed description in this manual. +Operating modes +This parameter defines selection between two available operating modes. +Available configuration parameters  + + * default value 0 + * 0 - Shutter mode + * 1 - venetian mode (up/down and slate rotation) + +**NOTE1**: After parameter change, first exclude module (without setting parameters to default value) then wait at least 30s and then re include the module! The following option values may be configured -: | Value | Description | @@ -238,11 +214,16 @@ This parameter has the configuration ID ```config_71_1``` and is of type ```INTE ### Parameter 72: Slats tilting full turn time -This parameter defines the time necessary for slats to make full turn (180 degrees) -NOTE: If time set is too high, this will result that after full turn, shutter will start move up or down, for time remaining. +Slats tilting full turn time +This parameter defines the time necessary for slats to make full turn (180 degrees). - * default value 15 +Available configuration parameters  + * default value 150 = 1,5 seconds + * 0 - tilting time disabled + * 1 - 32767 = 0,01seconds - 327,67 seconds + +**NOTE**: If time set is too high, this will result that after full turn, Shutter will start move up/down, for time remaining.  Values in the range 0 to 32767 may be set. The manufacturer defined default value is ```150```. @@ -252,27 +233,32 @@ This parameter has the configuration ID ```config_72_2``` and is of type ```INTE ### Parameter 73: Slats position +Slats position This parameter defines slats position after up/down movement through Z-wave or push-buttons. - The following option values may be configured -: | Value | Description | |--------|-------------| -| 0 | Slats return to previously set position only in case of Z-wave control | -| 1 | Slats return to previously set position in case of Z-wave control, pus | +| 0 | Return to previous position only with Z-wave | +| 1 | Return to previous position with Z-wave or button | -The manufacturer defined default value is ```1``` (Slats return to previously set position in case of Z-wave control, pus). +The manufacturer defined default value is ```1``` (Return to previous position with Z-wave or button). This parameter has the configuration ID ```config_73_1``` and is of type ```INTEGER```. ### Parameter 74: Motor moving up/down time -This parameter defines shutter motor moving time of complete opening or complete closing. -NOTE: If time set is too high, this will result that after full turn, shutter will start move up or down, for time remaining. +Motor moving up/down time +This parameter defines Shutter motor moving time of complete opening or complete closing. - * defau +Available configuration parameters + * default value 0 + * 0 - moving time disabled (working with limit switches) + * 1 - 32767 = 0,1seconds - 3276,7seconds. After that time motor is stopped (relay goes to off state) + +**NOTE**: Important is that the reference position to manually set moving time is always Shutter lower position! Values in the range 0 to 32767 may be set. The manufacturer defined default value is ```0```. @@ -282,12 +268,15 @@ This parameter has the configuration ID ```config_74_2``` and is of type ```INTE ### Parameter 76: Motor operation detection -Power threshold to be interpreted when motor reaches the limit switch. +Motor operation detection +Power threshold to be interpreted when motor reach the limit switch. - * default value 6 = 0,6W +Available configuration parameters + + *  default value 6 = 0,6W * 5 - 100 (0,5W - 10W), step is 0,1W. - * The value 0 means reaching a limit switch will not be detected +**NOTE**: Motors with power consumption less than 0,5W could not be auto calibrated. In that case set time manually (par. 74). Values in the range 0 to 100 may be set. The manufacturer defined default value is ```6```. @@ -297,9 +286,13 @@ This parameter has the configuration ID ```config_76_1``` and is of type ```INTE ### Parameter 78: Forced Shutter DC calibration -Setting value 0 or 1 a Shutter DC module enters the calibration mode. -When calibration process is finished, completing full cycle - up, down and up, set parameter 78 back to default of 0. +Forced Shutter DC calibration +By modifying the parameters setting from 0 to 1 a Shutter DC module enters the calibration mode. +Available configuration parameters  + + * default value 0 + * 1 - Start calibration process (when calibration process is finished, completing full cycle - up, down and up, set the parameter 78 (Forced Shutter calibration) value back to 0 The following option values may be configured -: | Value | Description | @@ -314,9 +307,13 @@ This parameter has the configuration ID ```config_78_1``` and is of type ```INTE ### Parameter 85: Power consumption max delay time -This parameter defines the max time before motor power consumption is read after one of the relays is switched ON. -If there is no power consumption during this max time (motor not connected, damaged or requires higher time to start, mo +Power consumption max delay time +This parameter defines the max time before motor power consumption is read after one of the relays is switched ON. If there is no power consumption during this max time (motor not connected, damaged or requires higher time to start, motor in end position,...) the relay will switch OFF. Time is defined by entering it manually. +Available configuration parameters + + * default value 8 = 800ms + * 3 - 50 = 0,3seconds - 5seconds (100ms resolution) Values in the range 3 to 50 may be set. The manufacturer defined default value is ```8```. @@ -326,9 +323,13 @@ This parameter has the configuration ID ```config_85_1``` and is of type ```INTE ### Parameter 86: Power consumption at limit switch delay time -This parameter defines the max time at limit switch, when power consumption is below power threshold. -If the power consumption during this time is below power threshold (par. 76), the active output will switch off, means that limit sw +Power consumption at limit switch delay time +This parameter defines the max time at limit switch, when power consumption is below power threshold. If the power consumption during this time is below power threshold (par. 76), the active output will switch off, means that limit switch is reached. +Available configuration parameters  + + * default value 8 = 800ms + * 3 - 50 = 0,3seconds - 5seconds (100ms resolution)  Values in the range 3 to 50 may be set. The manufacturer defined default value is ```8```. @@ -338,12 +339,13 @@ This parameter has the configuration ID ```config_86_1``` and is of type ```INTE ### Parameter 90: Time delay for next motor movement -This parameter defines the minimum time delay between next motor movemen. -(minimum time between switching motor off and on again) +Time delay for next motor movement +This parameter defines the minimum time delay between next motor movement (minimum time between switching motor off and on again). + +Available configuration parameters  * default value 5 = 500ms - * 1 – 30 = 0,1seconds – 3seconds (100ms resolution) - + * 1 - 30 = 0,1seconds - 3seconds (100ms resolution) Values in the range 1 to 30 may be set. The manufacturer defined default value is ```5```. @@ -353,8 +355,14 @@ This parameter has the configuration ID ```config_90_1``` and is of type ```INTE ### Parameter 110: Temperature sensor offset settings -Set value is added or subtracted to actual measured value by sensor. default value 32536 32536 – offset is 0.0C From 1 to 100 – value from 0.1 °C to 10.0 °C is added to actual measured temperature. +Temperature sensor offset settings +Set value is added or subtracted to actual measured value by sensor. +Available configuration parameters + + * default value 32536  32536 - offset is 0.0C + * From 1 to 100 - value from 0.1 °C to 10.0 °C is added to actual measured temperature. + * From 1001 to 1100 - value from -0.1 °C to -10.0 °C is subtracted to actual measured temperature. Values in the range 1 to 32536 may be set. The manufacturer defined default value is ```32536```. @@ -364,12 +372,14 @@ This parameter has the configuration ID ```config_110_2``` and is of type ```INT ### Parameter 120: Digital temperature sensor reporting -If digital temperature sensor is connected, module reports measured temperature on temperature change defined by this parameter. +Digital temperature sensor reporting +If digital temperature sensor is connected, module reports measured temperature on temperature change defined by this parameter. + +Available configuration parameters (data type is 1 Byte DEC): * Default value 5 = 0,5°C - * 32536 – offset is 0.0C - * 0 – Reporting disabled - + * 0 - reporting disabled + * 1-127 = 0,1°C - 12,7°C, step is 0,1°C Values in the range 0 to 127 may be set. The manufacturer defined default value is ```5```. diff --git a/_addons_bindings/zwave/doc/qubino/zmnhsd_0_0.md b/_addons_bindings/zwave/doc/qubino/zmnhsd_0_0.md index 7eeaea47d..c607a207f 100644 --- a/_addons_bindings/zwave/doc/qubino/zmnhsd_0_0.md +++ b/_addons_bindings/zwave/doc/qubino/zmnhsd_0_0.md @@ -37,39 +37,39 @@ Note: If the module is included with parameter 5 with value different from defau The following table summarises the channels available for the ZMNHSD -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | ### Switch Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Sensor (temperature) Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Electric meter (kWh) Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. diff --git a/_addons_bindings/zwave/doc/qubino/zmnhud_0_0.md b/_addons_bindings/zwave/doc/qubino/zmnhud_0_0.md index 3728bede3..05bcaa763 100644 --- a/_addons_bindings/zwave/doc/qubino/zmnhud_0_0.md +++ b/_addons_bindings/zwave/doc/qubino/zmnhud_0_0.md @@ -8,40 +8,51 @@ title: ZMNHUD - ZWave # ZMNHUD Flush pilot (DIN version) This describes the Z-Wave device *ZMNHUD*, manufactured by *[Goap](http://www.qubino.com/)* with the thing type UID of ```qubino_zmnhud_00_000```. +The device is in the category of *HVAC*, defining Air condition devices, Fans. + +![ZMNHUD product image](https://www.cd-jackson.com/zwave_device_uploads/715/715_default.png) + + The ZMNHUD 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 between other devices in the mesh network. ## 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/715) to improve the documentation. +The ZMNHUD is used to control electric Radiators with 6 different working modes by pilot wire control signal. The module can be controlled either through a Z-Wave network or through the wall switch. +The module is designed to be mounted inside an electrical cabinet onto DIN rail. + +### Inclusion Information + +Press the S button for 2 seconds + +### Exclusion Information + +Press the S button for 6 seconds ## Channels The following table summarises the channels available for the ZMNHUD -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Binary Sensor | sensor_binary | Door | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Binary Sensor | sensor_binary | sensor_binary | | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -68,7 +79,7 @@ Detailed information on each parameter can be found in the sections below. | 11 | Input 1 operation mode selection | | | 12 | Input 2 operation mode selection | | | 13 | Input 3 operation mode selection | | -| 30 | Saving the state of the device after a power failure | | +| 30 | Device state after pwr failure | Saving the state of the device after a power failure | | | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | ### Parameter 1: Input 1 switch type @@ -230,9 +241,9 @@ The manufacturer defined default value is ```5``` (Frost Protection). This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```. -### Parameter 30: Saving the state of the device after a power failure - +### Parameter 30: Device state after pwr failure +Saving the state of the device after a power failure The following option values may be configured -: @@ -266,8 +277,9 @@ Association groups allow the device to send unsolicited reports to the controlle The ZMNHUD supports 5 association groups. -### Group 1: Lifeline group +### Group 1: Lifeline +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. Reserved for communication with the main controller Association group 1 supports 1 node. @@ -316,6 +328,10 @@ Association group 5 supports 99 nodes. | COMMAND_CLASS_ASSOCIATION_V1| | | COMMAND_CLASS_VERSION_V1| | +### Documentation Links + +* [Manual (French)](https://www.cd-jackson.com/zwave_device_uploads/715/Qubino-DIN-pilot-wire-PLUS-user-manual-V1-0-fra.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/qubino/zmnhvd_0_0.md b/_addons_bindings/zwave/doc/qubino/zmnhvd_0_0.md index 75d451101..6d52ff028 100644 --- a/_addons_bindings/zwave/doc/qubino/zmnhvd_0_0.md +++ b/_addons_bindings/zwave/doc/qubino/zmnhvd_0_0.md @@ -17,39 +17,49 @@ The ZMNHVD supports routing. This allows the device to communicate using other r ## 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/363) to improve the documentation. +Universal dimmer module with a standard 0-10V output and a multi-function input, which may be a push button / switch, a potentiometer or 0-10V signal  + +### Inclusion Information + + * press service button S for more than 2 second or + * press push button I1 three times within 3s (3 times change switch state within 3 seconds) + +### Exclusion Information + + * press service button S for more than 6 second or + * press push button I1 five times within 3s ( 5 times change switch state within 3 seconds) in the first 60 seconds after the module is connected to the power supply ## Channels The following table summarises the channels available for the ZMNHVD -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Temperature Sensor | sensor_temperature | Temperature | Number:Temperature | -| Input I1 | sensor_general | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Temperature Sensor | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Input I1 | sensor_general | sensor_general | | Number | ### Switch Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Temperature Sensor Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Input I1 -The ```sensor_general``` channel supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_general``` channel is of type ```sensor_general``` and supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. @@ -60,11 +70,11 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 1 | Input 1 Switch Type | By this parameter the user can set input based on device type (switch, potentiometer, 0-10V sensor,...) | +| 1 | Input 1 Switch Type | Input 1 Switch Type | | 11 | Automatic turning off output after set time | | | 12 | Automatic turning on output after set time | | | 21 | Enable/Disable Double click function | | -| 30 | Saving the state of the device after a power failure | | +| 30 | Saving the state after a power failure | | | 52 | Auto or manual selection | | | 53 | PID value inside deadband | | | 54 | PID deadband | | @@ -88,8 +98,8 @@ Detailed information on each parameter can be found in the sections below. ### Parameter 1: Input 1 Switch Type +Input 1 Switch Type By this parameter the user can set input based on device type (switch, potentiometer, 0-10V sensor,...) - The following option values may be configured -: | Value | Description | @@ -139,13 +149,18 @@ The manufacturer defined default value is ```0```. This parameter has the configuration ID ```config_21_1``` and is of type ```INTEGER```. -### Parameter 30: Saving the state of the device after a power failure +### Parameter 30: Saving the state after a power failure -Values in the range 0 to 1 may be set. +The following option values may be configured -: -The manufacturer defined default value is ```0```. +| Value | Description | +|--------|-------------| +| 0 | Module saves it state | +| 1 | Module turns OFF | + +The manufacturer defined default value is ```0``` (Module saves it state). This parameter has the configuration ID ```config_30_1``` and is of type ```INTEGER```. diff --git a/_addons_bindings/zwave/doc/qubino/zmnhwd_0_0.md b/_addons_bindings/zwave/doc/qubino/zmnhwd_0_0.md index e4729c500..4e5467bb4 100644 --- a/_addons_bindings/zwave/doc/qubino/zmnhwd_0_0.md +++ b/_addons_bindings/zwave/doc/qubino/zmnhwd_0_0.md @@ -54,49 +54,49 @@ The following table summarises the channels available for the ZMNHWD -: ### Switch Switch the power on and off. -The ```switch_binary``` channel and is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and 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 and is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Color Control The color channel allows to control the color of a light. It is also possible to dim values and switch the light on and off. -The ```color_color``` channel and is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category. +The ```color_color``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category. ### Color Temperature The color temperature channel allows to set the color temperature of a light from 0 (cold) to 100 (warm). -The ```color_temperature``` channel and is of type ```color_temperature``` and supports the ```Dimmer``` item and is in the ```ColorLight``` category. +The ```color_temperature``` channel is of type ```color_temperature``` and supports the ```Dimmer``` item and is in the ```ColorLight``` category. ### Brightness 1 The brightness channel allows to control the brightness of a light. It is also possible to switch the light on and off. -The ```switch_dimmer1``` channel and is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. +The ```switch_dimmer1``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Brightness 2 The brightness channel allows to control the brightness of a light. It is also possible to switch the light on and off. -The ```switch_dimmer2``` channel and is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. +The ```switch_dimmer2``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Brightness 3 The brightness channel allows to control the brightness of a light. It is also possible to switch the light on and off. -The ```switch_dimmer3``` channel and is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. +The ```switch_dimmer3``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Brightness 4 The brightness channel allows to control the brightness of a light. It is also possible to switch the light on and off. -The ```switch_dimmer4``` channel and is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. +The ```switch_dimmer4``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. @@ -159,7 +159,7 @@ The following option values may be configured -: | 3 | NORMAL mode – toggle with memory switch type | | 4 | BRIGHTNESS mode – momentary switch type | | 5 | BRIGHTNESS mode – toggle switch type | -| 6 | BRIGHTNESS mode – toggle with memory switch type | +| 6 | BRIGHTNESS – toggle with memory switch | | 7 | RAINBOW mode – momentary switch type | | 8 | SCENE mode – momentary switch type | | 9 | SCENE mode – toggle switch type | @@ -348,9 +348,9 @@ The following option values may be configured -: | Value | Description | |--------|-------------| | 0 | Four dimmers mode disabled | -| 1 | Four dimmers mode enabled – momentary switch type | -| 2 | Four dimmers mode enabled – toggle switch type | -| 3 | Four dimmers mode enabled – toggle with memory switch type | +| 1 | 4 dimmers mode – momentary switch type | +| 2 | 4 dimmers mode – toggle switch | +| 3 | 4 dimmers mode – toggle with memory switch | The manufacturer defined default value is ```0``` (Four dimmers mode disabled). diff --git a/_addons_bindings/zwave/doc/qubino/zmnhxd_0_0.md b/_addons_bindings/zwave/doc/qubino/zmnhxd_0_0.md index 2e9a720bb..f3d4eee04 100644 --- a/_addons_bindings/zwave/doc/qubino/zmnhxd_0_0.md +++ b/_addons_bindings/zwave/doc/qubino/zmnhxd_0_0.md @@ -105,148 +105,128 @@ The installation process, tested and approved by professional electricians, cons The following table summarises the channels available for the ZMNHXD -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Electric meter (power factor) | meter_powerfactor | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (kVAh) | meter_kvah | Energy | Number | -| Electric meter (power factor) 1 | meter_powerfactor1 | Energy | Number | -| Electric meter (watts) 1 | meter_watts1 | Energy | Number | -| Electric meter (kWh) 1 | meter_kwh1 | Energy | Number | -| Electric meter (kVAh) 1 | meter_kvah1 | Energy | Number | -| Electric meter (power factor) 2 | meter_powerfactor2 | Energy | Number | -| Electric meter (amps) 2 | meter_current2 | Energy | Number | -| Electric meter (watts) 2 | meter_watts2 | Energy | Number | -| Electric meter (volts) 2 | meter_voltage2 | Energy | Number | -| Electric meter (power factor) 3 | meter_powerfactor3 | Energy | Number | -| Electric meter (amps) 3 | meter_current3 | Energy | Number | -| Electric meter (watts) 3 | meter_watts3 | Energy | Number | -| Electric meter (volts) 3 | meter_voltage3 | Energy | Number | -| Electric meter (power factor) 4 | meter_powerfactor4 | Energy | Number | -| Electric meter (amps) 4 | meter_current4 | Energy | Number | -| Electric meter (watts) 4 | meter_watts4 | Energy | Number | -| Electric meter (volts) 4 | meter_voltage4 | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Electric meter (power factor) | meter_powerfactor | meter_powerfactor | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (kVAh) | meter_kvah | meter_kvah | Energy | Number | +| Electric meter (power factor) 1 | meter_powerfactor1 | meter_powerfactor | Energy | Number | +| Electric meter (watts) 1 | meter_watts1 | meter_watts | Energy | Number | +| Electric meter (kWh) 1 | meter_kwh1 | meter_kwh | Energy | Number | +| Electric meter (kVAh) 1 | meter_kvah1 | meter_kvah | Energy | Number | +| Electric meter (power factor) 2 | meter_powerfactor2 | meter_powerfactor | Energy | Number | +| Electric meter (amps) 2 | meter_current2 | meter_current | Energy | Number | +| Electric meter (watts) 2 | meter_watts2 | meter_watts | Energy | Number | +| Electric meter (volts) 2 | meter_voltage2 | meter_voltage | Energy | Number | +| Electric meter (power factor) 3 | meter_powerfactor3 | meter_powerfactor | Energy | Number | +| Electric meter (amps) 3 | meter_current3 | meter_current | Energy | Number | +| Electric meter (watts) 3 | meter_watts3 | meter_watts | Energy | Number | +| Electric meter (volts) 3 | meter_voltage3 | meter_voltage | Energy | Number | +| Electric meter (power factor) 4 | meter_powerfactor4 | meter_powerfactor | Energy | Number | +| Electric meter (amps) 4 | meter_current4 | meter_current | Energy | Number | +| Electric meter (watts) 4 | meter_watts4 | meter_watts | Energy | Number | +| Electric meter (volts) 4 | meter_voltage4 | meter_voltage | Energy | Number | ### Electric meter (power factor) - Indicates the instantaneous power factor. -The ```meter_powerfactor``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kVAh) - Indicates the energy consumption (kVAh). -The ```meter_kvah``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kvah``` channel is of type ```meter_kvah``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (power factor) 1 - Indicates the instantaneous power factor. -The ```meter_powerfactor1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor1``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) 1 - Indicates the instantaneous power consumption. -The ```meter_watts1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts1``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 1 - Indicates the energy consumption (kWh). -The ```meter_kwh1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh1``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kVAh) 1 - Indicates the energy consumption (kVAh). -The ```meter_kvah1``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kvah1``` channel is of type ```meter_kvah``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (power factor) 2 - Indicates the instantaneous power factor. -The ```meter_powerfactor2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor2``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) 2 - Indicates the instantaneous current consumption. -The ```meter_current2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current2``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) 2 - Indicates the instantaneous power consumption. -The ```meter_watts2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts2``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) 2 - Indicates the instantaneous voltage. -The ```meter_voltage2``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage2``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (power factor) 3 - Indicates the instantaneous power factor. -The ```meter_powerfactor3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor3``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) 3 - Indicates the instantaneous current consumption. -The ```meter_current3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current3``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) 3 - Indicates the instantaneous power consumption. -The ```meter_watts3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts3``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) 3 - Indicates the instantaneous voltage. -The ```meter_voltage3``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage3``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (power factor) 4 - Indicates the instantaneous power factor. -The ```meter_powerfactor4``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_powerfactor4``` channel is of type ```meter_powerfactor``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) 4 - Indicates the instantaneous current consumption. -The ```meter_current4``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current4``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) 4 - Indicates the instantaneous power consumption. -The ```meter_watts4``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts4``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) 4 - Indicates the instantaneous voltage. -The ```meter_voltage4``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage4``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. diff --git a/_addons_bindings/zwave/doc/quby/en00_0_0.md b/_addons_bindings/zwave/doc/quby/en00_0_0.md new file mode 100644 index 000000000..f9a685202 --- /dev/null +++ b/_addons_bindings/zwave/doc/quby/en00_0_0.md @@ -0,0 +1,288 @@ +--- +layout: documentation +title: EN00 - ZWave +--- + +{% include base.html %} + +# EN00 Engie Meter Adapter +This describes the Z-Wave device *EN00*, manufactured by *Quby* with the thing type UID of ```quby_en00_00_000```. + +The device is in the category of *Sensor*, defining Device used to measure something. + +![EN00 product image](https://www.cd-jackson.com/zwave_device_uploads/1070/1070_default.png) + + +The EN00 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 between other devices in the mesh network. + +## Overview + +The meter adapter measures gas and electricity usage of analog meters. The analog meters are read by means of optical sensors that can be placed on the meter to monitor the rotating disc or the blinking LED. The meter adapter measures the cumulative and instantaneous gas and electricity consumption. + +### Inclusion Information + +To add the Meter Module into a Z-Wave network, the inclusion process should be started on the controller. In factory default mode, the Meter Module will try to join a Z-Wave network automatically after being plugged into a power socket. If the Meter Module was previously included in a Z-Wave network, or was not just plugged into a power socket, one needs to triple-press the button (quickly). + +### Exclusion Information + +The button on the Meter Module should be triple-pressed (quickly). + +## Channels + +The following table summarises the channels available for the EN00 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Gas meter (cubic meters) | meter_gas_cubic_meters | meter_gas_cubic_meters | Energy | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | + +### Gas meter (cubic meters) +Indicates the gas use in cubic meters. + +The ```meter_gas_cubic_meters``` channel is of type ```meter_gas_cubic_meters``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Clock Time Offset +Provides the current time difference for the devices time. + +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. + + + +## Device Configuration + +The following table provides a summary of the 6 configuration parameters available in the EN00. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Analog gas/heat port mode | Analog gas/heat port mode | +| 2 | Analog gas/heat port resolution | Analog gas/heat port resolution | +| 3 | Analog electricity port mode | Analog electricity port mode | +| 4 | Analog electricity port resolution | Analog electricity port resolution | +| 5 | Digital port mode | Digital port mode | +| 255 | Restart device | Restart device | + +### Parameter 1: Analog gas/heat port mode + +Analog gas/heat port mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Gas Enabled | +| 2 | Heat Enabled | + +The manufacturer defined default value is ```1``` (Gas Enabled). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Analog gas/heat port resolution + +Analog gas/heat port resolution +Analog gas/heat port resolution + +(pulses per cubic meter / pulses per MJ; in Q14.2 notation) +Values in the range 120 to 40000 may be set. + +The manufacturer defined default value is ```400```. + +This parameter has the configuration ID ```config_2_4``` and is of type ```INTEGER```. + + +### Parameter 3: Analog electricity port mode + +Analog electricity port mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Electricity import enabled | +| 2 | Electricity export enabled | + +The manufacturer defined default value is ```1``` (Electricity import enabled). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Analog electricity port resolution + +Analog electricity port resolution +Analog electricity port resolution + +(pulses per kWh; in Q14.2 notation) +Values in the range 120 to 40000 may be set. + +The manufacturer defined default value is ```400```. + +This parameter has the configuration ID ```config_4_4``` and is of type ```INTEGER```. + + +### Parameter 5: Digital port mode + +Digital port mode + +Values in the range 0 to 2 may be set. + +The manufacturer defined default value is ```2```. + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 255: Restart device + +Restart device + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Restart entire device | +| 2 | Restart metering chip | + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_255_1``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The EN00 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_APPLICATION_STATUS_V1| | +| COMMAND_CLASS_METER_V2| | +| COMMAND_CLASS_METER_TBL_CONFIG_V1| | +| COMMAND_CLASS_METER_TBL_MONITOR_V1| | +| COMMAND_CLASS_CRC_16_ENCAP_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_MULTI_CHANNEL_V2| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_TIME_PARAMETERS_V1| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 1 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_METER_TBL_CONFIG_V1| | +| COMMAND_CLASS_METER_TBL_MONITOR_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 2 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_METER_TBL_CONFIG_V1| | +| COMMAND_CLASS_METER_TBL_MONITOR_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 3 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_METER_TBL_CONFIG_V1| | +| COMMAND_CLASS_METER_TBL_MONITOR_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 4 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_METER_TBL_CONFIG_V1| | +| COMMAND_CLASS_METER_TBL_MONITOR_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 5 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_METER_TBL_CONFIG_V1| | +| COMMAND_CLASS_METER_TBL_MONITOR_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 6 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_METER_TBL_CONFIG_V1| | +| COMMAND_CLASS_METER_TBL_MONITOR_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 7 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_METER_TBL_CONFIG_V1| | +| COMMAND_CLASS_METER_TBL_MONITOR_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 8 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_METER_TBL_CONFIG_V1| | +| COMMAND_CLASS_METER_TBL_MONITOR_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +#### Endpoint 9 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_METER_TBL_CONFIG_V1| | +| COMMAND_CLASS_METER_TBL_MONITOR_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | + +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/1070/MM-documentation.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1070). diff --git a/_addons_bindings/zwave/doc/rcs/tbz48_0_0.md b/_addons_bindings/zwave/doc/rcs/tbz48_0_0.md index afb7ad667..ee45cb208 100644 --- a/_addons_bindings/zwave/doc/rcs/tbz48_0_0.md +++ b/_addons_bindings/zwave/doc/rcs/tbz48_0_0.md @@ -8,37 +8,59 @@ title: TBZ48 - ZWave # TBZ48 Thermostat This describes the Z-Wave device *TBZ48*, manufactured by *Residential Control Systems, Inc. (RCS)* with the thing type UID of ```rcs_tbz48_00_000```. +The device is in the category of *HVAC*, defining Air condition devices, Fans. + +![TBZ48 product image](https://www.cd-jackson.com/zwave_device_uploads/260/260_default.png) + + The TBZ48 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. ## 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/260) to improve the documentation. +The Z-Wave Thermostat (GC-TBZ48) is a programmable, Z-Wave communicating thermostat. It can be powered using 24VAC (if both “R”&”C”wires are available at the thermostat), or using four (4) AA batteries. Using Z-Wave technology, end users have the ability to use the 2GIG Go!Control panel to control the thermostat, configure programming settings, as well as to display current conditions in the home or office. + +### Inclusion Information + + 1. Press any button to take thermostat out of sleep mode. + 2. Press and hold FAN button for 5 seconds. SETUP will be displayed in the status display line. + 3. Scroll to “Z-Wave” using up & down buttons. Press SELECT. + 4. When prompted by your Z-Wave controller, Press the YES button on in the Z-Wave Install screen. + 5. Press SELECT (mode button) to add thermostat to network + +### Exclusion Information + + 1. Set your primary controller to Include, add or Install mode, to add the thermostat as a node on your network (see your controller’s user manual for detailed instructions). + 2. Press any button to take thermostat out of sleep mode. + 3. Press and hold FAN button for 5 seconds. SETUP will be displayed in the status display line. + 4. Scroll to “Z-Wave” using up/down buttons. Press SELECT. + 5. When prompted by your Z-Wave controller, Press the YES button in the Z-Wave Install screen. + 6. Press SELECT (mode button) to add thermostat to network. + 7. Display line should fl ash WAIT then SUCCESS if Z-Wave connection is made. + 8. If Z-Wave does not connect to controller, WAIT, then FAIL will flash in status display line.  ## Channels The following table summarises the channels available for the TBZ48 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Setpoint (cooling) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Thermostat fan mode | thermostat_fanmode | | | -| Thermostat fan state | thermostat_fanstate | | | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode | thermostat_fanmode | thermostat_fanmode | | | +| Thermostat fan state | thermostat_fanstate | thermostat_fanstate | | | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -59,31 +81,26 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Setpoint (cooling) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode - Channel type information on this channel is not found. ### Thermostat fan state - Channel type information on this channel is not found. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -96,8 +113,9 @@ Association groups allow the device to send unsolicited reports to the controlle The TBZ48 supports 3 association groups. -### Group 1: Group 1 +### Group 1: Lifeline +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. Association group 1 supports 5 nodes. @@ -135,6 +153,10 @@ Association group 3 supports 5 nodes. | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_MULTI_CMD_V1| | +### Documentation Links + +* [Installation Manual](https://www.cd-jackson.com/zwave_device_uploads/260/GC-TBZ48-Install.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/rcs/tz43_0_0.md b/_addons_bindings/zwave/doc/rcs/tz43_0_0.md index 0dbf7ab51..0ea13b0f7 100644 --- a/_addons_bindings/zwave/doc/rcs/tz43_0_0.md +++ b/_addons_bindings/zwave/doc/rcs/tz43_0_0.md @@ -8,38 +8,52 @@ title: TZ43 - ZWave # TZ43 Thermostat This describes the Z-Wave device *TZ43*, manufactured by *Residential Control Systems, Inc. (RCS)* with the thing type UID of ```rcs_tz43_00_000```. +The device is in the category of *HVAC*, defining Air condition devices, Fans. + +![TZ43 product image](https://www.cd-jackson.com/zwave_device_uploads/380/380_default.png) + + The TZ43 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 between other devices in the mesh network. ## 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/380) to improve the documentation. +The TZ43 thermostat provides for typical thermostat control of a central heating and cooling HVAC system plus has the added feature of ZWave communications for remote control. + +The thermostat has a large, backlit graphical display, control buttons, status LEDs and a temperature sensor. The thermostat can display multiple screens for different functions of the thermostat. In the default thermostat control screen, shown below, it displays the current temperature, setpoint, system mode, manual fan mode, time, outside temperature and other information.   + +### Inclusion Information + + 1. Navigate to the Z-Wave Install Button screen. This screen is located in the Installer Screen. To enter this screen, go to the main menu screen and press and hold the two inner buttons for 3 seconds until the Installer Settings screen appears. Scroll down until the Z-Wave Install Btn menu item is selected, press the Select button. + 2. Press the YES button.   + +### Exclusion Information + +Not provided ## Channels The following table summarises the channels available for the TZ43 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Operating State | thermostat_state | Temperature | Number | -| Setpoint (cooling) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Thermostat fan mode | thermostat_fanmode | | | -| Thermostat fan state | thermostat_fanstate | | | -| Clock Time Offset | time_offset | Temperature | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode | thermostat_fanmode | thermostat_fanmode | | | +| Thermostat fan state | thermostat_fanstate | thermostat_fanstate | | | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -60,10 +74,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State - Sets the thermostat operating state. -The ```thermostat_state``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -77,42 +90,385 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (cooling) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode - Channel type information on this channel is not found. ### Thermostat fan state - Channel type information on this channel is not found. ### Clock Time Offset - Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 24 configuration parameters available in the TZ43. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | System Type | System Type | +| 2 | Fan Type | Fan Type | +| 3 | Change Over Type | Change Over Type | +| 4 | C/F Type | C/F Type | +| 9 | Display Lock | Display Lock | +| 10 | MOT | Minimum OFF Time | +| 11 | MRT | Minimum Run Time | +| 12 | H Delta Stage 1 On | H Delta Stage 1 On | +| 13 | H Delta Stage 1 Off | H Delta Stage 1 Off | +| 14 | H Delta Stage 2 On | H Delta Stage 2 On | +| 15 | H Delta Stage 2 Off | H Delta Stage 2 Off | +| 16 | H Delta Stage 3 On | H Delta Stage 3 On | +| 17 | H Delta Stage 3 Off | H Delta Stage 3 Off | +| 18 | C Delta Stage 1 On | C Delta Stage 1 On | +| 19 | C Delta Stage 1 Off | C Delta Stage 1 Off | +| 20 | C Delta Stage 2 On | C Delta Stage 2 On | +| 21 | C Delta Stage 2 Off | C Delta Stage 2 Off | +| 25 | SB Mode | Setback mode | +| 69 | Service Mode (Test) | Service Mode (Test) | +| 75 | Fan Cycler ON Time | Fan Cycler ON Time | +| 76 | Fan Cycler OFF Time | Fan Cycler OFF Time | +| 77 | 2nd Stage Heat Enable | 2nd Stage Heat Enable | +| 78 | Aux Heat Enable | Aux Heat Enable | +| 79 | 2nd Stage Cool Enable | 2nd Stage Cool Enable | + +### Parameter 1: System Type + +System Type +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Gas/Elec | +| 1 | HeatPump | + +The manufacturer defined default value is ```0``` (Gas/Elec). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Fan Type + +Fan Type +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Gas | +| 1 | Elec | + +The manufacturer defined default value is ```0``` ( Gas). + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Change Over Type + +Change Over Type +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | w/Cool | +| 1 | w/Heat | + +The manufacturer defined default value is ```0``` ( w/Cool). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: C/F Type + +C/F Type + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | C | +| 1 | F | + +The manufacturer defined default value is ```1``` (F). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 9: Display Lock + +Display Lock + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Unlocked | +| 1 | Locked | + +The manufacturer defined default value is ```0``` ( Unlocked). + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: MOT + +Minimum OFF Time +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 5 to 9 may be set. + +The manufacturer defined default value is ```6```. + +This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```. + + +### Parameter 11: MRT + +Minimum Run Time +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 1 to 9 may be set. + +The manufacturer defined default value is ```6```. + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + + +### Parameter 12: H Delta Stage 1 On + +H Delta Stage 1 On +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 1 to 8 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```. + + +### Parameter 13: H Delta Stage 1 Off + +H Delta Stage 1 Off +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 8 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```. + + +### Parameter 14: H Delta Stage 2 On + +H Delta Stage 2 On +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 1 to 8 may be set. + +The manufacturer defined default value is ```4```. + +This parameter has the configuration ID ```config_14_1``` and is of type ```INTEGER```. + + +### Parameter 15: H Delta Stage 2 Off + +H Delta Stage 2 Off +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 8 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_15_1``` and is of type ```INTEGER```. + + +### Parameter 16: H Delta Stage 3 On + +H Delta Stage 3 On +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 1 to 8 may be set. + +The manufacturer defined default value is ```6```. + +This parameter has the configuration ID ```config_16_1``` and is of type ```INTEGER```. + + +### Parameter 17: H Delta Stage 3 Off + +H Delta Stage 3 Off +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 8 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_17_1``` and is of type ```INTEGER```. + + +### Parameter 18: C Delta Stage 1 On + +C Delta Stage 1 On +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 1 to 8 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_18_1``` and is of type ```INTEGER```. + + +### Parameter 19: C Delta Stage 1 Off + +C Delta Stage 1 Off +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 8 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```. + + +### Parameter 20: C Delta Stage 2 On + +C Delta Stage 2 On +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 1 to 8 may be set. + +The manufacturer defined default value is ```4```. + +This parameter has the configuration ID ```config_20_1``` and is of type ```INTEGER```. + + +### Parameter 21: C Delta Stage 2 Off + +C Delta Stage 2 Off +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 8 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_21_1``` and is of type ```INTEGER```. + + +### Parameter 25: SB Mode + +Setback mode +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | No Setback | +| 1 | Setback | + +The manufacturer defined default value is ```0``` (No Setback). + +This parameter has the configuration ID ```config_25_1``` and is of type ```INTEGER```. + + +### Parameter 69: Service Mode (Test) + +Service Mode (Test) +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | No Service Mode | +| 1 | Service Mode enabled | + +The manufacturer defined default value is ```0``` ( No Service Mode). + +This parameter has the configuration ID ```config_69_1``` and is of type ```INTEGER```. + + +### Parameter 75: Fan Cycler ON Time + +Fan Cycler ON Time +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 120 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_75_1``` and is of type ```INTEGER```. + + +### Parameter 76: Fan Cycler OFF Time + +Fan Cycler OFF Time +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +Values in the range 0 to 120 may be set. + +The manufacturer defined default value is ```20```. + +This parameter has the configuration ID ```config_76_1``` and is of type ```INTEGER```. + + +### Parameter 77: 2nd Stage Heat Enable + +2nd Stage Heat Enable +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | No 2nd Stage Heat | +| 1 | 2nd Stage Heat | + +The manufacturer defined default value is ```0``` ( No 2nd Stage Heat). + +This parameter has the configuration ID ```config_77_1``` and is of type ```INTEGER```. + + +### Parameter 78: Aux Heat Enable + +Aux Heat Enable +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | No Aux Heat | +| 1 | Aux Heat enabled | + +The manufacturer defined default value is ```0``` ( No Aux Heat). + +This parameter has the configuration ID ```config_78_1``` and is of type ```INTEGER```. + + +### Parameter 79: 2nd Stage Cool Enable + +2nd Stage Cool Enable +This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | No 2nd Stage Cool | +| 1 | 2nd Stage Cool | + +The manufacturer defined default value is ```0``` ( No 2nd Stage Cool). + +This parameter has the configuration ID ```config_79_1``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The TZ43 supports 1 association group. + +### Group 1: Group 1 + + +Association group 1 supports 1 node. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/rcs/tz45_0_0.md b/_addons_bindings/zwave/doc/rcs/tz45_0_0.md index 022fbd01f..22297f7f6 100644 --- a/_addons_bindings/zwave/doc/rcs/tz45_0_0.md +++ b/_addons_bindings/zwave/doc/rcs/tz45_0_0.md @@ -17,42 +17,47 @@ The TZ45 supports routing. This allows the device to communicate using other rou ## Overview +The Z-Wave thermostat provides for typical thermostat control of a central heating and cooling HVAC system plus has the added feature of Z-Wave communications for remote control. + +The thermostat has a large, backlit graphical display, control buttons, status LEDs and a temperature sensor. The thermostat can display multiple screens for different functions of the thermostat. The default thermostat control screen shown below, will display the current room temperature, heating and cooling setpoints, system mode, manual-fan mode, time, and status information.  + ### Inclusion Information General Programming Procedure (for controllers supporting the thermostat device class): 1. Set your primary controller to Include mode, to add the thermostat as a node on your network (see your controller’s user manual for detailed instructions). 2. In the Thermostat’s Main Menu, scroll down to the ZWave Install item. Select the item. 3. Press the YES button in the ZWave Install screen. +### Exclusion Information + +Not Provided + ## Channels The following table summarises the channels available for the TZ45 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Scene Number | scene_number | | Number | -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Operating State | thermostat_state | Temperature | Number | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (cooling) | thermostat_setpoint | Temperature | Number:Temperature | -| Thermostat fan mode | thermostat_fanmode | | | -| Thermostat fan state | thermostat_fanstate | | | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Scene Number | scene_number | scene_number | | Number | +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode | thermostat_fanmode | thermostat_fanmode | | | +| Thermostat fan state | thermostat_fanstate | thermostat_fanstate | | | ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -73,10 +78,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State - Sets the thermostat operating state. -The ```thermostat_state``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -90,23 +94,19 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (cooling) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode - Channel type information on this channel is not found. ### Thermostat fan state - Channel type information on this channel is not found. @@ -119,7 +119,13 @@ The device has no configuration parameters defined. Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The TZ45 supports 1 association group. + +### Group 1: Group 1 + + +Association group 1 supports 1 node. + ## Technical Information ### Endpoints diff --git a/_addons_bindings/zwave/doc/reitz/05431_0_0.md b/_addons_bindings/zwave/doc/reitz/05431_0_0.md index f6c6ce6d0..81faee3fa 100644 --- a/_addons_bindings/zwave/doc/reitz/05431_0_0.md +++ b/_addons_bindings/zwave/doc/reitz/05431_0_0.md @@ -8,25 +8,37 @@ title: Reitz 05431 - ZWave # Reitz 05431 Duewi ZW BJ ES 1000 / Reitz 05431 / ZWave.me 05457 Single button wall switch This describes the Z-Wave device *Reitz 05431*, manufactured by *Reitz-Group.de* with the thing type UID of ```reitz_05431_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![Reitz 05431 product image](https://www.cd-jackson.com/zwave_device_uploads/55/55_default.png) + + The Reitz 05431 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 between other devices in the mesh network. ## 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/55) to improve the documentation. +For wireless switching of: light bulbs, HV and LV halogen lamps or electrical equipment (e.g. fans). Combinable with all Z-Wave transmitters and remote controls, with installation in splash-proof junction box IP 44, can be selectively installed in flush-mounted power points and canopies or triggered directly via wireless rockers. + +### Inclusion Information + +Press 3x within 1.5 seconds the "UP" or "DOWN" button for the group on the remote control in which the device is to be included. + +### Exclusion Information + +In the case of a flush mounted module press 3x within 1.5 seconds either the "UP" 1 or the "DOWN" 2 button. ## Channels The following table summarises the channels available for the Reitz 05431 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -39,16 +51,15 @@ Detailed information on each parameter can be found in the sections below. |-------|-------|-------------| | 1 | Set LED indication mode | | | 2 | Automatic switch off | If not zero, automatically switch off after a user defined time | -| 3 | Function of RF off command | Defines how to interpret RF Off command. Can be used in conjunction with Auto Off function: Ignore - to switch on the light by motion detectors and switch it off after some amount of time: in case of multiple motion detectors each would try to switch the | -| 4 | Switch on dimming by buttons | Defines if the switch should change it state to on/off if it is dimmed by buttons | -| 5 | Switch on dimming by buttons | Defines if the switch should restore switch state to the last state prior to device power off (power cycle). | -| 10 | Typical click timeout | Typical time used to differentiate click, hold, double and triple clicks -Defined in 10ms ticks. | -| 11 | Invert buttons | | -| 12 | Switch by buttons | If disabled, the local operations by buttons will not switch the load, but only send commands to On/Off association group. In this mode buttons are not linked with the switch anymore. They can be used separately: buttons to control remote device, switch w | -| 13 | Action on button single press or hold | Defines which command should be sent on button single press or hold. Basic commands are sent to Association group. Switch All commands are sent broadcast. | -| 14 | Action on button double press or hold | Defines which command should be sent on button double press or press-hold. Basic commands are sent to Association group. Switch All commands are sent broadcast. If not disabled, the device will wait for a click timeout to see if the second click would be | -| 15 | Send the following switch all commands | | +| 3 | Function of RF off command | Function of RF off command | +| 4 | Switch on dimming by buttons | Switch on dimming by buttons | +| 5 | Switch on dimming by buttons | Switch on dimming by buttons | +| 10 | Typical click timeout | Typical click timeout | +| 11 | Invert buttons | Invert buttons | +| 12 | Switch by buttons | Switch by buttons | +| 13 | Action on button single press or hold | Action on button single press or hold | +| 14 | Action on button double press or hold | Action on button double press or hold | +| 15 | Send the following switch all commands | Send the following switch all commands | | 16 | What to do on button Down press | | | | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | @@ -83,8 +94,8 @@ This parameter has the configuration ID ```config_2_2``` and is of type ```INTEG ### Parameter 3: Function of RF off command -Defines how to interpret RF Off command. Can be used in conjunction with Auto Off function: Ignore - to switch on the light by motion detectors and switch it off after some amount of time: in case of multiple motion detectors each would try to switch the - +Function of RF off command +Defines how to interpret RF Off command. Can be used in conjunction with Auto Off function: Ignore - to switch on the light by motion detectors and switch it off after some amount of time: in case of multiple motion detectors each would try to switch the  The following option values may be configured -: | Value | Description | @@ -101,8 +112,8 @@ This parameter has the configuration ID ```config_3_1``` and is of type ```INTEG ### Parameter 4: Switch on dimming by buttons +Switch on dimming by buttons Defines if the switch should change it state to on/off if it is dimmed by buttons - The following option values may be configured -: | Value | Description | @@ -117,8 +128,8 @@ This parameter has the configuration ID ```config_4_1``` and is of type ```INTEG ### Parameter 5: Switch on dimming by buttons +Switch on dimming by buttons Defines if the switch should restore switch state to the last state prior to device power off (power cycle). - The following option values may be configured -: | Value | Description | @@ -133,9 +144,10 @@ This parameter has the configuration ID ```config_5_1``` and is of type ```INTEG ### Parameter 10: Typical click timeout -Typical time used to differentiate click, hold, double and triple clicks -Defined in 10ms ticks. +Typical click timeout +Typical time used to differentiate click, hold, double and triple clicks +Defined in 10ms ticks. Values in the range 1 to 100 may be set. The manufacturer defined default value is ```50```. @@ -145,7 +157,7 @@ This parameter has the configuration ID ```config_10_1``` and is of type ```INTE ### Parameter 11: Invert buttons - +Invert buttons The following option values may be configured -: @@ -161,8 +173,8 @@ This parameter has the configuration ID ```config_11_1``` and is of type ```INTE ### Parameter 12: Switch by buttons +Switch by buttons If disabled, the local operations by buttons will not switch the load, but only send commands to On/Off association group. In this mode buttons are not linked with the switch anymore. They can be used separately: buttons to control remote device, switch w - The following option values may be configured -: | Value | Description | @@ -178,8 +190,8 @@ This parameter has the configuration ID ```config_12_1``` and is of type ```INTE ### Parameter 13: Action on button single press or hold +Action on button single press or hold Defines which command should be sent on button single press or hold. Basic commands are sent to Association group. Switch All commands are sent broadcast. - The following option values may be configured -: | Value | Description | @@ -188,18 +200,18 @@ The following option values may be configured -: | 1 | Switch On, Off and dim using Basic Set | | 2 | Switch All | | 3 | Send Scenes | -| 4 | Switch On/Off and Dim (send Basic Set and Switch Multilevel) (Default) | +| 4 | Switch On/Off and Dim | | 5 | Send Preconfigured Scenes | -The manufacturer defined default value is ```4``` (Switch On/Off and Dim (send Basic Set and Switch Multilevel) (Default)). +The manufacturer defined default value is ```4``` (Switch On/Off and Dim). This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```. ### Parameter 14: Action on button double press or hold -Defines which command should be sent on button double press or press-hold. Basic commands are sent to Association group. Switch All commands are sent broadcast. If not disabled, the device will wait for a click timeout to see if the second click would be - +Action on button double press or hold +Defines which command should be sent on button double press or press-hold. Basic commands are sent to Association group. Switch All commands are sent broadcast. If not disabled, the device will wait for a click timeout to see if the second click would be  The following option values may be configured -: | Value | Description | @@ -208,7 +220,7 @@ The following option values may be configured -: | 1 | Switch On, Off and dim using Basic Set | | 2 | Switch All | | 3 | Send Scenes | -| 4 | Switch On/Off and Dim (send Basic Set and Switch Multilevel) | +| 4 | Switch On/Off and Dim | | 5 | Send Preconfigured Scenes | The manufacturer defined default value is ```0``` (Disabled (Default)). @@ -218,7 +230,7 @@ This parameter has the configuration ID ```config_14_1``` and is of type ```INTE ### Parameter 15: Send the following switch all commands - +Send the following switch all commands The following option values may be configured -: @@ -297,6 +309,7 @@ Association group 3 supports 8 nodes. | COMMAND_CLASS_BASIC_V1| | | COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_PROTECTION_V1| | | COMMAND_CLASS_HAIL_V1| | diff --git a/_addons_bindings/zwave/doc/reitz/05433_0_0.md b/_addons_bindings/zwave/doc/reitz/05433_0_0.md index 0be9c4f5b..0e6f62ea2 100644 --- a/_addons_bindings/zwave/doc/reitz/05433_0_0.md +++ b/_addons_bindings/zwave/doc/reitz/05433_0_0.md @@ -10,26 +10,36 @@ This describes the Z-Wave device *05433*, manufactured by *Reitz-Group.de* with The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. +![05433 product image](https://www.cd-jackson.com/zwave_device_uploads/51/51_default.png) + + The 05433 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 between other devices in the mesh network. ## 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/51) to improve the documentation. +For wireless dimming of: light bulbs, HV and LV halogen lamps with conventional transformer. Combinable with all Z-Wave transmitters and remote controls. For installation in splash-proof junction box IP 44, can be selectively installed in flush-mounted power points and canopies or triggered directly via wireless rockers. + +### Inclusion Information + +Press the "Include" button 3 times + +### Exclusion Information + +Press the "Exclude" button for 2 seconds ## Channels The following table summarises the channels available for the 05433 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. diff --git a/_addons_bindings/zwave/doc/reitz/05443_0_0.md b/_addons_bindings/zwave/doc/reitz/05443_0_0.md index 2aa1e4276..5c50e2951 100644 --- a/_addons_bindings/zwave/doc/reitz/05443_0_0.md +++ b/_addons_bindings/zwave/doc/reitz/05443_0_0.md @@ -8,6 +8,8 @@ title: Duwi ZW WS - 05443 - ZWave # Duwi ZW WS - 05443 Battery powered One paddle wall controller This describes the Z-Wave device *Duwi ZW WS - 05443*, manufactured by *Reitz-Group.de* with the thing type UID of ```reitz_05443_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + ![Duwi ZW WS - 05443 product image](https://www.cd-jackson.com/zwave_device_uploads/54/54_default.jpg) @@ -15,10 +17,16 @@ The Duwi ZW WS - 05443 does not permanently listen for messages sent from the co ## Overview +For wireless switching, resp. control of: all Z-Wave wireless switch inserts and wireless intermediate plugs, existing installations can also be expanded without flush-mounted power point, high flexibility with installation due to extremely flat design, to stick or screw on to various substrates, for installation in existing switch box or clipping-in in multiple combinations. + ### Inclusion Information Press inclusion button for 2 seconds +### Exclusion Information + +Press Exclude button for 2 seconds + ### Wakeup Information The Duwi ZW WS - 05443 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. @@ -32,23 +40,21 @@ Button triple press on on/off The following table summarises the channels available for the Duwi ZW WS - 05443 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/reitz/064394_0_0.md b/_addons_bindings/zwave/doc/reitz/064394_0_0.md index 246f62b76..7ae662478 100644 --- a/_addons_bindings/zwave/doc/reitz/064394_0_0.md +++ b/_addons_bindings/zwave/doc/reitz/064394_0_0.md @@ -8,26 +8,42 @@ title: 064394 - ZWave # 064394 Schuko Plug Dimmer This describes the Z-Wave device *064394*, manufactured by *Reitz-Group.de* with the thing type UID of ```reitz_064394_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![064394 product image](https://www.cd-jackson.com/zwave_device_uploads/53/53_default.png) + + The 064394 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 between other devices in the mesh network. ## 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/53) to improve the documentation. +For wireless dimming of: light bulbs, HV and LV halogen lamps with conventional transformer, combinable with all Z-Wave transmitters and remote controls. + +### Inclusion Information + +In the case of a plug adaptor press 3x within 1.5 seconds the function button; + +during this process the device retains its last switching status ("on" or "off"). + +### Exclusion Information + +In the case of a plug adaptor press 3x within 1.5 seconds the function button, + +during this process the device retains its last switching status ("on" or "off"). ## Channels The following table summarises the channels available for the 064394 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. @@ -58,6 +74,10 @@ The device does not support associations. | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_INDICATOR_V1| | +### Documentation Links + +* [Duwi Manual](https://www.cd-jackson.com/zwave_device_uploads/53/Duwi.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/reitz/zme05431_0_0.md b/_addons_bindings/zwave/doc/reitz/zme05431_0_0.md index dd8268887..ba237de62 100644 --- a/_addons_bindings/zwave/doc/reitz/zme05431_0_0.md +++ b/_addons_bindings/zwave/doc/reitz/zme05431_0_0.md @@ -10,6 +10,9 @@ This describes the Z-Wave device *ZME_05431*, manufactured by *Reitz-Group.de* w The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. +![ZME_05431 product image](https://www.cd-jackson.com/zwave_device_uploads/566/566_default.png) + + The ZME_05431 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 between other devices in the mesh network. ## Overview @@ -65,44 +68,39 @@ If the controller is in exclusion mode, press one of the buttons three times The following table summarises the channels available for the ZME_05431 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. @@ -406,6 +404,10 @@ Association group 3 supports 5 nodes. | COMMAND_CLASS_INDICATOR_V1| | | COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V2| | +### Documentation Links + +* [Duwi Manual](https://www.cd-jackson.com/zwave_device_uploads/566/Duwi.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/reitz/zwesj300_0_0.md b/_addons_bindings/zwave/doc/reitz/zwesj300_0_0.md index 8732dae11..8fcf8733a 100644 --- a/_addons_bindings/zwave/doc/reitz/zwesj300_0_0.md +++ b/_addons_bindings/zwave/doc/reitz/zwesj300_0_0.md @@ -8,10 +8,30 @@ title: ZW ESJ 300 - ZWave # ZW ESJ 300 Duwi ZW ESJ 300 Blind Control This describes the Z-Wave device *ZW ESJ 300*, manufactured by *Reitz-Group.de* with the thing type UID of ```reitz_zwesj300_00_000```. +The device is in the category of *Blinds*, defining Roller shutters, window blinds, etc.. + +![ZW ESJ 300 product image](https://www.cd-jackson.com/zwave_device_uploads/563/563_default.png) + + The ZW ESJ 300 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. Refer to the *Wakeup Information* section below for further information. ## Overview +Z-Wave Built-in Shade Controller.lush-mount Z-Wave shutter switch +For wireless control of: Shutters, awnings, sun blinds, garage door drives or stairwell light, combinable with all Z-Wave transmitters and remote controls. + +### Inclusion Information + +In the case of a flush mounted module press 3x within 1.5 seconds either the "UP" or "DOWN" button. + +During this process you can choose whether the device and any connected neighbouring devices switch on (by pressing the "UP" button) or switch off (by pressing the "DOWN" button). + +### Exclusion Information + +In the case of a flush mounted module press 3x within 1.5 seconds either the "UP" or the "DOWN" button. + +During this process you can choose whether the device and any connected neighbouring devices switch on (by pressing the "UP" button) or switch off (by pressing the "DOWN" button). + ### Wakeup Information The ZW ESJ 300 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. @@ -22,22 +42,20 @@ The wakeup period does not impact the devices ability to report events or sensor The following table summarises the channels available for the ZW ESJ 300 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Blinds Control | blinds_control | Blinds | Rollershutter | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Blinds Control | blinds_control | blinds_control | Blinds | Rollershutter | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Blinds Control - Provides start / stop control of blinds. -The ```blinds_control``` channel supports the ```Rollershutter``` item and is in the ```Blinds``` category. +The ```blinds_control``` channel is of type ```blinds_control``` and supports the ```Rollershutter``` item and is in the ```Blinds``` category. diff --git a/_addons_bindings/zwave/doc/remotec/adt8020_0_0.md b/_addons_bindings/zwave/doc/remotec/adt8020_0_0.md index 3fa57dfc4..dd4766c7d 100644 --- a/_addons_bindings/zwave/doc/remotec/adt8020_0_0.md +++ b/_addons_bindings/zwave/doc/remotec/adt8020_0_0.md @@ -8,32 +8,39 @@ title: ZRM-80 - ZWave # ZRM-80 Wall plug switch This describes the Z-Wave device *ZRM-80*, manufactured by *Remotec* with the thing type UID of ```remotec_adt8020_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![ZRM-80 product image](https://www.cd-jackson.com/zwave_device_uploads/692/692_default.png) + + The ZRM-80 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 between other devices in the mesh network. ## 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/692) to improve the documentation. +ZRW-80US Z-Wave Wall Switch + +### Inclusion Information + +Triple click the PROG button within 1 second. ## Channels The following table summarises the channels available for the ZRM-80 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. @@ -61,6 +68,10 @@ The device does not support associations. | COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +### Documentation Links + +* [Web Page](https://www.cd-jackson.com/zwave_device_uploads/692/ZRM-80SA.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/remotec/adt8021_0_0.md b/_addons_bindings/zwave/doc/remotec/adt8021_0_0.md index a45d38b0b..f4cfcf61a 100644 --- a/_addons_bindings/zwave/doc/remotec/adt8021_0_0.md +++ b/_addons_bindings/zwave/doc/remotec/adt8021_0_0.md @@ -8,44 +8,180 @@ title: ZDM-80 - ZWave # ZDM-80 Wall plug dimmer switch This describes the Z-Wave device *ZDM-80*, manufactured by *Remotec* with the thing type UID of ```remotec_adt8021_00_000```. +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![ZDM-80 product image](https://www.cd-jackson.com/zwave_device_uploads/693/693_default.png) + + The ZDM-80 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 between other devices in the mesh network. ## 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/693) to improve the documentation. +Dimming Module + +### Inclusion Information + +Triple click the PROG button within 1 second. ## Channels The following table summarises the channels available for the ZDM-80 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Scene Number | scene_number | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 6 configuration parameters available in the ZDM-80. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | All On/All Off | All On/All Off | +| 5 | Switch state after power failure | Switch state after power failure | +| 13 | Double click option | Double click option | +| 17 | Dimming time frame | Dimming time frame | +| 18 | Maximum Dimmer level control | Maximum Dimmer level control | +| 19 | Minimum Dimmer level control | Minimum Dimmer level control | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 1: All On/All Off + +All On/All Off + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| -1 | All On active, All Off active | +| 0 | All On is not active, All Off is not active | +| 1 | All On is not active, All Off active | +| 2 | All On active, All Off is not active | + +The manufacturer defined default value is ```-1``` (All On active, All Off active). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 5: Switch state after power failure + +Switch state after power failure + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Switch is OFF | +| 1 | Switch saves its state before power failure. | + +The manufacturer defined default value is ```1``` (Switch saves its state before power failure.). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 13: Double click option + +Double click option + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Enabled | + +The manufacturer defined default value is ```1``` (Enabled). + +This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```. + + +### Parameter 17: Dimming time frame + +Dimming time frame +Sets the time of moving the Dimmer from 0% to max. dimming values. + +(The ZDM-80 will implement the dimming duration if received this parameter value from controller/gateway. Otherwise, the ZDM-80 will implement the local parameter value) +Values in the range 0 to 5 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_17_1``` and is of type ```INTEGER```. + + +### Parameter 18: Maximum Dimmer level control + +Maximum Dimmer level control +Define the upper dimming level. Higher percentages lead to higher brightness level. +Values in the range 2 to 99 may be set. + +The manufacturer defined default value is ```99```. + +This parameter has the configuration ID ```config_18_1``` and is of type ```INTEGER```. + + +### Parameter 19: Minimum Dimmer level control + +Minimum Dimmer level control +Define the lower dimming level. Lower percentages lead to lower brightness level. +Values in the range 1 to 98 may be set. + +The manufacturer defined default value is ```13```. + +This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The ZDM-80 supports 2 association groups. + +### Group 1: Group 1 + +Association group_1 is used to report status change such as AUTO report to gateway. + +Association group 1 supports 1 node. + +### Group 2: Group 2 + +# Dimmer mode: + +ZDM-80 will send out related dimming level e.g. 50% by basic set command to its association group automatically when ZDM-80 received the dimming command by local switch or wireless command e.g. 50%. + +# Switch mode: + +ZDM-80 will send out related basic set command On (0xFF) or Off (0x00) to its association group automatically when ZDM-80 received On (0xFF) or Off (0x00) command by local switch or wireless command respectively. (Max. 4 nodes ID can be assigned to this association group) + +Association group 2 supports 4 nodes. + ## Technical Information ### Endpoints @@ -66,6 +202,10 @@ The device does not support associations. | COMMAND_CLASS_ASSOCIATION_V2| | | COMMAND_CLASS_VERSION_V1| | +### Documentation Links + +* [Web Page](https://www.cd-jackson.com/zwave_device_uploads/693/ZDM-80SA.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/remotec/zds210na_0_0.md b/_addons_bindings/zwave/doc/remotec/zds210na_0_0.md new file mode 100644 index 000000000..e1eae1a14 --- /dev/null +++ b/_addons_bindings/zwave/doc/remotec/zds210na_0_0.md @@ -0,0 +1,203 @@ +--- +layout: documentation +title: ZDS-210NA - ZWave +--- + +{% include base.html %} + +# ZDS-210NA Dimming Switch Module (Dual Mode) +This describes the Z-Wave device *ZDS-210NA*, manufactured by *Remotec* with the thing type UID of ```remotec_zds210na_00_000```. + +The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there. + +![ZDS-210NA product image](https://www.cd-jackson.com/zwave_device_uploads/1050/1050_default.png) + + +The ZDS-210NA 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 between other devices in the mesh network. + +## Overview + +Thank you for choosing the ZDS-210 (Dimming Switch Module) Z-Wave control product. ZDS-210 enabled product allows users to remotely control lighting, home appliance, and make home control easy with low installation and maintenance costs. + +### Inclusion Information + +# Note: + +ZDS-210 can be configured as either a "DIMMER" or a "SWITCH" device, and it will detect the operation mode using the position of the slide switch when powering on. The ZDS-210 will stay in the selected operation mode after inclusion process, and it will not respond to the slide switch selection after removing and re-adding power. + +If the user needs to change the operation mode, the user must first perform an exclusion process. The user will then switch to the target operation mode (Dimmer or Switch), and re-include the ZDS-210 afterwards. + +When prompted by your primary controller, triple click the PROG button within 1 second. + +### Exclusion Information + +When prompted by your primary controller, triple click the PROG button within 1 second. + +## Channels + +The following table summarises the channels available for the ZDS-210NA -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Scene Number | scene_number | scene_number | | Number | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Scene Number +Triggers when a scene button is pressed. + +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. + + + +## Device Configuration + +The following table provides a summary of the 5 configuration parameters available in the ZDS-210NA. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 5 | State after power failure | State after power failure | +| 13 | Double click option | Double click option | +| 17 | Dimmer time from 0% to max. | Dimmer time from 0% to max. | +| 18 | Maximum Dimmer level control | Maximum Dimmer level control | +| 19 | Minimum Dimmer level control | Minimum Dimmer level control | +| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | + +### Parameter 5: State after power failure + +State after power failure + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Switch OFF | +| 1 | Switch saves its state before power failure | + +The manufacturer defined default value is ```1``` (Switch saves its state before power failure). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 13: Double click option + +Double click option +Double click option (set to max. brightness) +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Enabled | + +The manufacturer defined default value is ```1``` (Enabled). + +This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```. + + +### Parameter 17: Dimmer time from 0% to max. + +Dimmer time from 0% to max. +Time to move the Dimmer from 0% to max. dimming values. + +(The ZDS-210 will implement the dimming duration if received this parameter value from controller/gateway.Otherwise, the ZDS-210 will implement the local parameter value) +Values in the range 0 to 5 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_17_1``` and is of type ```INTEGER```. + + +### Parameter 18: Maximum Dimmer level control + +Maximum Dimmer level control + +Values in the range 2 to 99 may be set. + +The manufacturer defined default value is ```99```. + +This parameter has the configuration ID ```config_18_1``` and is of type ```INTEGER```. + + +### Parameter 19: Minimum Dimmer level control + +Minimum Dimmer level control + +Values in the range 1 to 98 may be set. + +The manufacturer defined default value is ```13```. + +This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```. + +### Switch All Mode + +Set the mode for the switch when receiving SWITCH ALL commands. + +The following option values may be configured -: +| Value | Description | +|--------|-------------| +| 0 | Exclude from All On and All Off groups | +| 1 | Include in All On group | +| 2 | Include in All Off group | +| 255 | Include in All On and All Off groups | + +This parameter has the configuration ID ```switchall_mode``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The ZDS-210NA supports 2 association groups. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 1 node. + +### Group 2: Group 2 + +# Dimmer mode: + +After receiving a dimming command from a local switch or gateway (e.g. 50%), the ZDS-210 will automatically send out a related basic set command (e.g. 50%) to its associated group. + +# Switch mode: + +After receiving a basic set command from a local switch or gateway, On (0xFF) or Off (0x00), the ZDS-210 will automatically send out a related basic set command, On (0xFF) or Off (0x00) to its associated group. + +Association group 2 supports 4 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_ALL_V1| | +| COMMAND_CLASS_SCENE_ACTIVATION_V1| | +| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V1| | + +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/1050/F820-8131-0000-USER-Manual-20170816.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1050). diff --git a/_addons_bindings/zwave/doc/remotec/zfm80_0_0.md b/_addons_bindings/zwave/doc/remotec/zfm80_0_0.md index dc71f95dc..7118cd8e3 100644 --- a/_addons_bindings/zwave/doc/remotec/zfm80_0_0.md +++ b/_addons_bindings/zwave/doc/remotec/zfm80_0_0.md @@ -8,6 +8,8 @@ title: ZFM-80 - ZWave # ZFM-80 Fixture Switch Module This describes the Z-Wave device *ZFM-80*, manufactured by *Remotec* with the thing type UID of ```remotec_zfm80_00_000```. +The device is in the category of *Light Bulb*, defining Devices that illuminate something, such as bulbs, etc.. + ![ZFM-80 product image](https://www.cd-jackson.com/zwave_device_uploads/448/448_default.jpg) @@ -19,49 +21,43 @@ The ZFM-80US Fixture Switch Module is a Z-Wave enabled device and fully compatib Key Features: -- High output power - -- Remote ON/OFF control via the Z-Wave controller - -- Manual ON/OFF control with the front panel push button - -- Support External ON/OFF key connects to the module - -- Advanced function + * High output power + * Remote ON/OFF control via the Z-Wave controller + * Manual ON/OFF control with the front panel push button + * Support External ON/OFF key connects to the module + * Advanced function Conditional trigger for "Fail Safe Installation" -- Support Network Wide Inclusion (NWI) and Explore Frames - -- Screw terminals for wires connection - -- Flexible mounting structure - mount inside gang box or any place + * Support Network Wide Inclusion (NWI) and Explore Frames + * Screw terminals for wires connection + * Flexible mounting structure - mount inside gang box or any place ### Inclusion Information Include or exclude the Fixture Switch Module from the existing ZWave home control network with your primary controller. -- Refer to your primary controller instructions to process the inclusion / exclusion setup procedure. + * Refer to your primary controller instructions to process the inclusion / exclusion setup procedure. + * When prompted by your primary controller, click once on the PROG button or external switch. + * The primary controller should indicate that the action was successful. If the controller indicates the action was unsuccessful, please repeat the procedure. + * Once the Fixture Switch Module is part of the network, the same basic procedure is used to add the Fixture Switch Module to groups or scenes. Refer to the primary controller's instructions for details. -- When prompted by your primary controller, click once on the PROG button or external switch. +### Exclusion Information -- The primary controller should indicate that the action was successful. If the controller indicates the action was unsuccessful, please repeat the procedure. - -- Once the Fixture Switch Module is part of the network, the same basic procedure is used to add the Fixture Switch Module to groups or scenes. Refer to the primary controller's instructions for details. +Click once on the PROG button or external switch. ## Channels The following table summarises the channels available for the ZFM-80 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. diff --git a/_addons_bindings/zwave/doc/remotec/zts110_0_0.md b/_addons_bindings/zwave/doc/remotec/zts110_0_0.md index 37d138a16..b1f37d70c 100644 --- a/_addons_bindings/zwave/doc/remotec/zts110_0_0.md +++ b/_addons_bindings/zwave/doc/remotec/zts110_0_0.md @@ -30,33 +30,41 @@ ZTS-110 can be powered by 4 x AA batteries, and/or 24Vac C wire. 3. After inclusion process, ZTS-110 will not detect power source and not allow changing operation mode. You must perform exclusion process first if need to change Z-Wave operation mode. 4. After Z-Wave inclusion process, if you reset ZTS-110 to default while both 24Vac and batteries are applied, ZTS-110 will take 24Vac as primary power source and self-configure to Always Listening Mode, because reset to default process will automatically exclude ZTS-110 from the Z-Wave network. You should disconnect the power source and re-apply the power so ZTS-110 can detect the power source type and self-configure to corresponding mode. +### Inclusion Information + + 1. Press and hold "Home" key for 2 seconds to set ZTS-110 to Add (Inclusion) / Delete (Exclusion) Mode. + 2. Press "Prog" key once, it will search the network.  + +### Exclusion Information + + 1. Press and hold "Home" key for 2 seconds to set ZTS-110 to Add (Inclusion) / Delete (Exclusion) Mode. + 2. Press "Prog" key once, it will search the network. + ## Channels The following table summarises the channels available for the ZTS-110 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Operating State | thermostat_state | Temperature | Number | -| Setpoint (cooling) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Thermostat fan mode | thermostat_fanmode | | | -| Thermostat fan state | thermostat_fanstate | | | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset | time_offset | Temperature | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode | thermostat_fanmode | thermostat_fanmode | | | +| Thermostat fan state | thermostat_fanstate | thermostat_fanstate | | | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -77,10 +85,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State - Sets the thermostat operating state. -The ```thermostat_state``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -94,36 +101,30 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (cooling) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode - Channel type information on this channel is not found. ### Thermostat fan state - Channel type information on this channel is not found. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset - Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. @@ -139,14 +140,14 @@ Detailed information on each parameter can be found in the sections below. | 3 | Set Filter Counter | Set filter replacement timer from 500 to 4000 hours. | | 4 | Report Filter Counter | READ ONLY: Data in hours | | 5 | Scale of Temperature | Set Temperature Scale to Farhenheit or Centigrade. DEFAULT =1 Farhenheit | -| 6 | Upper Limit of Setpoint A | Determines Upper Limit of set point A. Unit in celsius A=(B+2)min (37.0 C)max, Unit in Fahrenheit A=(B+4)min (99.0 F)max | -| 7 | Lower Limit of Setpoint B | Determines Lower Limit of set point B. Unit in celsius (5.0 C to 35.0 C) Unit in Fahrenheit (41.0 F to 95.0 F) | +| 6 | Upper Limit of Setpoint A | Upper Limit of Setpoint A | +| 7 | Lower Limit of Setpoint B | Lower Limit of Setpoint B | | 8 | Easy Mode | Set Easy Mode 0:DISABLE 1:ENABLED DEFAULT:ENABLED | | 9 | Time Format | Configures for 12 or 24 Hour format. Default is 12 Hours. | -| 10 | Repeat Basic Set Counter | Thermostat sends 'Basic Set' command to its association node repeatedly ever X minutes. 0 = Disabled or Set to Enabled Values available 3 to 255. | -| 11 | Trigger AUTO report if room temperature is different from last report. | 0 = Disabled or set value from 1 to 8 where each number corresponds to 1 Degree F or .5 Degrees Celsius. | -| 12 | Sensor temperature calibration. | 0 = Disabled or set value from 1 to 10 in 1 degree F increments or -1 to -10 in 1 degree F increments . | -| 13 | AUTO report by time interval. | 0 = Disabled or set value from 1 to 16 where 1 = .5 hours and each consecutive number increases time by .5 hours. | +| 10 | Repeat Basic Set Counter | Repeat Basic Set Counter | +| 11 | AUTO report by room temperature | AUTO report by room temperature | +| 12 | Sensor temperature calibration. | Sensor temperature calibration. | +| 13 | AUTO report by time interval. | AUTO report by time interval. | ### Parameter 1: Swing @@ -210,8 +211,8 @@ This parameter has the configuration ID ```config_5_1``` and is of type ```INTEG ### Parameter 6: Upper Limit of Setpoint A -Determines Upper Limit of set point A. Unit in celsius A=(B+2)min (37.0 C)max, Unit in Fahrenheit A=(B+4)min (99.0 F)max - +Upper Limit of Setpoint A +Determines Upper Limit of set point A. Unit in celsius A=(B+2)min (37.0 C)max, Unit in Fahrenheit A=(B+4)min (99.0 F)max   Values in the range 37 to 99 may be set. The manufacturer defined default value is ```99```. @@ -221,8 +222,8 @@ This parameter has the configuration ID ```config_6_2``` and is of type ```INTEG ### Parameter 7: Lower Limit of Setpoint B -Determines Lower Limit of set point B. Unit in celsius (5.0 C to 35.0 C) Unit in Fahrenheit (41.0 F to 95.0 F) - +Lower Limit of Setpoint B +Determines Lower Limit of set point B. Unit in celsius (5.0 C to 35.0 C) Unit in Fahrenheit (41.0 F to 95.0  F)   Values in the range 5 to 95 may be set. The manufacturer defined default value is ```41```. @@ -264,8 +265,11 @@ This parameter has the configuration ID ```config_9_1``` and is of type ```INTEG ### Parameter 10: Repeat Basic Set Counter -Thermostat sends 'Basic Set' command to its association node repeatedly ever X minutes. 0 = Disabled or Set to Enabled Values available 3 to 255. +Repeat Basic Set Counter +Thermostat sends 'Basic Set' command to its association node repeatedly ever X minutes. + * 0 = Disabled or + * Set to Enabled Values available 3 to 255.   Values in the range 0 to 255 may be set. The manufacturer defined default value is ```0```. @@ -273,10 +277,13 @@ The manufacturer defined default value is ```0```. This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```. -### Parameter 11: Trigger AUTO report if room temperature is different from last report. +### Parameter 11: AUTO report by room temperature -0 = Disabled or set value from 1 to 8 where each number corresponds to 1 Degree F or .5 Degrees Celsius. +AUTO report by room temperature +Trigger AUTO report if room temperature is different from last report. + * 0 = Disabled or + * set value from 1 to 8 where each number corresponds to 1 Degree F or .5 Degrees Celsius.   Values in the range 0 to 8 may be set. The manufacturer defined default value is ```4```. @@ -286,8 +293,9 @@ This parameter has the configuration ID ```config_11_1``` and is of type ```INTE ### Parameter 12: Sensor temperature calibration. -0 = Disabled or set value from 1 to 10 in 1 degree F increments or -1 to -10 in 1 degree F increments . - +Sensor temperature calibration. + * 0 = Disabled or + * set value from 1 to 10 in 1 degree F increments or -1 to -10 in 1 degree F increments .  Values in the range -10 to 10 may be set. The manufacturer defined default value is ```0```. @@ -297,8 +305,9 @@ This parameter has the configuration ID ```config_12_1``` and is of type ```INTE ### Parameter 13: AUTO report by time interval. -0 = Disabled or set value from 1 to 16 where 1 = .5 hours and each consecutive number increases time by .5 hours. - +AUTO report by time interval. + * 0 = Disabled or + * set value from 1 to 16 where 1 = .5 hours and each consecutive number increases time by .5 hours.  Values in the range 0 to 16 may be set. The manufacturer defined default value is ```0```. diff --git a/_addons_bindings/zwave/doc/remotec/zxt120_0_0.md b/_addons_bindings/zwave/doc/remotec/zxt120_0_0.md index 6d04f3b60..1dac7dd79 100644 --- a/_addons_bindings/zwave/doc/remotec/zxt120_0_0.md +++ b/_addons_bindings/zwave/doc/remotec/zxt120_0_0.md @@ -8,36 +8,47 @@ title: ZXT-120 - ZWave # ZXT-120 AC IR Remote This describes the Z-Wave device *ZXT-120*, manufactured by *Remotec* with the thing type UID of ```remotec_zxt120_00_000```. +The device is in the category of *HVAC*, defining Air condition devices, Fans. + +![ZXT-120 product image](https://www.cd-jackson.com/zwave_device_uploads/202/202_default.png) + + The ZXT-120 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. ## 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/202) to improve the documentation. +The ZXT-120 is a Z-Wave to air-conditioner (AC) IR Extender and it works with any Z-Wave compliant gateway which supports the same command classes (check with your gateway support for compatibility) or portable controller by translating Z-Wave’s Thermostat commands to AC IR control code. User can set the IR code from the built-in code library of ZXT-120 through the configuration commands, or use the learning function of ZXT-120 through the UI on gateway. ZXT-120 also built in a temperature sensor that allow to report your room temperature to home gateway.  + +### Inclusion Information + +Click once on the PROG button + +### Exclusion Information + +Click once on the PROG button ## Channels The following table summarises the channels available for the ZXT-120 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Setpoint (cooling) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Thermostat fan mode | thermostat_fanmode | | | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode | thermostat_fanmode | thermostat_fanmode | | | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -58,27 +69,23 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Setpoint (cooling) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode - Channel type information on this channel is not found. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -88,7 +95,7 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 25 | Indicate a location for IR code learning and start learning | | +| 25 | Location | Location | | 26 | Learning status register (Read Only) | | | 27 | IR code number for built-in code library | | | 28 | External IR Emitter power level | | @@ -98,10 +105,10 @@ Detailed information on each parameter can be found in the sections below. | 37 | Sensor temperature compensation | | | | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands | -### Parameter 25: Indicate a location for IR code learning and start learning - - +### Parameter 25: Location +Location +Indicate a location for IR code learning and start learning Values in the range 0 to 22 may be set. The manufacturer defined default value is ```1```. diff --git a/_addons_bindings/zwave/doc/remotec/zxt310_0_0.md b/_addons_bindings/zwave/doc/remotec/zxt310_0_0.md new file mode 100644 index 000000000..743a47cf5 --- /dev/null +++ b/_addons_bindings/zwave/doc/remotec/zxt310_0_0.md @@ -0,0 +1,148 @@ +--- +layout: documentation +title: ZXT-310 - ZWave +--- + +{% include base.html %} + +# ZXT-310 AV IR Extender +This describes the Z-Wave device *ZXT-310*, manufactured by *Remotec* with the thing type UID of ```remotec_zxt310_00_000```. + +The device is in the category of *Remote Control*, defining Any portable or hand-held device that controls the status of something, e.g. remote control, keyfob etc.. + +![ZXT-310 product image](https://www.cd-jackson.com/zwave_device_uploads/876/876_default.png) + + +The ZXT-310 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 between other devices in the mesh network. + +## Overview + +ZXT‐310 is a Z‐Wave‐to‐AV IR Extender (Figure 1) and it works with any Z‐Wave compliant controller or gateway by translating Z‐Wave Simple AV command  + +### Inclusion Information + +Press the PROG button + +### Exclusion Information + +Press the PROG button + +## Channels + +The following table summarises the channels available for the ZXT-310 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| + + + +## Device Configuration + +The following table provides a summary of the 3 configuration parameters available in the ZXT-310. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | UIRD | parameter 1 - 20 (0x01 - 0x14) | +| 21 | The Simple AV command | The Simple AV command number or key going to be downloaded to the ZXT‐310 | +| 22 | Download status register | Download status register | + +### Parameter 1: UIRD + +parameter 1 - 20 (0x01 - 0x14) +UIRD formatted raw data for the Simple AV command number or key being downloaded or uploaded  +Values in the range 0 to 0 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_1_4``` and is of type ```INTEGER```. + + +### Parameter 21: The Simple AV command + +The Simple AV command number or key going to be downloaded to the ZXT‐310 +Referred to Simple AV command class key ID +Values in the range 0 to 0 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_21_2``` and is of type ```INTEGER```. + + +### Parameter 22: Download status register + +Download status register +**The status value 1, 3, 4 will be reset to 0 when ZXT‐310 receive a get command to this parameter ** +Values in the range 0 to 4 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_22_1``` and is of type ```INTEGER```. +This is a read only parameter. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The device does not support associations. +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_MULTI_CHANNEL_V2| | +| COMMAND_CLASS_CONFIGURATION_V1| Linked to BASIC| +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_VERSION_V1| | +| COMMAND_CLASS_SIMPLE_AV_CONTROL_V1| | +#### Endpoint 1 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| Linked to BASIC| +#### Endpoint 2 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| Linked to BASIC| +#### Endpoint 3 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| Linked to BASIC| +#### Endpoint 4 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| Linked to BASIC| +#### Endpoint 5 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| Linked to BASIC| +#### Endpoint 6 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| Linked to BASIC| + +### Documentation Links + +* [PDF from Remotec Webiste](https://www.cd-jackson.com/zwave_device_uploads/876/F-BW8371xx-ZXT-310xx-User-Manual-V1-2G-and-I-20141006-3.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/876). diff --git a/_addons_bindings/zwave/doc/rimport/zmeeraz2_0_0.md b/_addons_bindings/zwave/doc/rimport/zmeeraz2_0_0.md index b35c36bd5..c2b2dd1b0 100644 --- a/_addons_bindings/zwave/doc/rimport/zmeeraz2_0_0.md +++ b/_addons_bindings/zwave/doc/rimport/zmeeraz2_0_0.md @@ -19,8 +19,8 @@ No device information is provided in the database. Consider [updating the databa The following table summarises the channels available for the ZMEERAZ2 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| diff --git a/_addons_bindings/zwave/doc/ring/1156d_0_0.md b/_addons_bindings/zwave/doc/ring/1156d_0_0.md index 1c1f6557f..01df3ee79 100644 --- a/_addons_bindings/zwave/doc/ring/1156d_0_0.md +++ b/_addons_bindings/zwave/doc/ring/1156d_0_0.md @@ -1,21 +1,21 @@ --- layout: documentation -title: Ring - ZWave +title: PIR Motion Sensor - ZWave --- {% include base.html %} -# Ring Motion Sensor -This describes the Z-Wave device *Ring*, manufactured by *Ring* with the thing type UID of ```ring_1156d_00_000```. +# PIR Motion Sensor Motion Sensor +This describes the Z-Wave device *PIR Motion Sensor*, manufactured by *Ring* with the thing type UID of ```ring_1156d_00_000```. The device is in the category of *Motion Detector*, defining Motion sensors/detectors. -![Ring product image](https://www.cd-jackson.com/zwave_device_uploads/943/943_default.jpg) +![PIR Motion Sensor product image](https://www.cd-jackson.com/zwave_device_uploads/943/943_default.jpg) -The Ring 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 PIR Motion Sensor 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 Ring 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. Refer to the *Wakeup Information* section below for further information. +The PIR Motion Sensor 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. Refer to the *Wakeup Information* section below for further information. ## Overview @@ -43,7 +43,7 @@ Reset: ### Wakeup Information -The Ring 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 PIR Motion Sensor 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. @@ -52,19 +52,18 @@ By opening the cover, the sensor will get to tamper state and stay awake. ## Channels -The following table summarises the channels available for the Ring -: +The following table summarises the channels available for the PIR Motion Sensor -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Alarm (burglar) | alarm_burglar | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -74,10 +73,9 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Alarm (burglar) - Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -87,22 +85,95 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 3 configuration parameters available in the PIR Motion Sensor. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 2 | Dwell Time | Dwell Time | +| 3 | Pet Immunity | Pet Immunity | +| 4 | Walk Test | Walk Test | +| | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | +| | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | + +### Parameter 2: Dwell Time + +Dwell Time +Configures the “dwell” window or how long the sensor should not be detecting motion before sending the “no motion detected” message.  + +1 to 9 minutes. +Values in the range 1 to 9 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Pet Immunity + +Pet Immunity +Configures the “Pet Immunity,” or sensitivity of the motion detection used mostly so only human motion is detected. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | No pet immunity | +| 1 | 15kg (33lb) | +| 2 | 25kg (55lb) | + +The manufacturer defined default value is ```2``` (25kg (55lb)). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Walk Test + +Walk Test +Parameter 4 is used to activate a “walk test” mode to test the PIR motion detection coverage after being installed. + +This mode is active for 15 minutes only after which the sensor returns to normal operation. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Normal operation | +| 255 | Activate Walk Test for 15 minutes | + +The manufacturer defined default value is ```0``` (Normal operation). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + +### Wakeup Interval + +The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications. + +This setting is defined in *seconds*. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances. + +Note that this setting does not affect the devices ability to send sensor data, or notification events. + +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_node``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The Ring supports 2 association groups. +The PIR Motion Sensor supports 2 association groups. ### Group 1: Lifeline @@ -146,7 +217,7 @@ Association group 2 supports 1 node. ### Documentation Links -* [Ring_Motion_Sensor_Manual](https://www.cd-jackson.com/zwave_device_uploads/943/Ring-Motion-Sensor.pdf) +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/943/Ring-Motion-Sensor---Manual.pdf) --- diff --git a/_addons_bindings/zwave/doc/rtc/ct100plus_0_0.md b/_addons_bindings/zwave/doc/rtc/ct100plus_0_0.md index a41dc2828..3c018a087 100644 --- a/_addons_bindings/zwave/doc/rtc/ct100plus_0_0.md +++ b/_addons_bindings/zwave/doc/rtc/ct100plus_0_0.md @@ -17,46 +17,59 @@ The CT100 Plus supports routing. This allows the device to communicate using oth ## 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/641) to improve the documentation. +The CT100 Plus is a sleek, modern thermostat design for home automation systems. It’s clean user interface compliments app-enabled systems. It features adjustable real-time alerts to enable cloud triggers, a robust data stream of HVAC information for cloud monitoring, and configurable comfort response settings to customize home control scenes. The CT100 Plus is compatible with all popular HVAC systems and is battery-operated without the need for a C-wire. + +### Inclusion Information + + 1.  From the CT100’s Menu screen, touch MATE under the radio icon. The Network Include screen displays a large r1. + 2. Touch MATE again. This initiates the network connection (mating) process. The MATE icon and the status indicator LEDs will blink. + +When the CT100 has successfully joined a Z-Wave network, the MATE icon is replaced by the LINK icon under the radio tower.  + +### Exclusion Information + + 1.  From the CT100’s Menu screen, touch MATE under the radio icon. The Network Include screen displays a large r1. + 2. Touch MATE again. This initiates the network connection (mating) process. The MATE icon and the status indicator LEDs will blink. + +When you are trying to disconnect from (leave) a network, the LINK icon disappears when the node has successfully left the network. ## Channels The following table summarises the channels available for the CT100 Plus -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Binary Sensor | sensor_binary | Door | Switch | -| Sensor (relative humidity) | sensor_relhumidity | Humidity | Number | -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Operating State | thermostat_state | Temperature | Number | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (cooling) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (dry air) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (furnace) | thermostat_setpoint | Temperature | Number:Temperature | -| Thermostat fan mode | thermostat_fanmode | | | -| Thermostat fan state | thermostat_fanstate | | | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset | time_offset | Temperature | Number | -| Sensor (relative humidity) 1 | sensor_relhumidity1 | Humidity | Number | -| Sensor (temperature) 1 | sensor_temperature1 | Temperature | Number:Temperature | -| Thermostat mode 1 | thermostat_mode1 | Temperature | Number | -| Operating State 1 | thermostat_state1 | Temperature | Number | -| Setpoint (heating) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Setpoint (cooling) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Setpoint (dry air) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Setpoint (furnace) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Thermostat fan mode 1 | thermostat_fanmode1 | | | -| Thermostat fan state 1 | thermostat_fanstate1 | | | -| Clock Time Offset 1 | time_offset1 | Temperature | Number | -| Sensor (relative humidity) 2 | sensor_relhumidity2 | Humidity | Number | -| Sensor (temperature) 2 | sensor_temperature2 | Temperature | Number:Temperature | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number | +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (dry air) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (furnace) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode | thermostat_fanmode | thermostat_fanmode | | | +| Thermostat fan state | thermostat_fanstate | thermostat_fanstate | | | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | +| Sensor (relative humidity) 1 | sensor_relhumidity1 | sensor_relhumidity | Humidity | Number | +| Sensor (temperature) 1 | sensor_temperature1 | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode 1 | thermostat_mode1 | thermostat_mode | Temperature | Number | +| Operating State 1 | thermostat_state1 | thermostat_state | Temperature | Number | +| Setpoint (heating) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (cooling) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (dry air) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (furnace) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode 1 | thermostat_fanmode1 | thermostat_fanmode | | | +| Thermostat fan state 1 | thermostat_fanstate1 | thermostat_fanstate | | | +| Clock Time Offset 1 | time_offset1 | time_offset | Temperature | Number | +| Sensor (relative humidity) 2 | sensor_relhumidity2 | sensor_relhumidity | Humidity | Number | +| Sensor (temperature) 2 | sensor_temperature2 | sensor_temperature | Temperature | Number:Temperature | ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -66,22 +79,19 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Sensor (relative humidity) - Indicates the current relative humidity. -The ```sensor_relhumidity``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -102,10 +112,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State - Sets the thermostat operating state. -The ```thermostat_state``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -119,66 +128,55 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (cooling) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (dry air) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (furnace) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode - Channel type information on this channel is not found. ### Thermostat fan state - Channel type information on this channel is not found. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset - Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) 1 - Indicates the current relative humidity. -The ```sensor_relhumidity1``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity1``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Sensor (temperature) 1 - Indicates the current temperature. -The ```sensor_temperature1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature1``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode 1 - Sets the thermostat. -The ```thermostat_mode1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode1``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -199,10 +197,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State 1 - Sets the thermostat operating state. -The ```thermostat_state1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state1``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -216,54 +213,45 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (heating) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (cooling) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (dry air) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (furnace) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode 1 - Channel type information on this channel is not found. ### Thermostat fan state 1 - Channel type information on this channel is not found. ### Clock Time Offset 1 - Provides the current time difference for the devices time. -The ```time_offset1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset1``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) 2 - Indicates the current relative humidity. -The ```sensor_relhumidity2``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity2``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Sensor (temperature) 2 - Indicates the current temperature. -The ```sensor_temperature2``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature2``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. diff --git a/_addons_bindings/zwave/doc/rtc/ct101_0_0.md b/_addons_bindings/zwave/doc/rtc/ct101_0_0.md index eead0af6c..173d2e6ea 100644 --- a/_addons_bindings/zwave/doc/rtc/ct101_0_0.md +++ b/_addons_bindings/zwave/doc/rtc/ct101_0_0.md @@ -17,45 +17,51 @@ The CT101 supports routing. This allows the device to communicate using other ro ## 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/98) to improve the documentation. +Z-wave enabled thermostat + +### Inclusion Information + +Click "Manage" button alongside this device, click "Add Device" device + +### Exclusion Information + +Click "Manage" button alongside this device, click "Remove" device ## Channels The following table summarises the channels available for the CT101 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Operating State | thermostat_state | Temperature | Number | -| Setpoint (cooling) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Thermostat fan mode | thermostat_fanmode | | | -| Thermostat fan state | thermostat_fanstate | | | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset | time_offset | Temperature | Number | -| Sensor (temperature) 1 | sensor_temperature1 | Temperature | Number:Temperature | -| Thermostat mode 1 | thermostat_mode1 | Temperature | Number | -| Operating State 1 | thermostat_state1 | Temperature | Number | -| Setpoint (cooling) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Setpoint (heating) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Thermostat fan mode 1 | thermostat_fanmode1 | | | -| Thermostat fan state 1 | thermostat_fanstate1 | | | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset 1 | time_offset1 | Temperature | Number | -| Sensor (relative humidity) 2 | sensor_relhumidity2 | Humidity | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode | thermostat_fanmode | thermostat_fanmode | | | +| Thermostat fan state | thermostat_fanstate | thermostat_fanstate | | | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | +| Sensor (temperature) 1 | sensor_temperature1 | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode 1 | thermostat_mode1 | thermostat_mode | Temperature | Number | +| Operating State 1 | thermostat_state1 | thermostat_state | Temperature | Number | +| Setpoint (cooling) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode 1 | thermostat_fanmode1 | thermostat_fanmode | | | +| Thermostat fan state 1 | thermostat_fanstate1 | thermostat_fanstate | | | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset 1 | time_offset1 | time_offset | Temperature | Number | +| Sensor (relative humidity) 2 | sensor_relhumidity2 | sensor_relhumidity | Humidity | Number | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -76,10 +82,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State - Sets the thermostat operating state. -The ```thermostat_state``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -93,48 +98,40 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (cooling) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode - Channel type information on this channel is not found. ### Thermostat fan state - Channel type information on this channel is not found. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset - Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ### Sensor (temperature) 1 - Indicates the current temperature. -The ```sensor_temperature1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature1``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode 1 - Sets the thermostat. -The ```thermostat_mode1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode1``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -155,10 +152,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State 1 - Sets the thermostat operating state. -The ```thermostat_state1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state1``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -172,42 +168,35 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (cooling) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode 1 - Channel type information on this channel is not found. ### Thermostat fan state 1 - Channel type information on this channel is not found. ### Battery Level - 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 ```battery-level1``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level1``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset 1 - Provides the current time difference for the devices time. -The ```time_offset1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset1``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) 2 - Indicates the current relative humidity. -The ```sensor_relhumidity2``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity2``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. @@ -362,6 +351,7 @@ Association group 1 supports 2 nodes. ### Documentation Links * [User Manual](https://www.cd-jackson.com/zwave_device_uploads/98/CT101-IBIE-18jun12-revised.pdf) +* [Operation Manual](https://www.cd-jackson.com/zwave_device_uploads/98/CT101-Operation.pdf) --- diff --git a/_addons_bindings/zwave/doc/rtc/ct110_0_0.md b/_addons_bindings/zwave/doc/rtc/ct110_0_0.md index c6cdf3591..d38d0f8d8 100644 --- a/_addons_bindings/zwave/doc/rtc/ct110_0_0.md +++ b/_addons_bindings/zwave/doc/rtc/ct110_0_0.md @@ -8,62 +8,72 @@ title: CT110 - ZWave # CT110 Thermostat This describes the Z-Wave device *CT110*, manufactured by *Radio Thermostat Company of America (RTC)* with the thing type UID of ```rtc_ct110_00_000```. +The device is in the category of *HVAC*, defining Air condition devices, Fans. + +![CT110 product image](https://www.cd-jackson.com/zwave_device_uploads/555/555_default.png) + + The CT110 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. ## 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/555) to improve the documentation. +The Z-Wave Plus enabled CT110 is a sleek, modern thermostat design for home automation systems. It’s clean user interface compliments app-enabled systems, and it connects to a Z-Wave network with one touch. The CT110 features adjustable real-time alerts to enable cloud triggers, a robust data stream of HVAC information for cloud monitoring, and configurable comfort response settings to customize home control scenes. The CT110 is compatible with all popular HVAC systems and is battery-operated without the need for a C-wire + +### Inclusion Information + +Press and hold the network button for 5 seconds.  The thermostat must be in OFF mode. + +### Exclusion Information + +Press and hold the network button for 5 seconds.  The thermostat must be in OFF mode. ## Channels The following table summarises the channels available for the CT110 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Sensor (relative humidity) | sensor_relhumidity | Humidity | Number | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Operating State | thermostat_state | Temperature | Number | -| Setpoint (furnace) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (dry air) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (cooling) | thermostat_setpoint | Temperature | Number:Temperature | -| Thermostat fan mode | thermostat_fanmode | | | -| Thermostat fan state | thermostat_fanstate | | | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset | time_offset | Temperature | Number | -| Sensor (temperature) 1 | sensor_temperature1 | Temperature | Number:Temperature | -| Sensor (relative humidity) 1 | sensor_relhumidity1 | Humidity | Number | -| Thermostat mode 1 | thermostat_mode1 | Temperature | Number | -| Operating State 1 | thermostat_state1 | Temperature | Number | -| Setpoint (furnace) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Setpoint (dry air) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Setpoint (heating) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Setpoint (cooling) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Thermostat fan mode 1 | thermostat_fanmode1 | | | -| Thermostat fan state 1 | thermostat_fanstate1 | | | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset 1 | time_offset1 | Temperature | Number | -| Sensor (temperature) 2 | sensor_temperature2 | Temperature | Number:Temperature | -| Sensor (relative humidity) 2 | sensor_relhumidity2 | Humidity | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (furnace) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (dry air) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode | thermostat_fanmode | thermostat_fanmode | | | +| Thermostat fan state | thermostat_fanstate | thermostat_fanstate | | | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | +| Sensor (temperature) 1 | sensor_temperature1 | sensor_temperature | Temperature | Number:Temperature | +| Sensor (relative humidity) 1 | sensor_relhumidity1 | sensor_relhumidity | Humidity | Number | +| Thermostat mode 1 | thermostat_mode1 | thermostat_mode | Temperature | Number | +| Operating State 1 | thermostat_state1 | thermostat_state | Temperature | Number | +| Setpoint (furnace) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (dry air) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (cooling) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode 1 | thermostat_fanmode1 | thermostat_fanmode | | | +| Thermostat fan state 1 | thermostat_fanstate1 | thermostat_fanstate | | | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset 1 | time_offset1 | time_offset | Temperature | Number | +| Sensor (temperature) 2 | sensor_temperature2 | sensor_temperature | Temperature | Number:Temperature | +| Sensor (relative humidity) 2 | sensor_relhumidity2 | sensor_relhumidity | Humidity | Number | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) - Indicates the current relative humidity. -The ```sensor_relhumidity``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -84,10 +94,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State - Sets the thermostat operating state. -The ```thermostat_state``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -101,66 +110,55 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (furnace) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (dry air) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (cooling) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode - Channel type information on this channel is not found. ### Thermostat fan state - Channel type information on this channel is not found. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset - Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ### Sensor (temperature) 1 - Indicates the current temperature. -The ```sensor_temperature1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature1``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) 1 - Indicates the current relative humidity. -The ```sensor_relhumidity1``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity1``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Thermostat mode 1 - Sets the thermostat. -The ```thermostat_mode1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode1``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -181,10 +179,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State 1 - Sets the thermostat operating state. -The ```thermostat_state1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state1``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -198,72 +195,359 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (furnace) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (dry air) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (cooling) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode 1 - Channel type information on this channel is not found. ### Thermostat fan state 1 - Channel type information on this channel is not found. ### Battery Level - 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 ```battery-level1``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level1``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset 1 - Provides the current time difference for the devices time. -The ```time_offset1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset1``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ### Sensor (temperature) 2 - Indicates the current temperature. -The ```sensor_temperature2``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature2``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) 2 - Indicates the current relative humidity. -The ```sensor_relhumidity2``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity2``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 18 configuration parameters available in the CT110. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Temperature Reporting Threshold | Temperature Reporting Threshold | +| 2 | HVAC Type | HVAC Type | +| 2 | # of Auxiliary Stages | \# of Auxiliary Stages | +| 2 | Fuel Type | Fuel Type | +| 2 | # of Heat Pump Stages. | \# of Heat Pump Stages. | +| 2 | # of Cool Stages. | \# of Cool Stages. | +| 3 | Utility Lock | Utility Lock | +| 4 | C-Wire/Battery | C-Wire/Battery | +| 5 | Humidity Reporting Threshold | Humidity Reporting Threshold | +| 6 | Auxiliary/Emergency Mode | Auxiliary/Emergency Mode | +| 7 | Thermostat Swing Temperature | Thermostat Swing Temperature | +| 9 | Thermostat Recovery Mode | Thermostat Recovery Mode | +| 10 | Temperature Reporting Filter (lower bound) | Temperature Reporting Filter (lower bound) | +| 10 | Temperature Reporting Filter (upper bound) | Temperature Reporting Filter (upper bound) | +| 11 | Simple UI Mode | Simple UI Mode | +| 12 | Multicast | Multicast | +| 13 | Main Display Settings | Main Display Settings | +| 14 | Save Energy Mode Type | Save Energy Mode Type | + +### Parameter 1: Temperature Reporting Threshold + +Temperature Reporting Threshold + +Values in the range 0 to 4 may be set. + +The manufacturer defined default value is ```4```. + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: HVAC Type + +HVAC Type + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Normal | +| 2 | Heat Pump | + +The manufacturer defined default value is ```1``` (Normal). + +This parameter has the configuration ID ```config_2_4_000000FF``` and is of type ```INTEGER```. + + +### Parameter 2: # of Auxiliary Stages + +\# of Auxiliary Stages + +Values in the range 0 to 64 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_2_4_00000F00``` and is of type ```INTEGER```. + + +### Parameter 2: Fuel Type + +Fuel Type + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Gas | +| 2 | Electric | + +The manufacturer defined default value is ```1``` (Gas). + +This parameter has the configuration ID ```config_2_4_0000F000``` and is of type ```INTEGER```. + + +### Parameter 2: # of Heat Pump Stages. + +\# of Heat Pump Stages. + +Values in the range 0 to 128 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_2_4_00FF0000``` and is of type ```INTEGER```. + + +### Parameter 2: # of Cool Stages. + +\# of Cool Stages. + +Values in the range 0 to 64 may be set. + +The manufacturer defined default value is ```0```. + +This parameter has the configuration ID ```config_2_4_0F000000``` and is of type ```INTEGER```. + + +### Parameter 3: Utility Lock + +Utility Lock + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 255 | Enabled | + +The manufacturer defined default value is ```0``` (Disabled). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: C-Wire/Battery + +C-Wire/Battery + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | C-Wire | +| 2 | Battery | + +The manufacturer defined default value is ```1``` (C-Wire). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 5: Humidity Reporting Threshold + +Humidity Reporting Threshold + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | 3% RH | +| 2 | 5% RH | +| 3 | 10% RH | + +The manufacturer defined default value is ```0``` (Disabled). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +### Parameter 6: Auxiliary/Emergency Mode + +Auxiliary/Emergency Mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Enabled | + +The manufacturer defined default value is ```1``` (Enabled). + +This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```. + + +### Parameter 7: Thermostat Swing Temperature + +Thermostat Swing Temperature + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | 0.5ºF | +| 2 | 1.0ºF | +| 3 | 1.5ºF | +| 4 | 2.0ºF | +| 5 | 2.5ºF | +| 6 | 3.0ºF | +| 7 | 3.5ºF | +| 8 | 4.0ºF | + +The manufacturer defined default value is ```1``` (0.5ºF). + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 9: Thermostat Recovery Mode + +Thermostat Recovery Mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Fast | +| 2 | Economy | + +The manufacturer defined default value is ```2``` (Economy). + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: Temperature Reporting Filter (lower bound) + +Temperature Reporting Filter (lower bound) + 0 -124ºF (lower bound) +Values in the range 0 to 124 may be set. + +The manufacturer defined default value is ```124```. + +This parameter has the configuration ID ```config_10_2_0000FFFF``` and is of type ```INTEGER```. + + +### Parameter 10: Temperature Reporting Filter (upper bound) + +Temperature Reporting Filter (upper bound) +0-124ºF (upper bound) +Values in the range 0 to 124 may be set. + +The manufacturer defined default value is ```124```. + +This parameter has the configuration ID ```config_10_2_0FFF0000``` and is of type ```INTEGER```. + + +### Parameter 11: Simple UI Mode + +Simple UI Mode + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Normal Mode | +| 1 | Simple Mode | + +The manufacturer defined default value is ```1``` (Simple Mode). + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + + +### Parameter 12: Multicast + +Multicast + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Enabled | + +The manufacturer defined default value is ```1``` (Enabled). + +This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```. + + +### Parameter 13: Main Display Settings + +Main Display Settings + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Temperature | +| 2 | Humidity | + +The manufacturer defined default value is ```1``` (Temperature). + +This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```. + + +### Parameter 14: Save Energy Mode Type + +Save Energy Mode Type +1=Adjust by target delta, + +2=Least consuming point in the running program, + +3=Save energy absolute setpoint, + +255=Save Energy not supported +Values in the range 1 to 255 may be set. + +The manufacturer defined default value is ```255```. + +This parameter has the configuration ID ```config_14_1``` and is of type ```INTEGER```. +This is a read only parameter. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The CT110 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 2 nodes. + ## Technical Information ### Endpoints @@ -314,6 +598,11 @@ The device does not support associations. | COMMAND_CLASS_SENSOR_MULTILEVEL_V5| Linked to BASIC| | COMMAND_CLASS_ASSOCIATION_V1| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/555/CT110-Both-19aug14.pdf) +* [Operation Manual](https://www.cd-jackson.com/zwave_device_uploads/555/CT110-IBOE-rev001-24sep14.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/rtc/ct30_0_0.md b/_addons_bindings/zwave/doc/rtc/ct30_0_0.md index 9382cecaf..c7d5c3cad 100644 --- a/_addons_bindings/zwave/doc/rtc/ct30_0_0.md +++ b/_addons_bindings/zwave/doc/rtc/ct30_0_0.md @@ -46,18 +46,18 @@ The following table summarises the channels available for the CT30 -: | Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | | Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | | Thermostat fan mode | thermostat_fanmode | thermostat_fanmode | | | -| Battery Level | battery-level | Battery | Number | +| Battery Level | battery-level | system.battery_level | Battery | Number | | Clock Time Offset | time_offset | time_offset | Temperature | Number | ### Sensor (temperature) Indicates the current temperature. -The ```sensor_temperature``` channel and is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode Sets the thermostat. -The ```thermostat_mode``` channel and is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -80,7 +80,7 @@ The following state translation is provided for this channel to the ```Number``` ### Operating State Sets the thermostat operating state. -The ```thermostat_state``` channel and is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -96,23 +96,25 @@ The following state translation is provided for this channel to the ```Number``` ### Setpoint (cooling) Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel and is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel and is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode Channel type information on this channel is not found. ### Battery Level -Channel type information on this channel is not found. +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 is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset Provides the current time difference for the devices time. -The ```time_offset``` channel and is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. @@ -123,17 +125,17 @@ Detailed information on each parameter can be found in the sections below. | Param | Name | Description | |-------|-------|-------------| -| 1 | Temperature Reporting Threshold | Sets the reporting threshold for changes in the ambient temperature as detected by the thermostat. | -| 3 | Utility Lock Enable/Disable | The Utility Lock Configuration Set command enables or disables the utility lock. If the utility lock is enabled, the setpoint cannot be modified directly via the thermostat screen. | -| 5 | Humidity Reporting Threshold | The Humidity Threshold Configuration Set Command sets the reporting threshold for changes in the relative humidity as detected by the thermostat. | -| 6 | Auxiliary/Emergency | The Auxiliary/Emergency configuration command enables or disables auxiliary / emergency heating in the thermostat. Auxiliary / emergency heating is only available if the thermostat is configured in heat pump mode and with at least one stage of auxiliary h | -| 7 | Thermostat Swing Temperature | The Thermostat Swing Temperature configuration command sets swing temperature on the thermostat. The swing temperature is applied to the setpoint to determine when the thermostat will turn on the HVAC system. If the thermostat is heating, the swing temper | -| 8 | Thermostat Diff Temperature | The Thermostat Differential Temperature configuration command sets the differential temperature for multi-stage HVAC systems. The differential temperature delta defines when the thermostat will turn on additional stages. There are two differential tempera | +| 1 | Temperature Reporting Threshold | Temperature Reporting Threshold | +| 3 | Utility Lock Enable/Disable | Utility Lock Enable/Disable | +| 5 | Humidity Reporting Threshold | Humidity Reporting Threshold | +| 6 | Auxiliary/Emergency | Auxiliary/Emergency | +| 7 | Thermostat Swing Temperature | Thermostat Swing Temperature | +| 8 | Thermostat Diff Temperature | Thermostat Diff Temperature | ### Parameter 1: Temperature Reporting Threshold +Temperature Reporting Threshold Sets the reporting threshold for changes in the ambient temperature as detected by the thermostat. - The following option values may be configured -: | Value | Description | @@ -151,8 +153,8 @@ This parameter has the configuration ID ```config_1_1``` and is of type ```INTEG ### Parameter 3: Utility Lock Enable/Disable +Utility Lock Enable/Disable The Utility Lock Configuration Set command enables or disables the utility lock. If the utility lock is enabled, the setpoint cannot be modified directly via the thermostat screen. - The following option values may be configured -: | Value | Description | @@ -167,8 +169,8 @@ This parameter has the configuration ID ```config_3_1``` and is of type ```INTEG ### Parameter 5: Humidity Reporting Threshold +Humidity Reporting Threshold The Humidity Threshold Configuration Set Command sets the reporting threshold for changes in the relative humidity as detected by the thermostat. - The following option values may be configured -: | Value | Description | @@ -185,8 +187,8 @@ This parameter has the configuration ID ```config_5_1``` and is of type ```INTEG ### Parameter 6: Auxiliary/Emergency -The Auxiliary/Emergency configuration command enables or disables auxiliary / emergency heating in the thermostat. Auxiliary / emergency heating is only available if the thermostat is configured in heat pump mode and with at least one stage of auxiliary h - +Auxiliary/Emergency +The Auxiliary/Emergency configuration command enables or disables auxiliary / emergency heating in the thermostat. Auxiliary / emergency heating is only available if the thermostat is configured in heat pump mode and with at least one stage of auxiliary heat. The following option values may be configured -: | Value | Description | @@ -201,8 +203,8 @@ This parameter has the configuration ID ```config_6_1``` and is of type ```INTEG ### Parameter 7: Thermostat Swing Temperature +Thermostat Swing Temperature The Thermostat Swing Temperature configuration command sets swing temperature on the thermostat. The swing temperature is applied to the setpoint to determine when the thermostat will turn on the HVAC system. If the thermostat is heating, the swing temper - The following option values may be configured -: | Value | Description | @@ -218,8 +220,8 @@ This parameter has the configuration ID ```config_7_1``` and is of type ```INTEG ### Parameter 8: Thermostat Diff Temperature +Thermostat Diff Temperature The Thermostat Differential Temperature configuration command sets the differential temperature for multi-stage HVAC systems. The differential temperature delta defines when the thermostat will turn on additional stages. There are two differential tempera - The following option values may be configured -: | Value | Description | diff --git a/_addons_bindings/zwave/doc/rtc/ct32_0_0.md b/_addons_bindings/zwave/doc/rtc/ct32_0_0.md index bee440343..3271759dd 100644 --- a/_addons_bindings/zwave/doc/rtc/ct32_0_0.md +++ b/_addons_bindings/zwave/doc/rtc/ct32_0_0.md @@ -8,6 +8,8 @@ title: CT32 - ZWave # CT32 Z-Wave Thermostat This describes the Z-Wave device *CT32*, manufactured by *Radio Thermostat Company of America (RTC)* with the thing type UID of ```rtc_ct32_00_000```. +The device is in the category of *HVAC*, defining Air condition devices, Fans. + ![CT32 product image](https://www.cd-jackson.com/zwave_device_uploads/99/99_default.jpg) @@ -15,58 +17,63 @@ The CT32 supports routing. This allows the device to communicate using other rou ## 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/99) to improve the documentation. +The Z-Wave enabled CT32 thermostat is a compact, easy-to-use thermostat that is packed with functionality. The CT32 has a responsive touchscreen interface, easy-to-read backlight display, and 7-day programmability. It features a system lock to avoid unintentional changes for maximum efficiency, a filter change indicator to keep your HVAC system running efficiently, wide temperature operation range, and room temperature calibration for precise control. + +### Inclusion Information + +Go to Menu screen, and press INCLUDE icon. + +### Exclusion Information + +Go to Menu screen, and press EXCLUDE icon. ## Channels The following table summarises the channels available for the CT32 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Sensor (relative humidity) | sensor_relhumidity | Humidity | Number | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Operating State | thermostat_state | Temperature | Number | -| Setpoint (furnace) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (dry air) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | -| Setpoint (cooling) | thermostat_setpoint | Temperature | Number:Temperature | -| Thermostat fan mode | thermostat_fanmode | | | -| Thermostat fan state | thermostat_fanstate | | | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset | time_offset | Temperature | Number | -| Sensor (temperature) 1 | sensor_temperature1 | Temperature | Number:Temperature | -| Sensor (relative humidity) 1 | sensor_relhumidity1 | Humidity | Number | -| Thermostat mode 1 | thermostat_mode1 | Temperature | Number | -| Operating State 1 | thermostat_state1 | Temperature | Number | -| Setpoint (furnace) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Setpoint (dry air) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Setpoint (heating) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Setpoint (cooling) 1 | thermostat_setpoint1 | Temperature | Number:Temperature | -| Thermostat fan mode 1 | thermostat_fanmode1 | | | -| Thermostat fan state 1 | thermostat_fanstate1 | | | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset 1 | time_offset1 | Temperature | Number | -| Sensor (temperature) 2 | sensor_temperature2 | Temperature | Number:Temperature | -| Sensor (relative humidity) 2 | sensor_relhumidity2 | Humidity | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (furnace) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (dry air) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode | thermostat_fanmode | thermostat_fanmode | | | +| Thermostat fan state | thermostat_fanstate | thermostat_fanstate | | | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | +| Sensor (temperature) 1 | sensor_temperature1 | sensor_temperature | Temperature | Number:Temperature | +| Sensor (relative humidity) 1 | sensor_relhumidity1 | sensor_relhumidity | Humidity | Number | +| Thermostat mode 1 | thermostat_mode1 | thermostat_mode | Temperature | Number | +| Operating State 1 | thermostat_state1 | thermostat_state | Temperature | Number | +| Setpoint (furnace) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (dry air) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (cooling) 1 | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat fan mode 1 | thermostat_fanmode1 | thermostat_fanmode | | | +| Thermostat fan state 1 | thermostat_fanstate1 | thermostat_fanstate | | | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset 1 | time_offset1 | time_offset | Temperature | Number | +| Sensor (temperature) 2 | sensor_temperature2 | sensor_temperature | Temperature | Number:Temperature | +| Sensor (relative humidity) 2 | sensor_relhumidity2 | sensor_relhumidity | Humidity | Number | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) - Indicates the current relative humidity. -The ```sensor_relhumidity``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -87,10 +94,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State - Sets the thermostat operating state. -The ```thermostat_state``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -104,66 +110,55 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (furnace) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (dry air) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (cooling) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode - Channel type information on this channel is not found. ### Thermostat fan state - Channel type information on this channel is not found. ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset - Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ### Sensor (temperature) 1 - Indicates the current temperature. -The ```sensor_temperature1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature1``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) 1 - Indicates the current relative humidity. -The ```sensor_relhumidity1``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity1``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. ### Thermostat mode 1 - Sets the thermostat. -The ```thermostat_mode1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode1``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -184,10 +179,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State 1 - Sets the thermostat operating state. -The ```thermostat_state1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state1``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -201,60 +195,50 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (furnace) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (dry air) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (cooling) 1 - Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat fan mode 1 - Channel type information on this channel is not found. ### Thermostat fan state 1 - Channel type information on this channel is not found. ### Battery Level - 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 ```battery-level1``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level1``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset 1 - Provides the current time difference for the devices time. -The ```time_offset1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset1``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ### Sensor (temperature) 2 - Indicates the current temperature. -The ```sensor_temperature2``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature2``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) 2 - Indicates the current relative humidity. -The ```sensor_relhumidity2``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity2``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. diff --git a/_addons_bindings/zwave/doc/rtc/ct80_0_0.md b/_addons_bindings/zwave/doc/rtc/ct80_0_0.md index d16453e41..92f846d76 100644 --- a/_addons_bindings/zwave/doc/rtc/ct80_0_0.md +++ b/_addons_bindings/zwave/doc/rtc/ct80_0_0.md @@ -17,35 +17,43 @@ The CT80 supports routing. This allows the device to communicate using other rou ## Overview +The CT80 programmable communicating thermostat operates via a high-quality, easy-to-use touch screen. To program or adjust your CT80, simply touch your finger firmly to the screen. The screen will automatically light up. The screen will respond differently to different types of touches, so you may want to experiment with your finger or a stylus (not included), to see what works best for you. The “beep” sound is heard when the CT80 senses a valid touch of the screen. + ### Inclusion Information Push Menu button, choose network, choose Z-Wave Radio, push "Mate" (only usable with Z-Wave Module) +### Exclusion Information + +# Factory Default Restore + +Performing a Factory Default Restore will return your thermostat to the state it was in when it left the factory. This means that all of its configuration and parameters will be returned to their default values. This includes resetting its Z-Wave network information, removing it from its previous network. This action should only be used in the event that the network primary controller is missing or otherwise inoperable. To perform this action, the thermostat must be switch to OFF mode. Wait until the radio wave icons on the left side of the screen stop blinking then touch the screen once to turn on the back light and then hold the center of the screen for about 8 seconds until the thermostat beeps.  + ## Channels The following table summarises the channels available for the CT80 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat Mode | thermostat_mode | Temperature | Number | -| Operating State | thermostat_state | Temperature | Number | -| Setpoint (cooling) | thermostat_setpoint | Heating | Number:Temperature | -| Setpoint (heating) | thermostat_setpoint | Heating | Number:Temperature | -| Thermostat Fan Mode | thermostat_fanmode | | | -| Battery Level | battery-level | Battery | Number | -| Clock Time Offset | time_offset | Temperature | Number | -| Sensor (relative humidity) | sensor_relhumidity1 | Humidity | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat Mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Thermostat Fan Mode | thermostat_fanmode | thermostat_fanmode | | | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | +| Sensor (relative humidity) | sensor_relhumidity1 | sensor_relhumidity | Humidity | Number | ### Sensor (temperature) Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat Mode Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -68,7 +76,7 @@ The following state translation is provided for this channel to the ```Number``` ### Operating State Sets the thermostat operating state. -The ```thermostat_state``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -84,12 +92,12 @@ The following state translation is provided for this channel to the ```Number``` ### Setpoint (cooling) Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Heating``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Heating``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Thermostat Fan Mode Channel type information on this channel is not found. @@ -97,17 +105,17 @@ Channel type information on this channel is not found. ### Battery Level 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ### Clock Time Offset Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ### Sensor (relative humidity) Indicates the current relative humidity. -The ```sensor_relhumidity1``` channel supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_relhumidity1``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device. diff --git a/_addons_bindings/zwave/doc/ruixiang/dm0027mini_0_0.md b/_addons_bindings/zwave/doc/ruixiang/dm0027mini_0_0.md new file mode 100644 index 000000000..acd411baf --- /dev/null +++ b/_addons_bindings/zwave/doc/ruixiang/dm0027mini_0_0.md @@ -0,0 +1,91 @@ +--- +layout: documentation +title: DM0027 Mini - ZWave +--- + +{% include base.html %} + +# DM0027 Mini Smart-Touch Electronic Drapery Drive +This describes the Z-Wave device *DM0027 Mini*, manufactured by *Guangzhou Ruixiang M&E Co., Ltd* with the thing type UID of ```ruixiang_dm0027mini_00_000```. + +The device is in the category of *Blinds*, defining Roller shutters, window blinds, etc.. + +![DM0027 Mini product image](https://www.cd-jackson.com/zwave_device_uploads/1102/1102_default.jpg) + + +The DM0027 Mini 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 between other devices in the mesh network. + +## Overview + +Smart-Touch Motorized Drapery System +Sleek belt driven motorized drapery track can be easily curved to meet your installation requirements. +Spans up to 19' unspliced and pulls up to 133lbs of fabric.  + +### Inclusion Information + +Not provided + +### Exclusion Information + +Not provided + +## Channels + +The following table summarises the channels available for the DM0027 Mini -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Blinds Control | blinds_control | blinds_control | Blinds | Rollershutter | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Blinds Control +Provides start / stop control of blinds. + +The ```blinds_control``` channel is of type ```blinds_control``` and supports the ```Rollershutter``` item and is in the ```Blinds``` category. + + + +## Device Configuration + +The device has no configuration parameters defined. + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The device does not support associations. +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | + +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/1102/Finesse.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1102). diff --git a/_addons_bindings/zwave/doc/samsungsds/hmdm100_0_0.md b/_addons_bindings/zwave/doc/samsungsds/hmdm100_0_0.md index 90fea9edb..21a99d36d 100644 --- a/_addons_bindings/zwave/doc/samsungsds/hmdm100_0_0.md +++ b/_addons_bindings/zwave/doc/samsungsds/hmdm100_0_0.md @@ -31,16 +31,15 @@ Triple press inclusion button The following table summarises the channels available for the hmdm100 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Door Lock | lock_door | Door | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Door Lock | lock_door | lock_door | Door | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Door Lock - Lock and unlock the door. -The ```lock_door``` channel supports the ```Switch``` item and is in the ```Door``` category. +The ```lock_door``` channel is of type ```lock_door``` and supports the ```Switch``` item and is in the ```Door``` category. The following state translation is provided for this channel to the ```Switch``` item type -: | Value | Label | @@ -49,11 +48,10 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Unlocked | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration @@ -161,6 +159,7 @@ Association group 2 supports 5 nodes. | COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | | COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | | COMMAND_CLASS_DOOR_LOCK_V1| Linked to BASIC| +| COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | | COMMAND_CLASS_POWERLEVEL_V1| | | COMMAND_CLASS_BATTERY_V1| | diff --git a/_addons_bindings/zwave/doc/seco/clamp_0_0.md b/_addons_bindings/zwave/doc/seco/clamp_0_0.md index 2700f0f02..ea372e28f 100644 --- a/_addons_bindings/zwave/doc/seco/clamp_0_0.md +++ b/_addons_bindings/zwave/doc/seco/clamp_0_0.md @@ -8,65 +8,208 @@ title: Zwave Clamp - ZWave # Zwave Clamp Clamp Energy Meter This describes the Z-Wave device *Zwave Clamp*, manufactured by *[Seco](http://www.seco.com/)* with the thing type UID of ```seco_clamp_00_000```. +The device is in the category of *Sensor*, defining Device used to measure something. + +![Zwave Clamp product image](https://www.cd-jackson.com/zwave_device_uploads/569/569_default.png) + + The Zwave Clamp 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 between other devices in the mesh network. ## 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/569) to improve the documentation. +The Wireless Energy Meter performs real-time measurement of power, energy, voltage, and current, and transmits them wirelessly to a central controller. + +### Inclusion Information + +Press the WEM button for about 1 second. + +WEM enters the “Learning” state and the LED changes blinking pattern. + +When the learning phase ends successfully, WEM enters the “Synchronizing” state, and then the “Joined, Comm. Ok” state. + +### Exclusion Information + +Press the WEM button for about 3 seconds. + +WEM enters the “Leaving” state, and waits for the controller to acknowledge its exclusion. + +When the exclusion process is complete, WEM goes into the “Idle” state. ## Channels The following table summarises the channels available for the Zwave Clamp -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Electric meter (amps) | meter_current | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Clock Time Offset | time_offset | Temperature | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Clock Time Offset | time_offset | time_offset | Temperature | Number | ### Electric meter (amps) - Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) - Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) - Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) - Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Clock Time Offset - Provides the current time difference for the devices time. -The ```time_offset``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 8 configuration parameters available in the Zwave Clamp. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 2 | MEAS_PERIOD | MEAS_PERIOD | +| 3 | MAX_REP_INTERVAL | MAX\_REP\_INTERVAL | +| 4 | RES_ACTIVE_POWER | RES\_ACTIVE\_POWER | +| 5 | RES_RMS_VOLTAGE | RES\_RMS\_VOLTAGE | +| 6 | RES_RMS_CURRENT | RES\_RMS\_CURRENT | +| 8 | CLAMP_REVERSED | CLAMP_REVERSED | +| 9 | ENABLE_CRC16 | ENABLE_CRC16 | +| 10 | AVG_PERIOD | AVG_PERIOD | + +### Parameter 2: MEAS_PERIOD + +MEAS_PERIOD +MEAS\_PERIOD represents the minimum reporting interval, i.e. 1/MEAS\_PERIOD is the maximum reporting frequency. WEM checks for changes in the line measures every MEAS_PERIOD. If there are meaningful changes, a report is sent to the controller. +Values in the range 30 to 120 may be set. + +The manufacturer defined default value is ```30```. + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: MAX_REP_INTERVAL + +MAX\_REP\_INTERVAL +**Units of 10 sec** + +MAX\_REP\_INTERVAL is the maximum time that can elapse without sending a report. If no meaningful events occur, WEM sends one measurement every MAX\_REP\_INTERVAL seconds. Notice that, since the check is performed every MEAS\_PERIOD, the reporting interval is rounded to the smallest multiple integer of MEAS\_PERIOD (e.g. MEAS\_PERIOD = 45, MAX\_REP_INTERVAL = 12, reports are sent every 135 s). +Values in the range 3 to 60 may be set. + +The manufacturer defined default value is ```6```. + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: RES_ACTIVE_POWER + +RES\_ACTIVE\_POWER +The minimum quantity (resolution) that triggers a report +Values in the range 1 to 100 may be set. + +The manufacturer defined default value is ```4```. + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 5: RES_RMS_VOLTAGE + +RES\_RMS\_VOLTAGE +**Units of 100 mV** + +The minimum quantity (resolution) that triggers a report +Values in the range 1 to 1000 may be set. + +The manufacturer defined default value is ```10```. + +This parameter has the configuration ID ```config_5_2``` and is of type ```INTEGER```. + + +### Parameter 6: RES_RMS_CURRENT + +RES\_RMS\_CURRENT +**Units of 10 mA** + +The minimum quantity (resolution) that triggers a report +Values in the range 1 to 1000 may be set. + +The manufacturer defined default value is ```10```. + +This parameter has the configuration ID ```config_6_2``` and is of type ```INTEGER```. + + +### Parameter 8: CLAMP_REVERSED + +CLAMP_REVERSED +CLAMP\_REVERSED is a read-only parameter that the controller can query to learn about the current placement of the clamp. During the measurement phase, WEM checks whether the clamp has been placed correctly or reversed (with regard to phase rotation). In the latter case, WEM notifies the user with a different blink pattern and stores this information into the CLAMP\_REVERSED parameter. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Clamp placed Correctly | +| 1 | Clamp is REVERSED | +| 255 | Could not detect position | + +The manufacturer defined default value is ```255``` (Could not detect position). + +This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```. +This is a read only parameter. + + +### Parameter 9: ENABLE_CRC16 + +ENABLE_CRC16 +ENABLE\_CRC16 parameter provides for an extra layer of redundancy in order to protect low bit rate transmissions against radio channel errors. This applies to the reports and frames sent spontaneous by WEM. Requests from the controller are always answered as asked. WEM will send CRC16 encapsulated frames to the associated node if this has proved to support it and the ENABLE\_CRC16 parameter is set to 1. Otherwise, reports will be sent with no extra CRC16 encapsulation. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | False | +| 1 | True | + +The manufacturer defined default value is ```1``` (True). + +This parameter has the configuration ID ```config_9_1``` and is of type ```INTEGER```. + + +### Parameter 10: AVG_PERIOD + +AVG_PERIOD +**Units of 5 seconds** + +AVG\_PERIOD determines the time window used to compute an average over the line readings. Each unit of AVG\_PERIOD is worth 5 seconds. If AVG\_PERIOD = 0 no average is computed and the last sample is returned. Note that the maximum average window coincides with the minimum value of MAX\_REP_INTERVAL. Also note that a delay of up to the average window can be introduced in returning the measurements (each measurement is returned only when ready). +Values in the range 0 to 6 may be set. + +The manufacturer defined default value is ```1```. + +This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The device does not support associations. +The Zwave Clamp supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 1 node. + ## Technical Information ### Endpoints @@ -91,6 +234,10 @@ The device does not support associations. | COMMAND_CLASS_TIME_V1| | | COMMAND_CLASS_TIME_PARAMETERS_V1| | +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/569/72027101-UM-01-meter-user-manual-v1-0.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/sensative/1101011_0_0.md b/_addons_bindings/zwave/doc/sensative/1101011_0_0.md index 2dcf03522..817e673f8 100644 --- a/_addons_bindings/zwave/doc/sensative/1101011_0_0.md +++ b/_addons_bindings/zwave/doc/sensative/1101011_0_0.md @@ -19,6 +19,8 @@ The 11-01-011 does not permanently listen for messages sent from the controller ## Overview +Strips is a Z-Wave magnet sensor that can be added to any certified Z-Wave system and operate with any brand Z-Wave device. + ### Inclusion Information * Set your controller in inclusion mode (see your controller’s manual). @@ -52,17 +54,16 @@ Note that wakeup period can only be set to a minimum period of 30 minutes. The following table summarises the channels available for the 11-01-011 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Door Sensor | sensor_door | Door | Contact | -| Tamper Alarm | alarm_tamper | | Switch | -| Battery Level | battery-level | Battery | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Door Sensor | sensor_door | sensor_door | Door | Contact | +| Tamper Alarm | alarm_tamper | alarm_tamper | | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | ### Door Sensor - Indicates if the door/window is open or closed. -The ```sensor_door``` channel supports the ```Contact``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_door``` channel is of type ```sensor_door``` and supports the ```Contact``` item and is in the ```Door``` category. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Contact``` item type -: @@ -72,10 +73,9 @@ The following state translation is provided for this channel to the ```Contact`` | CLOSED | Closed | ### Tamper Alarm - Indicates if the tamper alarm is triggered. -The ```alarm_tamper``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_tamper``` channel is of type ```alarm_tamper``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -85,11 +85,10 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Battery Level - 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 ```battery-level``` channel supports the ```Number``` item and is in the ```Battery``` category. - +The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. ## Device Configuration diff --git a/_addons_bindings/zwave/doc/shenzhen/eu1_0_0.md b/_addons_bindings/zwave/doc/shenzhen/eu1_0_0.md index 3650f4e4a..24e886ee5 100644 --- a/_addons_bindings/zwave/doc/shenzhen/eu1_0_0.md +++ b/_addons_bindings/zwave/doc/shenzhen/eu1_0_0.md @@ -8,6 +8,11 @@ title: EU-1 - ZWave # EU-1 Light Switch 1 Channel This describes the Z-Wave device *EU-1*, manufactured by *[Shenzhen Neo Electronics Co., Ltd](http://www.szneo.com/)* with the thing type UID of ```shenzhen_eu1_00_000```. +The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. + +![EU-1 product image](https://www.cd-jackson.com/zwave_device_uploads/679/679_default.png) + + The EU-1 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 between other devices in the mesh network. ## Overview @@ -36,15 +41,14 @@ Light Switch is an intelligent device that can be remotely controlled through Z- The following table summarises the channels available for the EU-1 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | ### Switch - Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. @@ -162,6 +166,10 @@ Association group 2 supports 5 nodes. | COMMAND_CLASS_ASSOCIATION_V2| | | COMMAND_CLASS_VERSION_V2| | +### Documentation Links + +* [Web Page & Manual](https://www.cd-jackson.com/zwave_device_uploads/679/EU-1.pdf) + --- Did you spot an error in the above definition or want to improve the content? diff --git a/_addons_bindings/zwave/doc/shenzhen/neors_0_0.md b/_addons_bindings/zwave/doc/shenzhen/neors_0_0.md new file mode 100644 index 000000000..599331081 --- /dev/null +++ b/_addons_bindings/zwave/doc/shenzhen/neors_0_0.md @@ -0,0 +1,201 @@ +--- +layout: documentation +title: NEO Coolcam Roller Shutter - ZWave +--- + +{% include base.html %} + +# NEO Coolcam Roller Shutter NEO Coolcam Roller Shutter - Curtain Switch - NAS-SC03ZE-2-T-V3 +This describes the Z-Wave device *NEO Coolcam Roller Shutter*, manufactured by *[Shenzhen Neo Electronics Co., Ltd](http://www.szneo.com/)* with the thing type UID of ```shenzhen_neors_00_000```. + +The device is in the category of *Blinds*, defining Roller shutters, window blinds, etc.. + +![NEO Coolcam Roller Shutter product image](https://www.cd-jackson.com/zwave_device_uploads/1108/1108_default.jpg) + + +The NEO Coolcam Roller Shutter 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 between other devices in the mesh network. + +## Overview + + * Brand Name: Coolcam + * Model Number: ZWAVE Curtain Switch + * ZWAVE Plus frequency: 868.4MHZ + * Current output: 10A + * Power consumption: 1.2W + * operation mode: touch-sensitive + * power: 80-250V AC,50-60Hz + * hub: need hub to operate,such as Fibaro,Vera ect + * size: 86\*86\*34mm + +### Inclusion Information + + 1. Set Zwave controller intro inclusion mode + 2. power on the device + 3. touch the middle button 3 times within 1s + 4.  the device will be entered into inclusion mode automatically + +(All Led lights will be bliked with 1s interval until inclusion successfull) + +### Exclusion Information + + 1. Set Z-WaveControll into exclusion mode + 2. Pwer on the device + 3. Touch the middle button 3 times within 1s + 4. the device will be entered into exclusion mode + +## Channels + +The following table summarises the channels available for the NEO Coolcam Roller Shutter -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Blinds Control | blinds_control | blinds_control | Blinds | Rollershutter | + +### Switch +Switch the power on and off. + +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. + +### Blinds Control +Provides start / stop control of blinds. + +The ```blinds_control``` channel is of type ```blinds_control``` and supports the ```Rollershutter``` item and is in the ```Blinds``` category. + + + +## Device Configuration + +The following table provides a summary of the 5 configuration parameters available in the NEO Coolcam Roller Shutter. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Up/Down Button Swap Enable | Up/Down Button Swap Enable | +| 2 | Motor Rotation Direction Swap Enable | Motor Rotation Direction Swap Enable | +| 3 | Backlight Enable | Backlight Enable | +| 4 | Curtain Moving Indicate Enable | Curtain Moving Indicate Enable | +| 5 | Button Switch | Button Switch | + +### Parameter 1: Up/Down Button Swap Enable + +Up/Down Button Swap Enable + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Enabled | + +The manufacturer defined default value is ```1``` (Enabled). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Motor Rotation Direction Swap Enable + +Motor Rotation Direction Swap Enable + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Disabled | +| 1 | Enabled | + +The manufacturer defined default value is ```0``` (Disabled). + +This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```. + + +### Parameter 3: Backlight Enable + +Backlight Enable + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED Disabled | +| 1 | LED ON when Switch is ON | + +The manufacturer defined default value is ```1``` (LED ON when Switch is ON). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Curtain Moving Indicate Enable + +Curtain Moving Indicate Enable + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | LED Disabled | +| 1 | LED Enabled | + +The manufacturer defined default value is ```1``` (LED Enabled). + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 5: Button Switch + +Button Switch + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Button Switch Disabled | +| 1 | Button Switch Enabled | + +The manufacturer defined default value is ```1``` (Button Switch Enabled). + +This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The NEO Coolcam Roller Shutter supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 5 nodes. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V1| | + +### Documentation Links + +* [Manual](https://www.cd-jackson.com/zwave_device_uploads/1108/NeoRollerS.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1108). diff --git a/_addons_bindings/zwave/doc/shenzhen/sosremote_0_0.md b/_addons_bindings/zwave/doc/shenzhen/sosremote_0_0.md new file mode 100644 index 000000000..7c882d34d --- /dev/null +++ b/_addons_bindings/zwave/doc/shenzhen/sosremote_0_0.md @@ -0,0 +1,260 @@ +--- +layout: documentation +title: SOS/Remote Control - ZWave +--- + +{% include base.html %} + +# SOS/Remote Control Z-Wave Remote for Scene selection and SOS button +This describes the Z-Wave device *SOS/Remote Control*, manufactured by *[Shenzhen Neo Electronics Co., Ltd](http://www.szneo.com/)* with the thing type UID of ```shenzhen_sosremote_00_000```. + +The device is in the category of *Remote Control*, defining Any portable or hand-held device that controls the status of something, e.g. remote control, keyfob etc.. + +![SOS/Remote Control product image](https://www.cd-jackson.com/zwave_device_uploads/799/799_default.jpg) + + +The SOS/Remote Control 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 SOS/Remote Control 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. Refer to the *Wakeup Information* section below for further information. + +## Overview + +Remote control/SOS is a smart security device that can communication with other devices via z-wave. It is compatible with z-wave plus devices, battery powered , compact to carry .SOS is used for emergency. +With 4 buttons, you can use Remote control for emergency call and set 6 different scenes. + +### Inclusion Information + + 1. Ensure remote control is in z-wave range. + 2. Set the controller in learning mode.(refer to the controller user manual) + 3. Quickly pressing the red button three times,Led will blink. + 4. The controller will recognize remote control and add it into z-wave network. + 5. Wait for the controller to configure. + +### Exclusion Information + + 1. Ensure the device is connected to power supply.  + 2. Set the controller in remove mode(refer to controller’s user manual) + 3. Quick pressing the red button for three times. + 4. Wait for removing SOS from the controller . + +### Wakeup Information + +The SOS/Remote Control 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. + + +Press the red button once. + +## Channels + +The following table summarises the channels available for the SOS/Remote Control -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Scene Number | scene_number | scene_number | | Number | +| Alarm (emergency) | alarm_emergency | alarm_emergency | Alarm | Switch | +| Battery Level | battery-level | system.battery_level | Battery | Number | + +### Binary Sensor +Indicates if a sensor has triggered. + +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| ON | Triggered | +| OFF | Untriggered | + +### Scene Number +Triggers when a scene button is pressed. + +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. +This channel provides the scene, and the event as a decimal value in the form ```<scene>.<event>```. The scene number is set by the device, and the event is as follows -: + +| Event ID | Event Description | +|----------|--------------------| +| 0 | Single key press | +| 1 | Key released | +| 2 | Key held down | +| 3 | Double keypress | +| 4 | Tripple keypress | +| 5 | 4 x keypress | +| 6 | 5 x keypress | + +### Alarm (emergency) +Indicates Police, Fire, or Medical services should be contacted. + +The ```alarm_emergency``` channel is of type ```alarm_emergency``` and supports the ```Switch``` item and is in the ```Alarm``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| ON | EMERGENCY | +| OFF | OK | + +### Battery Level +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 is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. + + +## Device Configuration + +The following table provides a summary of the 3 configuration parameters available in the SOS/Remote Control. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Basic Set Level | Basic Set Level | +| 2 | SOS Event Clear Time | SOS Event Clear Time | +| 3 | SOS Configuration | SOS Configuration | +| | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | +| | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | + +### Parameter 1: Basic Set Level + +Basic Set Level +Basic Set Command will be sent where contains a value when SOS is triggered if group 2 have associated a device such as siren, the receiver will take it for consideration; for instance, if associated siren is received the Basic Set Command (0xFF), the siren will take alarm on. + +0~99 are mapping to Basic Set value (0 ~ 99). 100 is mapping to Basic Set Value 0xFF. +Values in the range 0 to 100 may be set. + +The manufacturer defined default value is ```100```. + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: SOS Event Clear Time + +SOS Event Clear Time +This parameter defines the time to clear emergency event after emergency event is triggered when parameter #3 is set to ‘2’. + +This parameter is set to ‘0’, the clearing emergency event will not occurred always. + +The default value of this parameter is set to ‘60’, means that the emergency event will be cleared after 60 seconds when emergency event is triggered. +Values in the range 30 to 32767 may be set. + +The manufacturer defined default value is ```60```. + +This parameter has the configuration ID ```config_2_2``` and is of type ```INTEGER```. + + +### Parameter 3: SOS Configuration + +SOS Configuration +This parameter defines the SOS key function, the SOS key can be configured as emergency event key or central scene notification key. + +If this parameter is set to ‘1’, the SOS key will be configured as central scene notification key. + +If this parameter is set to ‘2’, the SOS key will be configured as emergency event notification key. The default settings is ‘2’, the SOS key is  + +configured as emergency event notification key. +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | Enable Scene Mode | +| 2 | SOS Mode | + +The manufacturer defined default value is ```2``` (SOS Mode). + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + +### Wakeup Interval + +The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications. + +This setting is defined in *seconds*. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances. + +Note that this setting does not affect the devices ability to send sensor data, or notification events. + +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_node``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The SOS/Remote Control supports 2 association groups. + +### Group 1: Group 1 + +Able to control z-wave main controller setting or alarm host status. +* COMMAND\_CLASS\_ZWAVEPLUS_INFO (V2) + +* COMMAND\_CLASS\_VERSION (V2) + +* COMMAND\_CLASS\_MANUFACTURER_SPECIFIC (V2) + +* COMMAND\_CLASS\_DEVICE\_RESET\_LOCALLY (V1) + +* COMMAND\_CLASS\_POWERLEVEL (V1) + +* COMMAND\_CLASS\_BATTERY (V1) + +* COMMAND\_CLASS\_ASSOCIATION (V2) + +* COMMAND\_CLASS\_ASSOCIATION\_GRP\_INFO (V1) + +* COMMAND\_CLASS\_WAKE_UP (V2) + +* COMMAND\_CLASS\_NOTIFICATION (V8) + +* COMMAND\_CLASS\_SENSOR_BINARY (V2) + +* COMMAND\_CLASS\_CONFIGURATION (V1) + +Association group 1 supports 1 node. + +### Group 2: Group 2 + +Switch or active the scene existing in the z-wave controller,thus to control other devices in the scene . +Note:Remote control is communicating with other devices via z-wave network directly, z-wave controller is not involved in. + +Association group 2 supports 1 node. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SENSOR_BINARY_V2| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_CENTRAL_SCENE_V2| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V8| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_BATTERY_V1| | +| COMMAND_CLASS_WAKE_UP_V2| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | + +### Documentation Links + +* [SOS PDF from NEO](https://www.cd-jackson.com/zwave_device_uploads/799/SOS.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/799). diff --git a/_addons_bindings/zwave/doc/siegeniaaubi/sensoair_0_0.md b/_addons_bindings/zwave/doc/siegeniaaubi/sensoair_0_0.md index 352a0da87..45f821312 100644 --- a/_addons_bindings/zwave/doc/siegeniaaubi/sensoair_0_0.md +++ b/_addons_bindings/zwave/doc/siegeniaaubi/sensoair_0_0.md @@ -8,6 +8,8 @@ title: Sensoair - ZWave # Sensoair Air quality sensor for indoor use This describes the Z-Wave device *Sensoair*, manufactured by *[SIEGENIA-AUBI KG](https://www.siegenia.com)* with the thing type UID of ```siegeniaaubi_sensoair_00_000```. +The device is in the category of *Sensor*, defining Device used to measure something. + ![Sensoair product image](https://www.cd-jackson.com/zwave_device_uploads/451/451_default.jpg) @@ -15,21 +17,28 @@ The Sensoair supports routing. This allows the device to communicate using other ## 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/451) to improve the documentation. +This device measures levels og carbon dioxide & VOCs. + +### Inclusion Information + +Press the push-button on the bottom of the unit once. + +### Exclusion Information + +Press the push-button on the bottom of the unit once. ## Channels The following table summarises the channels available for the Sensoair -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (CO2) | sensor_co2 | | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (CO2) | sensor_co2 | sensor_co2 | CarbonDioxide | Number | ### Sensor (CO2) - Indicates the CO2 level. -The ```sensor_co2``` channel supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_co2``` channel is of type ```sensor_co2``` and supports the ```Number``` item and is in the ```CarbonDioxide``` category. This is a read only channel so will only be updated following state changes from the device. diff --git a/_addons_bindings/zwave/doc/simontech/10002041130_0_0.md b/_addons_bindings/zwave/doc/simontech/10002041130_0_0.md index 62e8201e9..e4e63dcd6 100644 --- a/_addons_bindings/zwave/doc/simontech/10002041130_0_0.md +++ b/_addons_bindings/zwave/doc/simontech/10002041130_0_0.md @@ -31,32 +31,32 @@ KeyPad long press (2s<t<30s) -> Central LED blinks until release of Pushbutton - The following table summarises the channels available for the 10002041-130 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | -| Electric meter (amps) | meter_current | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | ### Switch Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (watts) Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (amps) Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. @@ -118,7 +118,7 @@ This parameter has the configuration ID ```config_2_2``` and is of type ```INTEG Beacon LEDs 0x01-0x63 (1-100%) -> Sets the intensity of the beacon LEDs. -The following option values may be configured -: +The following option values may be configured, in addition to values in the range 0 to 99 -: | Value | Description | |--------|-------------| diff --git a/_addons_bindings/zwave/doc/simontech/1000204113x_0_0.md b/_addons_bindings/zwave/doc/simontech/1000204113x_0_0.md index 83b62be3b..a52f5bde2 100644 --- a/_addons_bindings/zwave/doc/simontech/1000204113x_0_0.md +++ b/_addons_bindings/zwave/doc/simontech/1000204113x_0_0.md @@ -31,32 +31,32 @@ KeyPad long press (2s<t<30s) -> Central LED blinks until release of Pushbutton - The following table summarises the channels available for the 10002041-13X -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Switch | switch_binary | Switch | Switch | -| Electric meter (amps) | meter_current | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Electric meter (volts) | meter_voltage | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Switch | switch_binary | switch_binary | Switch | Switch | +| Electric meter (amps) | meter_current | meter_current | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | ### Switch Switch the power on and off. -The ```switch_binary``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (amps) Indicates the instantaneous current consumption. -The ```meter_current``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_current``` channel is of type ```meter_current``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (volts) Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. @@ -114,7 +114,7 @@ This parameter has the configuration ID ```config_2_2``` and is of type ```INTEG Beacon LEDs 0x01-0x63 (1-100%) -> Sets the intensity of the beacon LEDs. -The following option values may be configured -: +The following option values may be configured, in addition to values in the range 0 to 99 -: | Value | Description | |--------|-------------| diff --git a/_addons_bindings/zwave/doc/somfy/zrtsi_0_0.md b/_addons_bindings/zwave/doc/somfy/zrtsi_0_0.md index adc4cdf1a..97fc3e5e5 100644 --- a/_addons_bindings/zwave/doc/somfy/zrtsi_0_0.md +++ b/_addons_bindings/zwave/doc/somfy/zrtsi_0_0.md @@ -10,16 +10,28 @@ This describes the Z-Wave device *ZRTSI*, manufactured by *[Somfy](http://www.so The device is in the category of *Blinds*, defining Roller shutters, window blinds, etc.. +![ZRTSI product image](https://www.cd-jackson.com/zwave_device_uploads/369/369_default.png) + + ## 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/369) to improve the documentation. +Somfy's new Z-Wave® to Radio Technology Somfy® Interface, or ZRTSI, is a Z-Wave certified device that receives Z-Wave signals and converts them to Radio Technology Somfy® (RTS). The ZRTSI was developed to integrate Somfy's range of RTS motors into TaHomATM. The ZRTSI can be used with up to 16 individual or groups of motorized products and plugs into any standard 120VAC 60Hz outlet. (Cat. No: 1870202) + +### Inclusion Information + +On the ZRTSI, Activate the “Base Node Include” command by pressing the Select Button. + +### Exclusion Information + + 1. From the ZRTSI's Home Screen, navigate to the Base Node Exclude screen.  + 2. Activate the “Base Node Exclude” command by pressing the Select Button.  ## Channels The following table summarises the channels available for the ZRTSI -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| diff --git a/_addons_bindings/zwave/doc/steinel/l810ledihf_0_0.md b/_addons_bindings/zwave/doc/steinel/l810ledihf_0_0.md index 012877be7..643f7e7f9 100644 --- a/_addons_bindings/zwave/doc/steinel/l810ledihf_0_0.md +++ b/_addons_bindings/zwave/doc/steinel/l810ledihf_0_0.md @@ -17,42 +17,49 @@ The L 810 LED iHF supports routing. This allows the device to communicate using ## 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/705) to improve the documentation. +A high-quality product is cleverly thought through and made from materials that last. Its value also extends beyond today, it has permanency and constancy. The L 810 iHF outdoor SensorLight is an LED uplight and downlight that translates intelligent technology into form and function. For the first time, we have managed to make a light's sensor completely invisible – without compromising on first-class design and technological perfection. For stunning upward and downward lighting. New: optional manual override for 4 hours. + +The optional Smart Friends box and the free Smart Friends app make it easy to set the L 810 LED iHF Z-Wave via smart phone or tablet. The light can also be switched ON or OFF via app. Other Steinel products can also be interconnected. If you wish, this also works via remote control when you are out. That completes your own light management system. + +### Inclusion Information + +4) Briefly press the device's button to set the light to inclusion mode. + +### Exclusion Information + +Briefly press the device's button to set the light to exclusion mode.  ## Channels The following table summarises the channels available for the L 810 LED iHF -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Dimmer | switch_dimmer | DimmableLight | Dimmer | -| Scene Number | scene_number | | Number | -| Binary Sensor | sensor_binary | Door | Switch | -| Sensor (luminance) | sensor_luminance | | Number | -| Alarm (burglar) | alarm_burglar | Door | Switch | -| Alarm (system) | alarm_system | | Switch | -| Dimmer 1 | switch_dimmer1 | DimmableLight | Dimmer | -| Scene Number 1 | scene_number1 | | Number | -| Alarm (burglar) 2 | alarm_burglar2 | Door | Switch | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | scene_number | scene_number | | Number | +| Binary Sensor | sensor_binary | sensor_binary | | Switch | +| Sensor (luminance) | sensor_luminance | sensor_luminance | | Number | +| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch | +| Alarm (system) | alarm_system | alarm_system | | Switch | +| Dimmer 1 | switch_dimmer1 | switch_dimmer | DimmableLight | Dimmer | +| Scene Number 1 | scene_number1 | scene_number | | Number | +| Alarm (burglar) 2 | alarm_burglar2 | alarm_burglar | Door | Switch | ### 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. +The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number - Triggers when a scene button is pressed. -The ```scene_number``` channel supports the ```Number``` item. +The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Binary Sensor - 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. +The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -62,16 +69,14 @@ The following state translation is provided for this channel to the ```Switch``` | OFF | Untriggered | ### Sensor (luminance) - Indicates the current light reading. -The ```sensor_luminance``` channel supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. +The ```sensor_luminance``` channel is of type ```sensor_luminance``` and supports the ```Number``` item. This is a read only channel so will only be updated following state changes from the device. ### Alarm (burglar) - Indicates if the burglar alarm is triggered. -The ```alarm_burglar``` 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. +The ```alarm_burglar``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -81,10 +86,9 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Alarm (system) - Indicates if a system alarm is triggered. -The ```alarm_system``` channel supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. +The ```alarm_system``` channel is of type ```alarm_system``` and supports the ```Switch``` item. This is a read only channel so will only be updated following state changes from the device. The following state translation is provided for this channel to the ```Switch``` item type -: @@ -94,23 +98,20 @@ The following state translation is provided for this channel to the ```Switch``` | ON | Alarm | ### Dimmer 1 - The brightness channel allows to control the brightness of a light. It is also possible to switch the light on and off. -The ```switch_dimmer1``` channel supports the ```Dimmer``` item and is in the ```DimmableLight``` category. +The ```switch_dimmer1``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. ### Scene Number 1 - Triggers when a scene button is pressed. -The ```scene_number1``` channel supports the ```Number``` item. +The ```scene_number1``` channel is of type ```scene_number``` and supports the ```Number``` item. ### Alarm (burglar) 2 - Indicates if the burglar alarm is triggered. -The ```alarm_burglar2``` 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. +The ```alarm_burglar2``` channel is of type ```alarm_burglar``` and 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. The following state translation is provided for this channel to the ```Switch``` item type -: diff --git a/_addons_bindings/zwave/doc/stelpro/stzw402_0_0.md b/_addons_bindings/zwave/doc/stelpro/stzw402_0_0.md index 070df9057..3116e1eee 100644 --- a/_addons_bindings/zwave/doc/stelpro/stzw402_0_0.md +++ b/_addons_bindings/zwave/doc/stelpro/stzw402_0_0.md @@ -8,34 +8,69 @@ title: STZW402 - ZWave # STZW402 4000W Thermostat This describes the Z-Wave device *STZW402*, manufactured by *[Stelpro](http://www.stelpro.com/)* with the thing type UID of ```stelpro_stzw402_00_000```. +The device is in the category of *HVAC*, defining Air condition devices, Fans. + +![STZW402 product image](https://www.cd-jackson.com/zwave_device_uploads/315/315_default.png) + + The STZW402 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 between other devices in the mesh network. ## 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/315) to improve the documentation. +Ki, the smart home line-voltage thermostat by Stelpro - STZW402+ + + * The very first Z-Wave Plus line voltage thermostat in North America + *  Supports 120Vac - 240Vac (50/60 Hz) voltages + *  Controls baseboard heaters and convectors up to 4000W + *  Easy to use 2 button interface + *  Made in Canada + *  High precision temperature control +/- 0.1 °C + *  Z-Wave Plus certified, works with thousands of other Z-Wave devices + *  Brings optimal comfort into your smart home + *  Can be integrated into smart home automated scenes + *  Local keypad lock + *  Displays external temperature + *  Adjustable backlight intensity + *  Comfort and Eco modes + *  Celsius or Fahrenheit display + *  Quiet TRIAC operation + *  Frost-free warning + *  Sleek design to harmonize with any decor + +### Inclusion Information + + 1. Enter the Menu 1 (Z-Wave menu) and select “On”. + 2. Press the UP and DOWN buttons to start the inclusion process. + +During inclusion, “On” will be blinking and the connectivity icon  will be animated in an increasing pattern. When the inclusion process has been completed, On will be displayed solid. If an error occurs, “Err” will be displayed for 3 seconds then the screen will revert to “Off” selection. + +### Exclusion Information + + 1. Enter the Menu1 (Z-Wave menu) and select “Off”. + 2. Press the UP and DOWN buttons to start the exclusion process. + +During exclusion, “Off” will be blinking and the connectivity icon  will be animated in an decreasing pattern. When the exclusion process has been completed, Off will be displayed solid. If an error occurs, “Err” will be displayed for 3 seconds then the screen will revert to “On” selection. ## Channels The following table summarises the channels available for the STZW402 -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Sensor (temperature) | sensor_temperature | Temperature | Number:Temperature | -| Thermostat mode | thermostat_mode | Temperature | Number | -| Operating State | thermostat_state | Temperature | Number | -| Setpoint (heating) | thermostat_setpoint | Temperature | Number:Temperature | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | ### Sensor (temperature) - Indicates the current temperature. -The ```sensor_temperature``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Thermostat mode - Sets the thermostat. -The ```thermostat_mode``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -56,10 +91,9 @@ The following state translation is provided for this channel to the ```Number``` | 13 | Away | ### Operating State - Sets the thermostat operating state. -The ```thermostat_state``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -73,10 +107,9 @@ The following state translation is provided for this channel to the ```Number``` | 6 | Vent / Economiser | ### Setpoint (heating) - Sets the thermostat setpoint. -The ```thermostat_setpoint``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. diff --git a/_addons_bindings/zwave/doc/sunricher/heatit_0_0.md b/_addons_bindings/zwave/doc/sunricher/heatit_0_0.md index e3e6ee6e0..f7024dc0c 100644 --- a/_addons_bindings/zwave/doc/sunricher/heatit_0_0.md +++ b/_addons_bindings/zwave/doc/sunricher/heatit_0_0.md @@ -99,7 +99,47 @@ This channel provides the battery level as a percentage and also reflects the lo ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 1 configuration parameters available in the Heatit Z-Push Button 8. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | factory reset | factory reset | +| | Wakeup Interval | Sets the interval at which the device will accept commands from the controller | +| | Wakeup Node | Sets the node ID of the device to receive the wakeup notifications | + +### Parameter 1: factory reset + +factory reset + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | normal operation | +| 21930 | factory reset | + +The manufacturer defined default value is ```0``` (normal operation). + +This parameter has the configuration ID ```config_1_2``` and is of type ```INTEGER```. + +### Wakeup Interval + +The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications. + +This setting is defined in *seconds*. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances. + +Note that this setting does not affect the devices ability to send sensor data, or notification events. + +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_node``` and is of type ```INTEGER```. + ## Association Groups diff --git a/_addons_bindings/zwave/doc/sunricher/zv9003t3_0_0.md b/_addons_bindings/zwave/doc/sunricher/zv9003t3_0_0.md index 6c30d9a7f..a403b8a4e 100644 --- a/_addons_bindings/zwave/doc/sunricher/zv9003t3_0_0.md +++ b/_addons_bindings/zwave/doc/sunricher/zv9003t3_0_0.md @@ -5,7 +5,7 @@ title: ZV9003T3-RGBW - ZWave {% include base.html %} -# ZV9003T3-RGBW RGBW 3 Zone Wall Controller +# ZV9003T3-RGBW RGBW 3 Scene Wall Controller This describes the Z-Wave device *ZV9003T3-RGBW*, manufactured by *[Sunricher](www.sunricher.com)* with the thing type UID of ```sunricher_zv9003t3_00_000```. The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch. @@ -17,7 +17,7 @@ The ZV9003T3-RGBW supports routing. This allows the device to communicate using ## Overview -The Wall controller is a Security Enabled Z-Wave Plus device that can both control other Z-Wave devices and activate scenes in Gateways. The wall controller can be included and operated in any Z-Wave network with other Z-Wave certified devices from other manufacturers and/or other applications. All non-battery operated nodes within the network will act as repeaters regardless of vendor to increase reliability of the network. +This wall controller is a Security Enabled Z-Wave Plus device that can both control other Z-Wave devices and activate scenes in Gateways. The wall controller can be included and operated in any Z-Wave network with other Z-Wave certified devices from other manufacturers and/or other applications. All non-battery operated nodes within the network will act as repeaters regardless of vendor to increase reliability of the network. Although it is controlling other devices, the device cannot act as Z-Wave network controller (primary or secondary), so a security enabled controller is needed for take full advantage of all functionally for the device. It also supports the Over The Air (OTA) feature for the product’s firmware upgrade. @@ -72,29 +72,26 @@ Note: Factory reset is not recommended for exclusion, please use this procedure **Association** - * Z-Wave devices control other Z-Wave devices. The relationship between one device controlling another device is called association. In order to control a different device, the controlling device needs to maintain a list of devices that will receive controlling commands. These lists are called association groups and they are always related to certain events (e.g. button pressed). In case the event happens all devices stored in the respective association group will receive a common wireless command. + * Z-Wave devices control other Z-Wave devices. The relationship between one device controlling another device is called association. In order to control a different device, the controlling device needs to maintain a list of devices that will receive controlling commands. + * These lists are called association groups and they are always related to certain events (e.g. button pressed). In case the event happens all devices stored in the respective association group will receive a common wireless command. -**Set and unset associations:** +**About Scene Command Types** -(Note: All association information will be cleared automatically once the wall controller is excluded from a network.) + * Configure the remote via gateway with CC COMMAND\_CLASS\_ASSOCIATION or COMMAND\_CLASS\_MULTI\_CHANNEL\_ASSOCIATION to associate controllable devices with remote. + * Configure the remote via gateway with CC COMMAND\_CLASS\_ASSOCIATION or COMMAND\_CLASS\_MULTI\_CHANNEL\_ASSOCIATION to associate controllable devices from remote. + * Note: all configuration parameters for association will be removed automatically after the remote is removed from the network. -Associations can be assigned and remove either via Z-Wave commands or using the device itself. +**About Scene Command Targets** - * Set association by operating primary controller/gateway to send packets to the wall controller: - * The primary controller/gateway sends packets to the wall controller using “Command Class ASSOCIATION” or “Command Class Multi Channel Association” - * Set association by operating the wall controller and devices to be controlled: - * To control a Z-Wave device from the Wall Controller the node ID of this device needs to be assigned to one of the four association groups. This is a three-step process: - * Press and hold down “ALL ON/OFF” button on the wall controller for over 3 seconds, LED indicator turns on. - * Click any Group number button on the wall controller within 25 seconds to add the device to be controlled to the association group, double click any Group number button on the wall controller within 25 seconds to remove the device to be controlled to the association group. - * Operate the device to be controlled to send Node Information Frame (please refer to the device manual) within 15 seconds, or set the device to exclusion mode within 15 seconds, since it will send Node Information Frame in exclusion mode, LED indications are as follows: - * LED blinks 5 times to indicate that the wall controller failed to add the associated device (the association group has already added maximum quantity associated devices that it supports ). - * LED blinks 10 times to indicate that the wall controller added the associated device successfully. - * LED blinks 8 times to indicate that the wall controller removed the associated device successfully. - - - * To remove all associated devices in an association group on the wall controller directly: - * Press and hold down “ALL ON/OFF” button on the wall controller for over 3 seconds, LED indicator turns on. - * Click any Group number button on the wall controller 5 times continuously within 25 seconds to remove all associated devices of this group, LED indicator blinks 8 times to indicate that the associated devices are removed successfully. + * Z-Wave has two types of mainstream scene commands: CENTRAL SCENE and SCENE ACTIVATION, and scene commands can either be emitted to controlled devices or to Z-Wave gateway.   + +**Control Devices Associated With This Controller** + +(Note: All association information will be cleared automatically once the wall controller is excluded from a network.) + + * Associations can be assigned and remove either via Z-Wave commands or using the device itself. + * This remote uses CONFIGURATION PARAMETER 3 to determine which of the possible command types to emit scene commands with. + * This remote uses CONFIGURATION PARAMETER 4 to determine which of the possible device types to emit scene commands to. ## Channels @@ -102,8 +99,57 @@ The following table summarises the channels available for the ZV9003T3-RGBW -: | Channel Name | Channel ID | Channel Type | Category | Item Type | |--------------|------------|--------------|----------|-----------| +| Dimmer Level | switch_dimmer | switch_dimmer | DimmableLight | Dimmer | +| Scene Number | thermostat_mode | thermostat_mode | Temperature | Number | +| Color | color_color | color_color | ColorLight | Color | +| Temperature | color_temperature | color_temperature | ColorLight | Dimmer | | Scene Number | scene_number | scene_number | | Number | +### Dimmer Level +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 is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category. + +### Scene Number +This device's behavior with regard to its three scene buttons changes along with the value of parameter 3.  Given its default value of 0, triggering a scene button causes the device to emit a CENTRAL\_SCENE command to report the event.  If the value of parameter 3 is changed to 1, the device's behavior also changes to use this channel's SCENE\_ACTIVATION command instead. + +Both commands fire a channel named _scene_number_, but only one instance of a channel with any name can exist in the database.  Since the factory default for this device is associated with CENTRAL_SCENE, that command defines the _scene_number_ channel.  If a user intends to operate this device using the SCENE_ACTIVATION command mode, it may be necessary to alter the channel names as released in order for the state of the channel actively in use to be displayed accurately. + +Sets the thermostat. + +The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. +The following state translation is provided for this channel to the ```Number``` item type -: + +| Value | Label | +|-------|-----------| +| 0 | Off | +| 1 | Heat | +| 2 | Cool | +| 3 | Auto | +| 4 | Aux Heat | +| 5 | Resume | +| 6 | Fan Only | +| 7 | Furnace | +| 8 | Dry Air | +| 9 | Moist Air | +| 10 | Auto Changeover | +| 11 | Heat Economy | +| 12 | Cool Economy | +| 13 | Away | + +### Color +The color channel allows to control the color of a light. + It is also possible to dim values and switch the light on and off. + +The ```color_color``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category. + +### Temperature +The color temperature channel allows to set the color + temperature of a light from 0 (cold) to 100 (warm). + +The ```color_temperature``` channel is of type ```color_temperature``` and supports the ```Dimmer``` item and is in the ```ColorLight``` category. + ### Scene Number Triggers when a scene button is pressed. @@ -124,62 +170,91 @@ This channel provides the scene, and the event as a decimal value in the form `` ## Device Configuration -The device has no configuration parameters defined. +The following table provides a summary of the 2 configuration parameters available in the ZV9003T3-RGBW. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 3 | Scene Command Type | Set to choose between CENTRAL\_SCENE or SCENE\_ACTIVATION command types | +| 4 | Scene Command Target Role | Send Scene Commands to Gateway or Controller Devices | + +### Parameter 3: Scene Command Type + +Set to choose between CENTRAL\_SCENE or SCENE\_ACTIVATION command types +Parameter 3 can be configured via COMMAND\_CLASS\_CONFIGURATION to decide which scene command to use. + +Set to 0 for CENTRAL SCENE, or 1 for SCENE ACTIVATION. Factory default is 0 for CENTRAL SCENE. +The following option values may be configured, in addition to values in the range 0 to 1 -: + +| Value | Description | +|--------|-------------| +| 0 | CENTRAL_SCENE (Default) | +| 1 | SCENE_ACTIVATION | + +The manufacturer defined default value is ```0``` (CENTRAL_SCENE (Default)). + +This parameter has the configuration ID ```config_3_1_00000001``` and is of type ```INTEGER```. + + +### Parameter 4: Scene Command Target Role + +Send Scene Commands to Gateway or Controller Devices +Parameter 4 can be configured via COMMAND\_CLASS\_CONFIGURATION to decide which object remote emits scene packets to,  Set to 0 for main gateway through Association Group 1 or 1 for controlled devices through Association Group 2.  Factory default is 1 for controlled devices through Association Group 2. +The following option values may be configured, in addition to values in the range 0 to 1 -: + +| Value | Description | +|--------|-------------| +| 0 | Gateway | +| 1 | Controlled Devices (Default) | + +The manufacturer defined default value is ```1``` (Controlled Devices (Default)). + +This parameter has the configuration ID ```config_4_1_00000001``` and is of type ```INTEGER```. + ## Association Groups Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. -The ZV9003T3-RGBW supports 4 association groups. +The ZV9003T3-RGBW supports 2 association groups. ### Group 1: Lifeline The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. Lifeline - 1. Send “Command Class Device Reset Locally” to associated devices of this group to report factory reset information when factory reset the wall controller. - 2. Double click a group number of the wall controller to send command to associated devices of this group using “Command Class Central Scene”. +**Lifeline — Group 1**  + +This group supports one node, with its default association assigned to Master Controller node after inclusion. + +Used by controlled devices to report state to Master Controller if any changes happen. + +Send Command Class Device Reset Locally to Group 1’s associated device to achieve a factory reset of wall controller. Association group 1 supports 1 node. ### Group 2: Launch 1 -Press button "1" to activate group. +Controlled Device Association +**Launch Association -- Group 2** - 1. Press and hold down button "1" to switch the associated devices with a Basic Set commands. - 2. Press PWM1-PWM4 buttons, direct control of associated devices using Color Switch Set commands. - 3. Press and hold down PWM1-PWM4 buttons, direct control of associated devices using Color Switch Start Level Change commands. - 4. Short touch or slide touch the “Color Wheel”, direct control of associated devices using Color Switch Set commands. - 5. Press and hold down brightness button, direct control of associated devices using Multilevel Switch Start Level Change commands. - 6. Short press "play/pause" button, direct control of associated devices using Configuration Set commands with Parameter Number = 5, Size = 1, toggling through values (1-0-2-0-3-0-4-0-5-0-6-0-1-...). Press and hold down "play/pause" button direct control of associated devices using Configuration Set commands with Parameter Number = 6, Size = 1 with varying values. +Association Group 2 supports up to 12 controllable devices.  + + * Associated devices may also be simultaneously associated with other remotes. + * Once remote and controllable devices are both added to same network, use your gateway or hub interface to associate device with remote using association group 2. Please refer to gateway’s user manual to learn how. + * Disassociate controllable devices no longer in working status from remote for best control experience. + +Following command types are sent to nodes in Association Group 2 + + * Basic Set + * Switch Multilevel Start Level Change + * Switch Multilevel Stop Level Change + * Switch Multilevel Set + * Switch Color Set + * Central Scene Notification -or- Scene Activation + * Scene Actuator Conf Set Association group 2 supports 12 nodes. -### Group 3: Launch 2 - -Press button "2" to activate group. - - 1. Press and hold down button "2" to switch the associated devices with a Basic Set commands. - 2. Press PWM1-PWM4 buttons, direct control of associated devices using Color Switch Set commands. - 3. Press and hold down PWM1-PWM4 buttons, direct control of associated devices using Color Switch Start Level Change commands. - 4. Short touch or slide touch the “Color Wheel”, direct control of associated devices using Color Switch Set commands. - 5. Press and hold down brightness button, direct control of associated devices using Multilevel Switch Start Level Change commands. - 6. Short press "play/pause" button, direct control of associated devices using Configuration Set commands with Parameter Number = 5, Size = 1, toggling through values (1-0-2-0-3-0-4-0-5-0-6-0-1-...). Press and hold down "play/pause" button direct control of associated devices using Configuration Set commands with Parameter Number = 6, Size = 1 with varying values. - -Association group 3 supports 12 nodes. - -### Group 4: Launch 3 - -Press button "3" to activate group. - - 1. Press and hold down button "3" to switch the associated devices with a Basic Set commands. - 2. Press PWM1-PWM4 buttons, direct control of associated devices using Color Switch Set commands. - 3. Press and hold down PWM1-PWM4 buttons, direct control of associated devices using Color Switch Start Level Change commands. - 4. Short touch or slide touch the “Color Wheel”, direct control of associated devices using Color Switch Set commands. - 5. Press and hold down brightness button, direct control of associated devices using Multilevel Switch Start Level Change commands. - 6. Short press "play/pause" button, direct control of associated devices using Configuration Set commands with Parameter Number = 5, Size = 1, toggling through values (1-0-2-0-3-0-4-0-5-0-6-0-1-...). Press and hold down "play/pause" button direct control of associated devices using Configuration Set commands with Parameter Number = 6, Size = 1 with varying values. - -Association group 4 supports 12 nodes. - ## Technical Information ### Endpoints @@ -189,26 +264,31 @@ Association group 4 supports 12 nodes. | Command Class | Comment | |---------------|---------| | COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_BASIC_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V2| | | COMMAND_CLASS_SWITCH_MULTILEVEL_V4| Linked to BASIC| | COMMAND_CLASS_SCENE_ACTIVATION_V1| | | COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| | | COMMAND_CLASS_SWITCH_COLOR_V3| | | COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | | COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | -| COMMAND_CLASS_CENTRAL_SCENE_V3| | +| COMMAND_CLASS_CENTRAL_SCENE_V2| | | COMMAND_CLASS_ZWAVEPLUS_INFO_V2| | +| COMMAND_CLASS_MULTI_CHANNEL_V3| | +| COMMAND_CLASS_CONFIGURATION_V1| | | COMMAND_CLASS_MANUFACTURER_SPECIFIC_V2| | | COMMAND_CLASS_POWERLEVEL_V1| | | COMMAND_CLASS_FIRMWARE_UPDATE_MD_V4| | | COMMAND_CLASS_ASSOCIATION_V2| | | COMMAND_CLASS_VERSION_V2| | -| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| | +| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V2| | | COMMAND_CLASS_SECURITY_V1| | | COMMAND_CLASS_MARK_V1| | ### Documentation Links * [ZV9003T3-RGBW-US Manual](https://www.cd-jackson.com/zwave_device_uploads/1024/SR-ZV9001T3-RGBW-US-Instruction-V1.pdf) +* [RGBGenie ZW-3003 Touch Panel 1 Zone 3 Scene RGBW Dimmer (OEM)](https://www.cd-jackson.com/zwave_device_uploads/1024/ZW-3003-instructions.pdf) --- diff --git a/_addons_bindings/zwave/doc/swidget/zw001rwa_0_0.md b/_addons_bindings/zwave/doc/swidget/zw001rwa_0_0.md index dcae90ceb..17740186e 100644 --- a/_addons_bindings/zwave/doc/swidget/zw001rwa_0_0.md +++ b/_addons_bindings/zwave/doc/swidget/zw001rwa_0_0.md @@ -97,7 +97,7 @@ Association group 1 supports 1 node. | COMMAND_CLASS_NO_OPERATION_V1| | | COMMAND_CLASS_BASIC_V1| | | COMMAND_CLASS_APPLICATION_STATUS_V1| | -| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_METER_V2| | | COMMAND_CLASS_CRC_16_ENCAP_V1| | | COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | @@ -114,7 +114,7 @@ Association group 1 supports 1 node. | Command Class | Comment | |---------------|---------| | COMMAND_CLASS_BASIC_V1| | -| COMMAND_CLASS_SWITCH_BINARY_V1| | +| COMMAND_CLASS_SWITCH_BINARY_V1| Linked to BASIC| | COMMAND_CLASS_METER_V2| | | COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | | COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | diff --git a/_addons_bindings/zwave/doc/thermofloor/ztrm2fx_3_0.md b/_addons_bindings/zwave/doc/thermofloor/ztrm2fx_3_0.md index 6e2385e10..ba4412c05 100644 --- a/_addons_bindings/zwave/doc/thermofloor/ztrm2fx_3_0.md +++ b/_addons_bindings/zwave/doc/thermofloor/ztrm2fx_3_0.md @@ -70,64 +70,72 @@ Leave programming mode by choosing ESC in menu. The following table summarises the channels available for the Z-TRM2fx -: -| Channel | Channel Id | Category | Item Type | -|---------|------------|----------|-----------| -| Electric meter (volts) | meter_voltage | Energy | Number | -| Electric meter (kWh) | meter_kwh | Energy | Number | -| Electric meter (watts) | meter_watts | Energy | Number | -| Energy Saving Mode Setpoint (ECO) | config_decimal | | Number | -| Heating mode setpoint (Comfort) | config_decimal | | Number | -| Display brightness - dimmed | config_decimal | | Number | -| Button brightness - dimmed | config_decimal | | Number | -| Thermostat mode | thermostat_mode1 | Temperature | Number | -| Setpoint (cooling) | thermostat_setpoint1 | Heating | Number:Temperature | -| Setpoint (heating) | thermostat_setpoint1 | Heating | Number:Temperature | -| External sensor | sensor_temperature2 | Temperature | Number:Temperature | -| Floor sensor | sensor_temperature3 | Temperature | Number:Temperature | -| Switch binary | switch_binary4 | Switch | Switch | -| Electric meter (volts) 4 | meter_voltage4 | Energy | Number | -| Electric meter (kWh) 4 | meter_kwh4 | Energy | Number | -| Electric meter (watts) 4 | meter_watts4 | Energy | Number | +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number | +| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number | +| Electric meter (watts) | meter_watts | meter_watts | Energy | Number | +| Clear Accumulated Energy | meter_reset | meter_reset | Energy | Switch | +| Energy Saving Mode Setpoint (ECO) | config_decimal | config_decimal | | Number | +| Heating mode setpoint (Comfort) | config_decimal | config_decimal | | Number | +| Display brightness - dimmed | config_decimal | config_decimal | | Number | +| Button brightness - dimmed | config_decimal | config_decimal | | Number | +| Thermostat mode | thermostat_mode1 | thermostat_mode | Temperature | Number | +| Setpoint (cooling) | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (heating) | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (Furnace) | thermostat_setpoint1 | thermostat_setpoint | Heating | Number:Temperature | +| External sensor | sensor_temperature2 | sensor_temperature | Temperature | Number:Temperature | +| Floor sensor | sensor_temperature3 | sensor_temperature | Temperature | Number:Temperature | +| Switch binary | switch_binary4 | switch_binary | Switch | Switch | +| Electric meter (volts) 4 | meter_voltage4 | meter_voltage | Energy | Number | +| Electric meter (kWh) 4 | meter_kwh4 | meter_kwh | Energy | Number | +| Electric meter (watts) 4 | meter_watts4 | meter_watts | Energy | Number | +| Resets Device Usage 4 [Deprecated]| meter_reset4 | meter_reset | Energy | Switch | ### Electric meter (volts) Indicates the instantaneous voltage. -The ```meter_voltage``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) Indicates the energy consumption (kWh). -The ```meter_kwh``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) Indicates the instantaneous power consumption. -The ```meter_watts``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Clear Accumulated Energy +Reset the meter. + +The ```meter_reset``` channel is of type ```meter_reset``` and supports the ```Switch``` item and is in the ```Energy``` category. ### Energy Saving Mode Setpoint (ECO) Generic class for configuration parameter. -The ```config_decimal``` channel supports the ```Number``` item. +The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. ### Heating mode setpoint (Comfort) Generic class for configuration parameter. -The ```config_decimal``` channel supports the ```Number``` item. +The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. ### Display brightness - dimmed Generic class for configuration parameter. -The ```config_decimal``` channel supports the ```Number``` item. +The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. ### Button brightness - dimmed Generic class for configuration parameter. -The ```config_decimal``` channel supports the ```Number``` item. +The ```config_decimal``` channel is of type ```config_decimal``` and supports the ```Number``` item. ### Thermostat mode Sets the thermostat. -The ```thermostat_mode1``` channel supports the ```Number``` item and is in the ```Temperature``` category. +The ```thermostat_mode1``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. The following state translation is provided for this channel to the ```Number``` item type -: | Value | Label | @@ -150,44 +158,56 @@ The following state translation is provided for this channel to the ```Number``` ### Setpoint (cooling) Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Heating``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### Setpoint (heating) The heating setpoint, for currently selected heating mode (Comfort or ECO). Sets the thermostat setpoint. -The ```thermostat_setpoint1``` channel supports the ```Number:Temperature``` item and is in the ```Heating``` category. +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. + +### Setpoint (Furnace) +Sets the thermostat setpoint. + +The ```thermostat_setpoint1``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. ### External sensor Indicates the current temperature. -The ```sensor_temperature2``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature2``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Floor sensor Indicates the current temperature. -The ```sensor_temperature3``` channel supports the ```Number:Temperature``` item and is in the ```Temperature``` category. +The ```sensor_temperature3``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. ### Switch binary Switch the power on and off. -The ```switch_binary4``` channel supports the ```Switch``` item and is in the ```Switch``` category. +The ```switch_binary4``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. ### Electric meter (volts) 4 Indicates the instantaneous voltage. -The ```meter_voltage4``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_voltage4``` channel is of type ```meter_voltage``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (kWh) 4 Indicates the energy consumption (kWh). -The ```meter_kwh4``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_kwh4``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. ### Electric meter (watts) 4 Indicates the instantaneous power consumption. -The ```meter_watts4``` channel supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. +The ```meter_watts4``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +### Resets Device Usage 4 [Deprecated] +Reset the meter. + +The ```meter_reset4``` channel is of type ```meter_reset``` and supports the ```Switch``` item and is in the ```Energy``` category. + +**Note:** This channel is marked as deprecated so should not be used. @@ -584,7 +604,7 @@ Association group 4 supports 5 nodes. |---------------|---------| | COMMAND_CLASS_BASIC_V1| | | COMMAND_CLASS_THERMOSTAT_MODE_V1| | -| COMMAND_CLASS_THERMOSTAT_SETPOINT_V1| | +| COMMAND_CLASS_THERMOSTAT_SETPOINT_V3| | | COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | | COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | | COMMAND_CLASS_ASSOCIATION_V2| | @@ -624,6 +644,7 @@ Association group 4 supports 5 nodes. ### Documentation Links * [Manual FW 3.4 Ver. 2018-A](https://www.cd-jackson.com/zwave_device_uploads/980/A4-Manual-Heatit-Z-TRM2fx-FW-3-4-Ver2018-A-ENG.pdf) +* [A4_Manual_Heatit_Z-TRM2fx_FW-3.6_Ver2019-A_ENG](https://www.cd-jackson.com/zwave_device_uploads/980/A4-Manual-Heatit-Z-TRM2fx-FW-3-6-Ver2019-A-ENG.pdf) --- diff --git a/_addons_bindings/zwave/doc/wayne/wdtc20_0_0.md b/_addons_bindings/zwave/doc/wayne/wdtc20_0_0.md index 6cb5bfa5d..bb6b5d84c 100644 --- a/_addons_bindings/zwave/doc/wayne/wdtc20_0_0.md +++ b/_addons_bindings/zwave/doc/wayne/wdtc20_0_0.md @@ -48,6 +48,18 @@ Your controller will indicate the thermostat was successfully added to its netwo 1. Press the REMOVE DEVICE button located in ThinkEssentials® on the DESIGN TAB. 2. Press and release the BIND button on the thermostat. If successful, ThinkEssentials® will display a message that the device was removed successfully and a thermostat icon will appear. +### General Usage Information + +If your controller supports full thermostat device class functions then the following remote features are available: + + * Up and Down Temperature Control + * Change between HEAT and COOL modes + * Change between NORMAL and SAVE ENERGY modes + * Read the current temperature + * Read target temperatures for NORMAL and SAVE ENERGY modes + * Set target temperatures for NORMAL and SAVE ENERGY modes + * Set indicator to Red, Green, Amber or Off + ## Channels The following table summarises the channels available for the WDTC-20 -: @@ -55,15 +67,26 @@ The following table summarises the channels available for the WDTC-20 -: | Channel Name | Channel ID | Channel Type | Category | Item Type | |--------------|------------|--------------|----------|-----------| | Switch | switch_binary | switch_binary | Switch | Switch | -| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number | +| Room Temperature | sensor_temperature | sensor_temperature | Temperature | Number:Temperature | +| Thermostat Mode | thermostat_mode | thermostat_mode | Temperature | Number | | Operating State | thermostat_state | thermostat_state | Temperature | Number | +| Setpoint (Cooling) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Setpoint (Heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature | +| Display Color | color_color | color_color | ColorLight | Color | ### Switch +Toggles between Normal (On) and Energy Saving (Off) set points for current heating or cooling mode. + Switch the power on and off. The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category. -### Thermostat mode +### Room Temperature +Indicates the current temperature. + +The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category. + +### Thermostat Mode Sets the thermostat. The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category. @@ -102,6 +125,24 @@ The following state translation is provided for this channel to the ```Number``` | 5 | Pending Cool | | 6 | Vent / Economiser | +### Setpoint (Cooling) +Sets the thermostat setpoint. + +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. + +### Setpoint (Heating) +Sets the thermostat setpoint. + +The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category. + +### Display Color +Set indicator to Red, Green, Amber or Off + +The color channel allows to control the color of a light. + It is also possible to dim values and switch the light on and off. + +The ```color_color``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category. + ## Device Configuration @@ -124,11 +165,11 @@ The device does not support associations. | COMMAND_CLASS_NO_OPERATION_V1| | | COMMAND_CLASS_BASIC_V1| | | COMMAND_CLASS_SWITCH_BINARY_V1| | -| COMMAND_CLASS_SENSOR_MULTILEVEL_V1| | -| COMMAND_CLASS_THERMOSTAT_MODE_V1| | +| COMMAND_CLASS_SENSOR_MULTILEVEL_V2| | +| COMMAND_CLASS_THERMOSTAT_MODE_V3| | | COMMAND_CLASS_THERMOSTAT_OPERATING_STATE_V1| | -| COMMAND_CLASS_THERMOSTAT_SETPOINT_V1| | -| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_THERMOSTAT_SETPOINT_V2| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V2| | | COMMAND_CLASS_VERSION_V1| | | COMMAND_CLASS_INDICATOR_V1| | diff --git a/_addons_bindings/zwave/doc/yale/yrd216_0_0.md b/_addons_bindings/zwave/doc/yale/yrd216_0_0.md index b3bdfdcdf..67b0dc4d8 100644 --- a/_addons_bindings/zwave/doc/yale/yrd216_0_0.md +++ b/_addons_bindings/zwave/doc/yale/yrd216_0_0.md @@ -32,8 +32,6 @@ Yale Assure Lock * Certified ANSI/BHMA A156.36, Grade 2 * Lifetime limited warranty for finish and mechanical, one year electronics -Zwave alliance information: https://products.z-wavealliance.org/products/1971 - ### Inclusion Information To join the lock in a Z-Wave Network (taken from the installation manual) @@ -65,7 +63,7 @@ The following table summarises the channels available for the YRD216 -: ### Door Lock Lock and unlock the door. -The ```lock_door``` channel and is of type ```lock_door``` and supports the ```Switch``` item and is in the ```Door``` category. +The ```lock_door``` channel is of type ```lock_door``` and supports the ```Switch``` item and is in the ```Door``` category. The following state translation is provided for this channel to the ```Switch``` item type -: | Value | Label | diff --git a/_addons_bindings/zwave/doc/yale/yrl256_1_78.md b/_addons_bindings/zwave/doc/yale/yrl256_1_78.md new file mode 100644 index 000000000..a386ada13 --- /dev/null +++ b/_addons_bindings/zwave/doc/yale/yrl256_1_78.md @@ -0,0 +1,323 @@ +--- +layout: documentation +title: YRL256 - ZWave +--- + +{% include base.html %} + +# YRL256 Yale Assure Key Free Touchscreen Lever Lock +This describes the Z-Wave device *YRL256*, manufactured by *ASSA ABLOY* with the thing type UID of ```yale_yrl256_01_078```. +This version of the device is limited to firmware versions above 1.78 + +The device is in the category of *Lock*, defining Devices whose primary pupose is locking something. + +![YRL256 product image](https://www.cd-jackson.com/zwave_device_uploads/1110/1110_default.jpg) + + +The YRL256 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. + +## Overview + +Yale Assure Key Free Touchscreen Lever Lock + +### Inclusion Information + +To include the lock in a Z-Wave Network: + + 1. Touch the Yale Icon on the touchscreen to activate + 2. Enter the master pin and press # + 3. Press 7, then # + 4. Press 1, then # + +The lock will now be in inclusion mode. + +### Exclusion Information + +To exclude the lock in a Z-Wave Network: + + 1. Touch the Yale Icon on the touchscreen to activate + 2. Enter the master pin and press # + 3. Press 7, then # + 4. Press 3, then # + +The lock will now be in exclusion mode. + +## Channels + +The following table summarises the channels available for the YRL256 -: + +| Channel Name | Channel ID | Channel Type | Category | Item Type | +|--------------|------------|--------------|----------|-----------| +| Door Lock [Deprecated]| lock_door | lock_door | Door | Switch | +| Alarm (access) | alarm_access | alarm_access | Door | Switch | +| Alarm (power) [Deprecated]| alarm_power | alarm_power | Energy | Switch | +| Alarm (raw) [Deprecated]| alarm_raw | alarm_raw | | String | +| Battery Level | battery-level | system.battery_level | Battery | Number | +| Clock Time Offset [Deprecated]| time_offset | time_offset | Temperature | Number | + +### Door Lock [Deprecated] +Lock and unlock the door. + +The ```lock_door``` channel is of type ```lock_door``` and supports the ```Switch``` item and is in the ```Door``` category. +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| ON | Locked | +| OFF | Unlocked | + +**Note:** This channel is marked as deprecated so should not be used. + +### Alarm (access) +Indicates if the access control alarm is triggered. + +The ```alarm_access``` channel is of type ```alarm_access``` and 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. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + +### Alarm (power) [Deprecated] +Indicates if a power alarm is triggered. + +The ```alarm_power``` channel is of type ```alarm_power``` and supports the ```Switch``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device. + +The following state translation is provided for this channel to the ```Switch``` item type -: + +| Value | Label | +|-------|-----------| +| OFF | OK | +| ON | Alarm | + +**Note:** This channel is marked as deprecated so should not be used. + +### Alarm (raw) [Deprecated] +Provides alarm parameters as json string. + +The ```alarm_raw``` channel is of type ```alarm_raw``` and supports the ```String``` item. This is a read only channel so will only be updated following state changes from the device. +This channel sets, and provides the alarm state as a JSON string. It is designed for use in rules. +**Note:** This channel is marked as deprecated so should not be used. + +### Battery Level +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 is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category. +This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%. +### Clock Time Offset [Deprecated] +Provides the current time difference for the devices time. + +The ```time_offset``` channel is of type ```time_offset``` and supports the ```Number``` item and is in the ```Temperature``` category. + +**Note:** This channel is marked as deprecated so should not be used. + + + +## Device Configuration + +The following table provides a summary of the 9 configuration parameters available in the YRL256. +Detailed information on each parameter can be found in the sections below. + +| Param | Name | Description | +|-------|-------|-------------| +| 1 | Silent Mode on/off | Changes speaker settigs | +| 2 | Auto Relock On/Off | | +| 3 | Auto Relock Time | | +| 4 | Wrong Code Entry Limit | | +| 7 | Shut Down Time (after wrong code entries) | | +| 8 | Operating Mode | | +| 11 | One Touch Locking | | +| 13 | Lock Status LED | | +| 15 | Reset to Factory Defaults | | +| | Lock Timeout | Sets the time after which the door will auto lock | + +### Parameter 1: Silent Mode on/off + +Changes speaker settigs + 1. High Volume + 2. Low Volume + 3. Silent +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 1 | High | +| 2 | Low | +| 3 | Silent | + +The manufacturer defined default value is ```1``` (High). + +This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```. + + +### Parameter 2: Auto Relock On/Off + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| -128 | Auto Relock On | +| 0 | Auto Relock Off | + +The manufacturer defined default value is ```0``` (Auto Relock Off). + +This parameter has the configuration ID ```config_2_1_wo``` and is of type ```INTEGER```. +This is a write only parameter. + + +### Parameter 3: Auto Relock Time + + + +Values in the range 10 to 127 may be set. + +The manufacturer defined default value is ```127```. + +This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```. + + +### Parameter 4: Wrong Code Entry Limit + + + +Values in the range 3 to 10 may be set. + +The manufacturer defined default value is ```3```. + +This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```. + + +### Parameter 7: Shut Down Time (after wrong code entries) + + + +Values in the range 10 to 127 may be set. + +The manufacturer defined default value is ```10```. + +This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```. + + +### Parameter 8: Operating Mode + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| 0 | Normal Mode (Default) | +| 1 | Vacation Mode (Keypad Locked Out) | +| 2 | Privacy Mode (Keypad Locked, RF Unlock Functional) | + +The manufacturer defined default value is ```0``` (Normal Mode (Default)). + +This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```. + + +### Parameter 11: One Touch Locking + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| -128 | One Touch Locking On | +| 0 | One Touch Locking Off | + +The manufacturer defined default value is ```0``` (One Touch Locking Off). + +This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```. + + +### Parameter 13: Lock Status LED + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| -128 | LED On | +| 0 | LED Off | + +The manufacturer defined default value is ```0``` (LED Off). + +This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```. + + +### Parameter 15: Reset to Factory Defaults + + + +The following option values may be configured -: + +| Value | Description | +|--------|-------------| +| -128 | Reset to Factory On | +| 0 | Reset to Factory Off | + +The manufacturer defined default value is ```0``` (Reset to Factory Off). + +This parameter has the configuration ID ```config_15_1``` and is of type ```INTEGER```. + +### Lock Timeout + +Sets the time after which the door will auto lock. + +This parameter has the configuration ID ```doorlock_timeout``` and is of type ```INTEGER```. + + +## Association Groups + +Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic. + +The YRL256 supports 1 association group. + +### Group 1: Lifeline + +The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. + +Association group 1 supports 1 node. + +## Technical Information + +### Endpoints + +#### Endpoint 0 + +| Command Class | Comment | +|---------------|---------| +| COMMAND_CLASS_NO_OPERATION_V1| | +| COMMAND_CLASS_DOOR_LOCK_LOGGING_V1| | +| COMMAND_CLASS_SCHEDULE_ENTRY_LOCK_V1| | +| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| | +| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| | +| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| | +| COMMAND_CLASS_DOOR_LOCK_V1| | +| COMMAND_CLASS_USER_CODE_V1| | +| COMMAND_CLASS_CONFIGURATION_V1| | +| COMMAND_CLASS_ALARM_V4| | +| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| | +| COMMAND_CLASS_POWERLEVEL_V1| | +| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| | +| COMMAND_CLASS_BATTERY_V1| | +| COMMAND_CLASS_ASSOCIATION_V2| | +| COMMAND_CLASS_VERSION_V2| | +| COMMAND_CLASS_TIME_V1| | +| COMMAND_CLASS_TIME_PARAMETERS_V1| | +| COMMAND_CLASS_SECURITY_V1| | + +### Documentation Links + +* [Assure Lever Key Free Touchscreen Manual](https://www.cd-jackson.com/zwave_device_uploads/1110/YRL-LKFTSINSTL-FUL-Rev-A-WEB-zwp-zb.pdf) + +--- + +Did you spot an error in the above definition or want to improve the content? +You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1110). diff --git a/_addons_iconsets/classic/src/main/resources/icons/motion-closed.png b/_addons_iconsets/classic/src/main/resources/icons/motion-closed.png new file mode 100644 index 000000000..bb56ce002 Binary files /dev/null and b/_addons_iconsets/classic/src/main/resources/icons/motion-closed.png differ diff --git a/_addons_iconsets/classic/src/main/resources/icons/motion-closed.svg b/_addons_iconsets/classic/src/main/resources/icons/motion-closed.svg new file mode 100644 index 000000000..5efcc5822 --- /dev/null +++ b/_addons_iconsets/classic/src/main/resources/icons/motion-closed.svg @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" style="enable-background:new 0 0 64 64"> + <g style="fill:none;stroke-miterlimit:10;stroke:#A0A0A0;stroke-width:3"> + <path d="m49.2 41.2c1.5-2.8 2.3-5.9 2.3-9.2 0-3.3-.8-6.5-2.3-9.2"/> + <path d="m14.8 22.8c-1.5 2.8-2.3 5.9-2.3 9.2 0 3.3.8 6.5 2.3 9.2"/> + <path d="m55.2 44.8c2.1-3.8 3.3-8.2 3.3-12.8 0-4.7-1.2-9-3.3-12.8"/> + <path d="M8.8,19.2C6.7,23,5.5,27.3,5.5,32 c0,4.7,1.2,9,3.3,12.8"/> + </g> + <g style="fill:#A0A0A0"> + <path d="m33.2 17.9c1.9.2 3.6-1.3 3.7-3.2.1-1.9-1.3-3.6-3.2-3.7-1.9-.1-3.6 1.3-3.7 3.2-.1 1.9 1.3 3.6 3.2 3.7"/> + <path d="m30.3 19.4c.7-.5 1.5-.8 2.4-.7 1.2.1 2.2.8 2.8 1.7l3.5 7 4.8 3.3c.4.3.7.8.6 1.4-.1.9-.8 1.5-1.7 1.4-.3 0-.5-.1-.7-.2l-5.2-3.6c-.2-.1-.3-.3-.4-.5l-1.3-2.6-1.6 6.9 6.2 7.3c.1.2.2.5.3.8l1.7 8.8c0 .2 0 .3 0 .5-.1 1.3-1.2 2.3-2.5 2.2-1.1-.1-1.9-.9-2.1-1.9l-1.6-8.2-5-5.5-1.2 5.3c0 .3-.4.8-.5 1l-4.8 8.1c-.5.7-1.3 1.2-2.2 1.1-1.3-.1-2.3-1.2-2.2-2.5 0-.4.2-.8.3-1l4.5-7.5 3.7-16.5-2.4 2-1.3 5.9c-.2.8-.9 1.4-1.7 1.3-.9-.1-1.5-.8-1.4-1.7 0-.1 0-.1 0-.2l1.5-6.9c.1-.3.3-.6.5-.8l7-5.7"/> + </g> +</svg> \ No newline at end of file diff --git a/_addons_iconsets/classic/src/main/resources/icons/motion-open.png b/_addons_iconsets/classic/src/main/resources/icons/motion-open.png new file mode 100644 index 000000000..2a6629f2a Binary files /dev/null and b/_addons_iconsets/classic/src/main/resources/icons/motion-open.png differ diff --git a/_addons_iconsets/classic/src/main/resources/icons/motion-open.svg b/_addons_iconsets/classic/src/main/resources/icons/motion-open.svg new file mode 100644 index 000000000..ec952cd89 --- /dev/null +++ b/_addons_iconsets/classic/src/main/resources/icons/motion-open.svg @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" style="enable-background:new 0 0 64 64"> + <g style="fill:none;stroke-miterlimit:10;stroke:#CC6666;stroke-width:3"> + <path d="m49.2 41.2c1.5-2.8 2.3-5.9 2.3-9.2 0-3.3-.8-6.5-2.3-9.2"/> + <path d="m14.8 22.8c-1.5 2.8-2.3 5.9-2.3 9.2 0 3.3.8 6.5 2.3 9.2"/> + <path d="m55.2 44.8c2.1-3.8 3.3-8.2 3.3-12.8 0-4.7-1.2-9-3.3-12.8"/> + <path d="M8.8,19.2C6.7,23,5.5,27.3,5.5,32 c0,4.7,1.2,9,3.3,12.8"/> + </g> + <g style="fill:#CC6666"> + <path d="m33.2 17.9c1.9.2 3.6-1.3 3.7-3.2.1-1.9-1.3-3.6-3.2-3.7-1.9-.1-3.6 1.3-3.7 3.2-.1 1.9 1.3 3.6 3.2 3.7"/> + <path d="m30.3 19.4c.7-.5 1.5-.8 2.4-.7 1.2.1 2.2.8 2.8 1.7l3.5 7 4.8 3.3c.4.3.7.8.6 1.4-.1.9-.8 1.5-1.7 1.4-.3 0-.5-.1-.7-.2l-5.2-3.6c-.2-.1-.3-.3-.4-.5l-1.3-2.6-1.6 6.9 6.2 7.3c.1.2.2.5.3.8l1.7 8.8c0 .2 0 .3 0 .5-.1 1.3-1.2 2.3-2.5 2.2-1.1-.1-1.9-.9-2.1-1.9l-1.6-8.2-5-5.5-1.2 5.3c0 .3-.4.8-.5 1l-4.8 8.1c-.5.7-1.3 1.2-2.2 1.1-1.3-.1-2.3-1.2-2.2-2.5 0-.4.2-.8.3-1l4.5-7.5 3.7-16.5-2.4 2-1.3 5.9c-.2.8-.9 1.4-1.7 1.3-.9-.1-1.5-.8-1.4-1.7 0-.1 0-.1 0-.2l1.5-6.9c.1-.3.3-.6.5-.8l7-5.7"/> + </g> +</svg> diff --git a/_addons_iconsets/classic/src/main/resources/icons/motion.png b/_addons_iconsets/classic/src/main/resources/icons/motion.png index 0d6be3d37..bb56ce002 100644 Binary files a/_addons_iconsets/classic/src/main/resources/icons/motion.png and b/_addons_iconsets/classic/src/main/resources/icons/motion.png differ diff --git a/_addons_iconsets/classic/src/main/resources/icons/motion.svg b/_addons_iconsets/classic/src/main/resources/icons/motion.svg index f628483f4..5efcc5822 100644 --- a/_addons_iconsets/classic/src/main/resources/icons/motion.svg +++ b/_addons_iconsets/classic/src/main/resources/icons/motion.svg @@ -1,13 +1,13 @@ <?xml version="1.0"?> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" style="enable-background:new 0 0 64 64"> - <g style="fill:none;stroke-miterlimit:10;stroke:#212121;stroke-width:3"> + <g style="fill:none;stroke-miterlimit:10;stroke:#A0A0A0;stroke-width:3"> <path d="m49.2 41.2c1.5-2.8 2.3-5.9 2.3-9.2 0-3.3-.8-6.5-2.3-9.2"/> <path d="m14.8 22.8c-1.5 2.8-2.3 5.9-2.3 9.2 0 3.3.8 6.5 2.3 9.2"/> <path d="m55.2 44.8c2.1-3.8 3.3-8.2 3.3-12.8 0-4.7-1.2-9-3.3-12.8"/> <path d="M8.8,19.2C6.7,23,5.5,27.3,5.5,32 c0,4.7,1.2,9,3.3,12.8"/> </g> - <g style="fill:#212121"> + <g style="fill:#A0A0A0"> <path d="m33.2 17.9c1.9.2 3.6-1.3 3.7-3.2.1-1.9-1.3-3.6-3.2-3.7-1.9-.1-3.6 1.3-3.7 3.2-.1 1.9 1.3 3.6 3.2 3.7"/> <path d="m30.3 19.4c.7-.5 1.5-.8 2.4-.7 1.2.1 2.2.8 2.8 1.7l3.5 7 4.8 3.3c.4.3.7.8.6 1.4-.1.9-.8 1.5-1.7 1.4-.3 0-.5-.1-.7-.2l-5.2-3.6c-.2-.1-.3-.3-.4-.5l-1.3-2.6-1.6 6.9 6.2 7.3c.1.2.2.5.3.8l1.7 8.8c0 .2 0 .3 0 .5-.1 1.3-1.2 2.3-2.5 2.2-1.1-.1-1.9-.9-2.1-1.9l-1.6-8.2-5-5.5-1.2 5.3c0 .3-.4.8-.5 1l-4.8 8.1c-.5.7-1.3 1.2-2.2 1.1-1.3-.1-2.3-1.2-2.2-2.5 0-.4.2-.8.3-1l4.5-7.5 3.7-16.5-2.4 2-1.3 5.9c-.2.8-.9 1.4-1.7 1.3-.9-.1-1.5-.8-1.4-1.7 0-.1 0-.1 0-.2l1.5-6.9c.1-.3.3-.6.5-.8l7-5.7"/> </g> -</svg> +</svg> \ No newline at end of file diff --git a/_addons_ios/alexa-skill/readme.md b/_addons_ios/alexa-skill/readme.md index bfac9656b..0577b0336 100644 --- a/_addons_ios/alexa-skill/readme.md +++ b/_addons_ios/alexa-skill/readme.md @@ -241,7 +241,7 @@ Number:Temperature Temperature2 "Temperature" {alexa="TemperatureSenso * Rollershutter * Default category: OTHER * `ThermostatController.targetSetpoint` - * Items that represent a target setpoint for a thermostat. The scale is determined based on: (1) value set in parameter `scale="Fahrenheit"`; (2) unit of item state presentation (`°F`=Fahrenheit; `°C`=Celsius); (3) unit of measurement unit if Number:Temperature item type; (4) your openHAB server regional measurement system or region settings (US=Fahrenheit; SI=Celsius); (5) defaults to Celsius. By default, the temperature range is limited to predefined setpoint values based on the scale parameter. If necessary, the temperature range can be customized using parameter `setpointRange="60:90"`. + * Items that represent a target setpoint for a thermostat. The scale is determined based on: (1) value set in parameter `scale="Fahrenheit"`; (2) unit of item state presentation (`°F`=Fahrenheit; `°C`=Celsius); (3) your openHAB server regional measurement system or region settings (US=Fahrenheit; SI=Celsius); (4) defaults to Celsius. By default, the temperature range is limited to predefined setpoint values based on the scale parameter. If necessary, the temperature range can be customized using parameter `setpointRange="60:90"`. * Supported item type: * Number(:Temperature) * Supported metadata parameters: @@ -252,7 +252,7 @@ Number:Temperature Temperature2 "Temperature" {alexa="TemperatureSenso * defaults to defined scale range listed above if omitted * Default category: THERMOSTAT * `ThermostatController.upperSetpoint` - * Items that represent a upper or HEAT setpoint for a thermostat. The scale is determined based on: (1) value set in parameter `scale="Fahrenheit"`; (2) unit of item state presentation (`°F`=Fahrenheit; `°C`=Celsius); (3) unit of measurement unit if Number:Temperature item type; (4) your openHAB server regional measurement system or region settings (US=Fahrenheit; SI=Celsius); (5) defaults to Celsius. By default, the temperature range is limited to predefined setpoint values based on the scale parameter. If necessary, the temperature range can be customized using parameter `setpointRange="60:90"`. + * Items that represent a upper or HEAT setpoint for a thermostat. The scale is determined based on: (1) value set in parameter `scale="Fahrenheit"`; (2) unit of item state presentation (`°F`=Fahrenheit; `°C`=Celsius); (3) your openHAB server regional measurement system or region settings (US=Fahrenheit; SI=Celsius); (4) defaults to Celsius. By default, the temperature range is limited to predefined setpoint values based on the scale parameter. If necessary, the temperature range can be customized using parameter `setpointRange="60:90"`. * Supported item type: * Number(:Temperature) * Supported metadata parameters: @@ -265,7 +265,7 @@ Number:Temperature Temperature2 "Temperature" {alexa="TemperatureSenso * defaults to defined scale range listed above if omitted * Default category: THERMOSTAT * `ThermostatController.lowerSetpoint` - * Items that represent a lower or COOL setpoint for a thermostat. The scale is determined based on: (1) value set in parameter `scale="Fahrenheit"`; (2) unit of item state presentation (`°F`=Fahrenheit; `°C`=Celsius); (3) unit of measurement unit if Number:Temperature item type; (4) your openHAB server regional measurement system or region settings (US=Fahrenheit; SI=Celsius); (5) defaults to Celsius. By default, the temperature range is limited to predefined setpoint values based on the scale parameter. If necessary, the temperature range can be customized using parameter `setpointRange="60:90"`. + * Items that represent a lower or COOL setpoint for a thermostat. The scale is determined based on: (1) value set in parameter `scale="Fahrenheit"`; (2) unit of item state presentation (`°F`=Fahrenheit; `°C`=Celsius); (3) your openHAB server regional measurement system or region settings (US=Fahrenheit; SI=Celsius); (4) defaults to Celsius. By default, the temperature range is limited to predefined setpoint values based on the scale parameter. If necessary, the temperature range can be customized using parameter `setpointRange="60:90"`. * Supported item type: * Number(:Temperature) * Supported metadata parameters: @@ -302,7 +302,7 @@ Number:Temperature Temperature2 "Temperature" {alexa="TemperatureSenso * defaults to, depending on the parameters provided, either user-based, preset-based or default item type-based mapping. * Default category: THERMOSTAT * `TemperatureSensor.temperature` - * Items that represent the current temperature. The scale is determined based on: (1) value set in parameter `scale="Fahrenheit"`; (2) unit of item state presentation (`°F`=Fahrenheit; `°C`=Celsius); (3) unit of measurement unit if Number:Temperature item type; (4) your openHAB server regional measurement system or region settings (US=Fahrenheit; SI=Celsius); (5) defaults to Celsius. + * Items that represent the current temperature. The scale is determined based on: (1) value set in parameter `scale="Fahrenheit"`; (2) unit of item state presentation (`°F`=Fahrenheit; `°C`=Celsius); (3) your openHAB server regional measurement system or region settings (US=Fahrenheit; SI=Celsius); (4) defaults to Celsius. * Supported item type: * Number(:Temperature) * Supported metadata parameters: @@ -519,7 +519,7 @@ Number:Temperature Temperature2 "Temperature" {alexa="TemperatureSenso * defaults to false * Default category: OTHER * `RangeController.rangeValue` - * Items that represent components of a device that are characterized by numbers within a minimum and maximum range. Multiple instances can be configured in a group endpoint. By default, to ask for a specific range, the item label will be used as the friendly name. To configure it, use `friendlyNames` parameter and provide a comma delimited list of different labels (Keep in mind that some names are [not allowed](#friendly-names-not-allowed)). Additionally, pre-defined [asset ids](#asset-catalog) can be used to label a mode as well prefixing with an @ sign (e.g. `friendlyNames="@Setting.FanSpeed,Speed"`). To set the supported range, provide a column delimited list including minimum, maximum and precision values. The latter value will be use as default increment when requesting adjusted range values. Optionally, to name specific presets, like fan speeds low [1] & high value [10], can be added in `presets` parameter and provide a comma delimited list of preset mappings composed of range value and the associated names/asset ids they should be called, delimited by equal and column signs (e.g. `presets="1=@Value.Minimum:@Value.Low:Lowest,10=@Value.Maximum:@Value.High:Highest"`). Another optional settings is `unitOfMeasure` parameter which gives a unit of measure to the range values. By default if omitted, it is based on the unit of measurement number item type that have a supported unit, otherwise, a [unit id](#unit-of-measurement-catalog) can be used. (e.g. `unitOfMeasure=Angle.Degrees`) + * Items that represent components of a device that are characterized by numbers within a minimum and maximum range. Multiple instances can be configured in a group endpoint. By default, to ask for a specific range, the item label will be used as the friendly name. To configure it, use `friendlyNames` parameter and provide a comma delimited list of different labels (Keep in mind that some names are [not allowed](#friendly-names-not-allowed)). Additionally, pre-defined [asset ids](#asset-catalog) can be used to label a mode as well prefixing with an @ sign (e.g. `friendlyNames="@Setting.FanSpeed,Speed"`). To set the supported range, provide a column delimited list including minimum, maximum and precision values. The latter value will be use as default increment when requesting adjusted range values. Optionally, to name specific presets, like fan speeds low [1] & high value [10], can be added in `presets` parameter and provide a comma delimited list of preset mappings composed of range value and the associated names/asset ids they should be called, delimited by equal and column signs (e.g. `presets="1=@Value.Minimum:@Value.Low:Lowest,10=@Value.Maximum:@Value.High:Highest"`). Another optional settings is `unitOfMeasure` parameter which gives a unit of measure to the range values. It is determined based on: (1) [unit id](#unit-of-measurement-catalog) set in parameter `unitOfMeasure=Angle.Degrees`; (2) supported unit of item state presentation; (3) default unit of measurement for item type with dimension based on your openHAB server regional settings; (4) defaults to empty. * Supported item type: * Dimmer * Number @@ -539,7 +539,10 @@ Number:Temperature Temperature2 "Temperature" {alexa="TemperatureSenso * presets=`<presets>` (optional) * each preset formatted as `<presetValue>=<@assetIdOrName1>:<@assetIdOrName2>:...` * unitOfMeasure=`<unitId>` (optional) - * defaults to item state unit of measurement symbol for Number:* item types + * defaults to unit of item state presentation or default unit of measurement for the Number:* item types listed below: + * Number:Angle [`Angle.Degrees`] + * Number:Length [`Distance.Meters` (SI); `Distance.Inches` (US)] + * Number:Temperature [`Temperature.Celsius` (SI); `Temperature.Fahrenheit` (US)] * Default category: OTHER * `ToggleController.toggleState` * Items that represent components of a device that can be turned on or off. Multiple instances can be configured in a group endpoint. By default, to ask for a specific range, the item label will be used as the friendly name. To configure it, use `friendlyNames` parameter and provide a comma delimited list of different labels (Keep in mind that some names are [not allowed](#friendly-names-not-allowed)). Additionally, pre-defined [asset ids](#asset-catalog) can be used to label a mode as well with an @ sign prefix (e.g. `friendlyNames="@Setting.Oscillate,Rotate"`). diff --git a/addons/uis/apps/android.md b/addons/uis/apps/android.md index 870abbff7..31f87093e 100644 --- a/addons/uis/apps/android.md +++ b/addons/uis/apps/android.md @@ -67,7 +67,6 @@ The Item name's default is `AlarmClock`, but you can change it in the settings. Example item definition: ``` Number AlarmClock - ``` Example rule: @@ -88,7 +87,6 @@ then } end - ``` ## Help and Technical Details diff --git a/addons/uis/apps/images/en_badge_web_generic.png b/addons/uis/apps/images/en_badge_web_generic.png index c77b7464b..54e62950c 100644 Binary files a/addons/uis/apps/images/en_badge_web_generic.png and b/addons/uis/apps/images/en_badge_web_generic.png differ diff --git a/addons/uis/apps/images/get-it-on-fdroid.png b/addons/uis/apps/images/get-it-on-fdroid.png index 23af0e408..abbec83eb 100644 Binary files a/addons/uis/apps/images/get-it-on-fdroid.png and b/addons/uis/apps/images/get-it-on-fdroid.png differ diff --git a/addons/uis/apps/images/main-menu.png b/addons/uis/apps/images/main-menu.png index f65e82aad..38986158d 100644 Binary files a/addons/uis/apps/images/main-menu.png and b/addons/uis/apps/images/main-menu.png differ diff --git a/addons/uis/apps/images/maps.png b/addons/uis/apps/images/maps.png index 4cf7d1d26..1164c3ad4 100644 Binary files a/addons/uis/apps/images/maps.png and b/addons/uis/apps/images/maps.png differ diff --git a/addons/uis/apps/images/widget-overview.png b/addons/uis/apps/images/widget-overview.png index dc8188063..44641d920 100644 Binary files a/addons/uis/apps/images/widget-overview.png and b/addons/uis/apps/images/widget-overview.png differ diff --git a/installation/openhabian.md b/installation/openhabian.md index 5b7392614..560ae7132 100644 --- a/installation/openhabian.md +++ b/installation/openhabian.md @@ -214,14 +214,14 @@ All password can be changed from openHABian menu. - Grafana visualization ("admin:admin") ## System Backup & Maintenance -When you have settled in how to use openHAB for your needs it could be a good moment to think about backup. Maybe you accedently delete something or the SD-card wearout which is a common on many single board computers such as Raspberry Pis. +Once you have gotten grip on how to use openHAB for your needs it is a good moment to think about backup. Maybe you accidently delete something or get hit by SD card wearout problem which is quite common on many single board computers such as Raspberry Pis. -There are four measuers and methods included to cover this matter today but they all need some reaserch and readup to be used. *(Hopfully will a more streamlined method be developed in the future which better integreted with openHAB itself, keep tuned.)* +There are four measures and methods in openHABian to cover this matter today, but they all need some research and readup to be successfully used. *(Hopefully we will get to develop a more streamlined method to better integrate with openHAB itself - stay tuned.)* 1. Use openHAB integrated [backup tool](https://community.openhab.org/t/recommended-way-to-backup-restore-oh2-configurations-and-things/7193/82?u=elias_gabrielsson). -2. Move the root filesystem to an external USB-memory. [Menu option:37] -3. (BETA) Reduce wear on SD-card by move write intensive actions temporary to RAM during operation (logs,persistant-data). Warning: powerfailure will result in lost data. [Menu option: 6A] -4. (Advanced) Use [Amanda Network Backup](http://www.amanda.org/) for full-system backup, longer introduction [here](https://github.com/openhab/openhabian/blob/master/docs/openhabian-amanda.md). [Menu option: 51] +2. Move the root filesystem to an external USB-memory. Warning: USB stick are as-susceptible to flash wearout as SD cards. [Menu option:37] +3. (BETA) Reduce wear on SD card by moving write intensive actions temporary to RAM during operation (logs,persistant-data). Warning: power failure will result in lost data. [Menu option: 6A] +4. (Advanced) Use [Amanda Network Backup](http://www.amanda.org/) for full system backup, longer introduction [here](https://github.com/openhab/openhabian/blob/master/docs/openhabian-amanda.md). [Menu option: 51] ## Optional Components