Differences

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

--- hardware:cflink:din-ry-cflink-protocol [2019/08/28 05:44]
terrylau
+++ hardware:cflink:din-ry-cflink-protocol [2021/04/28 15:00] (current)
terrylau Control Port Configuration
@@ Line 2: / Line 2: @@
 ====== DIN-RY CFLink Protocol ======
-The following documentation is for the DIN-RYx-N devices CFLink protocol messages.
+The following documentation is for the DIN-RYx-N devices CFLink protocol messages. This protocol can be used regardless of connection method to the DIN-RYx device either via USB, RS232 or RS485.
+===== Control Port Configuration =====
+This command is used to configure the communication properties for each control port on the unit.
+<sxh cflink; light: true>
+> [F2]<ID>[F3]CCFXSPC[F4]<PORT>:<MODE>:<BAUD>:<DATABITS>:<PARITY>:<STOP>:<FLOW CONTROL>[F5][F5]
+</sxh>
+* **<PORT>** would be designated as:
+       * P01 = RS232 IN
+       * P02 = RS485 IN
+       * P03 = RS485 OUT
+       * P04 = RS232 OUT
+       * PZZ = All Ports
+* **<MODE>** would be designated as:
+       * BUS (Bus Mode) - Messages are to be treated as control protocol commands and forwarded along the bus as per the Message Handling documentation. Available <BAUD> rates would be 115200 (default) and 38400.
+<sxh cflink; light: true>
+> [F2][20][F3]CCFXSPC[F4]P04:BUS:115200:8:N:1:0[F5][F5]
+</sxh>
+       * EXT (External Mode) - Messages sent to/from a third party device, allowing control of other RS232 or RS485 devices via rules and macros. Available <BAUD> rates would be:
+         * 100
+         * 600
+         * 1200
+         * 2400
+         * 4800
+         * 9600 (Default for EXT mode)
+         * 14400
+         * 19200
+         * 38400
+         * 57600
+         * 115200
+         * 128000
+         * 256000
+      * CFL (CFLink Mode) - Messages sent to/from the CFLink Bus, allowing control of other CFLink devices via rules and macros. 115200 is the default <BAUD> rate. Note that CFLink mode connection is only available for RS485-In port.
+<sxh cflink; light: true>
+> [F2][20][F3]CCFXSPC[F4]P02:CFL:115200:8:N:1:0[F5][F5]
+</sxh>
+=== Query Port Configuration ===
+This command is used to query and get the current port settings for each control port on the unit.
+<sxh cflink; light: true>
+> [F2]<ID>[F3]QCFXSPC[F4]<PORT>[F5][F5]    \\ Query status of individual ports
+> [F2]<ID>[F3]QCFXSPC[F4][F5][F5]          \\ Query status of all ports
+</sxh>
+=== Sending Command to Control External Devices ===
+This command is used to send data to control the external device depending on the port used.
+<sxh cflink; light: true>
+> [F2]<ID>[F3]TCFXSPW[F4]<PORT>:<DATA>[F5][F5]
+</sxh>
 ===== Relay Commands =====
@@ Line 28: / Line 86: @@
 To minimize the data traffic on the communication bus, the ''RRLYCHA'' will only reflect the affected ports only. It will also be sent as unsolicited messages when buttons on the display panel are set. The ''RRLYSTA'' reply will have all port status, separated by pipes.
-===== DRY CONTACTS =====
+===== Dry Contacts =====
 ==== Status Read ====
@@ Line 200: / Line 258: @@
-* <IF AC STATE> = S01:1 (AC state 1 is on)
+  * <IF AC STATE> = S01:1 (AC state 1 is on)
-* <IF AC STATE> = S01:0 (AC state 1 is off)
+  * <IF AC STATE> = S01:0 (AC state 1 is off)
-* <SET PORT STATE> = P01:1 (port 1 L1/NO)
+  * <SET PORT STATE> = P01:1 (port 1 L1/NO)
-* <SET PORT STATE> = P01:2 (port 1 L2/NC)
+  * <SET PORT STATE> = P01:2 (port 1 L2/NC)
-* <SET PORT STATE> = P01:0 (port 1 L2/NC)
+  * <SET PORT STATE> = P01:0 (port 1 L2/NC)
-* <SET PORT STATE> = P01:T (port 1 toggle)
+  * <SET PORT STATE> = P01:T (port 1 toggle)
 <sxh cflink; light: true>
@@ Line 217: / Line 275: @@
 </sxh>
+===== User Variable =====
+You can use user variables to store strings or values that can be retrieved anytime for use later.
+The ''CVARSET'' (Send) command is used to assign a value to the defined user variable.
+=== Data ===
+<sxh cflink; light: true>
+> [F2]<ID>[F3]CVARSET[F4]<VARIABLE_NAME>:<VALUE>[F5][F5]
+</sxh>
+  * **<VARIABLE_NAME>** = The name of the user variable.
+  * **<VALUE>** = The value to be assigned to the variable.
+=== Reply ===
+<sxh cflink; light: true>
+< [F2]<ID>[F3]RVARSET[F4]<VARIABLE_NAME>:<VALUE>[F5][F5]
+</sxh>
+There are two variable query commands available -  ''QVARLST'' command is used to query all available variables and its respective values. ''QVARGET'' command is used to query a specific variable value.
+=== Data ===
+<sxh cflink; light: true>
+> [F2]<ID>[F3]QVARLST[F4][F5][F5] \\ Query value for all variables
+> [F2]<ID>[F3]QVARGET[F4]<VARIABLE_NAME>[F5][F5] \\ Query value for specific variable
+</sxh>
+  * **<VARIABLE_NAME>** = The name of the user variable.
+  * **<VALUE>** = The value to be assigned to the variable.
+=== Reply ===
+<sxh cflink; light: true>
+< [F2]<ID>[F3]RVARGET[F4]<VARIABLE_NAME>:<VALUE>[F5][F5]
+</sxh>

CommandFusion Wiki

User Tools

Site Tools

Differences

Page Tools