diff --git a/README.md b/README.md index 625ebf7..e367e8d 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,20 @@ The attributs `PIN` and `Mode` must be set in the node properties (edit dialog). This node supports the following modes: -* `group code + Device` - For devices without family code. The group code is either an binary string with length 5 or a numeric value (1-4) and could be set in field Group or msg.group. The switch/device could be set in field Device or msg.device (value [ABCD] (in this case Field Device must be set to "msg.device"). The Switchposition could be set in field Switch Position or in msg.payload. In this case the value 0 means off and the value 1 means on. -* `Family + Group code + Device` -For devices with family code. The Family code must be one of the chars [abcdef] and could be set in field Family or msg.family. The group code is numeric and must be one of the values [1234] and could be set in field Group or msg.group. The switch/device could be set in field Device or msg.device (value [ABCD] (in this case Field Device must be set to "msg.device"). The Switchposition could be set in field Switch Position or in msg.payload. In this case the value 0 means off and the value 1 means on. -* `Channel + Device (Tristate)` For devices with tristate code like micro-electric AS 73 witch is also sold as REV Telecontrol in Germany (Version with house code with 6 DIP switches). The Channel code must be a binary string with 0=off and 1=on and could be set in field Channel or msg.channel (in this case Field Channel must be empty). The switch/device could be set in field Device or msg.device (value [ABCD] (in this case Field Device must be set to "msg.device"). The Switchposition could be set in field Switch Position or in msg.payload. In this case the value 0 means off and the value 1 means on. -* `Tristate String ` Send a tristate string. The String could be set in field systemcode or msg.payload. Only the chars 0,1,F and S without any blanks are alowed. -* `Binary String` Send a binary string. The String could be set in field systemcode or msg.payload. Only the chars 0 and 1 without any blanks are alowed. +* `group code + Device` - For devices without family code. + +The group code is either an binary string with length 5 or a numeric value (1-4) and could be set in field **Group** or **msg.group**. The switch/device could be set in field **Device** or **msg.device** (value [ABCD] (in this case Field Device must be set to "msg.device"). The Switchposition could be set in field **Switch Position** or in **msg.payload**. In this case the value 0 means off and the value 1 means on. +* `Family + Group code + Device` -For devices with family code. + +The Family code must be one of the chars [abcdef] and could be set in field **Family** or **msg.family**. The group code is numeric and must be one of the values [1234] and could be set in field **Group** or **msg.group**. The switch/device could be set in field **Device** or **msg.device** (value [ABCD] (in this case Field Device must be set to "msg.device"). The Switchposition could be set in field **Switch Position** or in **msg.payload**. In this case the value 0 means off and the value 1 means on. +* `Channel + Device (Tristate)` For devices with tristate code like micro-electric AS 73 witch is also sold as REV Telecontrol in Germany (Version with house code with 6 DIP switches). + +The Channel code must be a binary string with 0=off and 1=on and could be set in field **Channel** or **msg.channel** (in this case Field Channel must be empty). The switch/device could be set in field **Device** or **msg.device** (value [ABCD] (in this case Field Device must be set to "msg.device"). The Switchposition could be set in field **Switch Position** or in **msg.payload**. In this case the value 0 means off and the value 1 means on. +* `Tristate String ` Send a tristate string. + +The String could be set in field **systemcode** or **msg.payload**. Only the chars 0,1,F and S without any blanks are alowed. +* `Binary String` Send a binary string. + +The String could be set in field **systemcode** or **msg.payload**. Only the chars 0 and 1 without any blanks are alowed. An description of the types is on https://github.com/marvinroger/node-rcswitch".