User Tools
hardware:cflink:common-device-protocol
Differences
This shows you the differences between two versions of the page.
|
hardware:cflink:common-device-protocol [2012/08/10 05:20] aaron |
hardware:cflink:common-device-protocol [2012/08/22 13:31] (current) jarrod |
||
|---|---|---|---|
| Line 22: | Line 22: | ||
| \\ | \\ | ||
| At a minimum, the device will reply with its product code, serial number, application version and CFLink version. | At a minimum, the device will reply with its product code, serial number, application version and CFLink version. | ||
| - | <code> | + | <sxh cflink; light: true> |
| > [F2]<ID>[F3]R<DEVICE>WHO[F4]<PRODUCTCODE>:<SERIAL#>:<APP_VER>:<CFLINK_VER>:<DATA>[F5][F5] | > [F2]<ID>[F3]R<DEVICE>WHO[F4]<PRODUCTCODE>:<SERIAL#>:<APP_VER>:<CFLINK_VER>:<DATA>[F5][F5] | ||
| - | </code> | + | </sxh> |
| == Example == | == Example == | ||
| - | <code> | + | <sxh cflink; light: true> |
| // Request the details for the device at CFLink ID [03] | // Request the details for the device at CFLink ID [03] | ||
| > [F2][03][F3]QCFXWHO[F4][F5][F5] | > [F2][03][F3]QCFXWHO[F4][F5][F5] | ||
| - | // The Reply if the unit was a LANBridge would be as follows | + | // The Reply if the unit was a LAN Bridge would be as follows |
| < [F2][03][F3]RLANWHO[F4]LANBridge:192.168.0.100:00.04.A3.19.D5.70:1.0.0.0:1.0.0.0[F5][F5] | < [F2][03][F3]RLANWHO[F4]LANBridge:192.168.0.100:00.04.A3.19.D5.70:1.0.0.0:1.0.0.0[F5][F5] | ||
| - | </code> | + | </sxh> |
| ==== TGT - Query Notification Targets ==== | ==== TGT - Query Notification Targets ==== | ||
| Line 41: | Line 41: | ||
| The ''TGT'' query does not have any associated data. Instead, the <DEVICE> name used as part of the query determines which notifications to return the configuration for.\\ | The ''TGT'' query does not have any associated data. Instead, the <DEVICE> name used as part of the query determines which notifications to return the configuration for.\\ | ||
| - | <code> | + | <sxh cflink; light: true> |
| > [F2]<ID>[F3]Q<DEVICE>TFT[F4][F5][F5] | > [F2]<ID>[F3]Q<DEVICE>TFT[F4][F5][F5] | ||
| - | </code> | + | </sxh> |
| == Reply == | == Reply == | ||
| - | <code> | + | <sxh cflink; light: true> |
| < [F2]<ID>[F3]R<DEVICE>TGT[F4]<ID1>:<ID2>:<ID3>:<ID4>:<ID5>[F5][F5] | < [F2]<ID>[F3]R<DEVICE>TGT[F4]<ID1>:<ID2>:<ID3>:<ID4>:<ID5>[F5][F5] | ||
| - | </code> | + | </sxh> |
| * **<ID>** = The CFLink ID of the unit retrieving configured notifications from. Single byte. | * **<ID>** = The CFLink ID of the unit retrieving configured notifications from. Single byte. | ||
| Line 57: | Line 57: | ||
| * ''MIN'' is for on-board serial port read notifications from a CFMini. | * ''MIN'' is for on-board serial port read notifications from a CFMini. | ||
| * ''SWX'' is for Dry Contact Input notifications from a SW16. | * ''SWX'' is for Dry Contact Input notifications from a SW16. | ||
| - | * ''LAN'' is for on-board serial port read notifications from a LANBridge. | + | * ''LAN'' is for on-board serial port read notifications from a LAN Bridge. |
| * ''IRB'' is for IR receive notifications from an IRBlaster. | * ''IRB'' is for IR receive notifications from an IRBlaster. | ||
| * **<ID1> - <ID5>** = The CFLink ID of a device on the CFLink bus that notification messages will be sent to. In plain text format, 2 chars (A-F, 0-9). | * **<ID1> - <ID5>** = The CFLink ID of a device on the CFLink bus that notification messages will be sent to. In plain text format, 2 chars (A-F, 0-9). | ||
| Line 64: | Line 64: | ||
| == Example == | == Example == | ||
| - | <code> | + | <sxh cflink; light: true> |
| // Retreive the notification settings for all IO modules in a MOD4 on CFLink ID [04] | // Retreive the notification settings for all IO modules in a MOD4 on CFLink ID [04] | ||
| > [F2][04][F3]QIOXTGT[F4][F5][F5] | > [F2][04][F3]QIOXTGT[F4][F5][F5] | ||
| Line 77: | Line 77: | ||
| // Reply | // Reply | ||
| < [F2][03][F3]RMODTGT[F4]04:05:06:07:08[F5][F5] | < [F2][03][F3]RMODTGT[F4]04:05:06:07:08[F5][F5] | ||
| - | </code> | + | </sxh> |
| ===== Configuration Messages ===== | ===== Configuration Messages ===== | ||
| Line 88: | Line 88: | ||
| The data for the ''DID'' command is formatted as follows: | The data for the ''DID'' command is formatted as follows: | ||
| - | <code> | + | <sxh cflink; light: true> |
| > [F2]<ID>[F3]CCFXDID[F4]<NEWID>:<SERIALNUM>[F5][F5] | > [F2]<ID>[F3]CCFXDID[F4]<NEWID>:<SERIALNUM>[F5][F5] | ||
| - | </code> | + | </sxh> |
| * **<NEWID>** = The new CFLink ID to assign to the device, in plain text (2 bytes). | * **<NEWID>** = The new CFLink ID to assign to the device, in plain text (2 bytes). | ||
| Line 99: | Line 99: | ||
| The ''DID'' configuration takes affect immediately, and the reply will come from the **<NEWID>** with the **<OLDID>** as data.\\ | The ''DID'' configuration takes affect immediately, and the reply will come from the **<NEWID>** with the **<OLDID>** as data.\\ | ||
| If the ''DID'' configuration message included the optional **<SERIALNUM>** parameter, then the reply will also include the serial number.\\ | If the ''DID'' configuration message included the optional **<SERIALNUM>** parameter, then the reply will also include the serial number.\\ | ||
| - | <code> | + | <sxh cflink; light: true> |
| < [F2]<NEWID>[F3]R<DEVICE>DID[F4]<OLDID>[F5][F5] | < [F2]<NEWID>[F3]R<DEVICE>DID[F4]<OLDID>[F5][F5] | ||
| < [F2]<NEWID>[F3]R<DEVICE>DID[F4]<OLDID>:<SERIALNUM>[F5][F5] | < [F2]<NEWID>[F3]R<DEVICE>DID[F4]<OLDID>:<SERIALNUM>[F5][F5] | ||
| - | </code> | + | </sxh> |
| == Example == | == Example == | ||
| - | <code> | + | <sxh cflink; light: true> |
| - | // Change the ID of a LANBridge from [03] to [04] | + | // Change the ID of a LAN Bridge from [03] to [04] |
| > [F2][03][F3]CCFXDID[F4]04[F5][F5] | > [F2][03][F3]CCFXDID[F4]04[F5][F5] | ||
| // Reply (note the ID change takes affect immediately) | // Reply (note the ID change takes affect immediately) | ||
| Line 114: | Line 114: | ||
| // Reply (note the new ID takes affect immediately) | // Reply (note the new ID takes affect immediately) | ||
| < [F2][05][F3]RIRBDID[F4]04:00000132[F5][F5] | < [F2][05][F3]RIRBDID[F4]04:00000132[F5][F5] | ||
| - | </code> | + | </sxh> |
| ==== TGT - Configure Notification Targets ==== | ==== TGT - Configure Notification Targets ==== | ||
| Line 122: | Line 122: | ||
| === Data === | === Data === | ||
| - | <code> | + | <sxh cflink; light: true> |
| > [F2]<ID>[F3]C<DEVICE>TGT[F4]<ID1>:<ID2>:<ID3>:<ID4>:<ID5>[F5][F5] | > [F2]<ID>[F3]C<DEVICE>TGT[F4]<ID1>:<ID2>:<ID3>:<ID4>:<ID5>[F5][F5] | ||
| - | </code> | + | </sxh> |
| * **<ID>** = The CFLink ID of the unit configuring notification for. Single byte. | * **<ID>** = The CFLink ID of the unit configuring notification for. Single byte. | ||
| Line 137: | Line 137: | ||
| == Reply == | == Reply == | ||
| - | <code> | + | <sxh cflink; light: true> |
| < [F2]<ID>[F3]R<DEVICE>TGT[F4]<ID1>:<ID2>:<ID3>:<ID4>:<ID5>[F5][F5] | < [F2]<ID>[F3]R<DEVICE>TGT[F4]<ID1>:<ID2>:<ID3>:<ID4>:<ID5>[F5][F5] | ||
| - | </code> | + | </sxh> |
| == Example == | == Example == | ||
| - | <code> | + | <sxh cflink; light: true> |
| // Configure the notification targets for the status command of IO modules in a MOD4 on CFLink ID [04] | // Configure the notification targets for the status command of IO modules in a MOD4 on CFLink ID [04] | ||
| // Notifications for this command should be sent to IDs [05], [06] and [07] (without changing the last two ID's if previously configured) | // Notifications for this command should be sent to IDs [05], [06] and [07] (without changing the last two ID's if previously configured) | ||
| Line 149: | Line 149: | ||
| < [F2][04][F3]RIOXTGT[F4]05:06:07:00:00[F5][F5] | < [F2][04][F3]RIOXTGT[F4]05:06:07:00:00[F5][F5] | ||
| - | // Configure the notification targets for on-board serial port of a LANBridge on CFLink ID [04] | + | // Configure the notification targets for on-board serial port of a LAN Bridge on CFLink ID [04] |
| // Notifications for this command should be sent to IDs [07], [2C] and [0D] only (disabling the last two ID's if previously configured) | // Notifications for this command should be sent to IDs [07], [2C] and [0D] only (disabling the last two ID's if previously configured) | ||
| > [F2][04][F3]CLANTGT[F4]07:2C:0D:00:00[F5][F5] | > [F2][04][F3]CLANTGT[F4]07:2C:0D:00:00[F5][F5] | ||
| // Reply | // Reply | ||
| < [F2][04][F3]RLANTGT[F4]07:2C:0D:00:00[F5][F5] | < [F2][04][F3]RLANTGT[F4]07:2C:0D:00:00[F5][F5] | ||
| - | </code> | + | </sxh> |
| == Error == | == Error == | ||
| Line 171: | Line 171: | ||
| The ''RST'' command does not have any associated data. | The ''RST'' command does not have any associated data. | ||
| - | <code> | + | <sxh cflink; light: true> |
| > [F2]<ID>[F3]TCFXRST[F4][F5][F5] | > [F2]<ID>[F3]TCFXRST[F4][F5][F5] | ||
| - | </code> | + | </sxh> |
| === Reply === | === Reply === | ||
| Line 180: | Line 180: | ||
| == Example == | == Example == | ||
| - | <code> | + | <sxh cflink; light: true> |
| // Reset device on ID [05] | // Reset device on ID [05] | ||
| > [F2][05][F3]TCFXRST[F4][F5][F5] | > [F2][05][F3]TCFXRST[F4][F5][F5] | ||
| // After the device has reset and is operational again, it will announce itself with a WHO reply. | // After the device has reset and is operational again, it will announce itself with a WHO reply. | ||
| < [F2][05][F3]R<DEVICE>WHO[F4]<DATA>[F5][F5] | < [F2][05][F3]R<DEVICE>WHO[F4]<DATA>[F5][F5] | ||
| - | </code> | + | </sxh> |
| ===== Notifications ===== | ===== Notifications ===== | ||
| Line 196: | Line 196: | ||
| === Data === | === Data === | ||
| - | <code> | + | <sxh cflink; light: true> |
| > [F2]<ID>[F3]RCFXLDR[F4]<PRODUCT>:<FIRMWARE_STATE>:<BOOTVERSION>[F5][F5] | > [F2]<ID>[F3]RCFXLDR[F4]<PRODUCT>:<FIRMWARE_STATE>:<BOOTVERSION>[F5][F5] | ||
| - | </code> | + | </sxh> |
| * **<PRODUCT>** = The product code for the device. | * **<PRODUCT>** = The product code for the device. | ||
| Line 208: | Line 208: | ||
| == Example == | == Example == | ||
| - | <code> | + | <sxh cflink; light: true> |
| - | // LANBridge powerup notification, on CFLink ID [04] | + | // LAN Bridge powerup notification, on CFLink ID [04] |
| > [F2][04][F3]RCFXLDR[F4]LANBridge:App_OK:1.0.1[F5][F5] | > [F2][04][F3]RCFXLDR[F4]LANBridge:App_OK:1.0.1[F5][F5] | ||
| // DIN-MOD4 powerup notification, on CFLink ID [05], app firmware is missing. | // DIN-MOD4 powerup notification, on CFLink ID [05], app firmware is missing. | ||
| > [F2][04][F3]RCFXLDR[F4]DIN-MOD4:App_Err:1.0.4[F5][F5] | > [F2][04][F3]RCFXLDR[F4]DIN-MOD4:App_Err:1.0.4[F5][F5] | ||
| - | </code> | + | </sxh> |
hardware/cflink/common-device-protocol.1344576014.txt.gz · Last modified: 2012/08/10 05:20 by aaron
