Differences

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

--- en:configuration_api [2021/08/06 15:15]
kateyu
+++ en:configuration_api [2022/10/05 14:25]
kateyu [BS2FaceConfig]
@@ 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. \\ \\
+The default values of min and max are as follows. \\
+[+ 2.8.3] ''BioStation 3'' The settings are ignored. \\
+<WRAP group 30%>
+^  ^Default(min)  ^Default(max)  ^
+|FSF2  |66  |250  |
+|BS3  |-  |-  |
+</WRAP>
 **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 30%>
+^  ^Default(x)  ^Default(width)  ^
+|FSF2  |144  |432  |
+|BS3  |-  |-  |
+</WRAP>
+**14. //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(No limit)  ^Max sensing range(Default)  ^
+|BS3  |30  |100  |60  |40  |100  |255  |100  |
+</WRAP>
+**15. //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 ====
@@ Line 2410: / Line 2441: @@
     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 2435: / Line 2481: @@
         uint8_t    reserved;
-        uint8_t    supervisedResister;
+        uint8_t    supervisedResistor;
         uint8_t    reserved1[16];
@@ Line 2444: / Line 2490: @@
 } BS2InputConfigEx;
 </code>
 . //numInputs// \\
- 	Number of Input port. \\ \\
+Number of Input port. \\ \\
 . //numSupervised// \\
- 	Number of supervised input port. \\ \\
+Number of supervised input port. \\ \\
 . //reserved// \\
- 	Reserved Space. \\ \\
+Reserved Space. \\ \\
 . //portIndex// \\
- 	Input Port Number. \\ \\
+Input Port Number. \\ \\
-. //switchType// \\
+. //switchType// \\
- 	Input Signal Type\\
+Input Signal Type. \\
- 	<WRAP group 50%>
+<WRAP group 50%>
- 	^Value  ^Description  ^
+^Value  ^Description  ^
- 	|0  |Normally Open  |
+|0  |Normally Open  |
- 	|1  |Normally Closed  |
+|1  |Normally Closed  |
- 	</WRAP>
+</WRAP>
 . //duration// \\
- 	Input Signal Duration Time Measurement is milliseconds(ms). \\ \\
+Input Signal Duration Time Measurement is milliseconds(ms). \\ \\
 . //reserved// \\
- 	Reserved Space. \\ \\
+Reserved Space. \\ \\
-. //supervisedResister// \\
+. //supervisedResistor// \\
- 	You can set Supervised input resistance value type or unsupervise it. \\
+You can set Supervised input resistance value type or unsupervise it. \\
- 	<WRAP group 50%>
+<WRAP group 50%>
- 	^Value  ^Description  ^
+^Value  ^Description  ^
- 	|0  |1K Resistance  |
+|0  |1K Resistance  |
- 	|1  |2.2K Resistance  |
+|1  |2.2K Resistance  |
- 	|2  |4.7K Resistance  |
+|2  |4.7K Resistance  |
- 	|3  |10K Resistance  |
+|3  |10K Resistance  |
- 	|254  |Unsupervised(Default)  |
+|254  |Unsupervised(Default)  |
- 	</WRAP>
+</WRAP>
 . //reserved1// \\
- 	Reserved Space. \\ \\
+Reserved Space. \\ \\
 . //reserved2// \\
- 	Reserved Space. \\ \\
+Reserved Space. \\ \\
 . //reserved2// \\
- 	Reserved Space. \\ \\
+Reserved Space. \\ \\
+==== BS2RelayActionConfig ====
- 	==== BS2RelayActionConfig ====
+<code cpp>
- 	<code cpp>
+typedef struct {
- 	typedef struct {
+    uint32_t        deviceID;				///< 4 bytes
- 	    uint32_t        deviceID; ///< 4 bytes
+    uint8_t         reserved[16];			///< 16 bytes
- 	    uint8_t         reserved[16]; ///< 16 bytes
+    struct {
- 	    struct {
+        uint8_t     port;				///< 1 byte (relay port)
- 	        uint8_t     port; ///< 1 byte (relay port)
+        uint8_t     reserved0;				///< 1 byte
- 	        uint8_t     reserved0; ///< 1 byte
+        uint8_t     disconnEnabled;			///< 1 byte (RS485 disconnection)
- 	        uint8_t     disconnEnabled; ///< 1 byte (RS485 disconnection)
+        uint8_t     reserved[9];			///< 9 bytes
- 	        uint8_t     reserved[9]; ///< 9 bytes
+        struct {
- 	        struct {
+            uint8_t port;				///< 1 byte (input port)
- 	            uint8_t port; ///< 1 byte (input port)
+            uint8_t type;				///< 1 byte (linkage/latching/release)
- 	            uint8_t type; ///< 1 byte (linkage/latching/release)
+            uint8_t mask;				///< 1 byte (alarm/fault)
- 	            uint8_t mask; ///< 1 byte (alarm/fault)
+            uint8_t reserved[9];			///< 9 bytes
- 	            uint8_t reserved[9]; ///< 9 bytes
+        } input[BS2_MAX_RELAY_ACTION_INPUT];		///< 192 bytes
- 	        } input[BS2_MAX_RELAY_ACTION_INPUT]; ///< 192 bytes
+    } relay[BS2_MAX_RELAY_ACTION]; 			///< 816 bytes
- 	    } items[BS2_MAX_RELAY_ACTION]; ///< 816 bytes
+    uint8_t			reserved2[152];		///< 152 bytes
- 	    uint8_t reserved2[152]; ///< 152 bytes
+} BS2RelayActionConfig;
- 	} BS2RelayActionConfig;
+</code>
- 	</code>
+. //deviceID// \\
-. //deviceID// \\
+Device Identifier \\ \\
- 	Device Identifier \\ \\
+. //reserved// \\
-. //reserved// \\
+Reserved Space. \\ \\
- 	Reserved Space. \\ \\
+. //relay// \\
-. //items// \\
+Relay Setting Information \\ \\
- 	Relay Setting Information \\ \\
+. //port// \\
-. //port// \\
+Relay port Number. \\ \\
- 	Relay port Number. \\ \\
+. //reserved0// \\
-. //reserved0// \\
+Reserved Space. \\ \\
- 	Reserved Space. \\ \\
+. //disconnEnabled// \\
-. //disconnEnabled// \\
+If set to true, a signal is made when RS485 is disconnected. \\ \\
- 	If set to true, a signal is made when RS485 is disconnected. \\ \\
+. //reserved// \\
-. //reserved// \\
+Reserved Space. \\ \\
- 	Reserved Space. \\ \\
+. //input// \\
-. //input// \\
+Defines to which input ports the relay ports will take action. \\ \\
- 	Defines to which input ports the relay ports will take action. \\ \\
+. //port// \\
-. //port// \\
+Input port Identifier. \\ \\
- 	Input port Identifier. \\ \\
+. //type// \\
-. //type// \\
+Defines in which input type the input will take action. \\
- 	Defines in which input type the input will take action. \\
+If set to Linkage, signal can be made when alarm is set to mask. \\
- 	If set to Linkage, signal can be made when alarm is set to mask. \\
+<WRAP group 50%>
- 	<WRAP group 50%>
+^type  ^Value  ^Description  ^
- 	^type  ^Value  ^Description  ^
+|NONE  |0  |OFF  |
- 	|NONE  |0  |OFF  |
+|LINKAGE  |1  |Connect to the relay of the input  |
- 	|LINKAGE  |1  |Connect to the relay of the input  |
+|LATCHING  |2  |''Not Supported''  |
- 	|LATCHING  |2  |''Not Supported''  |
+|RELEASE  |3  |''Not Supported''  |
- 	|RELEASE  |3  |''Not Supported''  |
+</WRAP>
- 	</WRAP>
+. //mask// \\
-. //mask// \\
+Set mask to Input Signal Info. \\
- 	Set mask to Input Signal Info. \\
+<WRAP group 50%>
- 	<WRAP group 50%>
+^type  ^Value  ^Description ^
- 	^type  ^Value  ^Description  ^
+|NONE  |0  |OFF  |
- 	|NONE  |0  |OFF  |
+|ALARM  |1  |Signal Made  |
- 	|ALARM  |1  |Signal Made  |
+|FAULT  |2  |Signal Made when disconnected  |
- 	|FAULT  |2  |Signal Made when disconnected  |
+</WRAP>
- 	</WRAP>
+. //reserved// \\
-. //reserved// \\
+Reserved Space. \\ \\
- 	Reserved Space. \\ \\
+. //reserved2// \\
-. //reserved2// \\
+Reserved Space. \\ \\
- 	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. \\ \\