Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
en:configuration_api [2021/08/06 15:19] kateyu [BS2InputConfigEx] |
en:configuration_api [2022/04/21 12:07] mark [BS2BarcodeConfig] |
||
|---|---|---|---|
| Line 730: | Line 730: | ||
| **23. //cipher//** \\ | **23. //cipher//** \\ | ||
| Activates 'Keypad card ID' option. \\ | Activates 'Keypad card ID' option. \\ | ||
| - | Default value is 0, it is only valid for XPass D2 Gangbox Keypad type. \\ | + | Default value is 0, it is only valid for Gangbox Keypad type of Xpass 2, XPass D2. \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^Value ^Description ^ | ^Value ^Description ^ | ||
| Line 1812: | Line 1812: | ||
| **12. //faceWidth//** \\ | **12. //faceWidth//** \\ | ||
| [+ V2.7.1] ''FaceStation F2'' This indicates the width of the face image, and you can specify the minimum and maximum values. \\ | [+ V2.7.1] ''FaceStation F2'' This indicates the width of the face image, and you can specify the minimum and maximum values. \\ | ||
| - | The minimum and maximum values default to 66 and 250. \\ \\ | + | The default values of min and max are as follows. \\ |
| + | <WRAP group 20%> | ||
| + | ^ ^Default ^ | ||
| + | |min |66 | | ||
| + | |max |250 | | ||
| + | </WRAP> | ||
| **13. //searchRange//** \\ | **13. //searchRange//** \\ | ||
| [+ V2.7.1] ''FaceStation F2'' Represents the face search range, and you can specify the x value (horizontal coordinate) of the range and the width from the x value point. \\ | [+ V2.7.1] ''FaceStation F2'' Represents the face search range, and you can specify the x value (horizontal coordinate) of the range and the width from the x value point. \\ | ||
| - | The default values for x value and width are 144 and 432. \\ \\ | + | The default values of x and width are as follows. \\ |
| + | <WRAP group 20%> | ||
| + | ^ ^Default ^ | ||
| + | |x |144 | | ||
| + | |width |432 | | ||
| + | </WRAP> | ||
| 14. //reserved2// \\ | 14. //reserved2// \\ | ||
| Reserved space.\\ \\ | Reserved space.\\ \\ | ||
| Line 2414: | Line 2424: | ||
| </code> | </code> | ||
| 1. //useBarcode// \\ | 1. //useBarcode// \\ | ||
| - | This is the flag for enabling Barcode or disabling Barcode. \\ \\ | + | Barcode usage flag. \\ \\ |
| 2. //scanTimeout// \\ | 2. //scanTimeout// \\ | ||
| - | This is Timeout(second) setting for scanning Barcode. \\ | + | Set the Barcode scan time. The unit is in seconds. \\ |
| - | Default second is 4 seconds. The time out can be set from 4 to 10 seconds. \\ \\ | + | The default is 4 seconds, and can be entered within a range of 4 to 10 seconds.\\ \\ |
| - | 3. //reserved// \\ | + | 3. //bypassData// \\ |
| - | Reserved space. \\ | + | [+2.8.2] Used to send read barcode information to the server, not processed by the device. \\ |
| + | If the barcode value is stored in the user information structure for user authentication, \\ | ||
| + | There is a size constraint of 32 bytes ([[smartcard_api#BS2CSNCard|BS2CSNCard data]]), \\ | ||
| + | Call the [[BS2_SetBarcodeScanListener]], use this option to send barcodes up to 512 bytes of size to the server. \\ \\ | ||
| + | 4. //treatAsCSN// \\ | ||
| + | [+2.8.2] Indicates whether the Barcode should be treated the same as a regular CSN card. \\ | ||
| + | It is applied from XS2-QR 1.1.3 and in the case of false, it is treated the same as before. \\ | ||
| + | This allows you to freely specify character sets that can be treated as barcodes from ASCII codes 32 to 126. (See description in [[qr_code_api#BS2_WriteQRCode|BS2_WriteQRCode]]) \\ | ||
| + | If set to true, the barcode is treated like a number just like the existing CSN. \\ | ||
| + | Therefore, if you want to set the bar code card data with special characters and English characters. \\ | ||
| + | In this case, only the card type may be different, and the CSN card and barcode data may be used in the same value. \\ | ||
| + | 5. //reserved// \\ | ||
| + | Reserved space. \\ | ||
| ==== BS2InputConfigEx ==== | ==== BS2InputConfigEx ==== | ||
| Line 2435: | Line 2457: | ||
| | | ||
| uint8_t reserved; | uint8_t reserved; | ||
| - | uint8_t supervisedResister; | + | uint8_t supervisedResistor; |
| uint8_t reserved1[16]; | uint8_t reserved1[16]; | ||
| | | ||
| Line 2444: | Line 2466: | ||
| } BS2InputConfigEx; | } BS2InputConfigEx; | ||
| </code> | </code> | ||
| - | 1. //numInputs// \\ | + | 1. //numInputs// \\ |
| - | Number of Input port. \\ \\ | + | Number of Input port. \\ \\ |
| - | 2. //numSupervised// \\ | + | 2. //numSupervised// \\ |
| - | Number of supervised input port. \\ \\ | + | Number of supervised input port. \\ \\ |
| - | 3. //reserved// \\ | + | 3. //reserved// \\ |
| - | Reserved Space. \\ \\ | + | Reserved Space. \\ \\ |
| - | 4. //portIndex// \\ | + | 4. //portIndex// \\ |
| - | Input Port Number. \\ \\ | + | Input Port Number. \\ \\ |
| - | 5. //switchType// \\ | + | 5. //switchType// \\ |
| - | Input Signal Type. \\ | + | Input Signal Type. \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| - | ^Value ^Description ^ | + | ^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. \\ \\ | + | |
| - | 5. //switchType// \\ | + | |
| - | Input 신호 유형입니다. \\ | + | |
| - | <WRAP group 50%> | + | |
| - | ^값 ^설명 ^ | + | |
| |0 |Normally Open | | |0 |Normally Open | | ||
| - | |1 |Normally Closed | | + | |1 |Normally Closed | |
| </WRAP> | </WRAP> | ||
| - | 6. //duration// \\ | + | 6. //duration// \\ |
| - | Input 신호의 지속시간으로 단위는 밀리초(ms)입니다. \\ \\ | + | Input Signal Duration Time Measurement is milliseconds(ms). \\ \\ |
| - | 7. //reserved// \\ | + | 7. //reserved// \\ |
| - | 예약된 공간입니다. \\ \\ | + | Reserved Space. \\ \\ |
| - | 8. //supervisedResister// \\ | + | 8. //supervisedResistor// \\ |
| - | Supervised input 저항 값의 유형을 설정하거나, 해제할 수(unsupervised) 있습니다. \\ | + | You can set Supervised input resistance value type or unsupervise it. \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| - | ^값 ^설명 ^ | + | ^Value ^Description ^ |
| - | |0 |1K 저항 | | + | |0 |1K Resistance | |
| - | |1 |2.2K 저항 | | + | |1 |2.2K Resistance | |
| - | |2 |4.7K 저항 | | + | |2 |4.7K Resistance | |
| - | |3 |10K 저항 | | + | |3 |10K Resistance | |
| - | |254 |Unsupervised(기본값) | | + | |254 |Unsupervised(Default) | |
| </WRAP> | </WRAP> | ||
| + | 9. //reserved1// \\ | ||
| + | Reserved Space. \\ \\ | ||
| + | 10. //reserved2// \\ | ||
| + | Reserved Space. \\ \\ | ||
| + | 11. //reserved2// \\ | ||
| + | Reserved Space. \\ \\ | ||
| - | ==== BS2RelayActionConfig ==== | + | ==== BS2RelayActionConfig ==== |
| - | <code cpp> | + | <code cpp> |
| - | typedef struct { | + | typedef struct { |
| - | uint32_t deviceID; ///< 4 bytes | + | uint32_t deviceID; ///< 4 bytes |
| - | uint8_t reserved[16]; ///< 16 bytes | + | uint8_t reserved[16]; ///< 16 bytes |
| - | + | ||
| - | struct { | + | struct { |
| - | uint8_t port; ///< 1 byte (relay port) | + | uint8_t port; ///< 1 byte (relay port) |
| - | uint8_t reserved0; ///< 1 byte | + | uint8_t reserved0; ///< 1 byte |
| - | uint8_t disconnEnabled; ///< 1 byte (RS485 disconnection) | + | uint8_t disconnEnabled; ///< 1 byte (RS485 disconnection) |
| - | uint8_t reserved[9]; ///< 9 bytes | + | uint8_t reserved[9]; ///< 9 bytes |
| - | | + | |
| - | struct { | + | struct { |
| - | uint8_t port; ///< 1 byte (input port) | + | uint8_t port; ///< 1 byte (input port) |
| - | uint8_t type; ///< 1 byte (linkage/latching/release) | + | uint8_t type; ///< 1 byte (linkage/latching/release) |
| - | uint8_t mask; ///< 1 byte (alarm/fault) | + | uint8_t mask; ///< 1 byte (alarm/fault) |
| - | uint8_t reserved[9]; ///< 9 bytes | + | uint8_t reserved[9]; ///< 9 bytes |
| - | } input[BS2_MAX_RELAY_ACTION_INPUT]; ///< 192 bytes | + | } input[BS2_MAX_RELAY_ACTION_INPUT]; ///< 192 bytes |
| - | } items[BS2_MAX_RELAY_ACTION]; ///< 816 bytes | + | } relay[BS2_MAX_RELAY_ACTION]; ///< 816 bytes |
| - | + | ||
| - | uint8_t reserved2[152]; ///< 152 bytes | + | uint8_t reserved2[152]; ///< 152 bytes |
| - | } BS2RelayActionConfig; | + | } BS2RelayActionConfig; |
| - | </code> | + | </code> |
| - | 1. //deviceID// \\ | + | 1. //deviceID// \\ |
| - | Device Identifier \\ \\ | + | Device Identifier \\ \\ |
| - | 2. //reserved// \\ | + | 2. //reserved// \\ |
| - | Reserved Space. \\ \\ | + | Reserved Space. \\ \\ |
| - | 3. //items// \\ | + | 3. //relay// \\ |
| - | Relay Setting Information \\ \\ | + | Relay Setting Information \\ \\ |
| - | 4. //port// \\ | + | 4. //port// \\ |
| - | Relay port Number. \\ \\ | + | Relay port Number. \\ \\ |
| - | 5. //reserved0// \\ | + | 5. //reserved0// \\ |
| - | Reserved Space. \\ \\ | + | Reserved Space. \\ \\ |
| - | 6. //disconnEnabled// \\ | + | 6. //disconnEnabled// \\ |
| - | If set to true, a signal is made when RS485 is disconnected. \\ \\ | + | If set to true, a signal is made when RS485 is disconnected. \\ \\ |
| - | 7. //reserved// \\ | + | 7. //reserved// \\ |
| - | Reserved Space. \\ \\ | + | Reserved Space. \\ \\ |
| - | 8. //input// \\ | + | 8. //input// \\ |
| - | Defines to which input ports the relay ports will take action. \\ \\ | + | Defines to which input ports the relay ports will take action. \\ \\ |
| - | 9. //port// \\ | + | 9. //port// \\ |
| - | Input port Identifier. \\ \\ | + | Input port Identifier. \\ \\ |
| - | 10. //type// \\ | + | 10. //type// \\ |
| - | Defines in which input type the input will take action. \\ | + | Defines in which input type the input will take action. \\ |
| - | If set to Linkage, signal can be made when alarm is set to mask. \\ | + | If set to Linkage, signal can be made when alarm is set to mask. \\ |
| - | <WRAP group 50%> | + | <WRAP group 50%> |
| - | ^type ^Value ^Description ^ | + | ^type ^Value ^Description ^ |
| - | |NONE |0 |OFF | | + | |NONE |0 |OFF | |
| - | |LINKAGE |1 |Connect to the relay of the input | | + | |LINKAGE |1 |Connect to the relay of the input | |
| - | |LATCHING |2 |''Not Supported'' | | + | |LATCHING |2 |''Not Supported'' | |
| - | |RELEASE |3 |''Not Supported'' | | + | |RELEASE |3 |''Not Supported'' | |
| - | </WRAP> | + | </WRAP> |
| - | 11. //mask// \\ | + | 11. //mask// \\ |
| - | Set mask to Input Signal Info. \\ | + | Set mask to Input Signal Info. \\ |
| - | <WRAP group 50%> | + | <WRAP group 50%> |
| - | ^type ^Value ^Description ^ | + | ^type ^Value ^Description ^ |
| - | |NONE |0 |OFF | | + | |NONE |0 |OFF | |
| - | |ALARM |1 |Signal Made | | + | |ALARM |1 |Signal Made | |
| - | |FAULT |2 |Signal Made when disconnected | | + | |FAULT |2 |Signal Made when disconnected | |
| - | </WRAP> | + | </WRAP> |
| - | 12. //reserved// \\ | + | 12. //reserved// \\ |
| - | Reserved Space. \\ \\ | + | Reserved Space. \\ \\ |
| - | 13. //reserved2// \\ | + | 13. //reserved2// \\ |
| - | Reserved Space. \\ \\ | + | Reserved Space. \\ \\ |