Differences

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

--- hardware:cflink:input-output-io-module-cflink-protocol [2012/09/27 04:39]
jarrod
+++ hardware:cflink:input-output-io-module-cflink-protocol [2013/03/26 05:34] (current)
jarrod [PRT - Configure Port Settings]
@@ Line 1: / Line 1: @@
 ====== Input/Output (IO) CFLink Protocol ======
-The following documentation describes the CFLink protocol for IO ports on modular devices and standalone devices.
+The following documentation describes the CFLink protocol for controlling IO ports on any device with IO's.\\
+This includes IO modules and standalone devices such as the CF Mini.
 ===== Common Definitions =====
@@ Line 13: / Line 14: @@
     * ''R'' = ''R''esistance reading input, <STATE> = ''000''-''100'' (0 to 10,000 Ohms in 100 Ohm increments)
     * ''A'' = ''A''nalog Voltage reading input, <STATE> = ''000''-''100'' (00.0 to 10.0 Volts DC in 0.1 Volt increments)
-    * ''V'' = Digital Voltage reading input, <STATE> = ''0'' for voltage below threshold, ''1'' for voltage equal to or above threshold
+    * ''V'' = Digital ''V''oltage reading input, <STATE> = ''0'' for voltage below threshold, ''1'' for voltage equal to or above threshold
-    * ''S'' = Video Sensing input, <STATE> = ''0'' for no video sensed, ''1'' for video sensed.
+    * ''S'' = Video ''S''ensing input, <STATE> = ''0'' for no video sensed, ''1'' for video sensed.
-    * ''E'' = External relay control output, 0-24V DC (external power supply required), <STATE> = ''0'' for OFF, ''1'' for ON.
+    * ''E'' = ''E''xternal relay control output, 0-24V DC (external power supply required), <STATE> = ''0'' for OFF, ''1'' for ON.
-    * ''L'' = LED output (1mA), <STATE> = ''0'' for OFF, ''1'' for ON.
+    * ''L'' = ''L''ED output (5V DC, 1mA), <STATE> = ''0'' for OFF, ''1'' for ON.
 ===== Queries =====
@@ Line 26: / Line 27: @@
 === Data ===
 <sxh cflink; light: true>
+// Modular devices
 > [F2]<ID>[F3]QIOXSTA[F4]<MODULE>[F5][F5]
+// Standalone devices
+> [F2]<ID>[F3]QIOXSTA[F4][F5][F5]
 </sxh>
   * **<MODULE>** = The module number to request the status of. 2 chars, uppercase 'M' followed by the module number.
@@ Line 36: / Line 38: @@
 <sxh cflink; light: true>
+// Modular devices
 < [F2]<ID>[F3]RIOXSTA[F4]<MODULE>|<IODATA>[F5][F5]
+// Standalone devices
+< [F2]<ID>[F3]RIOXSTA[F4]<IODATA>[F5][F5]
 </sxh>
@@ Line 70: / Line 75: @@
 <sxh cflink; light: true>
+// Modular devices
 > [F2]<ID>[F3]QIOXPRT[F4]<MODULE>[F5][F5]
+// Standalone devices
+> [F2]<ID>[F3]QIOXPRT[F4][F5][F5]
 </sxh>
@@ Line 80: / Line 87: @@
 <sxh cflink; light: true>
+// Modular devices
 < [F2]<ID>[F3]RIOXPRT[F4]<MODULE>|<PORT_CONFIG>[F5][F5]
+// Standalone devices
+< [F2]<ID>[F3]RIOXPRT[F4]<PORT_CONFIG>[F5][F5]
 </sxh>
@@ Line 121: / Line 130: @@
 <sxh cflink; light: true>
+// Modular devices
 > [F2]<ID>[F3]QIOXCFG[F4]<MODULE>[F5][F5]
+// Standalone devices
+> [F2]<ID>[F3]QIOXCFG[F4][F5][F5]
 </sxh>
   * **<MODULE>** = The module number to request the module configuration of. 2 chars, uppercase 'M' followed by the module number.
@@ Line 130: / Line 141: @@
 <sxh cflink; light: true>
+// Modular devices
 < [F2]<ID>[F3]RIOXCFG[F4]<MODULE>:<ENABLED>:<REPORT_ON_CHANGE>:<REPORT_INTERVAL>[F5][F5]
+// Standalone devices
+< [F2]<ID>[F3]RIOXCFG[F4]<ENABLED>:<REPORT_ON_CHANGE>:<REPORT_INTERVAL>[F5][F5]
 </sxh>
@@ Line 155: / Line 168: @@
 < [F2][04][F3]RIOXCFG[F4]M1:1:1:36000[F5][F5]
 // IO module is enabled, report on change is enabled, reports status every hour.
 </sxh>
@@ Line 172: / Line 184: @@
 <sxh cflink; light: true>
+// Modular devices
 > [F2]<ID>[F3]CIOXPRT[F4]<MODULE>|<PORT_CONFIG>[F5][F5]
+// Standalone devices
+> [F2]<ID>[F3]CIOXPRT[F4]<PORT_CONFIG>[F5][F5]
 </sxh>
   * **<PORT_CONFIG>** = See the definition under the ''PRT'' Query for more details.
@@ Line 191: / Line 205: @@
 // Port 5 = External relay control, Power On State = Off
 // Port 6 = LED ouput, Power On State = On
-// Port 7 = Dry contact
+// Port 7 = Video Sense Input
 // Port 8 = Dry contact
-> [F2][05][F3]CIOXPRT[F4]M1|P01:D:0:0|P02:D:0:0|P03:R:15:0|P04:V:12:0|P05:E:0:0|P06:L:0:1|P07:D:0:0|P08:D:0:0[F5][F5]
+> [F2][05][F3]CIOXPRT[F4]M1|P01:D:0:0|P02:D:0:0|P03:R:15:0|P04:V:12:0|P05:E:0:0|P06:L:0:1|P07:S:0:0|P08:D:0:0[F5][F5]
 // Reply
 < [F2][05][F3]RIOXPRT[F4]M1|P01:D:0:0|P02:D:0:0|P03:R:15:0|P04:V:12:0|P05:E:0:0|P06:L:0:1|P07:D:0:0|P08:D:0:0[F5][F5]
@@ Line 213: / Line 227: @@
 <sxh cflink; light: true>
+// Modular devices
 > [F2]<ID>[F3]CIOXCFG[F4]<MODULE>:<ENABLED>:<REPORT_ON_CHANGE>:<REPORT_INTERVAL>[F5][F5]
+// Standalone devices
+> [F2]<ID>[F3]CIOXCFG[F4]<ENABLED>:<REPORT_ON_CHANGE>:<REPORT_INTERVAL>[F5][F5]
 </sxh>
@@ Line 230: / Line 247: @@
 // Reply
 < [F2][05][F3]RIOXCFG[F4]M1:1:1:00600[F5][F5]
 </sxh>
@@ Line 252: / Line 268: @@
 <sxh cflink; light: true>
+// Modular devices
 > [F2]<ID>[F3]TIOXSET[F4]<MODULE>|<OUTPUTDATA>[F5][F5]
+// Standalone devices
+> [F2]<ID>[F3]TIOXSET[F4]<OUTPUTDATA>[F5][F5]
 </sxh>
@@ Line 267: / Line 285: @@
 <sxh cflink; light: true>
+// Modular devices
 < [F2]<ID>[F3]RIOXSTA[F4]<MODULE>|<IODATA>[F5][F5]
+// Standalone devices
+< [F2]<ID>[F3]RIOXSTA[F4]<IODATA>[F5][F5]
 </sxh>
@@ Line 302: / Line 322: @@
 <sxh cflink; light: true>
+// Modular devices
 < [F2]<ID>[F3]RIOXSTA[F4]<MODULE>|<IODATA>[F5][F5]
+// Standalone devices
+< [F2]<ID>[F3]RIOXSTA[F4]<IODATA>[F5][F5]
 </sxh>
@@ Line 332: / Line 354: @@
 <sxh cflink; light: true>
+// Modular devices
 < [F2]<ID>[F3]RIOXCHA[F4]<MODULE>|<IODATA>[F5][F5]
+// Standalone devices
+< [F2]<ID>[F3]RIOXCHA[F4]<IODATA>[F5][F5]
 </sxh>

CommandFusion Wiki

User Tools

Site Tools

Differences

Page Tools