Differences

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

--- en:configuration_api [2019/07/22 17:39]
kkshin
+++ en:configuration_api [2020/08/28 12:38]
yjjung [Configuration API]
@@ Line 59: / Line 59: @@
   * [[BS2_GetDstConfig]]: Retrieves the device DST information.
   * [[BS2_SetDstConfig]]: Stores the device DST information.
+  * [[BS2_GetSupportedConfigMask]]: Retrieves supported configuration of the device.
   * [[BS2_GetIPConfigViaUDPEx]]: [+ 2.6.3] Retrieves IP configuration through UDP broadcast with host IP.
   * [[BS2_SetIPConfigViaUDPEx]]: [+ 2.6.3] Stores IP configuration through UDP broadcast with host IP.
@@ Line 67: / Line 68: @@
   * [[BS2_GetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Retrieves IPv6 configuration through UDP broadcast with host IP.
   * [[BS2_SetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Stores IPv6 configuration through UDP broadcast with host IP.
+  * [[BS2_GetDesFireCardConfigEx]]: [+ V2.6.4] Retrieves DesFire advanced configuration from the device.
+  * [[BS2_SetDesFireCardConfigEx]]: [+ V2.6.4] Sets DesFire advanced configuration in the device.
+  * [[BS2_GetAuthConfigExt]]: ''FaceStation F2'' Retrieves authentication settings from the device. [+ V2.7.1]
+  * [[BS2_SetAuthConfigExt]]: ''FaceStation F2'' Stores authentication settings from the device. [+ V2.7.1]
+  * [[BS2_GetFaceConfigExt]]: ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera and mask detection. [+ V2.7.1]
+  * [[BS2_SetFaceConfigExt]]: ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera and mask detection. [+ V2.7.1]
+  * [[BS2_GetThermalCameraConfig]]: ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera. [+ V2.7.1]
+  * [[BS2_SetThermalCameraConfig]]: ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera. [+ V2.7.1]
 \\
 ===== Structure =====
@@ Line 120: / Line 130: @@
 ==== BS2SystemConfig ====
-[[BS2_SetSystemConfig]] must be called after calling [[BS2_GetSystemConfig]] and completing necessary settings except for tamperOn.  \\
 <code cpp>
 typedef struct {
@@ Line 136: / Line 145: @@
     bool secureTamper;
     bool reserved0;     // (write protected)
-    bool gdprSupport;
+    uint8_t reserved[2];
-    uint8_t reserved[1];
+    uint32_t useCardOperationMask;
-    uint8_t reserved2[20];
+    uint8_t reserved2[16];
 } BS2SystemConfig;
 </code>
@@ Line 150: / Line 159: @@
 Reserved variable. \\ \\
 **5. //deviceLocked//** \\
-Decides whether to show lock screen in stand-by mode. \\ \\
+Indicates the current locked state of the device. (Read only filed) \\ \\
 **6. //useInterphone//** \\
 Decides whether to use intercom. \\ \\
@@ Line 172: / Line 181: @@
 Flag to determine whether to use a security tamper. \\
 When Tamper on, the following data is deleted from the device. (User, log, data encryption key, SSL certificate) \\ \\
-**13. //tamperOn//** \\
+**13. //reserved0//** \\
-The information to manage the tampering internally, which should not be set. \\
-Be sure to call [[BS2_SetSystemConfig]] after completing the necessary settings except for tamperOn after [[BS2_GetSystemConfig]]. \\ \\
-**14. //reserved1//** \\
 Reserved space. \\ \\
-**15. //reserved2//** \\
+**14. //reserved//** \\
+Reserved space. \\ \\
+**15. //useCardOperationMask//** \\
+[+ V2.6.4] Provides a card selective option not to read all kinds of cards from the device. \\
+You can select multiple cards using MASK. The user can select or deselect of a specific card reading option using this option. \\
+However, it can be applied to the card types the device supporting. If you add a card type which isn't supported from the device would be ignored. \\
+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.
+<WRAP group 50%>
+^Value  ^Description ^
+|0xFFFFFFFF  |CARD_OPERATION_MASK_DEFAULT  |
+|0x80000000  |CARD_OPERATION_USE  |
+|0x00000200  |CARD_OPERATION_MASK_BLE  |
+|0x00000100  |CARD_OPERATION_MASK_NFC  |
+|0x00000080  |CARD_OPERATION_MASK_SEOS  |
+|0x00000040  |CARD_OPERATION_MASK_SR_SE  |
+|0x00000020  |CARD_OPERATION_MASK_DESFIRE_EV1  |
+|0x00000010  |CARD_OPERATION_MASK_CLASSIC_PLUS  |
+|0x00000008  |CARD_OPERATION_MASK_ICLASS  |
+|0x00000004  |CARD_OPERATION_MASK_MIFARE_FELICA  |
+|0x00000002  |CARD_OPERATION_MASK_HIDPROX  |
+|0x00000001  |CARD_OPERATION_MASK_EM  |
+</WRAP>
+**16. //reserved2//** \\
 Reserved space. \\ \\
@@ Line 241: / Line 270: @@
 **7. //faceDetectionLevel//** \\
 Level of face detection in user authentication. If the detected face level is lower than the configuration, it will be processed as authentication fail.\\
+When set, the camera view according to Normal/Strict is displayed, access is denied if the device doesn't recognize facial image through image log. Default is 0.
 <WRAP group 50%>
 ^Value  ^Description  ^
@@ Line 248: / Line 278: @@
 </WRAP>
 <WRAP info>
-Only valid for devices with a camera.
+Only valid for A2. Not used with FaceStation2 or FaceLite.
 </WRAP>
 **8. //useServerMatching//** \\
@@ Line 341: / Line 371: @@
     uint8_t timeFormat;
     uint8_t homeFormation;
-    uint8_t useUserPhrase;
+    BS2_BOOL useUserPhrase;
-    uint8_t reserved[1];
+    BS2_BOOL queryUserPhrase;
     uint8_t shortcutHome[BS2_MAX_SHORTCUT_HOME];
     uint8_t tnaIcon[16];
@@ Line 414: / Line 444: @@
 **13. //useUserPhrase//** \\
 Flag that determines whether to use the user phrase feature. \\ \\
-**14. //shortcutHome//** \\
+**13. //queryUserPhrase//** \\
-Home screen layout(Currently, not used). \\ \\
+If set true, asks for the user phrase to the server. \\ \\
-**15. //tnaIcon//** \\
+**15. //shortcutHome//** \\
+Home screen layout(Going to apply later, not used currently). \\ \\
+**16. //tnaIcon//** \\
 Icon displayed on the device corresponding to the job code. \\ \\
-**16. //reserved1//** \\
+**17. //reserved1//** \\
 Reserved space. \\
@@ Line 639: / Line 671: @@
 |0  |Lagacy mode (Using PICC master key)  |
 |1  |New mode (Using App master key)  |
+</WRAP>
 **17. //reserved//** \\
 Reserved space.\\ \\
@@ Line 667: / Line 700: @@
 **24. //reserved5//** \\
 Reserved space. \\
+</WRAP>
 ==== BS2FingerprintConfig ====
 <code cpp>
 typedef struct {
-    uint8_t securityLevel;
+    uint8_t      securityLevel;
-    uint8_t fastMode;
+    uint8_t      fastMode;
-    uint8_t sensitivity;
+    uint8_t      sensitivity;
-    uint8_t sensorMode;
+    uint8_t      sensorMode;
-    uint16_t templateFormat;
+    uint16_t     templateFormat;
-    uint16_t scanTimeout;
+    uint16_t     scanTimeout;
-    uint8_t successiveScan;
+    uint8_t      successiveScan;
-    uint8_t advancedEnrollment;
+    uint8_t      advancedEnrollment;
-    uint8_t showImage;
+    uint8_t      showImage;
-    uint8_t lfdLevel;
+    uint8_t      lfdLevel;
-    uint8_t reserved1[32];
+    bool         checkDuplicate;
+    uint8_t      reserved3[31];
 } BS2FingerprintConfig;
 </code>
@@ Line 733: / Line 769: @@
 Decides whether to display scanned fingerprint image on the screen. \\ \\
 **10. //lfdLevel//** \\
-Configuration for the LFD sensitivity. \\
+Configuration for the LFD(Live Fingerprint Detection - fake fingerprint detection) sensitivity. \\
 <WRAP group 50%>
 ^Value  ^Description  ^
@@ Line 741: / Line 777: @@
 |3  |Most Strict  |
 </WRAP>
-**11. //reserved1//** \\
+**11. //checkDuplicate//** \\
-Reserved space.
+[+ V2.6.4] If set to true, it will determine if the fingerprint is a duplicate. \\ \\
+**12. //reserved3//** \\
+Reserved space. \\ \\
 ==== BS2Rs485Config ====
@@ Line 1312: / Line 1350: @@
 |11|Led action|
 |12|Fire alarm input|
+|13|Auth Success(Access granted)|
+|14|Auth Fail(Access denied)|
+|15|Lift action|
 </WRAP>
 . //stopFlag// \\
@@ Line 1531: / Line 1572: @@
 <code cpp>
 typedef struct {
-	BS2_FACE_SECURITY_LEVEL       securityLevel;
+    uint8_t       securityLevel;
-	BS2_FACE_LIGHT_CONDITON       lightCondition;
+    uint8_t       lightCondition;
-	BS2_FACE_ENROLL_THRESHOLD     enrollThreshold;
+    uint8_t       enrollThreshold;
-	BS2_FACE_DETECT_SENSITIVITY   detectSensitivity;
+    uint8_t       detectSensitivity;
-	uint16_t                      enrollTimeout;
+    uint16_t      enrollTimeout;
-	uint8_t                       reserved3[32];
+    uint8_t       lfdLevel;
+    bool          quickEnrollment;
+    uint8_t       previewOption;
+    bool          checkDuplicate;
+    uint8_t       reserved[2];
+    uint8_t       reserved2[26];
 } BS2FaceConfig;
 </code>
-. //securityLevel// \\
+**1. //securityLevel//** \\
 Face authentication security level. This is used across the system. . \\
 <WRAP group 50%>
@@ Line 1548: / Line 1596: @@
 |2  |Most highly secure  |
 </WRAP>
-. //lightCondition// \\
+**2. //lightCondition//** \\
 Configuration of the light condition.\\
 <WRAP group 50%>
@@ Line 1556: / Line 1604: @@
 |2  |Automatic  |
 </WRAP>
-. //enrollThreshold// \\
+**3. //enrollThreshold//** \\
-Threshold of face enrollment.\\
+Threshold of face enrollment. It determines how much movement of pose is allowed when enrolling the face.  \\
 <WRAP group 50%>
 ^Value  ^Description  ^
-|0  |THRESHOLD_0  |
+|0  |THRESHOLD_0 (Most strict) |
 |1  |THRESHOLD_1 |
 |2  |THRESHOLD_2  |
@@ Line 1569: / Line 1617: @@
 |7  |THRESHOLD_7  |
 |8  |THRESHOLD_8  |
-|9  |THRESHOLD_9  |
+|9  |THRESHOLD_9 (Least strict) |
 </WRAP>
-. //detectSensitivity// \\
+**4. //detectSensitivity//** \\
 Configuration of sensitivity on detecting the face. \\
 <WRAP group 50%>
@@ Line 1580: / Line 1628: @@
 |3  |High  |
 </WRAP>
-. //enrollTimeout// \\
+**5. //enrollTimeout//** \\
 Timeout period of face scanning which is 60 seconds by default.\\ \\
-. //reserved3// \\
+**6. //lfdLevel//** \\
-Reserved space.\\ \\
+[+ V2.6.3] Configuration for the LFD(Live Face Detection - fake face detection) sensitivity. \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |Not Use  |
+|1  |Strict  |
+|2  |More Strict  |
+|3  |Most Strict  |
+</WRAP>
+**7. //quickEnrollment//** \\
+[+ V2.6.3] Quick face enrollment process. \\
+True - Face enrollment process with a single step.\\
+False - Face enrollment rpcoess with 3 steps.\\
+Please use false if you want to enroll with a high quality of face templates. \\ \\
+**8. //previewOption//** \\
+[+ V2.6.3] IR camera preview option when you authenticate with face. \\
+Only used to ''FaceLite''. \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |Preview not used  |
+|1  |Preview not used at frist of authentication, preview at 1/2 stage  |
+|2  |Preview of all stages on authentication  |
+</WRAP>
+**9. //checkDuplicate//** \\
+[+ V2.6.4] Check whether the scanned face is duplicated in the device. \\ \\
+**10. //reserved//** \\
+Reserved space. \\ \\
+**11. //reserved2//** \\
+Reserved space. \\ \\
 ==== BS2Rs485ConfigEX ====
 <code cpp>
@@ Line 1801: / Line 1875: @@
 |0xFFFFFFFF|All configuration|
 </WRAP>
+==== BS2IPV6Config ====
+<code cpp>
+enum {
+    BS2_MAX_IPV6_ALLOCATED_ADDR = 8,
+};
+typedef struct {
+    uint8_t useIPV6;
+    uint8_t reserved1;
+    uint8_t useDhcpV6;
+    uint8_t useDnsV6;
+    uint8_t reserved[1];
+    char staticIpAddressV6[BS2_IPV6_ADDR_SIZE];
+    char staticGatewayV6[BS2_IPV6_ADDR_SIZE];
+    char dnsAddrV6[BS2_IPV6_ADDR_SIZE];
+    char serverIpAddressV6[BS2_IPV6_ADDR_SIZE];
+    uint16_t serverPortV6;
+    uint16_t sslServerPortV6;
+    uint16_t portV6;
+    uint8_t numOfAllocatedAddressV6;
+    uint8_t numOfAllocatedGatewayV6;
+    uint8_t reserved[8];
+    char allocatedIpAddressV6[BS2_IPV6_ADDR_SIZE][BS2_MAX_IPV6_ALLOCATED_ADDR];
+    char allocatedGatewayV6[BS2_IPV6_ADDR_SIZE][BS2_MAX_IPV6_ALLOCATED_ADDR];
+} BS2IpConfig;
+</code>
+. //useIPV6// \\
+Flag indicating whether to use IP V6. \\ \\
+. //reserved1// \\
+Reserved space. \\ \\
+. //useDhcpV6// \\
+Flag indicating whether to use DHCP. \\ \\
+. //useDnsV6// \\
+Decides whether to use server address or server URL. \\ \\
+. //staticIpAddressV6// \\
+Static IP V6 address of current device. \\ \\
+. //staticGatewayV6// \\
+Static IP V6 address of gateway. \\ \\
+. //dnsAddrV6// \\
+DNS address. \\ \\
+. //serverIpAddressV6// \\
+IP address of BioStar. Used only in the server mode. \\ \\
+. //serverPortV6// \\
+Port number of BioStar. Used only in the server mode. \\ \\
+. //sslServerPortV6// \\
+Used when the connectionMode is set as server SSL mode, which is the port of the SDK application. \\ \\
+. //portV6// \\
+Port number of the device. \\ \\
+. //numOfAllocatedAddressV6// \\
+The number of IP V6 address currently assigned to the device. \\ \\
+. //numOfAllocatedGatewayV6// \\
+The number of gateway address currently assigned to the device. \\ \\
+. //reserved// \\
+Reserved space. \\ \\
+. //allocatedIpAddressV6// \\
+The IP V6 address currently assigned to the device. \\ \\
+. //allocatedGatewayV6// \\
+The gateway address currently assigned to the device.\\ \\
+==== BS2DesFireCardConfigEx ====
+<code cpp>
+typedef struct {
+    uint8_t appMasterKey[16];
+    uint8_t fileReadKey[16];
+    uint8_t fileWriteKey[16];
+    uint8_t fileReadKeyNumber;
+    uint8_t fileWriteKeyNumber;
+    uint8_t reserved[2];
+} BS2DesFireAppLevelKey;                 ///< 52 bytes
+typedef struct {
+    BS2DesFireAppLevelKey desfireAppKey;    ///< 52 bytes
+    uint8_t reserved[16];
+} BS2DesFireCardConfigEx;                   ///< 68 bytes
+</code>
+. //appMasterKey// \\
+Application master key of DesFire. \\ \\
+. //fileReadKey// \\
+The key used to read the file. \\ \\
+. //fileWriteKey// \\
+The key used to write the file. \\ \\
+. //fileReadKeyNumber// \\
+The index of the key for reading the file. \\ \\
+. //fileWriteKeyNumber// \\
+The index of the key for writing the file. \\ \\
+. //reserved// \\
+Reserved space. \\ \\
+. //desfireAppKey// \\
+A structure containing DesFire key information. \\ \\
+. //reserved// \\
+Reserved space. \\