CommandFusion Wiki

Documentation Resources

User Tools

Site Tools


hardware:cflink:sw16-cflink-protocol

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

hardware:cflink:sw16-cflink-protocol [2012/08/14 04:39]
aaron created
hardware:cflink:sw16-cflink-protocol [2012/09/05 13:17] (current)
jarrod
Line 10: Line 10:
  
 === Data === === Data ===
-<code>+<sxh cflink; light: true>
 < [F2]<​ID>​[F3]RSWXSTA[F4]P01:<​STATE>​|P02:<​STATE>​|P03:<​STATE>​|P04:<​STATE>​|P05:<​STATE>​|P06:<​STATE>​|P07:<​STATE>​|P08:<​STATE>​|P09:<​STATE>​|P10:<​STATE>​|P11:<​STATE>​|P12:<​STATE>​|P13:<​STATE>​|P14:<​STATE>​|P15:<​STATE>​|P16:<​STATE>​[F5][F5] < [F2]<​ID>​[F3]RSWXSTA[F4]P01:<​STATE>​|P02:<​STATE>​|P03:<​STATE>​|P04:<​STATE>​|P05:<​STATE>​|P06:<​STATE>​|P07:<​STATE>​|P08:<​STATE>​|P09:<​STATE>​|P10:<​STATE>​|P11:<​STATE>​|P12:<​STATE>​|P13:<​STATE>​|P14:<​STATE>​|P15:<​STATE>​|P16:<​STATE>​[F5][F5]
-</code>+</sxh>
  
   * **<​STATE>​** = The current state of each dry contact input:   * **<​STATE>​** = The current state of each dry contact input:
Line 18: Line 18:
     * ''​1''​ = closed, on.     * ''​1''​ = closed, on.
 === Example === === Example ===
-<code>+<sxh cflink; light: true>
 // States returned for SW16 on CFLink ID [22] // States returned for SW16 on CFLink ID [22]
 < [F2][22][F3]RSWXSTA[F4]P01:​1|P02:​0|P03:​0|P04:​0|P05:​0|P06:​0|P07:​0|P08:​0|P09:​0|P10:​0|P11:​0|P12:​0|P13:​0|P14:​0|P15:​0|P16:​0[F5][F5] < [F2][22][F3]RSWXSTA[F4]P01:​1|P02:​0|P03:​0|P04:​0|P05:​0|P06:​0|P07:​0|P08:​0|P09:​0|P10:​0|P11:​0|P12:​0|P13:​0|P14:​0|P15:​0|P16:​0[F5][F5]
 // Port 1 is closed, on. // Port 1 is closed, on.
 // Ports 2-16 are open, off. // Ports 2-16 are open, off.
-</code>+</sxh>
  
 ==== LED - Query LED States ==== ==== LED - Query LED States ====
Line 29: Line 29:
  
 === Data === === Data ===
-<code>+<sxh cflink; light: true>
 > [F2]<​ID>​[F3]QSWXLED[F4][F5][F5] > [F2]<​ID>​[F3]QSWXLED[F4][F5][F5]
-</code>+</sxh>
  
 === Reply === === Reply ===
-<code>+<sxh cflink; light: true>
 < [F2]<​ID>​[F3]RSWXLED[F4]<​PORT>:<​STATE>:<​LEVEL>​[F5][F5] < [F2]<​ID>​[F3]RSWXLED[F4]<​PORT>:<​STATE>:<​LEVEL>​[F5][F5]
-</code>+</sxh>
  
 The reply will include data for all ports of the device. So for the SW16, there will be 16 sets of port data, separated by single pipe ''​|''​.\\ The reply will include data for all ports of the device. So for the SW16, there will be 16 sets of port data, separated by single pipe ''​|''​.\\
Line 52: Line 52:
  
 === Example === === Example ===
-<code>+<sxh cflink; light: true>
 // Request the LED states of a SW16 on CFLink ID [22] // Request the LED states of a SW16 on CFLink ID [22]
 > [F2][22][F3]QSWXLED[F4][F5][F5] > [F2][22][F3]QSWXLED[F4][F5][F5]
 // Returns states for all 16 LEDs // Returns states for all 16 LEDs
 < [F2][22][F3]RSWXLED[F4]P01:​X:​0|P02:​X:​100|P03:​D:​50|P04:​D:​20|P05:​B:​0|P06:​B:​70|P07:​P:​0|P08:​P:​68|P09:​X:​0|P10:​X:​0|P11:​X:​0|P12:​X:​0|P13:​X:​0|P14:​X:​0|P15:​X:​0|P16:​X:​0[F5][F5] < [F2][22][F3]RSWXLED[F4]P01:​X:​0|P02:​X:​100|P03:​D:​50|P04:​D:​20|P05:​B:​0|P06:​B:​70|P07:​P:​0|P08:​P:​68|P09:​X:​0|P10:​X:​0|P11:​X:​0|P12:​X:​0|P13:​X:​0|P14:​X:​0|P15:​X:​0|P16:​X:​0[F5][F5]
-</code>+</sxh>
  
 ==== BKL - Query Backlight LED States ==== ==== BKL - Query Backlight LED States ====
Line 64: Line 64:
  
 === Data === === Data ===
-<code>+<sxh cflink; light: true>
 > [F2]<​ID>​[F3]QSWXBKL[F4][F5][F5] > [F2]<​ID>​[F3]QSWXBKL[F4][F5][F5]
-</code>+</sxh>
  
 === Reply === === Reply ===
-<code>+<sxh cflink; light: true>
 < [F2]<​ID>​[F3]RSWXBKL[F4]<​PORT>:<​STATE>:<​LEVEL>​[F5][F5] < [F2]<​ID>​[F3]RSWXBKL[F4]<​PORT>:<​STATE>:<​LEVEL>​[F5][F5]
-</code>+</sxh>
  
 ==== BKL - Query Backlight LED States ==== ==== BKL - Query Backlight LED States ====
Line 78: Line 78:
  
 === Data === === Data ===
-<code>+<sxh cflink; light: true>
 > [F2]<​ID>​[F3]QSWXBKL[F4][F5][F5] > [F2]<​ID>​[F3]QSWXBKL[F4][F5][F5]
-</code>+</sxh>
  
 === Reply === === Reply ===
-<code>+<sxh cflink; light: true>
 < [F2]<​ID>​[F3]RSWXBKL[F4]<​PORT>:<​STATE>:<​LEVEL>​[F5][F5] < [F2]<​ID>​[F3]RSWXBKL[F4]<​PORT>:<​STATE>:<​LEVEL>​[F5][F5]
-</code>+</sxh>
  
 The reply will include data for all backlight LEDs of the device. So for the SW16, there will be 4 sets of port data, separated by single pipe ''​|''​. The reply will include data for all backlight LEDs of the device. So for the SW16, there will be 4 sets of port data, separated by single pipe ''​|''​.
Line 99: Line 99:
  
 === Example === === Example ===
-<code>+<sxh cflink; light: true>
 // Request the backlight LED states of a SW16 on CFLink ID [22] // Request the backlight LED states of a SW16 on CFLink ID [22]
 > [F2][22][F3]QSWXBKL[F4][F5][F5] > [F2][22][F3]QSWXBKL[F4][F5][F5]
 // Returns states for all 4 LEDs // Returns states for all 4 LEDs
 < [F2][22][F3]RSWXBKL[F4]P01:​X:​0|P02:​P:​100|P03:​D:​50|P04:​B:​20[F5][F5] < [F2][22][F3]RSWXBKL[F4]P01:​X:​0|P02:​P:​100|P03:​D:​50|P04:​B:​20[F5][F5]
-</code>+</sxh>
  
 ===== Transmission Messages ===== ===== Transmission Messages =====
Line 115: Line 115:
  
 The ''​LED''​ command can be used to change the LED states in a variety of ways, including basic on/​off/​toggle,​ and more advanced blinking, dimming and ramping.\\ The ''​LED''​ command can be used to change the LED states in a variety of ways, including basic on/​off/​toggle,​ and more advanced blinking, dimming and ramping.\\
-Combine multiple LED port changes by using the port separator character, ''​|''​ (single pipe).+Combine multiple LED port changes by using the [[hardware:​cflink:​cflink-introduction#​data-separators|port separator]] character, ''​|''​ (single pipe).
  
 == On, Off, Toggle == == On, Off, Toggle ==
-<code>+<sxh cflink; light: true>
 > [F2]<​ID>​[F3]TSWXLED[F4]<​PORT>:<​STATE>​[F5][F5] > [F2]<​ID>​[F3]TSWXLED[F4]<​PORT>:<​STATE>​[F5][F5]
-</code>+</sxh>
  
   * **<​PORT>​** = The port number in ''​P##''​ format. Eg. Port 1 is ''​P01''​.   * **<​PORT>​** = The port number in ''​P##''​ format. Eg. Port 1 is ''​P01''​.
Line 129: Line 129:
  
 == Pulse == == Pulse ==
-<code>+<sxh cflink; light: true>
 > [F2]<​ID>​[F3]TSWXLED[F4]<​PORT>:​P:<​TIME>​[F5][F5] > [F2]<​ID>​[F3]TSWXLED[F4]<​PORT>:​P:<​TIME>​[F5][F5]
-</code>+</sxh>
  
   * **<​PORT>​** = The port number in ''​P##''​ format. Eg. Port 1 is ''​P01''​.   * **<​PORT>​** = The port number in ''​P##''​ format. Eg. Port 1 is ''​P01''​.
Line 140: Line 140:
  
 == Blinking, Dimming == == Blinking, Dimming ==
-<code>+<sxh cflink; light: true>
 > [F2]<​ID>​[F3]TSWXLED[F4]<​PORT>:<​MODE>:<​MIN_LEVEL>:<​MAX_LEVEL>:<​TIME_ON>:<​TIME_OFF>:<​COUNT>​[F5][F5] > [F2]<​ID>​[F3]TSWXLED[F4]<​PORT>:<​MODE>:<​MIN_LEVEL>:<​MAX_LEVEL>:<​TIME_ON>:<​TIME_OFF>:<​COUNT>​[F5][F5]
-</code>+</sxh>
  
   * **<​PORT>​** = The port number in ''​P##''​ format. Eg. Port 1 is ''​P01''​.   * **<​PORT>​** = The port number in ''​P##''​ format. Eg. Port 1 is ''​P01''​.
Line 164: Line 164:
  
 == Ramping == == Ramping ==
-<code>+<sxh cflink; light: true>
 > [F2]<​ID>​[F3]TSWXLED[F4]<​PORT>:​R:<​LEVEL>:<​TIME>​[F5][F5] > [F2]<​ID>​[F3]TSWXLED[F4]<​PORT>:​R:<​LEVEL>:<​TIME>​[F5][F5]
-</code>+</sxh>
  
   * **<​PORT>​** = The port number in ''​P##''​ format. Eg. Port 1 is ''​P01''​.   * **<​PORT>​** = The port number in ''​P##''​ format. Eg. Port 1 is ''​P01''​.
Line 177: Line 177:
 === Reply === === Reply ===
  
-See LED Query Reply for more information.+See [[#​led-query-led-states|LED Query Reply]] for more information.
  
 === Example === === Example ===
-<code>+<sxh cflink; light: true>
 // Change the state of 6 LEDs on a SW16 on CFLink ID [22] // Change the state of 6 LEDs on a SW16 on CFLink ID [22]
 > [F2][22][F3]TSWXLED[F4]P01:​T|P02:​1|P03:​P:​100|P04:​B:​10:​88:​10:​10|P05:​D:​0:​100:​10:​20:​3|P06:​R:​55:​33[F5][F5] > [F2][22][F3]TSWXLED[F4]P01:​T|P02:​1|P03:​P:​100|P04:​B:​10:​88:​10:​10|P05:​D:​0:​100:​10:​20:​3|P06:​R:​55:​33[F5][F5]
Line 189: Line 189:
 // LED 5 = Dim to min level of 0 over 1 second, then to max level of 100 over 2 seconds, 3 times. // LED 5 = Dim to min level of 0 over 1 second, then to max level of 100 over 2 seconds, 3 times.
 // LED 6 = Ramp to a level of 55 over a period of 3.3 seconds. // LED 6 = Ramp to a level of 55 over a period of 3.3 seconds.
-</code> +</sxh>
 ==== BKL - Set Backlight State ==== ==== BKL - Set Backlight State ====
 The ''​BKL''​ (Backlight) command is used to set the state of one or more of the 4 backlight LED channels.\\ The ''​BKL''​ (Backlight) command is used to set the state of one or more of the 4 backlight LED channels.\\
-It uses the exact same options as the ''​LED''​ command, so see the ''​LED''​ command for more details. +It uses the exact same options as the ''​LED''​ command, so see the [[hardware:​cflink:​sw16-cflink-protocol:#​led-set-led-states|''​LED''​ command]] for more details.
 ===== Notifications ===== ===== Notifications =====
  
Line 203: Line 201:
  
 === Data === === Data ===
-<code>+<sxh cflink; light: true>
 > [F2]<​ID>​[F3]RSWXCHA[F4]<​PORT>:<​STATE>​[F5][F5] > [F2]<​ID>​[F3]RSWXCHA[F4]<​PORT>:<​STATE>​[F5][F5]
-</code>+</sxh>
  
   * **<​PORT>​** = The port number in ''​P##''​ format. Eg. Port 1 is ''​P01''​.   * **<​PORT>​** = The port number in ''​P##''​ format. Eg. Port 1 is ''​P01''​.
Line 211: Line 209:
     * ''​0''​ = open, off.     * ''​0''​ = open, off.
     * ''​1''​ = closed, on.     * ''​1''​ = closed, on.
-Example+=== Example ​=== 
 + 
 +<sxh cflink; light: true>
 // Input 1 is closed on SW16 on CFLink ID [22] // Input 1 is closed on SW16 on CFLink ID [22]
 < [F2][22][F3]RSWXCHA[F4]P01:​1[F5][F5] < [F2][22][F3]RSWXCHA[F4]P01:​1[F5][F5]
Line 217: Line 217:
 // Input 1 is opened on SW16 on CFLink ID [22] // Input 1 is opened on SW16 on CFLink ID [22]
 < [F2][22][F3]RSWXCHA[F4]P01:​0[F5][F5] < [F2][22][F3]RSWXCHA[F4]P01:​0[F5][F5]
 +</​sxh>​
  
 ==== STA - Input States ==== ==== STA - Input States ====
  
 The ''​STA''​ (Status) notification is sent out any time a dry contact input on the SW16 changes state or the input states are queried.\\ The ''​STA''​ (Status) notification is sent out any time a dry contact input on the SW16 changes state or the input states are queried.\\
-This notification contains the state of all ports at once, separated using the port separator character, ''​|''​ (single pipe).+This notification contains the state of all ports at once, separated using the [[hardware:​cflink:​cflink-introduction#​data-separators|port separator]] character, ''​|''​ (single pipe).
  
 === Data === === Data ===
-<code>+<sxh cflink; light: true>
 < [F2]<​ID>​[F3]RSWXSTA[F4]P01:<​STATE>​|P02:<​STATE>​|P03:<​STATE>​|P04:<​STATE>​|P05:<​STATE>​|P06:<​STATE>​|P07:<​STATE>​|P08:<​STATE>​|P09:<​STATE>​|P10:<​STATE>​|P11:<​STATE>​|P12:<​STATE>​|P13:<​STATE>​|P14:<​STATE>​|P15:<​STATE>​|P16:<​STATE>​[F5][F5] < [F2]<​ID>​[F3]RSWXSTA[F4]P01:<​STATE>​|P02:<​STATE>​|P03:<​STATE>​|P04:<​STATE>​|P05:<​STATE>​|P06:<​STATE>​|P07:<​STATE>​|P08:<​STATE>​|P09:<​STATE>​|P10:<​STATE>​|P11:<​STATE>​|P12:<​STATE>​|P13:<​STATE>​|P14:<​STATE>​|P15:<​STATE>​|P16:<​STATE>​[F5][F5]
-</code>+</sxh>
  
   * **<​STATE>​** = The current state of each dry contact input:   * **<​STATE>​** = The current state of each dry contact input:
Line 233: Line 234:
    
 === Example === === Example ===
-<code>+<sxh cflink; light: true>
 // States returned for SW16 on CFLink ID [22] // States returned for SW16 on CFLink ID [22]
 < [F2][22][F3]RSWXSTA[F4]P01:​1|P02:​0|P03:​0|P04:​0|P05:​0|P06:​0|P07:​0|P08:​0|P09:​0|P10:​0|P11:​0|P12:​0|P13:​0|P14:​0|P15:​0|P16:​0[F5][F5] < [F2][22][F3]RSWXSTA[F4]P01:​1|P02:​0|P03:​0|P04:​0|P05:​0|P06:​0|P07:​0|P08:​0|P09:​0|P10:​0|P11:​0|P12:​0|P13:​0|P14:​0|P15:​0|P16:​0[F5][F5]
 // Port 1 is closed, on. // Port 1 is closed, on.
 // Ports 2-16 are open, off. // Ports 2-16 are open, off.
-</code>+</sxh>
hardware/cflink/sw16-cflink-protocol.txt · Last modified: 2012/09/05 13:17 by jarrod