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/08/17 13:03] 127.0.0.1 external edit |
en:configuration_api [2024/05/28 19:34] kkshin [BS2FaceConfigExt] |
||
---|---|---|---|
Line 70: | Line 70: | ||
* [[BS2_GetDesFireCardConfigEx]]: [+ 2.6.4] Retrieves DesFire advanced configuration from the device. | * [[BS2_GetDesFireCardConfigEx]]: [+ 2.6.4] Retrieves DesFire advanced configuration from the device. | ||
* [[BS2_SetDesFireCardConfigEx]]: [+ 2.6.4] Sets DesFire advanced configuration in the device. | * [[BS2_SetDesFireCardConfigEx]]: [+ 2.6.4] Sets DesFire advanced configuration in the device. | ||
- | * [[BS2_GetAuthConfigExt]]: [+ 2.7.1] ''FaceStation F2'' Retrieves authentication settings from the device. | + | * [[BS2_GetAuthConfigExt]]: [+ 2.7.1] ''Visual Face-based devices'' Retrieves authentication settings from the device. |
- | * [[BS2_SetAuthConfigExt]]: [+ 2.7.1] ''FaceStation F2'' Stores authentication settings from the device. | + | * [[BS2_SetAuthConfigExt]]: [+ 2.7.1] ''Visual Face-based devices'' Stores authentication settings from the device. |
- | * [[BS2_GetFaceConfigExt]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' 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] ''FaceStation F2, FaceStation2'' 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 82: | Line 82: | ||
* [[BS2_GetRelayActionConfig]]: [+ 2.8.1] ''IM-120'' Retrieves Configuration related to the RelayAction. | * [[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. | * [[BS2_SetRelayActionConfig]]: [+ 2.8.1] ''IM-120'' Retrieves Configuration related to the RelayAction. | ||
+ | * [[BS2_GetVoipConfigExt]]: [+ 2.8.3] Gets the extended VoIP settings. | ||
+ | * [[BS2_SetVoipConfigExt]]: [+ 2.8.3] Save the extended VoIP settings. | ||
+ | * [[BS2_GetRtspConfig]]: [+ 2.8.3] Gets 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 166: | Line 170: | ||
Represents standard time zone in seconds. \\ \\ | Represents standard time zone in seconds. \\ \\ | ||
**3. //syncTime//** \\ | **3. //syncTime//** \\ | ||
- | Stores when synchronization with BioStar has occurred. \\ \\ | + | This is a FLAG that determines time synchronization with the BioStar Server. \\ \\ |
**4. //serverSync//** \\ | **4. //serverSync//** \\ | ||
Reserved variable. \\ \\ | Reserved variable. \\ \\ | ||
Line 202: | Line 206: | ||
Also, the required card type MASK should be combined with ''CARD_OPERATION_USE''. \\ | Also, the required card type MASK should be combined with ''CARD_OPERATION_USE''. \\ | ||
For example, useCardOperationMask needs to be configured ''x0x80000001'' when EM card is selected only. | For example, useCardOperationMask needs to be configured ''x0x80000001'' when EM card is selected only. | ||
- | <WRAP group 50%> | + | <WRAP group 60%> |
^Value ^Description ^ | ^Value ^Description ^ | ||
|0xFFFFFFFF |CARD_OPERATION_MASK_DEFAULT | | |0xFFFFFFFF |CARD_OPERATION_MASK_DEFAULT | | ||
|0x80000000 |CARD_OPERATION_USE | | |0x80000000 |CARD_OPERATION_USE | | ||
+ | |0x00000000 |CARD_OPERATION_MASK_NONE | | ||
+ | |0x00000800 |CARD_OPERATION_MASK_CUSTOM_DESFIRE_EV1 | | ||
+ | |0x00000400 |CARD_OPERATION_MASK_CUSTOM_CLASSIC_PLUS | | ||
|0x00000200 |CARD_OPERATION_MASK_BLE | | |0x00000200 |CARD_OPERATION_MASK_BLE | | ||
|0x00000100 |CARD_OPERATION_MASK_NFC | | |0x00000100 |CARD_OPERATION_MASK_NFC | | ||
Line 387: | Line 394: | ||
uint8_t tnaIcon[16]; | uint8_t tnaIcon[16]; | ||
uint8_t useScreenSaver; | uint8_t useScreenSaver; | ||
- | uint8_t reserved1[31]; | + | uint8_t showOsdpResult; |
+ | uint8_t reserved1[30]; | ||
} BS2DisplayConfig; | } BS2DisplayConfig; | ||
</code> | </code> | ||
Line 492: | 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. //reserved1//** \\ | + | **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. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^Value ^Description ^ | ||
+ | |0 |Display OSDP Authentication Result (Default) | | ||
+ | |1 |Do Not Display OSDP Authentication Result | | ||
+ | </WRAP> | ||
+ | 19. //reserved1// \\ | ||
Reserved space. \\ | Reserved space. \\ | ||
Line 1229: | Line 1244: | ||
uint32_t deviceID; | uint32_t deviceID; | ||
uint8_t type; | uint8_t type; | ||
- | uint8_t reserved[3]; | + | uint8_t reserved; |
+ | uint16_t ignoreSignalTime; | ||
| | ||
union { | union { | ||
Line 1275: | Line 1291: | ||
|3|Schedule trigger| | |3|Schedule trigger| | ||
</WRAP> | </WRAP> | ||
+ | 11. //reserved// \\ | ||
+ | Reserved space. \\ \\ | ||
+ | 12. //ignoreSignalTime// \\ | ||
+ | [+2.9.6] This setting is specified in milliseconds and is used to ignore repetitive input signals within a certain time frame. \\ | ||
+ | In environments where Suprema devices are connected to third-party controllers via Wiegand, \\ | ||
+ | if the feedback for authentication is repetitively input to the Suprema device from a specific model of the controller, \\ | ||
+ | this feature allows you to forcibly ignore the input signal for the specified duration. \\ \\ | ||
==== BS2Action ==== | ==== BS2Action ==== | ||
Line 1679: | Line 1702: | ||
Reserved space.\\ \\ | Reserved space.\\ \\ | ||
- | ==== BS2FaceConfig==== | + | ==== BS2FaceConfig ==== |
<code cpp> | <code cpp> | ||
typedef struct { | typedef struct { | ||
Line 1696: | Line 1719: | ||
uint8_t maxRotation; | uint8_t maxRotation; | ||
+ | // Deprecated | ||
struct { | struct { | ||
uint16_t min; | uint16_t min; | ||
Line 1701: | Line 1725: | ||
} faceWidth; | } faceWidth; | ||
+ | // Deprecated | ||
struct { | struct { | ||
uint16_t x; | uint16_t x; | ||
Line 1706: | Line 1731: | ||
} searchRange; | } searchRange; | ||
- | uint8_t reserved2[18]; | + | struct { |
+ | uint8_t min; // 30 ~ 100 | ||
+ | uint8_t max; // 40 ~ 100, 255 | ||
+ | } detectDistance; ////< 2 bytes | ||
+ | |||
+ | BS2_BOOL wideSearch; ///< 1 byte | ||
+ | uint8_t unused; | ||
+ | |||
+ | uint8_t unableToSaveImageOfVisualFace; | ||
+ | uint8_t reserved[13]; | ||
} BS2FaceConfig; | } BS2FaceConfig; | ||
</code> | </code> | ||
Line 1724: | 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 1757: | 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 1764: | 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 1775: | 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 1802: | Line 1836: | ||
**10. //operationMode//** \\ | **10. //operationMode//** \\ | ||
- | [+ 2.7.1] ''FaceStation F2'' Configures operation mode with below values, default is Fusion mode. \\ | + | [+ 2.7.1] ''FaceStation F2 V1.0.0'' can be set to the following operation modes, default is Fusion mode. \\ |
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Mode ^Description ^Default ^ | ^Value ^Mode ^Description ^Default ^ | ||
Line 1809: | Line 1843: | ||
|2 |Visual + IR |Visual matching, IR detects only face| | | |2 |Visual + IR |Visual matching, IR detects only face| | | ||
</WRAP> | </WRAP> | ||
+ | |||
+ | ''FaceStation F2 V1.0.1'' or later versions, ''Visual Face based'' are used in the following sense. | ||
+ | <WRAP group 50%> | ||
+ | |0 |Fusion Mode |Visual matching + IR matching |Default | | ||
+ | |1 |Fast Mode |Visual matching | | | ||
+ | </WRAP> | ||
**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. \\ \\ | ||
+ | [+ 2.9.6] Additional definitions of Angle \\ | ||
+ | <WRAP group 40%> | ||
+ | ^Definition ^Value ^ | ||
+ | |BS2_MAX_ROTATION_DEFAULT | 15 | | ||
+ | |BS2_MAX_ROTATION_ANGLE_15 | 15 | | ||
+ | |BS2_MAX_ROTATION_ANGLE_30 | 30 | | ||
+ | |BS2_MAX_ROTATION_ANGLE_45 | 45 | | ||
+ | |BS2_MAX_ROTATION_ANGLE_60 | 60 | | ||
+ | |BS2_MAX_ROTATION_ANGLE_75 | 75 | | ||
+ | |BS2_MAX_ROTATION_ANGLE_90 | 90 | | ||
+ | |BS2_MAX_ROTATION_ANGLE_MAX | 90 | | ||
+ | </WRAP> | ||
**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. \\ | ||
- | [+ 2.8.3] ''BioStation 3'' The settings are ignored. \\ | ||
<WRAP group 30%> | <WRAP group 30%> | ||
^ ^Default(min) ^Default(max) ^ | ^ ^Default(min) ^Default(max) ^ | ||
|FSF2 |66 |250 | | |FSF2 |66 |250 | | ||
- | |BS3 |- |- | | + | |BS3 |130 |350 | |
+ | |BEW3 |130 |350 | | ||
</WRAP> | </WRAP> | ||
**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. \\ | ||
- | [+ 2.8.3] ''BioStation 3'' The settings are ignored. \\ | ||
<WRAP group 30%> | <WRAP group 30%> | ||
^ ^Default(x) ^Default(width) ^ | ^ ^Default(x) ^Default(width) ^ | ||
|FSF2 |144 |432 | | |FSF2 |144 |432 | | ||
- | |BS3 |- |- | | + | |BS3 |90 |540 | |
+ | |BEW3 |90 |540 | | ||
</WRAP> | </WRAP> | ||
**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. \\ |
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. \\ | ||
<WRAP group 80%> | <WRAP group 80%> | ||
- | ^ ^Min limit for min detection range ^Max limit for min detection range ^Min detection range(Default) ^Min limit for max detection range ^Max limit for max detection range ^Max sensing range(No limit) ^Max sensing range(Default) ^ | + | ^ ^Min limit for min detection range ^Max limit for min detection range ^Min detection range(Default) ^Min limit for max detection range ^Max limit for max detection range ^Max sensing range(No limit) ^Max sensing range(Default) ^ |
- | |BS3 |30 |100 |60 |40 |100 |255 |100 | | + | |FSF2 |30 |130 |30 |40 |130 |255 |130 | |
+ | |BS3 |30 |100 |30 |40 |100 |255 |100 | | ||
+ | |BEW3 |30 |100 |30 |40 |100 |255 |100 | | ||
</WRAP> | </WRAP> | ||
**15. //wideSearch//** \\ | **15. //wideSearch//** \\ | ||
- | [+ 2.8.3] ''BioStation 3'' This can increase the detection range for facial recognition. \\ | + | [+ 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). \\ | ||
The details of the settings and protocols for the detection of wide area is set within the device, which the user cannot change. \\ \\ | The details of the settings and protocols for the detection of wide area is set within the device, which the user cannot change. \\ \\ | ||
- | If this setting is set to TRUE, the camera detects subjects within a large range, and unintentionally detect and authenticate multiple subjects at once. Therefore, the default setting is at FALSE. \\ \\ | + | If this setting is set to TRUE, the camera detects subjects within a large range, and unintentionally detect and authenticate multiple subjects at once. \\ |
+ | Therefore, the default setting is at FALSE. \\ \\ | ||
16. //unused// \\ | 16. //unused// \\ | ||
Reserved space.\\ \\ | Reserved space.\\ \\ | ||
- | 17. //reserved// \\ | + | 17. //unableToSaveImageOfVisualFace// \\ |
+ | [+ 2.9.6] Indicates whether devices that use visual face as a credential will store facial images on the device. \\ | ||
+ | Enabling this setting will immediately delete image information from all users' facial data stored in the device, leaving only the templates. \\ | ||
+ | Additionally, even if face information containing user images is obtained through the [[BS2_EnrollUserFaceEx]] API, the device will ignore it. \\ | ||
+ | The default value is false, which means both facial data and images are stored. \\ \\ | ||
+ | 18. //reserved// \\ | ||
Reserved space.\\ \\ | Reserved space.\\ \\ | ||
==== BS2Rs485ConfigEX ==== | ==== BS2Rs485ConfigEX ==== | ||
Line 2341: | 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 2366: | 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 2379: | 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 ^ |