Differences

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

--- en:device_api [2022/10/05 14:29]
sungjun
+++ en:device_api [2026/03/11 15: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.
+  * [[BS2_GetMasterAdmin]]: [+ 2.9.12] Gets the master admin from the device.
+  * [[BS2_SetMasterAdmin]]: [+ 2.9.12] Sets the master admin on the device.
 ===== Structure =====
 ==== BS2SimpleDeviceInfo ====
@@ Line 102: / Line 106: @@
 |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  |
+|0x27  |UZ OSDP Module  |
+|0x28  |UZ OSDP Door handle  |
+|0x29  |UZ OSDP Door knob  |
+|0x2A  |BioEntry W3  |
+|0x2B  |CoreStation 20  |
+|0x2C  |Door Interface 24  |
+|0x2D  |BioStation 3 MAX  |
+|0x2E  |BioStation 3 MAX FP	 |
+|0x2F  |XPass Q2  |
 </WRAP>
@@ Line 261: / Line 278: @@
 <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 313: / Line 330: @@
 ==== BS2AuthOperatorLevel ====
+<callout type="warning" icon="true">To use the Operator feature properly, **at least one administrator(//BS2_OPERATOR_LEVEL_ADMIN//)** must be configured on the device. \\
+If no administrator is assigned, **any user will be able to access the device menu without restriction**.</callout>
 <code cpp>
 typedef struct {
@@ Line 334: / Line 353: @@
 </WRAP>
 . //reserved// \\
-Reserved space \\
+Reserved space \\ \\
 ==== BS2DeviceCapabilities ====
@@ Line 378: / Line 399: @@
             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 504: / Line 530: @@
     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;
-    uint8_t reserved[431];
+    uint16_t visualFaceTemplateVersion;
+    //-------------------------------------------------------------------------------- 2 byte
+    uint8_t authDenyMaskSupported: 1;
+    uint8_t mifareExSupported: 1;
+    uint8_t lockOverrideSupported: 1;
+    uint8_t doorModeOverrideSupported: 1;
+    uint8_t alternateAccessTimerSupported: 1;
+    uint8_t realtimeIOStatusReportSupported:1;
+    uint8_t dynamicSlaveDeviceNumSupported: 1;
+    uint8_t secureTamperSupported: 1;
+    //-------------------------------------------------------------------------------- 1 byte
+    uint8_t customSmartcardSlaveSupported: 1;
+    uint8_t serverPrivateMsgSupported: 1;
+    uint8_t facilityCodeSupported: 1;
+    uint8_t masterAdminSupported: 1;
+    uint8_t adminTwoStepAuthSupported: 1;
+    uint8_t qrDetectGuideLedSupported: 1;
+    uint8_t unused: 2;
+    uint8_t reserved[424];		///< 424 bytes
 } BS2DeviceCapabilities;
 </code>
@@ Line 549: / Line 625: @@
 . //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 573: / Line 648: @@
 |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 582: / Line 662: @@
 . //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 596: / Line 676: @@
 . //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 603: / Line 683: @@
 . //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 613: / Line 693: @@
 . //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 619: / Line 699: @@
 |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 634: / Line 714: @@
 . //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 644: / Line 724: @@
 . //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 664: / Line 744: @@
 . //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 683: / Line 763: @@
 . //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  |Whether Intelligent PD is supported.([[configuration api#BS2Rs485Config|BS2Rs485Config]])  |
+|0  |1  |intelligentPDSupported  |Whether Intelligent PD is supported. ([[configuration api#BS2Rs485Config|BS2Rs485Config]])  |
 |1  |1  |updateUserSupported  |Whether User information update is supported.  |
 |2  |1  |simulatedUnlockSupported  |Whether simulated button unlock is supported.  |
-|3  |1  |smartCardByteOrderSupported  |Whether smartCardByteOrder is supported ([[configuration api#BS2CardConfig|BS2CardConfig]])  |
+|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.\\ \\
-. //reserved// \\
+. //System support information 2// \\
-Reserved space.\\ \\
+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.12] Indicates the system information supported by the device in bit units as follows. \\
+^Bit Position  ^Number of Bits  ^Member Name  ^Description  ^
+|0  |1  |authDenyMaskSupported  |Whether to support mask wearing prohibition in facial authentication  |
+|1  |1  |mifareExSupported  |Whether Mifare CardEx is supported  |
+|2  |1  |lockOverrideSupported  |Whether lock override is supported  |
+|3  |1  |doorModeOverrideSupported  |Whether door mode override is supported  |
+|4  |1  |alternateAccessTimerSupported  |Whether user override is supported  |
+|5  |1  |realtimeIOStatusReportSupported  |Whether real-time device I/O port status information is provided  |
+|6  |1  |dynamicSlaveDeviceNumSupported  |Whether dynamic slave device connection (up to 128 devices) is supported  |
+|7  |1  |secureTamperSupported  |Whether secure tamper is supported  |
+. //System Support Information 5// \\
+[+2.9.12] Indicates the system information supported by the device in bit units as follows. \\
+^Bit Position  ^Number of Bits  ^Member Name  ^Description  ^
+|0  |1  |customSmartcardSlaveSupported  |Whether custom smart card slave is supported  |
+|1  |1  |serverPrivateMsgSupported  |Whether server private message is supported  |
+|2  |1  |facilityCodeSupported  |Whether facility code is supported  |
+|3  |1  |masterAdminSupported  |Whether master admin is supported  |
+|4  |1  |adminTwoStepAuthSupported  |Whether two-step authentication for master admin is supported  |
+|5  |1  |qrDetectGuideLedSupported  |Whether QR detection LED can be displayed (XPQ2)  |
+|6  |2  |unused  |Unused  |
+. //reserved// \\
+Reserved space.\\ \\