Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:configuration_api [2024/05/28 19:28] kkshin [BS2FaceConfig] |
en:configuration_api [2024/05/28 19:37] (current) kkshin |
||
|---|---|---|---|
| Line 2401: | Line 2401: | ||
| </WRAP> | </WRAP> | ||
| 2. //maskCheckMode// \\ | 2. //maskCheckMode// \\ | ||
| - | ''FaceStation F2'' Sets the Mask Check Mode. \\ | + | ''Visual Face based'' Sets the Mask Check Mode. \\ |
| - | ''FaceStation 2'' This setting is ignored. \\ | + | |
| When set to HARD, access is denied if not detecting any mask on the face based on maskDetectionLevel. \\ | When set to HARD, access is denied if not detecting any mask on the face based on maskDetectionLevel. \\ | ||
| When set to SOFT, access is not affected even if not detecting any mask on the face based on maskDetectionLevel but leaves a related log. \\ | When set to SOFT, access is not affected even if not detecting any mask on the face based on maskDetectionLevel but leaves a related log. \\ | ||
| Line 2426: | Line 2425: | ||
| Reserved \\ \\ | Reserved \\ \\ | ||
| 6. //thermalThresholdLow// \\ | 6. //thermalThresholdLow// \\ | ||
| - | ''Supported version'' : ''FaceStation F2 V1.0.2'', ''FaceStation 2 V1.5.0'' \\ | ||
| This is the range value for determining high temperature and must be entered as a value multiplied by 100 of the temperature to be set. \\ | This is the range value for determining high temperature and must be entered as a value multiplied by 100 of the temperature to be set. \\ | ||
| Also, you can only enter in degrees Celsius. \\ | Also, you can only enter in degrees Celsius. \\ | ||
| Line 2439: | Line 2437: | ||
| And you must set a value greater than thermalThresholdLow. \\ \\ | And you must set a value greater than thermalThresholdLow. \\ \\ | ||
| 8. //maskDetectionLevel// \\ | 8. //maskDetectionLevel// \\ | ||
| - | ''FaceStation F2'' Sets the mask detection level. The detecting level is based on internal setting value. \\ | + | ''Visual Face based'' Sets the mask detection level. The detecting level is based on internal setting value. \\ |
| - | ''FaceStation 2'' This setting is ignored. \\ | + | |
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^Value ^Description ^Default ^ | ^Value ^Description ^Default ^ | ||
| Line 2888: | Line 2885: | ||
| License information and can be set up to 16. \\ \\ | License information and can be set up to 16. \\ \\ | ||
| 5. //reserved1// \\ | 5. //reserved1// \\ | ||
| - | Reserved Space. \\ \\ | ||
| - | |||
| - | |||
| - | ==== BS2BarcodeConfig ==== | ||
| - | <code cpp> | ||
| - | typedef struct { | ||
| - | uint8_t useBarcode; | ||
| - | uint8_t scanTimeout; | ||
| - | uint8_t bypassData; | ||
| - | uint8_t treatAsCSN; | ||
| - | |||
| - | uint8_t useVisualBarcode; | ||
| - | uint8_t motionSensitivity; | ||
| - | uint8_t visualCameraScanTimeout; | ||
| - | uint8_t reserved[9]; | ||
| - | } BS2BarcodeConfig; | ||
| - | </code> | ||
| - | 1. //useBarcode// \\ | ||
| - | ''Supports XS2-QR models only'' | ||
| - | Barcode usage flag. \\ \\ | ||
| - | 2. //scanTimeout// \\ | ||
| - | 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. \\ \\ | ||
| - | <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// \\ | ||
| - | [+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. //useVisualBarcode// \\ | ||
| - | [+2.9.1] Visual barcode usage flag. \\ | ||
| - | <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 [[BS2_EnableDeviceLicense]]. \\ \\ | ||
| - | 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. \\ \\ | Reserved Space. \\ \\ | ||