Differences

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

--- en:configuration_api [2017/11/29 21:20]
michael [BS2IpConfig]
+++ en:configuration_api [2020/02/19 13:47]
yjjung [BS2SystemConfig]
@@ Line 5: / Line 5: @@
   * [[BS2_ResetConfig]]: Initializes the device's configurations.
+  * [[BS2_ResetConfigExceptNetInfo]]:  Initializes the setting information of the device. (Excluding network settings)
   * [[BS2_GetConfig]]: Retrieves configuration blob from the device.
   * [[BS2_SetConfig]]: Stores configuration blob on the device.
@@ Line 52: / Line 53: @@
   * [[BS2_GetFaceConfig]]: Retrieves face settings from the device.
   * [[BS2_SetFaceConfig]]: Stores face settings on the device.
-  * [[BS2_GetRS485ConfigEx]]: CIn case of Corestation, retrieves RS-485 network settings from the device.
+  * [[BS2_GetRS485ConfigEx]]: In case of Corestation, retrieves RS-485 network settings from the device.
   * [[BS2_SetRS485ConfigEx]]: In case of CoreStation, stores RS-485 network settings on the device.
   * [[BS2_GetCardConfigEx]]: Retrieves iClass SEOS card settings from the device.
   * [[BS2_SetCardConfigEx]]: Stores iClass SEOS card settings on the device.
+  * [[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.
+  * [[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.
+  * [[BS2_GetDesFireCardConfigEx]]: [+ V2.6.4] Retrieves DesFire advanced configuration from the device.
+  * [[BS2_SetDesFireCardConfigEx]]: [+ V2.6.4] Sets DesFire advanced configuration in the device.
 \\
 ===== Structure =====
@@ Line 109: / Line 123: @@
 ==== BS2SystemConfig ====
+[[BS2_SetSystemConfig]] must be called after calling [[BS2_GetSystemConfig]] and completing necessary settings except for tamperOn.  \\
 <code cpp>
 typedef struct {
@@ Line 120: / Line 135: @@
     uint8_t keyEncrypted;
     uint8_t useJobCode;
-    uint8_t useAlphanumericID
+    uint8_t useAlphanumericID;
-    uint32_t cameraFrequency
+    uint32_t cameraFrequency;
-    uint8_t reserved1[24];
+    bool secureTamper;
+    bool reserved0;     // (write protected)
+    uint8_t reserved[2];
+    uint32_t useCardOperationMask;
+    uint8_t reserved2[16];
 } BS2SystemConfig;
 </code>
@@ Line 138: / Line 157: @@
 Decides whether to use intercom. \\ \\
 **7. //useUSBConnection//** \\
-Decides whether to use USB connection. \\ \\
+This is not used anymore. (The device automatically detects USB connection.) \\ \\
 **8. //keyEncrypted//** \\
 Decides whether to use OSDP secure key. \\ \\
@@ Line 153: / Line 172: @@
 |2  |60Hz  |
 </WRAP>
-**12. //reserved1//** \\
+***12. //secureTamper//** \\
+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. //reserved0//** \\
+Reserved space. \\ \\
+**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 182: / Line 229: @@
 **1. //authSchedule//** \\
 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//** \\
 Decides whether to enable global APB zone. \\ \\
@@ Line 200: / Line 264: @@
 **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 207: / Line 272: @@
 </WRAP>
 <WRAP info>
-Only valid for devices with a camera.
+Only valid for A2. Not used with FaceStation2 or FaceLite.
 </WRAP>
 **8. //useServerMatching//** \\
@@ Line 230: / Line 295: @@
 |1  |Administrative privilege  |
 |2  |Privilege to change the system settings|
-|3  |Normal user privilege|
+|3  |Privilege to change user information|
 </WRAP>
 <WRAP alert>
@@ Line 359: / Line 424: @@
 |0  |12 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>
 **12. //homeFormation//** \\
@@ Line 420: / Line 486: @@
 Port number of BioStar. Used only in the server mode. \\ \\
 **11. //mtuSize//** \\
-Maximum transmission unit for the TCP/IP communication. \\ \\
+MTU((Maximum Transmission Unit)) size for the TCP/IP communication. \\ \\
 **12. //baseband//** \\
 Bandwidth of the device. The value can be set to 10MB/S or 100 MB/S. \\ \\
@@ Line 538: / Line 604: @@
     uint8_t fileID;
     uint8_t encryptionType;
-    uint8_t reserved[3];
+    uint8_t operationMode;
+    uint8_t reserved[2];
 } BS2DesFireCard;
@@ Line 550: / Line 617: @@
     BS2DesFireCard desfire;
     uint8_t formatID;
+    uint8_t cipher;
     uint8_t reserved[24];
 } BS2CardConfig;
@@ Line 583: / Line 651: @@
 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 589: / Line 657: @@
 |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 604: / Line 679: @@
 |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. //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. \\
+</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 684: / Line 769: @@
 |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 754: / Line 841: @@
 typedef struct {
-    uint8_t inOut;
+    uint8_t mode;
     uint8_t useWiegandBypass;
     uint8_t useFailCode;
@@ Line 797: / Line 884: @@
 **5. //parityPos//** \\
 Select the position of the parity bit on the wiegand card data. \\ \\
-**6. //inOut//** \\
+**6. //mode//** \\
 Set the wiegand Input/Output mode. \\
 <WRAP group 50%>
@@ Line 803: / Line 890: @@
 |0  |Input  |
 |1  |Output  |
+|2  |In/Output  |
 </WRAP>
 **7. //useWiegandBypass//** \\
@@ Line 1147: / Line 1235: @@
     uint32_t deviceID;
     uint8_t type;
-    uint8_t reserved[3];
+    uint8_t stopFlag;
+    uint16_t delay;
     union {
         BS2RelayAction relay;
@@ Line 1237: / Line 1326: @@
 ID of the device that will execute the action. \\ \\
 . //type// \\
-Action 유형입니다. \\
+Action types. \\
 <WRAP group 50%>
 ^Value  ^Description  ^
@@ Line 1254: / Line 1343: @@
 |12|Fire alarm input|
 </WRAP>
-. //reserved// \\
+. //stopFlag// \\
-Reserved space. \\ \\
+Specifies the condition to stop the Action. \\
+If this value is set to 1 and the signal is detected through the door sensor, the action will stop. \\
+If this value is set to 2, it can be stopped only by the current action information. \\
+In general, related APIs that stop an action are called with a zone id, in which case all devices in the zone will stop the action. \\
+By setting stopFlag to 2 and and loading action information, you can selectively control only the alarms of that device.
+<WRAP group 50%>
+^Value  ^Description  ^
+|0|Don't stop|
+|1|Stop if door is closed|
+|2|Stop by command(Added in V2.6.0)|
+</WRAP>
+. //delay// \\
+Action delay. Unit is millisecond(ms). \\ \\
 ==== BS2TriggerActionConfig ====
@@ Line 1605: / Line 1707: @@
 . //reserved// \\
 Reserved space\\ \\
+==== BS2DstConfig ====
+<code cpp>
+enum {
+	BS2_MAX_DST_SCHEDULE = 2,
+};
+typedef struct {
+	uint16_t year;		// year, 0 means every year.
+	uint8_t month;		// [0, 11] : months since January
+	int8_t ordinal;		// [0, -1] : first, second, ..., last
+	uint8_t weekDay;	// [0, 6] : days since Sunday
+	uint8_t hour;		// [0, 23]
+	uint8_t minute;		// [0, 59]
+	uint8_t second;		// [0, 59]
+} BS2WeekTime;
+typedef struct {
+	BS2WeekTime startTime;
+	BS2WeekTime endTime;
+	int32_t timeOffset;	// in seconds
+	uint8_t reserved[4];
+} BS2DstSchedule;
+typedef struct {
+	uint8_t numSchedules;
+	uint8_t reserved[31];
+	BS2DstSchedule schedules[BS2_MAX_DST_SCHEDULE];
+} BS2DstConfig;
+</code>
+. // year // \\
+Means year, and if set to 0, it means yearly. \\ \\
+. // month // \\
+Means month, and has a value between 0 and 11 [January-December]. \\ \\
+. // ordinal // \\
+It starts with 0 and means the order of first, second, etc. \\ \\
+. // weekDay // \\
+Day of the week, 0 means Sunday, 1 means Monday. \\ \\
+. // hour // \\
+Specifies the time in 24-hour format. \\ \\
+. // minute // \\
+Specifies the minute. \\ \\
+. // second // \\
+Specifies the seconds. \\ \\
+. // startTime // \\
+It means start date and time. \\ \\
+. // endTime // \\
+It means the end date. \\ \\
+. // timeOffset // \\
+You can apply the DST time in seconds. \\
+For example, if you want to apply 1 hour, enter 3600. \\ \\
+. // reserved // \\
+Reserved space. \\ \\
+. // numSchedules // \\
+The number of DST schedules to apply. \\ \\
+. // schedules // \\
+DST schedule, up to two can be specified. \\ \\
 ==== BS2Configs ====
@@ Line 1666: / Line 1825: @@
 |0x2000000|Multi-Wiegand configuration|
 |0x4000000|Extended System configuration|
-|0x8000000|Daylight Saving configuration|
+|<del>0x8000000</del>|<del>Daylight Saving configuration (Deprecated)</del>|
+|0x10000000|RS485 Extended configuration|
+|0x20000000|Extended Card configuration|
+|0x40000000|Daylight Saving configuration|
 |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. \\