CommandFusion Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== DIN-RY CFLink Protocol ======

The following documentation is for the DIN-RYx-N devices CFLink protocol messages.

===== Relay Commands =====

==== On / Off / Toggle ====

The ''TRLYSET'' (Send) command is used to send a command to the relay channels.

=== Data ===

<sxh cflink; light: true>
> [F2]<ID>[F3]TRLYSET[F4]<PORT>:<STATE>[F5][F5]
</sxh>

  * **<PORT>** = The relay channel (port) to be controlled. Relay channels would be from ''P01-P08'' for the 8-channel and ''P01-P05'' for the 5-channel.
  * **<STATE>** = The command to set the status of relay. ''0'' would set the relay to open, ''1'' would set the relay to close, ''T'' would set the relay to toggle. 

=== Reply ===

<sxh cflink; light: true>
< [F2]<ID>[F3]RRLYCHA[F4]<PORT>:<STATE>[F5][F5] // The reply comes from only the port where the change event happens
< [F2]<ID>[F3]RRLYSTA[F4]<PORT>:<STATE>[F5][F5] // The reply comes from all the ports 
</sxh>

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 =====

==== Status Read ====

=== Data ===

<sxh cflink; light: true>
> [F2]<ID>[F3]QCFXSTA[F4]<PORT>[F5][F5] // query single port
> [F2]<ID>[F3]QCFXSTA[F4][F5][F5]       // query all ports
</sxh>

=== Reply ===

<sxh cflink; light: true>
> [F2]<ID>[F3]RCFXSTA[F4]<PORT>:<STATE>[F5][F5]  // reply with 
> [F2]<ID>[F3]RCFXCHA[F4]<PORT>:<STATE>[F5][F5]  // auto reporting
</sxh>

When <PORT> is specified, reply will have status of only specified port. If <PORT> is omitted, reply will have all port states. RCFXCHA will be sent as unsolicited message when port changed.

==== Configuration ====

Send:   \xF2<ID>\xF3CCFXDCP\xF4<Port>:<Mode>:<Double Tap Time>:<Hold Time>\xF5\xF5
Send:   \xF2<ID>\xF3CCFXDCP\xF4<Port>:<Mode>:<Timeout Time>:<Trigger State>\xF5\xF5
Reply:  \xF2<ID>\xF3RCFXDCP\xF4<Port>:<Mode>:<Double Tap Time>:<Hold Time>\xF5\xF5
<Port> = P01 to P08 for DIN-RY8, P01 to P05 for DIN-RY5.
<Mode> = N for normal (default), A for Advanced, T for Timer
<Double Tap Time> = Time in 100ths of a second for a double tap to occur within. Valid range (1-65535) (0.1s - 6553.5s)
<Hold Time> = Time in 100ths of a second for a long press and hold to occur. Valid range (1-65535) (0.1s - 6553.5s)
<Timeout Time> = Time in 100ths of a second for a port to stop reporting commands. Valid range (1-65535) (0.1s - 6553.5s)
<Trigger State> = When to trigger timer to start and restart. 1 = on close, 0 = on open. Default is “1 On Close” if this param is missing.

In Normal mode, dry contacts work as currently - report state on change, on press and on release. Double Tap Time and Hold Time can be omitted from command when setting normal mode.
Reply:  \xF2<ID>\xF3RCFXCHA\xF4<PORT>:<STATE>\xF5\xF5 (auto reporting)
<STATE> = 1 for press or 0 for release.

In Timer mode, dry contacts report on change as normal to start, but do not report any CHA or STA again until the timer goes out. Still report if manually requested via QCFXSTA regardless of timer.

Each time the port “trigger state” is reached, the timer will restart. Only once it times out (the time elapses with no state changes) will it begin to start sending state changes again.

When the timer times out, it will also send a special command “RCFXTUP” for “Times Up” with the port number as the data. Eg:
Eg:  \xF2<ID>\xF3RCFXTUP\xF4<PORT>\xF5\xF5
<PORT> = P01 or P02, etc.

Timer example:
\xF2<ID>\xF3CCFXDCP\xF4P01:T:3000:1\xF5\xF5
(Port 1 defined as timer mode with timer as 300s, trigger on close)
-> Port 1 closes: (time = 0s)
\xF2<ID>\xF3RCFXCHA\xF4P01:1\xF5\xF5
-> 10 secs later, Port 1 closes: (time = 10s)
<no report, timer restarts>
-> 290 secs later from last event, Port 1 closes: (time = 300s) 
<no report, timer restarts>
-> 300 secs later from last event, and Port 1 is now open: (time = 600s)
\xF2<ID>\xF3RCFXCHA\xF4P01:0\xF5\xF5 (reports state)
\xF2<ID>\xF3RCFXTUP\xF4P01\xF5\xF5 (timeout) 

Another example:

^ Time from 0 ^ Event ^ Bus Traffic ^ Timer ^
|Before 0s| | |inactive|
|0s|Motion trigger on port 1|\xF2<ID>\xF3RCFXCHA\xF4P01:1\xF5\xF5|started (300s)|
|10s|Motion trigger on port 1|(port closes)|<no report>|re-started(300s)|
|15s|Port 1 opens|<no report>|No effect|
|20s|Motion trigger on port 1(port closes)|<no report>|re-started (300s)|
|25s|Port 1 opens|<no report>|No effect|
|320s|No event|\xF2<ID>\xF3RCFXCHA\xF4P01:0\xF5\xF5|Timer completed|
|~320s|No event|\xF2<ID>\xF3RCFXTUP\xF4P01\xF5\xF5|Timer completed|
|350s|Motion trigger on port 1 (port closes)|\xF2<ID>\xF3RCFXCHA\xF4P01:1\xF5\xF5|started (300s)|
|650s|No event|\xF2<ID>\xF3RCFXSTA\xF4P01:1\xF5\xF5| |
|~650s|No event|\xF2<ID>\xF3RCFXTUP\xF4P01\xF5\xF5|Timer completed|
|660s|Port 1 opens|<no report>|No effect|
|670s|Motion trigger on port 1 (port closes)|\xF2<ID>\xF3RCFXCHA\xF4P01:1\xF5\xF5|Timer “restarts” (300s)|

In Advanced mode, dry contacts reports on change:
On press: no report
On release: no report

Instead, it reports single tap, double tap or held on change based on timing configuration:
Reply:  \xF2<ID>\xF3RCFXCHA\xF4<PORT>:<STATE>\xF5\xF5 (auto reporting)
<STATE> = S for Single Tap, D for Double Tap OR H for Held

For example, configure as advanced mode P01:A:15:30 
Double Tap time = 1.5 seconds, Hold time = 3.0 seconds

A Single Tap is reported if the 1 press and 1 release is detected within the double tap time (1.5 seconds). A single tap will not be reported til after the double tap time has lapsed.

A Double Tap is reported if the 2 presses and 2 releases are detected within the double tap time (1.5 seconds).

A Hold is reported if 1 press with no release is detected within the hold time (3 seconds). 


Start is defined by the detection of the first press. End is defined when a report is made. All timings are PER PORT.

Therefore a report of an event should be either a S, D OR H.  A “single” event CANNOT report multiple types of presses.

Valid time values are 000:100 where 100 = 10 seconds

Send:   \xF2<ID>\xF3CCFXDCP\xF4<PORT_CONFIG>\xF5\xF5
Reply:  \xF2<ID>\xF3RCFXDCP\xF4<PORT_CONFIG>\xF5\xF5

Example:
Send:   \xF2<ID>\xF3CCFXDCP\xF4P01:A:15:300|P02:N|P03:N\xF5\xF5
Reply:  \xF2<ID>\xF3RCFXDCP\xF4P01:A:15:300|P02:N|P03:N\xF5\xF5
CommandFusion Wiki

User Tools

Site Tools

Page Tools
