CommandFusion Wiki

Documentation Resources

User Tools

Site Tools


hardware:cflink:com-module-cflink-documentation

Differences

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

Link to this comparison view

hardware:cflink:com-module-cflink-documentation [2012/09/28 06:47]
jarrod old revision restored (2012/08/22 23:04)
hardware:cflink:com-module-cflink-documentation [2015/07/16 04:38] (current)
jarrod
Line 1: Line 1:
-====== COM Module CFLink Documentation ====== +====== COM Module/Card CFLink Documentation ====== 
-The following documentation is for COM (serial port) modules.+The following documentation is for COM (serial port) modules ​and cards.
  
 ===== Port Configurations ===== ===== Port Configurations =====
Line 311: Line 311:
 ==== SPC - Query Configuration ==== ==== SPC - Query Configuration ====
  
-The ''​SPC''​ (Serial Port Configuration) query is used to return the status of the port configurations for the module.+The ''​SPC''​ (Serial Port Configuration) query is used to return the status of the port configurations for the module/card.
  
 === Data === === Data ===
Line 320: Line 320:
 </​sxh>​ </​sxh>​
  
-  * **<​M#>​** = The module number return the configuration for. 2 chars, uppercase '​M'​ followed by the module number. +  * **<​M#>​** = The module number return the configuration for. 2 chars, uppercase '​M'​ followed by the module/card number. 
-    * eg. ''​M1''​ = Module 1, ''​M4''​ = Module 4.+    * eg. ''​M1''​ = Module/card 1, ''​M4''​ = Module4.
  
 === Reply === === Reply ===
Line 330: Line 330:
 </​sxh>​ </​sxh>​
  
-Each port on the COM module will be included in the reply.\\+Each port on the COM module/card will be included in the reply.\\
 See the definitions for all returned data in the SPC command. See the definitions for all returned data in the SPC command.
  
Line 359: Line 359:
 </​sxh>​ </​sxh>​
  
-  * <M#> = The module number to configure port settings for. 2 chars, uppercase '​M'​ followed by the module number. +  * <M#> = The module number to configure port settings for. 2 chars, uppercase '​M'​ followed by the module/card number. 
-    * eg. ''​M1''​ = Module 1, ''​M4''​ = Module 4.+    * eg. ''​M1''​ = Module/card 1, ''​M4''​ = Module 4.
   * **<​P##>​** = Port number to configure. 3 chars, uppercase '​P'​ followed by the two digit port number.   * **<​P##>​** = Port number to configure. 3 chars, uppercase '​P'​ followed by the two digit port number.
     * eg. ''​P01''​ = Port 1, ''​P02''​ = Port 2.     * eg. ''​P01''​ = Port 1, ''​P02''​ = Port 2.
Line 387: Line 387:
     * ''​N''​ = No Parity     * ''​N''​ = No Parity
     * ''​O''​ = Odd (uppercase letter '​O'​)     * ''​O''​ = Odd (uppercase letter '​O'​)
-    * E''''​ = Even+    * ''​E''​ = Even
   * **<​STOPBITS>​** = The following stop bits are available:   * **<​STOPBITS>​** = The following stop bits are available:
     * ''​1''​ = 1 stop bit     * ''​1''​ = 1 stop bit
Line 401: Line 401:
  
 </​sxh>​ </​sxh>​
-The reply will contain information for each port of the module, even if only one port was changed. See the definitions for all returned data above.+The reply will contain information for each port of the module/card, even if only one port was changed. See the definitions for all returned data above.
  
 === Example === === Example ===
Line 429: Line 429:
 ==== SPW - Send Serial Data ==== ==== SPW - Send Serial Data ====
  
-The ''​SPW''​ (Serial Port Write) command is used to send serial data out a specific port within the module.+The ''​SPW''​ (Serial Port Write) command is used to send serial data out a specific port within the module/card.
  
 <sxh cflink; light: true> <sxh cflink; light: true>
Line 437: Line 437:
 </​sxh>​ </​sxh>​
  
-  * **<​M#>​** = The module number to send the data via. 2 chars, uppercase '​M'​ followed by the module number. +  * **<​M#>​** = The module number to send the data via. 2 chars, uppercase '​M'​ followed by the module/card number. 
-    * eg. ''​M1''​ = Module 1, ''​M4''​ = Module 4.+    * eg. ''​M1''​ = Module/card 1, ''​M4''​ = Module 4.
   * **<​P##>​** = Port number to send the data out via. 3 chars, uppercase '​P'​ followed by the two digit port number.   * **<​P##>​** = Port number to send the data out via. 3 chars, uppercase '​P'​ followed by the two digit port number.
     * eg. ''​P01''​ = Port 1, ''​P02''​ = Port 2.     * eg. ''​P01''​ = Port 1, ''​P02''​ = Port 2.
Line 452: Line 452:
 </​sxh>​ </​sxh>​
  
-If the SPW command is successful, the reply will contain the module and port number parameters used for the SPW. The data will not be echoed, in an effort to reduce bus traffic.+If the SPW command is successful, the reply will contain the module/card and port number parameters used for the SPW. The data will not be echoed, in an effort to reduce bus traffic.
  
 === Example - Sending Serial Data === === Example - Sending Serial Data ===
Line 465: Line 465:
  
   * 003 = Invalid Port Number   * 003 = Invalid Port Number
-  * 004 = Invalid Module Number+  * 004 = Invalid Module/card Number
  
 ===== Notifications ===== ===== Notifications =====
Line 471: Line 471:
 ==== SPR - Read Serial Data ==== ==== SPR - Read Serial Data ====
  
-The ''​SPR''​ (Serial Port Read) reply contains any data received via a specific port within the module.\\+The ''​SPR''​ (Serial Port Read) reply contains any data received via a specific port within the module/card.\\
 This reply is automatically transmitted whenever data is received. This reply is automatically transmitted whenever data is received.
  
Line 480: Line 480:
 </​sxh>​ </​sxh>​
  
-  * **<​M#>​** = The module number that received the data. 2 chars, uppercase '​M'​ followed by the module number. +  * **<​M#>​** = The module number that received the data. 2 chars, uppercase '​M'​ followed by the module/card number. 
-    * eg. ''​M1''​ = Module 1, ''​M4''​ = Module 4.+    * eg. ''​M1''​ = Module/card 1, ''​M4''​ = Module 4.
   * **<​P##>​** = Port number that received the data. 3 chars, uppercase '​P'​ followed by the two digit port number.   * **<​P##>​** = Port number that received the data. 3 chars, uppercase '​P'​ followed by the two digit port number.
     * eg. ''​P01''​ = Port 1, ''​P02''​ = Port 2.     * eg. ''​P01''​ = Port 1, ''​P02''​ = Port 2.
hardware/cflink/com-module-cflink-documentation.1348814856.txt.gz · Last modified: 2012/09/28 06:47 by jarrod