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
Next revision Both sides next revision
en:configuration_api [2018/03/20 16:17]
yjjung 		en:configuration_api [2020/02/18 10:00]
yjjung [Configuration API]
Line 57: Line 57:
   * [[BS2_GetCardConfigEx]]:​ Retrieves iClass SEOS card settings from the device.   * [[BS2_GetCardConfigEx]]:​ Retrieves iClass SEOS card settings from the device.
   * [[BS2_SetCardConfigEx]]:​ Stores iClass SEOS card settings on 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 ===== ===== Structure =====
Line 127: Line 136:
     uint32_t cameraFrequency; ​     uint32_t cameraFrequency; ​
     bool secureTamper;​​ ​     bool secureTamper;​​ ​
-private: ​  +    ​bool reserved0;     ​// (write protected) 
-    ​bool tamperOn; ​    ​// (write protected)  +    uint8_t reserved[2];​
-    uint8_t reserved[2];​​      ​+
     uint8_t ​reserved2[20]; ​         uint8_t ​reserved2[20]; ​    
 } BS2SystemConfig;​ } BS2SystemConfig;​
Line 146: Line 154:
 Decides whether to use intercom. \\ \\  Decides whether to use intercom. \\ \\ 
 **7. //​useUSBConnection//​** \\  **7. //​useUSBConnection//​** \\ 
-Decides whether to use USB connection. \\ \\ +This is not used anymore. (The device automatically detects ​USB connection.) \\ \\ 
 **8. //​keyEncrypted//​** \\  **8. //​keyEncrypted//​** \\ 
 Decides whether to use OSDP secure key. \\ \\  Decides whether to use OSDP secure key. \\ \\ 
Line 164: Line 172:
 Flag to determine whether to use a security tamper. \\ 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) \\ \\ 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. \\ +Reserved space. \\ \\  
-Be sure to call [[BS2_SetSystemConfig]] after completing the necessary settings except for tamperOn after [[BS2_GetSystemConfig]]. \\ \\ +**14. //reserved//** \\ 
-**14. //reserved1//** \\ +
 Reserved space. \\ \\  Reserved space. \\ \\ 
 **15. //​reserved2//​** \\  **15. //​reserved2//​** \\ 
Line 198: Line 205:
 **1. //​authSchedule//​** \\  **1. //​authSchedule//​** \\ 
 Stores schedules for different types of authentication modes. \\ \\  Stores schedules for different types of authentication modes. \\ \\ 
 +It has the following meanings in the value of the array. \\
 +If the value in the array is greater than 0, the corresponding authentication mode is enabled. \\
 +Biometric information in the descriptions below refers to the fingerprint or face depending on the device. \\
 +<WRAP group 60%>
 +^Value ^Code  ^Description ​ ^
 +|0  |BS2_AUTH_MODE_BIOMETRIC_ONLY ​ |Biometric only |
 +|1  |BS2_AUTH_MODE_BIOMETRIC_PIN ​ |Biometric + PIN  |
 +|2  |BS2_AUTH_MODE_CARD_ONLY ​ |Card only  |
 +|3  |BS2_AUTH_MODE_CARD_BIOMETRIC ​ |Card + Biometric ​ |
 +|4  |BS2_AUTH_MODE_CARD_PIN ​ |Card + PIN |
 +|5  |BS2_AUTH_MODE_CARD_BIOMETRIC_OR_PIN ​ |Card + Biometric or PIN  |
 +|6  |BS2_AUTH_MODE_CARD_BIOMETRIC_PIN ​ |Card + Biometric + PIN  |
 +|7  |BS2_AUTH_MODE_ID_BIOMETRIC ​ |ID + Biometric ​ |
 +|8  |BS2_AUTH_MODE_ID_PIN ​ |ID + PIN  |
 +|9  |BS2_AUTH_MODE_ID_BIOMETRIC_OR_PIN ​ |ID + Biometric or PIN  |
 +|10  |BS2_AUTH_MODE_ID_BIOMETRIC_PIN ​ |ID + Biometric + PIN  |
 +</​WRAP>​
 **2. //​useGlobalAPB//​** \\  **2. //​useGlobalAPB//​** \\ 
 Decides whether to enable global APB zone. \\ \\  Decides whether to enable global APB zone. \\ \\ 
Line 216: Line 240:
 **7. //​faceDetectionLevel//​** \\  **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.\\ 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%> <WRAP group 50%>
 ^Value ​ ^Description ​ ^ ^Value ​ ^Description ​ ^
Line 223: Line 248:
 </​WRAP>​ </​WRAP>​
 <WRAP info> <WRAP info>
-Only valid for devices ​with a camera.+Only valid for A2. Not used with FaceStation2 or FaceLite.
 </​WRAP>​ </​WRAP>​
 **8. //​useServerMatching//​** \\  **8. //​useServerMatching//​** \\ 
Line 246: Line 271:
 |1  |Administrative privilege ​ | |1  |Administrative privilege ​ |
 |2  |Privilege to change the system settings| |2  |Privilege to change the system settings|
-|3  |Normal ​user privilege|+|3  |Privilege to change ​user information|
 </​WRAP>​ </​WRAP>​
 <WRAP alert> <WRAP alert>
Line 375: Line 400:
 |0  |12 hour  | |0  |12 hour  |
 |1  |24 hour  | |1  |24 hour  |
 +However, Linux OS devices like BioStation 2, BioStation L2, BioLite N2 and FaceLite have opposite settings.(0 = 24 hour / 1 = 12 hour) 
 </​WRAP>​ </​WRAP>​
 **12. //​homeFormation//​** \\  **12. //​homeFormation//​** \\ 
Line 554: Line 580:
     uint8_t fileID;     uint8_t fileID;
     uint8_t encryptionType;​     uint8_t encryptionType;​
-    uint8_t reserved[3];+    ​uint8_t operationMode;​ 
 +    ​uint8_t reserved[2];
 } BS2DesFireCard;​ } BS2DesFireCard;​
  
Line 566: Line 593:
     BS2DesFireCard desfire;     BS2DesFireCard desfire;
     uint8_t formatID;     uint8_t formatID;
 +    uint8_t cipher;
     uint8_t reserved[24];​     uint8_t reserved[24];​
 } BS2CardConfig;​ } BS2CardConfig;​
Line 599: Line 627:
 File ID that is stored inside the DesFire card, which will be used by the application to read and write data.\\ \\  File ID that is stored inside the DesFire card, which will be used by the application to read and write data.\\ \\ 
 **15. //​encryptionType//​** \\  **15. //​encryptionType//​** \\ 
-Type of data encryption. AES will be supported soon.\\ +Type of data encryption.\\ ​
 <WRAP group 50%> <WRAP group 50%>
 ^Value ​ ^Description ​ ^ ^Value ​ ^Description ​ ^
Line 605: Line 633:
 |1  |AES  | |1  |AES  |
 </​WRAP>​ </​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.\\ \\  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)). \\ \\  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.\\ \\  Decides whether to use Wiegand format.\\ \\ 
-**19. //​dataType//​** \\ +**20. //​dataType//​** \\ 
 Type of card data. \\  Type of card data. \\ 
 <WRAP group 50%> <WRAP group 50%>
Line 620: Line 655:
 |3  |BCD  | |3  |BCD  |
 </​WRAP>​ </​WRAP>​
-**20. //​useSecondaryKey//​** \\ +**21. //​useSecondaryKey//​** \\ 
 Decides whether to use the secondary encryption key. \\ \\  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.\\ \\  ID that is used when the card configuration needs to be managed from the database on the BioStar application.\\ \\ 
-**22. //​reserved5//​** \\ +**23. //​cipher//​** \\ 
 +Activates '​Keypad card ID' option. \\ 
 +Default value is 0, it is only valid for XPass D2 Gangbox Keypad type. \\ 
 +<WRAP group 50%> 
 +^Value ​ ^Description ​ ^ 
 +|0  |Deactivate ​ | 
 +|1  |Activate ​ | 
 +**24. //​reserved5//​** \\ 
 Reserved space. \\  ​ Reserved space. \\  ​
 +</​WRAP>​
 ==== BS2FingerprintConfig ==== ==== BS2FingerprintConfig ====
 <code cpp> <code cpp>
Line 1670: Line 1712:
 2. // month // \\ 2. // month // \\
 Means month, and has a value between 0 and 11 [January-December]. \\ \\ Means month, and has a value between 0 and 11 [January-December]. \\ \\
-// // ordinal // \\+3. // ordinal // \\
 It starts with 0 and means the order of first, second, etc. \\ \\ It starts with 0 and means the order of first, second, etc. \\ \\
 4. // weekDay // \\ 4. // weekDay // \\