Differences

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

--- en:configuration_api [2021/08/07 15:49]
kkshin [BS2InputConfigEx]
+++ en:configuration_api [2022/10/05 13:57]
sungjun
@@ Line 730: / Line 730: @@
 **23. //cipher//** \\
 Activates 'Keypad card ID' option. \\
-Default value is 0, it is only valid for XPass D2 Gangbox Keypad type. \\
+Default value is 0, it is only valid for Gangbox Keypad type of Xpass 2, XPass D2. \\
 <WRAP group 50%>
 ^Value  ^Description  ^
@@ Line 1812: / Line 1812: @@
 **12. //faceWidth//** \\
 [+ V2.7.1] ''FaceStation F2'' This indicates the width of the face image, and you can specify the minimum and maximum values. \\
-The minimum and maximum values default to 66 and 250. \\ \\
+[+ 2.8.3] ''BioStation 3'' The settings are ignored. \\
+<WRAP group 20%>
+^  ^Default(min)  ^Default(max)  ^
+|FSF2  |66  |250  |
+|BS3  |-  |-  |
 **13. //searchRange//** \\
 [+ V2.7.1] ''FaceStation F2'' Represents the face search range, and you can specify the x value (horizontal coordinate) of the range and the width from the x value point. \\
-The default values for x value and width are 144 and 432. \\ \\
+The default values of x and width are as follows. \\
-. //reserved2// \\
+[+ 2.8.3] ''BioStation 3'' The settings are ignored. \\
+<WRAP group 20%>
+^  ^Default(x)  ^Default(width)  ^
+|FSF2  |144  |432  |
+|BS3  |-  |-  |
+. //detectDistance// \\
+[+ 2.8.3] ''BioStation 3'' This configures the minimum and maximum detection range for facial recognition.. \\
+We no longer support faceWidth to pinpoint the face location using pixel units due to its complexity. \\
+Instead, we set the detection range of the subject(face). The unit is set to cm, and the value must be inputted as a multiple of 10. \\
+<WRAP group 80%>
+^  ^Min limit for min detection range  ^Max limit for min detection range  ^Min detection range(Default)  ^Min limit for max detection range  ^Max limit for max detection range  ^Max sensing range(Infinite)  ^Max sensing range(Default)  ^
+|BS3  |30  |100  |60  |40  |100  |255  |100  |
+</WRAP>
+. //wideSearch// \\
+[+ 2.8.3] ''BioStation 3'' This can increase the detection range for facial recognition. \\
+We no longer support searchRange to set the x-coordinate and width due to its complexity. \\
+ Instead, we set the face detection setting as default(false), or a wide area(true). \\
+The details of the settings and protocols for the detection of wide area is set within the device, which the user cannot change. \\ \\
+If this setting is set to TRUE, the camera detects subjects within a large range, and unintentionally detect and authenticate multiple subjects at once. \\
+Therefore, the default setting is at false. \\ \\
+. //unused// \\
 Reserved space.\\ \\
+. //reserved// \\
+Reserved space.\\ \\
 ==== BS2Rs485ConfigEX ====
 <code cpp>
@@ Line 2410: / Line 2437: @@
     uint8_t useBarcode;
     uint8_t scanTimeout;
-    uint8_t reserved[14];
+    uint8_t bypassData;
+    uint8_t treatAsCSN;
+    uint8_t reserved[12];
 } BS2BarcodeConfig;
 </code>
 . //useBarcode// \\
-This is the flag for enabling Barcode or disabling Barcode. \\ \\
+Barcode usage flag. \\ \\
 . //scanTimeout// \\
-This is Timeout(second) setting for scanning Barcode. \\
+Set the Barcode scan time. The unit is in seconds. \\
-Default second is 4 seconds. The time out can be set from 4 to 10 seconds. \\ \\
+The default is 4 seconds, and can be entered within a range of 4 to 10 seconds.\\ \\
-. //reserved// \\
+. //bypassData// \\
-Reserved space. \\
+[+2.8.2] Used to send read barcode information to the server, not processed by the device. \\
+If the barcode value is stored in the user information structure for user authentication, \\
+There is a size constraint of 32 bytes ([[smartcard_api#BS2CSNCard|BS2CSNCard data]]), \\
+Call the [[BS2_SetBarcodeScanListener]], use this option to send barcodes up to 512 bytes of size to the server. \\ \\
+. //treatAsCSN// \\
+[+2.8.2] Indicates whether the Barcode should be treated the same as a regular CSN card. \\
+It is applied from XS2-QR 1.1.3 and in the case of false, it is treated the same as before. \\
+This allows you to freely specify character sets that can be treated as barcodes from ASCII codes 32 to 126.  (See description in [[qr_code_api#BS2_WriteQRCode|BS2_WriteQRCode]]) \\
+If set to true, the barcode is treated like a number just like the existing CSN. \\
+Therefore, if you want to set the bar code card data with special characters and English characters. \\
+In this case, only the card type may be different, and the CSN card and barcode data may be used in the same value. \\
+. //reserved// \\
+Reserved space. \\
 ==== BS2InputConfigEx ====
@@ Line 2543: / Line 2585: @@
 . //reserved2// \\
 Reserved Space. \\ \\
+==== BS2VoipConfigExt ====
+<code cpp>
+typedef struct {
+    BS2_USER_ID phoneNumber;
+    char description[48 * 3];
+    uint8_t reserved[32];
+} BS2ExtensionNumber;
+typedef struct {
+    BS2_BOOL enabled;
+    BS2_BOOL useOutboundProxy;
+    uint16_t registrationDuration;
+    BS2_URL address;
+    BS2_PORT port;
+    struct {
+        uint8_t speaker;		// 0 ~ 100
+        uint8_t mic;			// 0 ~ 100
+    } volume;			///< 2 bytes
+    BS2_USER_ID id;
+    BS2_USER_ID password;
+    BS2_USER_ID authorizationCode;
+    struct {
+        BS2_URL address;
+        BS2_PORT port;
+        uint8_t reserved[2];
+    } outboundProxy;
+    uint8_t exitButton;            /// *, #, 0~9
+    uint8_t reserved1;
+    uint8_t numPhoneBook;
+    BS2_BOOL showExtensionNumber;
+    BS2ExtensionNumber phonebook[128];
+    uint8_t reserved2[32];        ///< 32 bytes (reserved)
+} BS2VoipConfigExt;
+</code>
+. //phoneNumber// \\
+This is the extension. \\ \\
+. //description// \\
+Display information. \\ \\
+. //reserved// \\
+Reserved space. \\ \\
+. //enabled// \\
+Sets whether the VoIP extension feature is enabled. \\ \\
+. //useOutboundProxy// \\
+Sets whether the Outbound Proxy Server is configured. \\ \\
+. //registrationDuration// \\
+The cycle of updating the relevant information to the SIP server. \\
+Set in seconds and must be between 60 and 600. \\ \\
+. //address// \\
+Enter the IP address of the SIP server (usually BioStar). \\ \\
+. //port// \\
+Enter the SIP server port. The default port is 5060. \\ \\
+. //speaker// \\
+Enter the speaker volume information for the intercom in the range 0 to 100. The default value is 50. \\ \\
+. //mic// \\
+Enter the microphone volume information for the intercom in the range 0 to 100. The default value is 50. \\ \\
+. //id// \\
+Enter the ID to connect to the SIP server. \\
+. //password// \\
+Specifies the password to connect to the SIP server. \\ \\
+. //authorizationCode// \\
+The authentication code value required to connect to the SIP server. \\ \\
+. //outboundProxy// \\
+Enter Outbound proxy server information. \\ \\
+. //address// \\
+Enter the IP address of the Outbound Proxy Server. \\ \\
+. //port// \\
+Enter the Outbound Proxy Server port. \\ \\
+. //reserved// \\
+Reserved space. \\ \\
+. //exitButton// \\
+Button symbol to be used as a check-out button. \\
+<WRAP group 50%>
+^Value ^Description ^
+|*  |'*' ASCII code 42  |
+|#  |'#' ASCII code 35  |
+|0~9  |'0'~'9' ASCII code (48~57)  |
+</WRAP>
+. //reserved1// \\
+Reserved space. \\ \\
+. //numPhoneBook// \\
+Number of phone books. \\ \\
+. //showExtensionNumber// \\
+Determines whether to show the phone book. \\ \\
+. //phonebook// \\
+You can specify up to 128 extensions in your phone book. \\ \\
+. //reserved2// \\
+Reserved space. \\ \\
+==== BS2RtspConfig ====
+<code cpp>
+typedef struct {
+    BS2_USER_ID id;
+    BS2_USER_ID password;
+    BS2_URL address;
+    BS2_PORT port;
+    BS2_BOOL enabled;
+    uint8_t reserved;
+    uint8_t reserved2[32];
+} BS2RtspConfig;
+</code>
+. //id// \\
+Account information when connecting to the RTSP server. \\ \\
+. //password// \\
+Password when connecting to the RTSP server. \\ \\
+. //address// \\
+Enter the address of the RTSP server. \\ \\
+. //port// \\
+Enter the RTSP server connection port. The default port is 554. \\ \\
+. //enabled// \\
+Sets whether an RTSP connection is enabled. \\ \\
+. //reserved// \\
+Reserved space. \\ \\
+. //reserved2// \\
+Reserved space. \\ \\