Differences

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

--- en:configuration_api [2019/01/04 14:02]
michael [BS2AuthConfig]
+++ en:configuration_api [2020/02/19 11:03]
kkshin
@@ Line 57: / Line 57: @@
   * [[BS2_GetCardConfigEx]]: Retrieves iClass SEOS card settings from the device.
   * [[BS2_SetCardConfigEx]]: Stores iClass SEOS card settings on the device.
-  * [[BS2_GetDstConfig]]: Gets the device DST information.
+  * [[BS2_GetDstConfig]]: Retrieves the device DST information.
-  * [[BS2_SetDstConfig]]: Sets 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.
+  * [[BS2_GetIPV6Config]]: [+ 2.6.3] Retrieves IPv6 configuration information.
+  * [[BS2_SetIPV6Config]]: [+ 2.6.3] Stores IPv6 configuration information.
+  * [[BS2_GetIPV6ConfigViaUDP]]: [+ 2.6.3] Retrieves IPv6 configuration through UDP broadcast.
+  * [[BS2_SetIPV6ConfigViaUDP]]: [+ 2.6.3] Stores IPv6 configuration through UDP broadcast.
+  * [[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.
 \\
 ===== Structure =====
@@ Line 127: / Line 136: @@
     uint32_t cameraFrequency;
     bool secureTamper;
-private:
+    bool reserved0;     // (write protected)
-    bool tamperOn;     // (write protected)
+    uint8_t reserved[2];
-    uint8_t reserved[2];
+    uint32_t useCardOperationMask;
-    uint8_t reserved2[20];
+    uint8_t reserved2[16];
 } BS2SystemConfig;
 </code>
@@ Line 164: / Line 173: @@
 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. \\ \\
+. //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 233: / Line 262: @@
 **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 240: / Line 270: @@
 </WRAP>
 <WRAP info>
-Only valid for devices with a camera.
+Only valid for A2. Not used with FaceStation2 or FaceLite.
 </WRAP>
 **8. //useServerMatching//** \\
@@ Line 572: / Line 602: @@
     uint8_t fileID;
     uint8_t encryptionType;
-    uint8_t reserved[3];
+    uint8_t operationMode;
+    uint8_t reserved[2];
 } BS2DesFireCard;
@@ Line 618: / Line 649: @@
 File ID that is stored inside the DesFire card, which will be used by the application to read and write data.\\ \\
 **15. //encryptionType//** \\
-Type of data encryption. AES will be supported soon.\\
+Type of data encryption.\\
 <WRAP group 50%>
 ^Value  ^Description  ^
@@ Line 624: / Line 655: @@
 |1  |AES  |
 </WRAP>
-**16. //reserved//** \\
+**16. //operationMode//** \\
+Operation mode. (operationMode will be supported soon.)\\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |Lagacy mode (Using PICC master key)  |
+|1  |New mode (Using App master key)  |
+</WRAP>
+**17. //reserved//** \\
 Reserved space.\\ \\
-**17. //byteOrder//** \\
+**18. //byteOrder//** \\
 Order of how the byte of the card is stored. When it is set as 0, will function as MSB((Most Significant Bit)). When it is set as 1, will function as LSB((Least Significant Bit)). \\ \\
-**18. //useWiegandFormat//** \\
+**19. //useWiegandFormat//** \\
 Decides whether to use Wiegand format.\\ \\
-**19. //dataType//** \\
+**20. //dataType//** \\
 Type of card data. \\
 <WRAP group 50%>
@@ Line 639: / Line 677: @@
 |3  |BCD  |
 </WRAP>
-**20. //useSecondaryKey//** \\
+**21. //useSecondaryKey//** \\
 Decides whether to use the secondary encryption key. \\ \\
-**21. //formatID//** \\
+**22. //formatID//** \\
 ID that is used when the card configuration needs to be managed from the database on the BioStar application.\\ \\
-**22. //cipher//** \\
+**23. //cipher//** \\
 Activates 'Keypad card ID' option. \\
 Default value is 0, it is only valid for XPass D2 Gangbox Keypad type. \\
@@ Line 650: / Line 688: @@
 |0  |Deactivate  |
 |1  |Activate  |
-**23. //reserved5//** \\
+**24. //reserved5//** \\
 Reserved space. \\
+</WRAP>
 ==== BS2FingerprintConfig ====
 <code cpp>
@@ Line 1786: / Line 1824: @@
 |0xFFFFFFFF|All configuration|
 </WRAP>
+==== 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. \\