Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision Both sides next revision
en:configuration_api [2021/06/06 20:20]
kateyu [BS2Rs485Config] 		en:configuration_api [2021/08/05 15:30]
peter
Line 78: Line 78:
   * [[BS2_GetBarcodeConfig]]:​ [+ 2.8] ''​X-Station 2''​ Retrieves configuration of Barcode.   * [[BS2_GetBarcodeConfig]]:​ [+ 2.8] ''​X-Station 2''​ Retrieves configuration of Barcode.
   * [[BS2_SetBarcodeConfig]]:​ [+ 2.8] ''​X-Station 2''​ Stores configuration of Barcode.   * [[BS2_SetBarcodeConfig]]:​ [+ 2.8] ''​X-Station 2''​ Stores configuration of Barcode.
 +  * [[BS2_GetInputConfigEx]]:​​ [+ 2.8.1] ''​​IM-120''​​ Retrieves Expanded Configuration related to the Input.
 +  * [[BS2_SetInputConfigEx]]:​​ [+ 2.8.1] ''​​IM-120''​​ Retrieves Expanded Configuration related to the Input.
 +  * [[BS2_GetRelayActionConfig]]:​​ [+ 2.8.1] ''​​IM-120''​​ Retrieves Configuration related to the RelayAction.
 +  * [[BS2_SetRelayActionConfig]]:​​ [+ 2.8.1] ''​​IM-120''​​ Retrieves Configuration related to the RelayAction.
 \\ \\
 ===== Structure ===== ===== Structure =====
Line 2416: Line 2420:
 3. //​reserved//​ \\  3. //​reserved//​ \\ 
 Reserved space. \\ Reserved space. \\
 +
 +
 +  ==== BS2InputConfigEx ====
 + ​ <​code cpp>
 + ​ typedef struct {
 + ​  ​   uint8_t ​   ​numInputs;​
 + ​  ​   uint8_t ​   ​numSupervised;​​
 + ​  ​   uint8_t ​   ​reserved[18];​​
 + 
 + ​  ​   struct {
 + ​  ​       uint8_t ​   ​portIndex;​
 + ​  ​       uint8_t ​   ​switchType;​
 + ​  ​       uint16_t ​  ​duration;​​
 + ​  ​   ​
 + ​  ​       uint8_t ​   ​reserved;​
 + ​  ​       uint8_t ​   ​supervisedResister;​​
 + ​  ​       uint8_t ​   ​reserved1[16];​​
 + ​  ​   ​
 + ​  ​       uint8_t ​   ​reserved2[26];​​
 + ​  ​   } inputs[BS2_MAX_INPUT_NUM_EX];​​
 + 
 + ​  ​   uint8_t ​   ​reserved2[200];​​
 +  } BS2InputConfigEx;​​
 + ​ </​​code>​​
 +  1. //​​numInputs//​​ \\ 
 + ​ Number of Input port. \\ \\
 +  2. //​​numSupervised//​​ \\
 + ​ Number of supervised input port. \\ \\
 +  3. //​​reserved//​​ \\
 + ​ Reserved Space. \\ \\
 +  4. //​​portIndex//​​ \\ 
 + ​ Input Port Number. \\ \\
 +  5. //​​switchType//​​ \\
 + ​ Input Signal Type\\ ​
 + ​ <​WRAP group 50%>
 + ​ ^Value ​ ^Description ​ ^
 + ​ |0 ​ |Normally Open  |
 + ​ |1 ​ |Normally Closed ​ |
 + ​ </​​WRAP>​ ​
 +  6. //​​duration//​​ \\ 
 + ​ Input Signal Duration Time Measurement is milliseconds(ms). \\ \\
 +  7. //​​reserved//​​ \\
 + ​ Reserved Space. \\ \\
 +  8. //​​supervisedResister//​​ \\
 +  You can set Supervised input resistance value type or unsupervise it. \\
 + ​ <​WRAP group 50%>
 + ​ ^Value ​ ^Description ​ ^
 + ​ |0 ​ |1K Resistance ​ |
 + ​ |1 ​ |2.2K Resistance ​ |
 + ​ |2 ​ |4.7K Resistance ​ |
 + ​ |3 ​ |10K Resistance ​ |
 + ​ |254 ​ |Unsupervised(Default) ​ |
 + ​ </​​WRAP>​ ​
 +  9. //​​reserved1//​​ \\
 + ​ Reserved Space. \\ \\
 +  10. //​​reserved2//​​ \\
 + ​ Reserved Space. \\ \\
 +  11. //​​reserved2//​​ \\
 + ​ Reserved Space. \\ \\
 + 
 + 
 +  ==== BS2RelayActionConfig ====
 + ​ <​code cpp>
 + ​ typedef struct {
 + ​  ​   uint32_t ​       ​deviceID;​​ ///<​ 4 bytes
 + ​  ​   uint8_t ​        ​reserved[16];​​ ///<​ 16 bytes
 + 
 + ​  ​   struct {
 + ​  ​       uint8_t ​    ​port;​ ///<​ 1 byte (relay port)
 + ​  ​       uint8_t ​    ​reserved0;​​ ///<​ 1 byte
 + ​  ​       uint8_t ​    ​disconnEnabled;​​ ///<​ 1 byte (RS485 disconnection)
 + ​  ​       uint8_t ​    ​reserved[9];​​ ///<​ 9 bytes
 + ​  ​       ​
 + ​  ​       struct {
 + ​  ​           uint8_t port;​ ///<​ 1 byte (input port)
 + ​  ​           uint8_t type;​ ///<​ 1 byte (linkage/​​latching/​​release)
 + ​  ​           uint8_t mask;​ ///<​ 1 byte (alarm/​​fault)
 + ​  ​           uint8_t reserved[9];​​ ///<​ 9 bytes
 + ​  ​       } input[BS2_MAX_RELAY_ACTION_INPUT];​​ ///<​ 192 bytes
 + ​  ​   } items[BS2_MAX_RELAY_ACTION];​​ ///< 816 bytes
 + 
 + ​  ​   uint8_t reserved2[152];​​ ///<​ 152 bytes
 +  } BS2RelayActionConfig;​​
 + ​ </​​code>​​
 +  1. //​​deviceID//​​ \\ 
 + ​ Device Identifier \\ \\
 +  2. //​​reserved//​​ \\
 + ​ Reserved Space. \\ \\
 +  3. //items// \\
 + ​ Relay Setting Information \\ \\
 +  4. //port// \\ 
 + ​ Relay port Number. \\ \\
 +  5. //​​reserved0//​​ \\
 + ​ Reserved Space. \\ \\
 +  6. //​​disconnEnabled//​​ \\ 
 +  If set to true, a signal is made when RS485 is disconnected. \\ \\
 +  7. //​​reserved//​​ \\
 + ​ Reserved Space. \\ \\
 +  8. //input// \\
 + ​ Defines to which input ports the relay ports will take action. \\ \\
 +  9. //port// \\
 + ​ Input port Identifier. \\ \\
 +  10. //type// \\
 + ​ Defines in which input type the input will take action. \\
 +  If set to Linkage, signal can be made when alarm is set to mask. \\
 + ​ <​WRAP group 50%>
 + ​ ^type ​ ^Value ​ ^Description ​ ^
 + ​ |NONE ​ |0  |OFF ​ |
 + ​ |LINKAGE ​ |1  |Connect to the relay of the input ​ |
 + ​ |LATCHING ​ |2  |''​​Not Supported''​ ​ |
 + ​ |RELEASE ​ |3  |''​​Not Supported''​ ​ |
 + ​ </​​WRAP>​ ​
 +  11. //mask// \\
 +  Set mask to Input Signal Info. \\
 + ​ <​WRAP group 50%>
 + ​ ^type ​ ^Value ​ ^Description ​ ^
 + ​ |NONE ​ |0  |OFF ​ |
 + ​ |ALARM ​ |1  |Signal Made ​ |
 + ​ |FAULT ​ |2  |Signal Made when disconnected ​ |
 + ​ </​​WRAP>​ ​
 +  12. //​​reserved//​​ \\
 + ​ Reserved Space. \\ \\
 +  13. //​​reserved2//​​ \\
 + ​ Reserved Space. \\ \\