Differences

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

--- en:device_api [2021/06/06 20:58]
kateyu [BS2DeviceCapabilities]
+++ en:device_api [2024/10/24 14:56] (current)
@@ Line 22: / Line 22: @@
   * [[BS2_RemoveAllAuthOperatorLevelEx]]: [+ 2.6.3] Removes all device operators. (Support operator up to 1000)
   * [[BS2_GetDeviceCapabilities]]: [+ 2.8] Gets available function information of the device.
+  * [[BS2_RunAction]]: [+ 2.8.1] Commands the device to take certain actions.
 ===== Structure =====
 ==== BS2SimpleDeviceInfo ====
@@ Line 67: / Line 68: @@
 <WRAP group 50%>
 ^Value  ^Description  ^
+|0x00  |Unknown Type  |
 |0x01  |BioEntry Plus  |
 |0x02  |BioEntry W  |
@@ Line 80: / Line 82: @@
 |0x0C  |BioStation L2  |
 |0x0D  |BioEntry W2  |
-|0x0E  |CoreStation  |
+|0x0E  |CoreStation 40  |
-|0x0F  |Output Module|
+|0x0F  |Output Module  |
-|0x10  |Input Module|
+|0x10  |Input Module  |
-|0x11  |BioEntry P2|
+|0x11  |BioEntry P2  |
-|0x0F  |OM-120  |
+|0x12  |BioLite N2  |
+|0x13  |XPass2  |
+|0x14  |XPass S3  |
+|0x15  |BioEntry R2  |
+|0x16  |XPass D2  |
+|0x17  |Door Module 21  |
+|0x18  |XPass D2 Keypad  |
+|0x19  |FACELITE  |
+|0x1A  |XPass2 Keypad  |
+|0x1B  |XPass D2 Revision  |
+|0x1C  |XPass D2 Keypad Revision  |
+|0x1D  |FaceStation F2 Finger  |
+|0x1E  |FaceStation F2  |
+|0x1F  |XStation 2 QR  |
+|0x20  |XStation 2  |
+|0x21  |Input Module 120  |
+|0x22  |XStation 2 Finger  |
+|0x23  |BioStation 3  |
+|0x24  |3rd party OSDP device  |
+|0x25  |3rd party OSDP IO device  |
+|0x26  |BioStation 2a  |
 </WRAP>
@@ Line 183: / Line 205: @@
         BS2_SUPPORT_DESFIREEX	= 0x00000008,
         BS2_SUPPORT_FACE_EX	= 0x00000010,
+        BS2_SUPPORT_QR     	= 0x00000020,
         BS2_SUPPORT_FINGER_SCAN	= 0x00010000,
         BS2_SUPPORT_FACE_SCAN	= 0x00020000,
         BS2_SUPPORT_FACE_EX_SCAN = 0x00040000,
+        BS2_SUPPORT_QR_SCAN     = 0x00080000,
-        BS2_SUPPORT_ALL     	= BS2_SUPPORT_RS485EX | BS2_SUPPORT_CARDEX | BS2_SUPPORT_DST | BS2_SUPPORT_DESFIREEX | BS2_SUPPORT_FACE_EX | BS2_SUPPORT_FINGER_SCAN | BS2_SUPPORT_FACE_SCAN | BS2_SUPPORT_FACE_EX_SCAN,
+        BS2_SUPPORT_ALL     	= BS2_SUPPORT_RS485EX |
+				  BS2_SUPPORT_CARDEX |
+				  BS2_SUPPORT_DST |
+				  BS2_SUPPORT_DESFIREEX |
+				  BS2_SUPPORT_FACE_EX |
+				  BS2_SUPPORT_QR |
+				  BS2_SUPPORT_FINGER_SCAN |
+				  BS2_SUPPORT_FACE_SCAN |
+				  BS2_SUPPORT_FACE_EX_SCAN |
+				  BS2_SUPPORT_QR_SCAN,
     };
     uint32_t supported;
@@ Line 205: / Line 238: @@
 |BS2_SUPPORT_DESFIREEX |0x00000008 |Whether DesFire advanced setting is supported [+2.6.4] |
 |BS2_SUPPORT_FACE_EX |0x00000010 |Whether support face matching for FSF2 [+ V2.7.1] |
+|BS2_SUPPORT_QR |0x00000020 |Whether support QR matching ''XStation 2 QR'' [+ V2.8.0] |
 |BS2_SUPPORT_FINGER_SCAN |0x00010000 |Whether support fingerprint scan [+ V2.7.1] |
 |BS2_SUPPORT_FACE_SCAN |0x00020000 |Whether support face scan for FS2 and FL [+ V2.7.1] |
 |BS2_SUPPORT_FACE_EX_SCAN |0x00040000 |Whether support face scan for FSF2 [+ V2.7.1] |
-|BS2_SUPPORT_ALL  |0x0000000F  |Whether to provide additional full information |
+|BS2_SUPPORT_QR_SCAN |0x00080000 |Whether support QR scan ''XStation 2'' [+ V2.8.0] |
+|BS2_SUPPORT_ALL  |0x000FFFFF  |Whether to provide additional full information |
 </WRAP>
@@ Line 231: / Line 266: @@
 <WRAP group 100%>
 ^Value  ^Description  ^Supported data format  ^
-|0  |UI(Langauge pack)  |Suprema language pack |
+|0  |UI(Language pack)  |Suprema language pack |
 |1  |Notice message  | UTF-8 string |
 |2  |Image(Background)  | PNG |
@@ Line 304: / Line 339: @@
 </WRAP>
 . //reserved// \\
-Reserved space \\
+Reserved space \\ \\
 ==== BS2DeviceCapabilities ====
@@ Line 348: / Line 385: @@
             uint32_t NFC: 1;
             uint32_t BLE: 1;
-            uint32_t reserved: 21;
+            uint32_t CustomClassicPlus: 1;
+            uint32_t CustomDesFireEV1: 1;
+            uint32_t TOM_NFC: 1;
+            uint32_t TOM_BLE: 1;
+            uint32_t CustomFelica: 1;
+            uint32_t reserved: 16;
             uint32_t useCardOperation: 1;
         };
@@ Line 474: / Line 516: @@
     uint8_t intelligentPDSupported: 1;
-    uint8_t unused2: 7;
+    uint8_t updateUserSupported: 1;
+    uint8_t simulatedUnlockSupported: 1;
+    uint8_t smartCardByteOrderSupported: 1;
+    uint8_t treatAsCSNSupported: 1;
+    uint8_t rtspSupported: 1;
+    uint8_t lfdSupported: 1;
+    uint8_t visualQRSupported: 1;
+    uint8_t maxVoipExtensionNumbers;		///< 1 byte
+    uint8_t osdpStandardCentralSupported : 1;		///< 1 byte
+    uint8_t enableLicenseFuncSupported : 1;   ///< 1 byte
+    uint8_t keypadBacklightSupported: 1;
+    uint8_t uzWirelessLockDoorSupported: 1;
+    uint8_t customSmartCardSupported: 1;
+    uint8_t tomSupported: 1;
+    uint8_t tomEnrollSupported: 1;
+    uint8_t showOsdpResultbyLED: 1;
+    uint8_t customSmartCardFelicaSupported: 1;
+    uint8_t ignoreInputAfterWiegandOut: 1;
+    uint8_t setSlaveBaudrateSupported: 1;
+    uint8_t rtspResolutionChangeSupported: 1;
+    uint8_t voipResolutionChangeSupported: 1;
+    uint8_t voipTransportChangeSupported: 1;
+    uint8_t authMsgUserInfoSupported: 1;
+    uint8_t scrambleKeyboardModeSupported: 1;
+    uint16_t visualFaceTemplateVersion;
+    uint8_t authDenyMaskSupported: 1;
+    uint8_t unused: 7;
+    uint8_t unused2;
+    uint8_t reserved[424];
-    uint8_t reserved[431];
 } BS2DeviceCapabilities;
 </code>
@@ Line 519: / Line 596: @@
 . //System support information// \\
 It indicates the system information supported by the device in bit units as follows. \\
-^Bit position  ^Number of bit  ^Member   ^Description  ^
+^Bit position  ^Number of bit  ^Member  ^Description  ^
-|0  |1  |cameraSupported  |Camera Support or not   |
+|0  |1  |cameraSupported  |Camera Support or not  |
 |1  |1  |tamperSupported  |Tamper Support or not  |
 |2  |1  |wlanSupported  |WLAN Support or not  |
-|3  |1  |displaySupported  |Available LCD or not |
+|3  |1  |displaySupported  |Available LCD or not  |
-|4  |1  |thermalSupported  |TCM 10 (Thermal Detection) Support or not |
+|4  |1  |thermalSupported  |TCM 10 (Thermal Detection) Support or not  |
 |5  |1  |maskSupported  |Mask Detection Support or not  |
-|6  |1  |faceExSupported  |Visual Face device such as FaceStation F2 or not |
+|6  |1  |faceExSupported  |Visual Face device such as FaceStation F2 or not  |
 |7  |1  |unused  |Unassigned  |
 . //cardSupported// \\
-This indicates the card support relevant. \\
+This indicates the card support relevant. Referring to mask value, you can access each item in its entirety or in bit units. \\
-Referring to mask value, you can access each item in its entirety or in bit units. \\
+^Bit position  ^Number of bit  ^Member  ^Description  ^
-^Bit position  ^Number of bit  ^Member   ^Description  ^
+|-  |Total  |mask  |	total Information  |
-|-  |Total  |mask  |total Information  |
 |0  |1  |EM  |EM Card  |
 |1  |1  |HIDProx  |HID Proximity Card  |
@@ Line 543: / Line 619: @@
 |8  |1  |NFC  |NFC Card  |
 |9  |1  |BLE  |BLE  |
-|10 |21 |reserved  |Unassigned  |
+|10 |1  |ClassicPlus(Custom card)  |ClassicPlus(Custom Card)  |
+|11 |1  |DesFireEV1(Custom card)  |DesFireEV1(Custom Card)  |
+|12 |1  |TOM NFC  |TOM NFC  |
+|13 |1  |TOM BLE  |TOM BLE  |
+|14 |1  |FeliCa(Custom card)  | FeliCa (Custom Card)  |
+|15 |16 |reserved  |Unassigned  |
 |31 |1  |useCardOperation  |Card operation enabled or not  |
 . //authSupported// \\
@@ Line 552: / Line 633: @@
 . //credentials// \\
 This indicates supported authentication methods. You can access each item in its entirety or in bit units as a mask value. \\
-^Bit position  ^Number of bit  ^Member   ^Description  ^
+^Bit position  ^Number of bit  ^Member  ^Description  ^
 |-  |Total  |mask  |Total Information  |
 |0  |1  |card  |Card  |
@@ Line 566: / Line 647: @@
 . //biometricAuth// \\
 (Non-extended authentication mode) Indicates the biometric authentication combination. \\
-^Bit position  ^Number of bit  ^Member   ^Description  ^
+^Bit position  ^Number of bit  ^Member  ^Description  ^
 |-  |Total  |mask  |Total Information  |
 |0  |1  |biometricOnly  |Biometric only  |
@@ Line 573: / Line 654: @@
 . //cardAuth// \\
 (Non-extended authentication mode) Indicates the card authentication combination. \\
-^Bit position  ^Number of bit  ^Member   ^Description  ^
+^Bit position  ^Number of bit  ^Member  ^Description  ^
 |-  |Total  |mask  |Total Information  |
 |0  |1  |cardOnly  |Card only  |
@@ Line 583: / Line 664: @@
 . //idAuth// \\
 (Non-extended authentication mode) Indicates the ID authentication combination. \\
-^Bit position  ^Number of bit  ^Member   ^Description  ^
+^Bit position  ^Number of bit  ^Member  ^Description  ^
 |-  |Total  |mask  |Total Information  |
 |0  |1  |idBiometric  |ID + Biometric  |
@@ Line 589: / Line 670: @@
 |2  |1  |idBiometricOrPIN  |ID + Biometric/PIN  |
 |3  |1  |idBiometricPIN  |ID + Biometric + PIN  |
-|4  |4  |unused  |미할당 필드.  |
+|4  |4  |unused  |Unassigned  |
 . //extended// \\
 This information is referenced when supporting extended authentication mode. \\ \\
 . //faceAuth// \\
 (Extended authentication mode) Indicates the face authentication combination. \\
-^Bit position  ^Number of bit  ^Member   ^Description  ^
+^Bit position  ^Number of bit  ^Member  ^Description  ^
 |-  |Total  |mask  |Total Information  |
 |0  |1  |faceOnly  |Face only  |
@@ Line 604: / Line 685: @@
 . //fingerprintAuth// \\
 (Extended authentication mode) Indicates a combination of fingerprint authentication. \\
-^Bit position  ^Number of bit  ^Member   ^Description  ^
+^Bit position  ^Number of bit  ^Member  ^Description  ^
 |-  |Total  |mask  |Total Information  |
 |0  |1  |fingerprintOnly  |Fingerprint only  |
@@ Line 614: / Line 695: @@
 . //cardAuth// \\
 (Extended authentication mode) Indicates the card authentication combination. \\
-^Bit position  ^Number of bit  ^Member   ^Description  ^
+^Bit position  ^Number of bit  ^Member  ^Description  ^
 |-  |Total  |mask  |Total Information  |
 |0  |1  |cardOnly  |Card only  |
@@ Line 634: / Line 715: @@
 . //idAuth// \\
 (Extended authentication mode) Indicates the ID authentication combination. \\
-^Bit position  ^Number of bit  ^Member   ^Description  ^
+^Bit position  ^Number of bit  ^Member  ^Description  ^
 |-  |Total  |mask  |Total Information  |
 |1  |1  |idFace  |ID + Face  |
@@ Line 653: / Line 734: @@
 . //System support information// \\
 It indicates the system information supported by the device in bit units as follows. \\
-^Bit position  ^Number of bit  ^Member   ^Description  ^
+^Bit position  ^Number of bit  ^Member  ^Description  ^
-|0  |1  |intelligentPDSupported  |Intelligent Slave Support or not  |
+|0  |1  |intelligentPDSupported  |Whether Intelligent PD is supported. ([[configuration api#BS2Rs485Config|BS2Rs485Config]])  |
-|1  |7  |unused2  |Unassigned  |
+|1  |1  |updateUserSupported  |Whether User information update is supported.  |
-. //reserved// \\
+|2  |1  |simulatedUnlockSupported  |Whether simulated button unlock is supported.  |
-Reserved space.\\ \\
+|3  |1  |smartCardByteOrderSupported  |Whether smartCardByteOrder is supported. ([[configuration api#BS2CardConfig|BS2CardConfig]])  |
+|4  |1  |treatAsCSNSupported  |Whether treatAsCSN is supported. ([[configuration api#BS2BarcodeConfig|BS2BarcodeConfig]])  |
+|5  |1  |rtspSupported  |Whether RTSP is supported. ([[configuration api#BS2RtspConfig|BS2RtspConfig]])  |
+|6  |1  |lfdSupported  |Whether LFD is supported.  |
+|7  |1  |visualQRSupported  |Whether Visual QR is supported.  |
+. //maxVoipExtensionNumbers// \\
+It is the number of registered internal numbers in the extension phone book at the extended VoIP setting information.\\ \\
+. //System support information 2// \\
+It indicates the system information supported by the device in bit units as follows. \\
+^Bit position  ^Number of bit  ^Member  ^Description  ^
+|0  |1  |osdpStandardCentralSupported  |Whether OSDP Standard is supported. ([[configuration_api#BS2OsdpStandardConfig|BS2OsdpStandardConfig]])  |
+|1  |1  |enableLicenseFuncSupported  |Whether Device license is supported.([[configuration_api#BS2LicenseConfig|BS2LicenseConfig]])  |
+|2  |1  |keypadBacklightSupported  |Whether Keypad backlight is supported.  |
+|3  |1  |uzWirelessLockDoorSupported  |Whether U&Z wireless lock is supported.  |
+|4  |1  |customSmartCardSupported  |Whether Custom card is supported. ([[configuration_api#BS2CustomCardConfig|BS2CustomCardConfig]])  |
+|5  |1  |tomSupported  |Whether ToM is supported.  |
+|6  |1  |tomEnrollSupported  |Whether ToM enrollment is supported.  |
+|7  |1  |showOsdpResultbyLED  |Whether OSDP standard device supports the ability to display authentication results. ([[configuration_api#BS2DisplayConfig|BS2DisplayConfig]])  |
+. //System support information 3// \\
+It indicates the system information supported by the device in bit units as follows. \\
+^Bit position  ^Number of bit  ^Member  ^Description  ^
+|0  |1  |customSmartCardFelicaSupported  |Whether FeliCa custom smart card is supported.  |
+|1  |1  |ignoreInputAfterWiegandOut  |Whether a feature to filter out repetitive re-entry of Wiegand output results is included.  |
+|2  |1  |setSlaveBaudrateSupported  |Whether to support baudrate setting of RS485 slave device.  |
+|3  |1  |rtspResolutionChangeSupported  |[+2.9.8] Whether to support changing RTSP video resolution.  |
+|4  |1  |voipResolutionChangeSupported  |[+2.9.8] Whether to support changing intercom video resolution.  |
+|5  |1  |voipTransportChangeSupported  |[+2.9.8] Whether to support changing intercom data transmission method.  |
+|6  |1  |authMsgUserInfoSupported  |[+2.9.8] Whether to support changing the method of displaying user information on the authentication screen.  |
+|7  |1  |scrambleKeyboardModeSupported  |[+2.9.8] Whether to support changing the use of scramble keypad.  |
+. //visualFaceTemplateVersion// \\
+[+2.9.8] For visual face devices, indicates template version information supported by the device. \\ \\
+. //System support information 4// \\
+[+2.9.8] It indicates the system information supported by the device in bit units as follows.
+^Bit position  ^Number of bit  ^Member  ^Description  ^
+|0  |1  |authDenyMaskSupported  |Whether to support for the require no mask setting in facial authentication.  |
+|1  |7  |unused  |Unassigned  |
+. //unused2// \\
+Reserved space.\\ \\
+. //reserved// \\
+Reserved space.\\ \\