Differences

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

--- en:configuration_api [2024/07/15 15:56]
ghshin [BS2InputConfig]
+++ en:configuration_api [2024/10/24 14:56] (current)
@@ Line 396: / Line 396: @@
     uint8_t showOsdpResult;
     uint8_t reserved1[30];
-} BS2DisplayConfig;
+    BS2_SHOW_OSDP_RESULT showOsdpResult;	///< 1 byte
-</code>
+    BS2_AUTHMSG_USERINFO authMsgUserName;			///< 1 byte
+    BS2_AUTHMSG_USERINFO authMsgUserId;			///< 1 byte
+    BS2_SCRAMBLE_KEYBOARD_MODE scrambleKeyboardMode;		///< 1 byte
+    uint8_t reserved3[27];		///< 27 bytes (padding)
+} BS2DisplayConfig;</code>
 **1. //language//** \\
 Language code. \\
@@ Line 508: / Line 514: @@
 |1  |Do Not Display OSDP Authentication Result  |
 </WRAP>
 . //reserved1// \\
-Reserved space. \\
+Reserved space. \\ \\
+**20. //authMsgUserName//** \\
+[+2.9.8] The display method of the user's name in the authentication result message shown on the device screen is set. \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |Display All  |
+|1  |Mask All but First Letter  |
+|2  |Hide All  |
+</WRAP>
+**21. //authMsgUserID//** \\
+[+2.9.8]  The display method of the user's ID in the authentication result message shown on the device screen is set. \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |Display All  |
+|1  |Mask All but First Letter  |
+|2  |Hide All  |
+</WRAP>
+**22. //scrambleKeyboardMode//** \\
+[+2.9.8] Sets whether to use the scramble keypad. \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |Use  |
+|1  |Not use  |
+</WRAP>
 ==== BS2IpConfig ====
@@ Line 1129: / Line 1162: @@
     uint8_t numInputs;
     uint8_t numSupervised;
-    uint16_t reserved;
+    union {
+	uint16_t value;
+	struct {
+		uint16_t tamperAuxIndex : 4;
+		uint16_t acFailAuxIndex : 4;
+		uint16_t aux0Type : 1;
+		uint16_t aux1Type : 1;
+		uint16_t reserved : 6;
+	} field;
+    } aux;
     struct {
         uint8_t portIndex;
@@ Line 1169: / Line 1211: @@
 |255  |Custom  |
 </WRAP>
-**12. //reserved//** \\
+**12. //aux//** \\
-Reserved space. \\ \\
+[+2.9.8] Sets the operation of Aux.
+^Bit position  ^Number of bit  ^Member  ^Description  ^
+|0  |4  |tamperAuxIndex  |Aux number to use as tamper (0:None, 1:Aux0, 2:Aux1)  |
+|7  |4  |acFailAuxIndex  |Aux number to use as AC Fail (0:None, 1:Aux0, 2:Aux1)  |
+|8  |1  |aux0Type  |Type of Aux 0 (0: NO, 1:NC)  |
+|9  |1  |aux1Type  |Type of Aux 1 (0: NO, 1:NC)  |
+|10  |6  |reserved  |Reserved space  |
 **13. //config//** \\
 Configuration that distinguishes the supervised input signal type. This configuration will be valid only when the supervised input's resistance is set as custom . \\
@@ Line 2402: / Line 2450: @@
 </WRAP>
 . //maskCheckMode// \\
 ''Visual Face based'' Sets the Mask Check Mode. \\
 When set to HARD, access is denied if not detecting any mask on the face based on maskDetectionLevel. \\
 When set to SOFT, access is not affected even if not detecting any mask on the face based on maskDetectionLevel but leaves a related log. \\
-If maskCheckMode is set to No use(0), \\
+If maskCheckMode is set to No use(0), The setting of maskDetectionLevel is ignored. \\
-The setting of maskDetectionLevel is ignored. \\
 And the reject sound due to mask detection check by useRejectSound, the mask detection check by faceCheckOrder is ignored. \\
+[+2.9.8] Require no mask (3) can only be set when Mask Check Mode is Check Before Authentication, and users wearing masks will fail authentication according to the maskDetectionLevel. This option can only be set on devices that support [[device_api#bs2devicecapabilities|BS2DeviceCapabilities - authDenyMaskSupported]]. \\
 <WRAP group 50%>
 ^Value  ^Description  ^Default  ^
@@ Line 2413: / Line 2461: @@
 |1  |Mask Check Mode (HARD)  |  |
 |2  |Mask Check Mode (SOFT)  |  |
+|3  |Require no mask  |  |
 </WRAP>
 . //reserved// \\
@@ Line 2730: / Line 2779: @@
     BS2ExtensionNumber phonebook[128];
-    uint8_t reserved2[32];        ///< 32 bytes (reserved)
+    uint8_t resolution;
+    uint8_t transport;
+    uint8_t reserved2[30];		///< 30 bytes (reserved)
 } BS2VoipConfigExt;
 </code>
@@ Line 2784: / Line 2835: @@
 . //phonebook// \\
 You can specify up to 128 extensions in your phone book. \\ \\
-. //reserved2// \\
+. //resolution// \\
+[+2.9.8] Sets the resolution of video output. \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |360 x 640  |
+|1  |720 x 480  |
+</WRAP>
+. //transport// \\
+[+2.9.8] Sets the data transfer method.
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |UDP  |
+|1  |TCP  |
+|2  |SSL  |
+</WRAP>
+. //reserved2// \\
 Reserved space. \\ \\
@@ Line 2798: / Line 2865: @@
     BS2_PORT port;
     BS2_BOOL enabled;
-    uint8_t reserved;
+    uint8_t reserved;				///< 1 byte (packing)
-    uint8_t reserved2[32];
+    uint8_t resolution;
+    uint8_t reserved2[31];			///< 31 bytes (reserved)
 } BS2RtspConfig;
 </code>
@@ Line 2815: / Line 2883: @@
 . //reserved// \\
 Reserved space. \\ \\
-. //reserved2// \\
+. //resolution// \\
+[+2.9.8] Sets the resolution of video output.
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |180 x 320  |
+|1  |720 x 480  |
+</WRAP>
+. //reserved2// \\
 Reserved space. \\ \\