Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
en:configuration_api [2023/08/17 13:03]
127.0.0.1 external edit 		en:configuration_api [2024/04/04 14:05] (current)
ghshin [BS2FaceConfig]
Line 166: Line 166:
 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 202:
 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 390:
     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 493: Line 497:
 **17. //​useScreenSaver//​** \\  **17. //​useScreenSaver//​** \\ 
 ''​FaceStation 2'',​ ''​FaceStation F2''​ If set true, you can activate the screensaver. \\ \\ ''​FaceStation 2'',​ ''​FaceStation F2''​ 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 1240:
     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 1287:
 |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 1698:
 Reserved space.\\ \\ Reserved space.\\ \\
  
-==== BS2FaceConfig====+==== BS2FaceConfig ====
 <code cpp> <code cpp>
 typedef struct { typedef struct {
Line 1696: Line 1715:
     uint8_t ​      ​maxRotation;​     uint8_t ​      ​maxRotation;​
  
 +    // Deprecated
     struct {     struct {
         uint16_t ​ min;         uint16_t ​ min;
Line 1701: Line 1721:
     } faceWidth;     } faceWidth;
  
 +    // Deprecated
     struct {     struct {
         uint16_t ​ x;         uint16_t ​ x;
Line 1706: Line 1727:
     } 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 1802: Line 1832:
  
 **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 1839:
 |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, ''​BioStatoin 3'',​ ''​BioEntry W3''​ 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//​** \\ 
Line 1815: Line 1851:
 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] ''​FaceStation F2''​ 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] ''​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 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] ''​BioStation 3''​ 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. \\
 <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''​ 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 ====