Differences

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

--- en:configuration_api [2018/03/15 15:17]
yjjung
+++ en:configuration_api [2019/07/22 17:39]
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_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 135: @@
     uint32_t cameraFrequency;
     bool secureTamper;
-private:
+    bool reserved0;     // (write protected)
-    bool tamperOn;     // (write protected)
+    bool gdprSupport;
-    uint8_t reserved[2];
+    uint8_t reserved[1];
     uint8_t reserved2[20];
 } BS2SystemConfig;
@@ Line 146: / Line 154: @@
 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 198: / Line 206: @@
 **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 246: / Line 271: @@
 |1  |Administrative privilege  |
 |2  |Privilege to change the system settings|
-|3  |Normal user privilege|
+|3  |Privilege to change user information|
 </WRAP>
 <WRAP alert>
@@ Line 375: / Line 400: @@
 |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 436: / Line 462: @@
 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 554: / Line 580: @@
     uint8_t fileID;
     uint8_t encryptionType;
-    uint8_t reserved[3];
+    uint8_t operationMode;
+    uint8_t reserved[2];
 } BS2DesFireCard;
@@ Line 566: / Line 593: @@
     BS2DesFireCard desfire;
     uint8_t formatID;
+    uint8_t cipher;
     uint8_t reserved[24];
 } 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.\\ \\
 **15. //encryptionType//** \\
-Type of data encryption. AES will be supported soon.\\
+Type of data encryption.\\
 <WRAP group 50%>
 ^Value  ^Description  ^
@@ Line 605: / Line 633: @@
 |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)  |
+**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 620: / Line 654: @@
 |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. \\
@@ Line 1636: / Line 1677: @@
 . //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 1697: / Line 1795: @@
 |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>