User Tools
hardware:cflink:relay-modules
Differences
This shows you the differences between two versions of the page.
|
hardware:cflink:relay-modules [2012/08/23 04:02] aaron created |
hardware:cflink:relay-modules [2015/10/12 22:23] (current) jarrod [Relay Ports CFLink Protocol] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Relay Modules CFLink Protocol ====== | + | ====== Relay Ports CFLink Protocol ====== |
| The following documentation describes the CFLink protocol for controlling relay ports on any device with relays.\\ | The following documentation describes the CFLink protocol for controlling relay ports on any device with relays.\\ | ||
| - | This includes relay modules and standalone devices such as the CF Mini | + | This includes relay modules, cards and standalone devices such as the CF Mini |
| ===== Queries ===== | ===== Queries ===== | ||
| ==== STA - Query Status ==== | ==== STA - Query Status ==== | ||
| - | |||
| The ''STA'' (Status) query returns the status of all relays in a single module/device. | The ''STA'' (Status) query returns the status of all relays in a single module/device. | ||
| Line 19: | Line 18: | ||
| * **<MODULE>** = The module number to request the status of. 2 chars, uppercase 'M' followed by the module number. | * **<MODULE>** = The module number to request the status of. 2 chars, uppercase 'M' followed by the module number. | ||
| - | eg. ''M1'' = Module 1, ''M4'' = Module 4. | + | * eg. ''M1'' = Module 1, ''M4'' = Module 4. |
| === Reply === | === Reply === | ||
| Line 73: | Line 72: | ||
| // Modular devices | // Modular devices | ||
| - | < [F2]<ID>[F3]RRLYSTA[F4]<MODULE>|<RELAYSTATES>[F5][F5] | + | < [F2]<ID>[F3]RRLYPOS[F4]<MODULE>|<RELAYSTATES>[F5][F5] |
| // Standalone devices | // Standalone devices | ||
| - | < [F2]<ID>[F3]RRLYSTA[F4]<RELAYSTATES>[F5][F5] | + | < [F2]<ID>[F3]RRLYPOS[F4]<RELAYSTATES>[F5][F5] |
| <RELAYSTATES> = Repeated for each relay port in the module/device, the port status is returned in P##:<STATE> format. Multiple relay ports are included in a single reply using the Port Separator | (Pipe character) | <RELAYSTATES> = Repeated for each relay port in the module/device, the port status is returned in P##:<STATE> format. Multiple relay ports are included in a single reply using the Port Separator | (Pipe character) | ||
| <STATE> = Single character: | <STATE> = Single character: | ||
| Line 208: | Line 207: | ||
| </sxh> | </sxh> | ||
| - | * **<MODULE>** = The module number to change the state of of. 2 chars, uppercase 'M' followed by the module number. | + | * **<MODULE>** = The module number to change the state of. 2 chars, uppercase 'M' followed by the module number. |
| * eg. ''M1'' = Module 1, ''M4'' = Module 4. | * eg. ''M1'' = Module 1, ''M4'' = Module 4. | ||
| - | * **<RELAYDATA>** = For each relay port in the command, the port state is written in P##:<STATE> format. Multiple relays can be changed in a single command by using the Port Separator | | + | * **<RELAYDATA>** = For each relay port in the command, the port state is written in ''P##:<STATE>'' format. Multiple relays can be changed in a single command by using the [[hardware:cflink:cflink-introduction#port-separator|Port Separator]] ''|'' |
| * **<STATE>** = Single character: | * **<STATE>** = Single character: | ||
| * ''0'' = Open relay | * ''0'' = Open relay | ||
| * ''1'' = Close relay. | * ''1'' = Close relay. | ||
| * ''T'' = Toggle relay state. If relay was closed, it will open. If relay was open, it will close. | * ''T'' = Toggle relay state. If relay was closed, it will open. If relay was open, it will close. | ||
| - | * ''P'' = Pulse relay. This requires a third parameter to the message: P##:P:<TIME>. | + | * ''P'' = Pulse relay. This requires a third parameter to the message: ''P##:P:<TIME>''. |
| * **<TIME>** = The time to pulse, 00000 - 99999, 100ms resolution. | * **<TIME>** = The time to pulse, 00000 - 99999, 100ms resolution. | ||
| * 00010 = Pulse for 1 second | * 00010 = Pulse for 1 second | ||
| Line 269: | Line 268: | ||
| * 004 = Invalid Module Number | * 004 = Invalid Module Number | ||
| * 402 = Invalid Relay State | * 402 = Invalid Relay State | ||
| - | |||
hardware/cflink/relay-modules.1345694525.txt.gz ยท Last modified: 2012/08/23 04:02 by aaron
