Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
en:configuration_api [2024/05/28 19:28]
kkshin [BS2FaceConfig] 		en:configuration_api [2024/10/24 14:56] (current)
Line 396: Line 396:
     uint8_t showOsdpResult;​     uint8_t showOsdpResult;​
     uint8_t reserved1[30];​     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//​** \\  **1. //​language//​** \\ 
 Language code. \\  Language code. \\ 
Line 508: Line 514:
 |1  |Do Not Display OSDP Authentication Result ​ | |1  |Do Not Display OSDP Authentication Result ​ |
 </​WRAP>​ </​WRAP>​
 +
 19. //​reserved1//​ \\  19. //​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 ==== ==== BS2IpConfig ====
Line 921: Line 954:
 <WRAP group 50%> <WRAP group 50%>
 ^Value ​ ^Description ​ ^ ^Value ​ ^Description ​ ^
-|0  |Not use  | 
 |1  |Master ​ | |1  |Master ​ |
 |2  |Slave ​ | |2  |Slave ​ |
Line 1130: Line 1162:
     uint8_t numInputs;     uint8_t numInputs;
     uint8_t numSupervised;​     uint8_t numSupervised;​
-    uint16_t ​reseved;+    ​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 {     struct {
         uint8_t portIndex;         uint8_t portIndex;
Line 1170: Line 1211:
 |255  |Custom ​ | |255  |Custom ​ |
 </​WRAP>​ </​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//​** \\  **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 . \\  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 1957: Line 2004:
 <WRAP group 50%> <WRAP group 50%>
 ^Value ^Description ^ ^Value ^Description ^
-|0  |Not use  | 
 |1  |Master ​ | |1  |Master ​ |
 |2  |Slave ​ | |2  |Slave ​ |
 |3  |Standalone ​ | |3  |Standalone ​ |
 +</​WRAP>​
 +<WRAP info>
 +CoreStation can only be used as a Master. Other values cannot be configured.
 </​WRAP>​ </​WRAP>​
 7. //​numOfChannels//​ \\  7. //​numOfChannels//​ \\ 
Line 2401: Line 2450:
 </​WRAP>​ </​WRAP>​
 2. //​maskCheckMode//​ \\  2. //​maskCheckMode//​ \\ 
-''​FaceStation F2''​ Sets the Mask Check Mode. \\  +''​Visual Face based''​ Sets the Mask Check Mode. \\
-''​FaceStation 2''​ This setting is ignored. \\ +
 When set to HARD, access is denied if not detecting any mask on the face based on maskDetectionLevel. \\ 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. \\ 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. \\ 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%> <WRAP group 50%>
 ^Value ​ ^Description ​ ^Default ​ ^ ^Value ​ ^Description ​ ^Default ​ ^
Line 2413: Line 2461:
 |1  |Mask Check Mode (HARD) ​ |  | |1  |Mask Check Mode (HARD) ​ |  |
 |2  |Mask Check Mode (SOFT) ​ |  | |2  |Mask Check Mode (SOFT) ​ |  |
 +|3  |Require no mask  |  |
 </​WRAP>​ </​WRAP>​
 3. //​reserved//​ \\  3. //​reserved//​ \\ 
Line 2426: Line 2475:
 Reserved \\ \\ Reserved \\ \\
 6. //​thermalThresholdLow//​ \\ 6. //​thermalThresholdLow//​ \\
-''​Supported version''​ : ''​FaceStation F2 V1.0.2'',​ ''​FaceStation 2 V1.5.0''​ \\  
 This is the range value for determining high temperature and must be entered as a value multiplied by 100 of the temperature to be set. \\ This is the range value for determining high temperature and must be entered as a value multiplied by 100 of the temperature to be set. \\
 Also, you can only enter in degrees Celsius. \\ Also, you can only enter in degrees Celsius. \\
Line 2439: Line 2487:
 And you must set a value greater than thermalThresholdLow. \\ \\ And you must set a value greater than thermalThresholdLow. \\ \\
 8. //​maskDetectionLevel//​ \\ 8. //​maskDetectionLevel//​ \\
-''​FaceStation F2''​ Sets the mask detection level. The detecting level is based on internal setting value. \\ +''​Visual Face based''​ Sets the mask detection level. The detecting level is based on internal setting value. \\
-''​FaceStation 2''​ This setting is ignored. \\ +
 <WRAP group 50%> <WRAP group 50%>
 ^Value ^Description ​ ^Default ​ ^ ^Value ^Description ​ ^Default ​ ^
Line 2732: Line 2779:
     BS2ExtensionNumber phonebook[128];​     BS2ExtensionNumber phonebook[128];​
  
-    uint8_t reserved2[32];        ///< ​32 bytes (reserved)+    ​uint8_t resolution;​ 
 +    uint8_t transport;​ 
 +    ​uint8_t reserved2[30]; ///< ​30 bytes (reserved)
 } BS2VoipConfigExt;​ } BS2VoipConfigExt;​
 </​code>​ </​code>​
Line 2786: Line 2835:
 22. //​phonebook//​ \\ 22. //​phonebook//​ \\
 You can specify up to 128 extensions in your phone book. \\ \\ You can specify up to 128 extensions in your phone book. \\ \\
-23. //​reserved2//​ \\+23. //​resolution//​ \\ 
 +[+2.9.8] Sets the resolution of video output. \\ 
 +<WRAP group 50%> 
 +^Value ​ ^Description ​ ^ 
 +|0  |360 x 640  | 
 +|1  |720 x 480  | 
 +</​WRAP>​  
 + 
 +24. //​transport//​ \\ 
 +[+2.9.8] Sets the data transfer method. 
 +<WRAP group 50%> 
 +^Value ​ ^Description ​ ^ 
 +|0  |UDP  | 
 +|1  |TCP  | 
 +|2  |SSL  | 
 +</​WRAP>​  
 +25. //​reserved2//​ \\
 Reserved space. \\ \\ Reserved space. \\ \\
  
Line 2800: Line 2865:
     BS2_PORT port;     BS2_PORT port;
     BS2_BOOL enabled;     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;​ } BS2RtspConfig;​
 </​code>​ </​code>​
Line 2817: Line 2883:
 6. //​reserved//​ \\ 6. //​reserved//​ \\
 Reserved space. \\ \\ Reserved space. \\ \\
-7. //​reserved2//​ \\+7. //​resolution//​ \\ 
 +[+2.9.8] Sets the resolution of video output. 
 +<WRAP group 50%> 
 +^Value ​ ^Description ​ ^ 
 +|0  |180 x 320  | 
 +|1  |720 x 480  | 
 +</​WRAP>​  
 +8. //​reserved2//​ \\
 Reserved space. \\ \\ Reserved space. \\ \\
  
Line 2888: Line 2961:
 License information and can be set up to 16. \\ \\ License information and can be set up to 16. \\ \\
 5. //​reserved1//​ \\  5. //​reserved1//​ \\ 
-Reserved Space. \\ \\ 
- 
- 
-==== BS2BarcodeConfig ==== 
-<code cpp> 
-typedef struct { 
-    uint8_t useBarcode; 
-    uint8_t scanTimeout;​ 
-    uint8_t bypassData; 
-    uint8_t treatAsCSN; 
- 
- uint8_t useVisualBarcode;​ 
- uint8_t motionSensitivity;​ 
-    uint8_t visualCameraScanTimeout;​ 
-    uint8_t reserved[9];​ 
-} BS2BarcodeConfig;​ 
-</​code>​ 
-1. //​useBarcode//​ \\  
-''​Supports XS2-QR models only''​ 
-Barcode usage flag. \\ \\  
-2. //​scanTimeout//​ \\  
-Set the Barcode scan time. The unit is in seconds. \\ 
-The default is 4 seconds, and can be entered within a range of 4 to 10 seconds. \\ \\ 
-<WRAP group 50%> 
-^Value ​ ^Macro ​ ^Description ​ ^ 
-|4  |BS2_BARCODE_TIMEOUT_DEFAULT ​ |Default ​ | 
-|4  |BS2_BARCODE_TIMEOUT_MIN ​ |Min Value  | 
-|10  |BS2_BARCODE_TIMEOUT_MAX ​ |Max Value  | 
-</​WRAP>​ 
-3. //​bypassData//​ \\  
-[+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. \\ \\ 
-4. //​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. \\ \\ 
-5. //​useVisualBarcode//​ \\ 
-[+2.9.1] Visual barcode usage flag. \\ 
-<WRAP group 50%> 
-^Supported devices ​ ^Firmware ​ ^ 
-|XS2-Finger ​ |V1.2.0 ​ | 
-|XS2-Card ​ |V1.2.0 ​ | 
-|BS3  |V1.1.0 ​ | 
-</​WRAP>​ 
-Visual barcode scans QR code with a general visual camera instead of a QR code sensor, \\ 
-and a separate license activation is required to use this feature. \\ 
-License activation is supported through [[BS2_EnableDeviceLicense]]. \\ \\ 
-6. //​motionSensitivity//​ \\ 
-[+2.9.1] Set the sensitivity of motion sensor for visual barcode. \\ 
-<WRAP group 50%> 
-^Value ​ ^Macro ​ ^Description ​ ^ 
-|0  |BS2_MOTION_SENSITIVITY_LOW ​ |Low  | 
-|1  |BS2_MOTION_SENSITIVITY_NORMAL ​ |Normal ​ | 
-|2  |BS2_MOTION_SENSITIVITY_HIGH ​ |High  | 
-</​WRAP>​ 
-7. //​visualCameraScanTimeout//​ \\ 
-[+2.9.1] Set the scan time for the visual camera. Units are seconds. \\ 
-The default is 10 seconds, and can be entered within a range of 3 to 20 seconds. \\ 
-<WRAP group 50%> 
-^Value ​ ^Macro ​ ^Description ​ ^ 
-|10  |BS2_VISUAL_BARCODE_TIMEOUT_DEFAULT ​ |Default ​ | 
-|3  |BS2_VISUAL_BARCODE_TIMEOUT_MIN ​ |Min Value  | 
-|20  |BS2_VISUAL_BARCODE_TIMEOUT_MAX ​ |Max Value  | 
-</​WRAP>​ 
-8. //​reserved//​ \\  
 Reserved Space. \\ \\ Reserved Space. \\ \\