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 [2024/05/28 19:00] kkshin |
en:configuration_api [2024/05/28 19:37] kkshin |
||
---|---|---|---|
Line 74: | Line 74: | ||
* [[BS2_GetFaceConfigExt]]: [+ 2.7.1] Retrieves configuration of thermal camera and mask detection. | * [[BS2_GetFaceConfigExt]]: [+ 2.7.1] Retrieves configuration of thermal camera and mask detection. | ||
* [[BS2_SetFaceConfigExt]]: [+ 2.7.1] Stores configuration of thermal camera and mask detection. | * [[BS2_SetFaceConfigExt]]: [+ 2.7.1] Stores configuration of thermal camera and mask detection. | ||
- | * [[BS2_GetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera. | + | * [[BS2_GetThermalCameraConfig]]: [+ 2.7.1] Retrieves configuration of thermal camera. |
- | * [[BS2_SetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera. | + | * [[BS2_SetThermalCameraConfig]]: [+ 2.7.1] Stores configuration of thermal camera. |
* [[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. | ||
Line 84: | Line 84: | ||
* [[BS2_GetVoipConfigExt]]: [+ 2.8.3] Gets the extended VoIP settings. | * [[BS2_GetVoipConfigExt]]: [+ 2.8.3] Gets the extended VoIP settings. | ||
* [[BS2_SetVoipConfigExt]]: [+ 2.8.3] Save the extended VoIP settings. | * [[BS2_SetVoipConfigExt]]: [+ 2.8.3] Save the extended VoIP settings. | ||
- | * [[BS2_GetRtspConfig]]: [+ 2.8.3] ''BS3'' Gets the RTSP settings. | + | * [[BS2_GetRtspConfig]]: [+ 2.8.3] Gets the RTSP settings. |
- | * [[BS2_SetRtspConfig]]: [+ 2.8.3] ''BS3'' Save the RTSP settings. | + | * [[BS2_SetRtspConfig]]: [+ 2.8.3] Save the RTSP settings. |
* [[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] Get the device's OSDP setting information. | * [[BS2_GetOsdpStandardConfig]]: [+ 2.9.1] Get the device's OSDP setting information. | ||
Line 500: | Line 500: | ||
Icon displayed on the device corresponding TNA key. \\ \\ | Icon displayed on the device corresponding TNA key. \\ \\ | ||
**17. //useScreenSaver//** \\ | **17. //useScreenSaver//** \\ | ||
- | ''FaceStation 2'', ''FaceStation F2'' If set true, you can activate the screensaver. \\ \\ | + | If set true, you can activate the screensaver. \\ \\ |
**18. //showOsdpResult//** \\ | **18. //showOsdpResult//** \\ | ||
[+ 2.9.6] In environments where Suprema devices are connected as peripheral devices to Intelligent Slaves or third-party controllers, this option allows authentication results to be displayed on the device screen. \\ | [+ 2.9.6] In environments where Suprema devices are connected as peripheral devices to Intelligent Slaves or third-party controllers, this option allows authentication results to be displayed on the device screen. \\ | ||
Line 1758: | Line 1758: | ||
|1 |Outdoor | | |1 |Outdoor | | ||
|2 |Automatic | | |2 |Automatic | | ||
- | |3 |[+ 2.8] Not used ''(FaceStation F2 v1.1.0 or higher version)'' | | + | |3 |[+ 2.8] Not used | |
</WRAP> | </WRAP> | ||
[Note]\\ | [Note]\\ | ||
Line 1791: | Line 1791: | ||
</WRAP> | </WRAP> | ||
**5. //enrollTimeout//** \\ | **5. //enrollTimeout//** \\ | ||
- | ''FaceStation2, FaceLite'' : Timeout period of face scanning which is 60 seconds by default.\\ \\ | + | ''IR Face supported'' : Timeout period of face scanning which is 60 seconds by default.\\ \\ |
<WRAP group 60%> | <WRAP group 60%> | ||
^Value ^Description ^ | ^Value ^Description ^ | ||
Line 1798: | Line 1798: | ||
|BS2_FACE_ENROLL_TIMEOUT_DEFAULT |BS2_FACE_ENROLL_TIMEOUT_MAX | | |BS2_FACE_ENROLL_TIMEOUT_DEFAULT |BS2_FACE_ENROLL_TIMEOUT_MAX | | ||
</WRAP> | </WRAP> | ||
- | ''FaceStation F2'' : [+ 2.7.1] Face scan wait time, default is 20 seconds. \\ | + | ''Visual Face supported'' : [+ 2.7.1] Face scan wait time, default is 20 seconds. \\ |
<WRAP group 70%> | <WRAP group 70%> | ||
^Value ^Description ^ | ^Value ^Description ^ | ||
Line 1809: | Line 1809: | ||
**6. //lfdLevel//** \\ | **6. //lfdLevel//** \\ | ||
[+ 2.6.3] Configuration for the LFD(Live Face Detection - fake face detection) sensitivity. \\ | [+ 2.6.3] Configuration for the LFD(Live Face Detection - fake face detection) sensitivity. \\ | ||
- | ''FaceStation2, FaceLite'' : Default is 0. \\ | + | ''IR Face supported'' : Default is 0. \\ |
- | ''FaceStation F2'' : [+ 2.7.1] Default is 1. \\ | + | ''Visual Face supported'' : [+ 2.7.1] Default is 1. \\ |
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Description ^ | ^Value ^Description ^ | ||
Line 1844: | Line 1844: | ||
</WRAP> | </WRAP> | ||
- | ''FaceStation F2 V1.0.1'' or later versions, ''BioStatoin 3'', ''BioEntry W3'' are used in the following sense. | + | ''FaceStation F2 V1.0.1'' or later versions, ''Visual Face based'' are used in the following sense. |
<WRAP group 50%> | <WRAP group 50%> | ||
|0 |Fusion Mode |Visual matching + IR matching |Default | | |0 |Fusion Mode |Visual matching + IR matching |Default | | ||
Line 1851: | Line 1851: | ||
**11. //maxRotation//** \\ | **11. //maxRotation//** \\ | ||
- | [+ 2.7.1] ''FaceStation F2'' When face is recognized normally it's front side. \\ | + | [+ 2.7.1] ''Visual Face based'' When face is recognized normally it's front side. \\ |
- | Still, it is possible to determine how many degrees the image has been rotated from the front when FSF2 detects a face. \\ | + | Still, it is possible to determine how many degrees the image has been rotated from the front when device detects a face. \\ |
This enables detection failure in the case of images rotated over a certain angle. \\ | This enables detection failure in the case of images rotated over a certain angle. \\ | ||
maxRotation represents the maximum allowable value in this case, and the default value is 15 degrees. \\ \\ | maxRotation represents the maximum allowable value in this case, and the default value is 15 degrees. \\ \\ | ||
Line 1869: | Line 1869: | ||
**12. //faceWidth//** \\ | **12. //faceWidth//** \\ | ||
- | [+ 2.7.1] ''FaceStation F2'' This indicates the width of the face image, and you can specify the minimum and maximum values. \\ | + | [+ 2.7.1] ''Visual Face based'' This indicates the width of the face image, and you can specify the minimum and maximum values. \\ |
The default values of min and max are as follows. \\ | The default values of min and max are as follows. \\ | ||
<WRAP group 30%> | <WRAP group 30%> | ||
Line 1879: | Line 1879: | ||
**13. //searchRange//** \\ | **13. //searchRange//** \\ | ||
- | [+ 2.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. \\ | + | [+ 2.7.1] ''Visual Face based'' 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 of x and width are as follows. \\ | The default values of x and width are as follows. \\ | ||
<WRAP group 30%> | <WRAP group 30%> | ||
Line 1889: | Line 1889: | ||
**14. //detectDistance//** \\ | **14. //detectDistance//** \\ | ||
- | [+ 2.8.3] ''BioStation 3'' This configures the minimum and maximum detection range for facial recognition. \\ | + | [+ 2.8.3] ''Visual Face based'' This configures the minimum and maximum detection range for facial recognition. \\ |
- | [+ 2.9.6] Added features to ''FaceStation F2'' and ''BioEntry W3'' \\ | + | |
We no longer support faceWidth to pinpoint the face location using pixel units due to its complexity. \\ | We no longer support faceWidth to pinpoint the face location using pixel units due to its complexity. \\ | ||
Instead, we set the detection range of the subject(face). The unit is set to cm, and the value must be inputted as a multiple of 10. \\ | Instead, we set the detection range of the subject(face). The unit is set to cm, and the value must be inputted as a multiple of 10. \\ | ||
Line 1901: | Line 1900: | ||
**15. //wideSearch//** \\ | **15. //wideSearch//** \\ | ||
- | [+ 2.8.3] ''BioStation 3'' This can increase the detection range for face detection. \\ | + | [+ 2.8.3] ''BioStation 3, BioEntry W3'' This can increase the detection range for face detection. \\ |
We no longer support searchRange to set the x-coordinate and width due to its complexity. \\ | We no longer support searchRange to set the x-coordinate and width due to its complexity. \\ | ||
Instead, we set the face detection setting as default(FALSE), or a wide area(TRUE). \\ | Instead, we set the face detection setting as default(FALSE), or a wide area(TRUE). \\ | ||
Line 2402: | 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 2427: | 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 2440: | 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 2889: | 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. \\ \\ | ||