CommandFusion Wiki

Documentation Resources

User Tools

Site Tools


hardware:cflink:on-board-rs232-port-protocol

Differences

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

Link to this comparison view

hardware:cflink:on-board-rs232-port-protocol [2014/02/20 11:55]
jarrod [On-Board RS232 Port Protocol]
hardware:cflink:on-board-rs232-port-protocol [2015/07/02 05:09] (current)
jarrod [SPR - Serial Port Read]
Line 6: Line 6:
   * [[hardware:​modular-base-units:​din-mod4|DIN-MOD4]] (DB9 Female)   * [[hardware:​modular-base-units:​din-mod4|DIN-MOD4]] (DB9 Female)
   * [[hardware:​modular-base-units:​mod4|MOD4]] (DB9 Female)   * [[hardware:​modular-base-units:​mod4|MOD4]] (DB9 Female)
 +  * [[hardware:​solo|Solo]] (2 x detachable 3-pin spring terminals)
  
-Anywhere that ''​MOD'',​ ''​LAN'' ​or ''​MIN''​ are used in outgoing commands, you can safely interchange with ''​CFX''​.\\ +Anywhere that ''​MOD'',​ ''​LAN''​''​MIN''​ or ''​SOL''​ are used in outgoing commands, you can safely interchange with ''​CFX''​.\\ 
-This goes for all commands sent to any CFLink device. However, all replies/​notifications will be sent with the correct 3 character device identifier for the device sending the data.+This goes for all commands sent to any CFLink device.\\ 
 +However, all //replies/​notifications// will be sent with the correct 3 character device identifier for the device sending the data (''​CFX''​ is never used in replies except from bootloader notifications).
  
 ===== Queries ===== ===== Queries =====
Line 22: Line 24:
 === Reply === === Reply ===
 <sxh cflink; light: true> <sxh cflink; light: true>
-< [F2]<​ID>​[F3]RCFXSPC[F4]<​MODE>:<​BAUD>:<​DATABITS>:<​PARITY>:<​STOP>:<​FLOWCTRL>​[F5][F5]+< [F2]<​ID>​[F3]RCFXSPC[F4]<​PORT>:​<​MODE>:<​BAUD>:<​DATABITS>:<​PARITY>:<​STOP>:<​FLOWCTRL>​[F5][F5]
 </​sxh>​ </​sxh>​
  
-See the ''​SPC''​ command for details on each returned data parameter.+See the [[#​spc-serial-port-configuration|''​SPC''​ command]] for details on each returned data parameter.
  
 === Example === === Example ===
Line 33: Line 35:
 // Reply with the configuration data, Serial Port is in Program mode // Reply with the configuration data, Serial Port is in Program mode
 < [F2][02][F3]RLANSPC[F4]PGM:​115200:​8:​N:​1:​0[F5][F5] < [F2][02][F3]RLANSPC[F4]PGM:​115200:​8:​N:​1:​0[F5][F5]
 +
 +// Query the Serial Port configuration of a Solo on ID [03]
 +> [F2][03][F3]QSOLSPC[F4][F5][F5]
 +// Reply with the configuration data for both on-board serial ports
 +< [F2][03][F3]RSOLSPC[F4]P01:​232:​115200:​8:​N:​1:​0|P02:​232:​115200:​8:​N:​1:​0[F5][F5]
 </​sxh>​ </​sxh>​
  
Line 39: Line 46:
 ==== SPC - Serial Port Configuration ==== ==== SPC - Serial Port Configuration ====
  
-The ''​SPC''​ (Serial Port Configuration) command is used to configure the properties of the serial port such as Port ModeBaud rate, Flow Control, etc.+The ''​SPC''​ (Serial Port Configuration) command is used to configure the properties of the serial port such as port modebaud rate, flow control, etc.
  
 === Data === === Data ===
 <sxh cflink; light: true> <sxh cflink; light: true>
-> [F2]<​ID>​[F3]CCFXSPC[F4]<​MODE>:<​BAUD>:<​DATABITS>:<​PARITY>:<​STOPBITS>:<​FLOWCTRL>​[F5][F5]+> [F2]<​ID>​[F3]CCFXSPC[F4]<​PORT>:​<​MODE>:<​BAUD>:<​DATABITS>:<​PARITY>:<​STOPBITS>:<​FLOWCTRL>​[F5][F5]
 </​sxh>​ </​sxh>​
  
 +  * **<​PORT>​** = Only required if the device has more than one on-board RS232 port, such as the [[hardware:​solo|Solo]].
   * **<​MODE>​** = The mode of the RS232 port:   * **<​MODE>​** = The mode of the RS232 port:
 +    * ''​OFF''​ (Disabled) means the serial port is turned off, disabled entirely.
     * ''​PGM''​ (Program Mode) means incoming data must be valid CFLink formatted commands, and allows you to send data to any device on the CFLink network via RS232. All CFLink data received by the device will also be sent out the RS232 port in this mode.     * ''​PGM''​ (Program Mode) means incoming data must be valid CFLink formatted commands, and allows you to send data to any device on the CFLink network via RS232. All CFLink data received by the device will also be sent out the RS232 port in this mode.
-    * ''​232''​ (RS232 Mode) means incoming data is sent only to devices that are configured via the TGT command. The incoming RS232 data will be wrapped in a SPR reply before being sent to the target devices. Data is sent to the RS232 port using the SPW command when in this mode.+    * ''​232''​ (RS232 Mode) means incoming data is sent to devices that are configured via the ''​TGT'' ​command, as well as any network sockets on the device itself. The incoming RS232 data will be wrapped in a SPR reply before being sent to the target devices. Data is sent to the RS232 port using the SPW command when in this mode
 +    * ''​TCP''​ **SOLO ONLY** (RS232 Mode with TCP Server) is the same as ''​232''​ mode, except that a TCP Server socket is opened (TCP port 10208 for Serial Port 1, TCP port 10209 for Serial Port 2). Up to 4 TCP Clients can connect to each port, and data is simply piped between the TCP Client and the RS232 port. This is essentially turning the [[hardware:​solo|Solo]] into an RS232 to Ethernet adapter. Data does NOT need to be wrapped in CFLink packets to be sent/​received in this mode. The data received via the TCP Socket is piped directly to the RS232 port unchanged.
   * **<​BAUD>​** = The baud rate of the RS232 port:   * **<​BAUD>​** = The baud rate of the RS232 port:
     * 100     * 100
Line 56: Line 66:
     * 2400     * 2400
     * 4800     * 4800
-    * 9600+    * 9600 (Default baud rate for [[hardware:​solo|Solo]] RS232 ports)
     * 14400     * 14400
     * 19200     * 19200
Line 70: Line 80:
     * ''​E''​ = Even     * ''​E''​ = Even
   * **<​STOPBITS>​** = The stop bits of the RS232 port (''​1''​ or ''​2''​).   * **<​STOPBITS>​** = The stop bits of the RS232 port (''​1''​ or ''​2''​).
-  * **<​FLOWCONTROL>​** = The flow control of the RS232 port (''​0''​ = None, ''​1''​ = RTS/CTS).+  * **<​FLOWCONTROL>​** = The flow control of the RS232 port (''​0''​ = None, ''​1''​ = RTS/CTS). If flow control is enabled on Port 1 of the [[hardware:​solo|Solo]],​ Port 2 will be automatically disabled entirely. Note that flow control cannot be enabled on port 2 of the [[hardware:​solo|Solo]],​ only Port 1 on the [[hardware:​solo|Solo]] has flow control capabilities.
  
 === Reply === === Reply ===
 <sxh cflink; light: true> <sxh cflink; light: true>
-< [F2]<​ID>​[F3]RCFXSPC[F4]<​MODE>:<​BAUD>:<​DATABITS>:<​PARITY>:<​STOP>:<​FLOWCTRL>​[F5][F5]+< [F2]<​ID>​[F3]RCFXSPC[F4]<​PORT>:​<​MODE>:<​BAUD>:<​DATABITS>:<​PARITY>:<​STOP>:<​FLOWCTRL>​[F5][F5]
 </​sxh>​ </​sxh>​
  
Line 83: Line 93:
 // Reply // Reply
 < [F2][02][F3]RLANSPC[F4]232:​9600:​8:​N:​1:​0[F5][F5] < [F2][02][F3]RLANSPC[F4]232:​9600:​8:​N:​1:​0[F5][F5]
 +
 +// Configure the on-board serial port for a Solo on ID [03] to enable Port 1 in RS232 mode, 9600 baud, 8:None:1. No changes made to Port 2.
 +> [F2][03][F3]CSOLSPC[F4]P01:​232:​9600:​8:​N:​1:​0[F5][F5]
 +// Reply
 +< [F2][03][F3]RSOLSPC[F4]P01:​232:​9600:​8:​N:​1:​0|P02:​232:​115200:​8:​N:​1:​0[F5][F5]
 </​sxh>​ </​sxh>​
  
Line 124: Line 139:
 === Data === === Data ===
 <sxh cflink; light: true> <sxh cflink; light: true>
-> [F2]<​ID>​[F3]TCFXSPW[F4]<​DATA>​[F5][F5]+> [F2]<​ID>​[F3]TCFXSPW[F4]<​PORT>:​<​DATA>​[F5][F5]
 </​sxh>​ </​sxh>​
  
 +**<​PORT>​** = The port number to send the data to. Only used for devices that have more than one on-board RS232 port, such as the [[hardware:​solo|Solo]].
 **<​DATA>​** = The data to be written out the on-board serial port. Hex bytes must be entered in \xFF format. eg. A carriage return is written as \x0D **<​DATA>​** = The data to be written out the on-board serial port. Hex bytes must be entered in \xFF format. eg. A carriage return is written as \x0D
  
Line 141: Line 157:
 // Reply // Reply
 < [F2][03][F3]RMINSPW[F4][F5][F5] < [F2][03][F3]RMINSPW[F4][F5][F5]
 +
 +// Send a command out the second on-board serial port of a Solo on CFLink ID [03]
 +> [F2][03][F3]TSOLSPW[F4]P02:​Hello World!\x0D[F5][F5]
 +// Reply
 +< [F2][03][F3]RSOLSPW[F4][F5][F5]
 </​sxh>​ </​sxh>​
  
Line 156: Line 177:
 === Data === === Data ===
 <sxh cflink; light: true> <sxh cflink; light: true>
-< [F2]<​ID>​[F3]R<​DEVICE>​SPR[F4]<​DATA>​[F5][F5]+< [F2]<​ID>​[F3]R<​DEVICE>​SPR[F4]<​PORT>:​<​DATA>​[F5][F5]
 </​sxh>​ </​sxh>​
 +
 +  * **<​PORT>​** = Only present if the device has more than one on-board RS232 port, such as the [[hardware:​solo|Solo]].
 +  * **<​DATA>​** = The data that was received.
  
 === Example === === Example ===
Line 166: Line 190:
 < [F2][04][F3]RMINSPR[F4]Hello World!\x0D[F5][F5] < [F2][04][F3]RMINSPR[F4]Hello World!\x0D[F5][F5]
 < [F2][07][F3]RMINSPR[F4]Hello World!\x0D[F5][F5] < [F2][07][F3]RMINSPR[F4]Hello World!\x0D[F5][F5]
 +
 +// An incoming message "Hello World!"​ followed by a carriage return is received on the first on-board serial port of a Solo on CFLink ID [03].
 +// The Solo is configured to send incoming RS232 data to all CFLink ID's.
 +< [F2][FF][F3]RSOLSPR[F4]P01:​Hello World!\x0D[F5][F5]
 </​sxh>​ </​sxh>​
hardware/cflink/on-board-rs232-port-protocol.1392897306.txt.gz · Last modified: 2014/02/20 11:55 by jarrod