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 [2023/02/28 14:43] mwkim [Configuration API] |
en:configuration_api [2023/03/02 15:21] kkshin [BS2BarcodeConfig] |
||
---|---|---|---|
Line 83: | Line 83: | ||
* [[BS2_SetRelayActionConfig]]: [+ 2.8.1] ''IM-120'' Retrieves Configuration related to the RelayAction. | * [[BS2_SetRelayActionConfig]]: [+ 2.8.1] ''IM-120'' Retrieves Configuration related to the RelayAction. | ||
* [[BS2_GetLicenseConfig]]: [+ 2.9.1] Gets the device license activation information. | * [[BS2_GetLicenseConfig]]: [+ 2.9.1] Gets the device license activation information. | ||
- | * [[BS2_GetOsdpStandardConfig]]: [+ 2.9.1] 장치의 OSDP 설정 정보를 가져옵니다. | + | * [[BS2_GetOsdpStandardConfig]]: [+ 2.9.1] Get the device's OSDP setting information. |
- | * [[BS2_GetOsdpStandardActionConfig]]: [+ 2.9.1] OSDP 장치의 action별 LED/buzzer 설정을 가져옵니다. | + | * [[BS2_GetOsdpStandardActionConfig]]: [+ 2.9.1] Get the LED/buzzer settings for each action of the OSDP device. |
- | * [[BS2_SetOsdpStandardActionConfig]]: [+ 2.9.1] OSDP 장치의 action별 LED/buzzer 설정을 지정합니다. | + | * [[BS2_SetOsdpStandardActionConfig]]: [+ 2.9.1] Specifies the LED/buzzer setting for each action of the OSDP device. |
\\ | \\ | ||
===== Structure ===== | ===== Structure ===== | ||
Line 2448: | Line 2448: | ||
uint8_t treatAsCSN; | uint8_t treatAsCSN; | ||
- | uint8_t reserved[12]; | + | uint8_t useVisualBarcode; |
+ | uint8_t motionSensitivity; | ||
+ | uint8_t visualCameraScanTimeout; | ||
+ | uint8_t reserved[9]; | ||
} BS2BarcodeConfig; | } BS2BarcodeConfig; | ||
</code> | </code> | ||
1. //useBarcode// \\ | 1. //useBarcode// \\ | ||
+ | ''Supports XS2-QR models only'' | ||
Barcode usage flag. \\ \\ | Barcode usage flag. \\ \\ | ||
2. //scanTimeout// \\ | 2. //scanTimeout// \\ | ||
Set the Barcode scan time. The unit is in seconds. \\ | Set the Barcode scan time. The unit is in seconds. \\ | ||
- | The default is 4 seconds, and can be entered within a range of 4 to 10 seconds.\\ \\ | + | The default is 4 seconds, and can be entered within a range of 4 to 10 seconds. \\ \\ |
+ | <WRAP group 50%> | ||
+ | ^Value ^Macro ^Description ^ | ||
+ | |4 |BS2_BARCODE_TIMEOUT_DEFAULT |Default | | ||
+ | |4 |BS2_BARCODE_TIMEOUT_MIN |Min Value | | ||
+ | |10 |BS2_BARCODE_TIMEOUT_MAX |Max Value | | ||
+ | </WRAP> | ||
3. //bypassData// \\ | 3. //bypassData// \\ | ||
[+2.8.2] Used to send read barcode information to the server, not processed by the device. \\ | [+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, \\ | 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]]), \\ | + | 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. \\ \\ | Call the [[BS2_SetBarcodeScanListener]], use this option to send barcodes up to 512 bytes of size to the server. \\ \\ | ||
4. //treatAsCSN// \\ | 4. //treatAsCSN// \\ | ||
[+2.8.2] Indicates whether the Barcode should be treated the same as a regular CSN card. \\ | [+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. \\ | 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]]) \\ | + | 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. \\ | 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. \\ | 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. \\ | + | 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. //useVisualBarcode// \\ | |
- | 5. //reserved// \\ | + | [+2.9.1] Visual barcode usage flag. \\ |
- | Reserved space. \\ | + | <WRAP group 50%> |
+ | ^Supported devices ^Firmware ^ | ||
+ | |XS2-Finger |V1.2.0 | | ||
+ | |XS2-Card |V1.2.0 | | ||
+ | |BS3 |V1.1.0 | | ||
+ | </WRAP> | ||
+ | Visual barcode scans QR code with a general visual camera instead of a QR code sensor, \\ | ||
+ | and a separate license activation is required to use this feature. \\ | ||
+ | License activation is supported through [[qr_code_api#BS2_EnableBarcodeLicense]]. \\ \\ | ||
+ | 6. //motionSensitivity// \\ | ||
+ | [+2.9.1] Set the sensitivity of motion sensor for visual barcode. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^Value ^Macro ^Description ^ | ||
+ | |0 |BS2_MOTION_SENSITIVITY_LOW |Low | | ||
+ | |1 |BS2_MOTION_SENSITIVITY_NORMAL |Normal | | ||
+ | |2 |BS2_MOTION_SENSITIVITY_HIGH |High | | ||
+ | </WRAP> | ||
+ | 7. //visualCameraScanTimeout// \\ | ||
+ | [+2.9.1] Set the scan time for the visual camera. Units are seconds. \\ | ||
+ | The default is 10 seconds, and can be entered within a range of 3 to 20 seconds. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^Value ^Macro ^Description ^ | ||
+ | |10 |BS2_VISUAL_BARCODE_TIMEOUT_DEFAULT |Default | | ||
+ | |3 |BS2_VISUAL_BARCODE_TIMEOUT_MIN |Min Value | | ||
+ | |20 |BS2_VISUAL_BARCODE_TIMEOUT_MAX |Max Value | | ||
+ | </WRAP> | ||
+ | 8. //reserved// \\ | ||
+ | Reserved Space. \\ \\ | ||
==== BS2InputConfigEx ==== | ==== BS2InputConfigEx ==== |