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:device_api [2022/10/05 14:29]
sungjun 		en:device_api [2024/04/18 08:11] (current)
kkshin
Line 22: Line 22:
   * [[BS2_RemoveAllAuthOperatorLevelEx]]:​ [+ 2.6.3] Removes all device operators. (Support operator up to 1000)   * [[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_GetDeviceCapabilities]]:​ [+ 2.8] Gets available function information of the device.
 +  * [[BS2_RunAction]]:​ [+ 2.8.1] Commands the device to take certain actions.
 ===== Structure ===== ===== Structure =====
 ==== BS2SimpleDeviceInfo ==== ==== BS2SimpleDeviceInfo ====
Line 102: Line 103:
 |0x21  |Input Module 120  | |0x21  |Input Module 120  |
 |0x22  |XStation 2 Finger ​ | |0x22  |XStation 2 Finger ​ |
 +|0x23  |BioStation 3  |
 +|0x24  |3rd party OSDP device ​ |
 +|0x25  |3rd party OSDP IO device ​ |
 +|0x26  |BioStation 2a  |
 </​WRAP>​ </​WRAP>​
  
Line 261: Line 266:
 <WRAP group 100%> <WRAP group 100%>
 ^Value ​ ^Description ​ ^Supported data format ​ ^ ^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 | |1  |Notice message ​ | UTF-8 string |
 |2  |Image(Background) ​ | PNG | |2  |Image(Background) ​ | PNG |
Line 334: Line 339:
 </​WRAP>​ </​WRAP>​
 3. //​reserved//​ \\  3. //​reserved//​ \\ 
-Reserved space \\ +Reserved space \\ \\ 
 + 
  
 ==== BS2DeviceCapabilities ==== ==== BS2DeviceCapabilities ====
Line 378: Line 385:
             uint32_t NFC: 1;             uint32_t NFC: 1;
             uint32_t BLE: 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;             uint32_t useCardOperation:​ 1;
         };         };
Line 504: Line 516:
  
     uint8_t intelligentPDSupported:​ 1;     uint8_t intelligentPDSupported:​ 1;
-    uint8_t ​unused2: 7; +    uint8_t ​updateUserSupported: 1; 
-     +    ​uint8_t simulatedUnlockSupported:​ 1; 
-    uint8_t reserved[431];+    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 unused: 5; 
 + 
 +    uint16_t visualFaceTemplateVersion;​ 
 +    uint8_t unused2[2];​ 
 + 
 +    uint8_t reserved[424];
 } BS2DeviceCapabilities;​ } BS2DeviceCapabilities;​
 </​code>​ </​code>​
Line 549: Line 586:
 20. //System support information//​ \\ 20. //System support information//​ \\
 It indicates the system information supported by the device in bit units as follows. \\ 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  | |1  |1  |tamperSupported ​ |Tamper Support or not  |
 |2  |1  |wlanSupported ​ |WLAN 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  | |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 ​ | |7  |1  |unused ​ |Unassigned ​ |
 21. //​cardSupported//​ \\ 21. //​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  | |0  |1  |EM  |EM Card  |
 |1  |1  |HIDProx ​ |HID Proximity Card  | |1  |1  |HIDProx ​ |HID Proximity Card  |
Line 573: Line 609:
 |8  |1  |NFC  |NFC Card  | |8  |1  |NFC  |NFC Card  |
 |9  |1  |BLE  |BLE  | |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  | |31 |1  |useCardOperation ​ |Card operation enabled or not  |
 22. //​authSupported//​ \\ 22. //​authSupported//​ \\
Line 582: Line 623:
 24. //​credentials//​ \\ 24. //​credentials//​ \\
 This indicates supported authentication methods. You can access each item in its entirety or in bit units as a mask value. \\ 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 ​ | |-  |Total ​ |mask  |Total Information ​ |
 |0  |1  |card  |Card  | |0  |1  |card  |Card  |
Line 596: Line 637:
 27. //​biometricAuth//​ \\ 27. //​biometricAuth//​ \\
 (Non-extended authentication mode) Indicates the biometric authentication combination. \\ (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 ​ | |-  |Total ​ |mask  |Total Information ​ |
 |0  |1  |biometricOnly ​ |Biometric only  | |0  |1  |biometricOnly ​ |Biometric only  |
Line 603: Line 644:
 28. //​cardAuth//​ \\ 28. //​cardAuth//​ \\
 (Non-extended authentication mode) Indicates the card authentication combination. \\ (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 ​ | |-  |Total ​ |mask  |Total Information ​ |
 |0  |1  |cardOnly ​ |Card only  | |0  |1  |cardOnly ​ |Card only  |
Line 613: Line 654:
 29. //idAuth// \\ 29. //idAuth// \\
 (Non-extended authentication mode) Indicates the ID authentication combination. \\ (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 ​ | |-  |Total ​ |mask  |Total Information ​ |
 |0  |1  |idBiometric ​ |ID + Biometric ​ | |0  |1  |idBiometric ​ |ID + Biometric ​ |
Line 619: Line 660:
 |2  |1  |idBiometricOrPIN ​ |ID + Biometric/​PIN ​ | |2  |1  |idBiometricOrPIN ​ |ID + Biometric/​PIN ​ |
 |3  |1  |idBiometricPIN ​ |ID + Biometric + PIN  | |3  |1  |idBiometricPIN ​ |ID + Biometric + PIN  |
-|4  |4  |unused ​ |미할당 필드. ​ |+|4  |4  |unused ​ |Unassigned ​ |
 30. //​extended//​ \\ 30. //​extended//​ \\
 This information is referenced when supporting extended authentication mode. \\ \\ This information is referenced when supporting extended authentication mode. \\ \\
 31. //​faceAuth//​ \\ 31. //​faceAuth//​ \\
 (Extended authentication mode) Indicates the face authentication combination. \\ (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 ​ | |-  |Total ​ |mask  |Total Information ​ |
 |0  |1  |faceOnly ​ |Face only  | |0  |1  |faceOnly ​ |Face only  |
Line 634: Line 675:
 32. //​fingerprintAuth//​ \\ 32. //​fingerprintAuth//​ \\
 (Extended authentication mode) Indicates a combination of fingerprint authentication. \\ (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 ​ | |-  |Total ​ |mask  |Total Information ​ |
 |0  |1  |fingerprintOnly ​ |Fingerprint only  | |0  |1  |fingerprintOnly ​ |Fingerprint only  |
Line 644: Line 685:
 33. //​cardAuth//​ \\ 33. //​cardAuth//​ \\
 (Extended authentication mode) Indicates the card authentication combination. \\ (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 ​ | |-  |Total ​ |mask  |Total Information ​ |
 |0  |1  |cardOnly ​ |Card only  | |0  |1  |cardOnly ​ |Card only  |
Line 664: Line 705:
 34. //idAuth// \\ 34. //idAuth// \\
 (Extended authentication mode) Indicates the ID authentication combination. \\ (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 ​ | |-  |Total ​ |mask  |Total Information ​ |
 |1  |1  |idFace ​ |ID + Face  | |1  |1  |idFace ​ |ID + Face  |
Line 683: Line 724:
 35. //System support information//​ \\ 35. //System support information//​ \\
 It indicates the system information supported by the device in bit units as follows. \\ 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. ​ | |1  |1  |updateUserSupported ​ |Whether User information update is supported. ​ |
 |2  |1  |simulatedUnlockSupported ​ |Whether simulated button unlock 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]]) ​ | |4  |1  |treatAsCSNSupported ​ |Whether treatAsCSN is supported. ([[configuration api#​BS2BarcodeConfig|BS2BarcodeConfig]]) ​ |
 |5  |1  |rtspSupported ​ |Whether RTSP is supported. ([[configuration api#​BS2RtspConfig|BS2RtspConfig]]) ​ | |5  |1  |rtspSupported ​ |Whether RTSP is supported. ([[configuration api#​BS2RtspConfig|BS2RtspConfig]]) ​ |
 |6  |1  |lfdSupported ​ |Whether LFD is supported. ​ | |6  |1  |lfdSupported ​ |Whether LFD is supported. ​ |
 |7  |1  |visualQRSupported ​ |Whether Visual QR is supported. ​ | |7  |1  |visualQRSupported ​ |Whether Visual QR is supported. ​ |
- 
 36. //​maxVoipExtensionNumbers//​ \\  36. //​maxVoipExtensionNumbers//​ \\ 
 It is the number of registered internal numbers in the extension phone book at the extended VoIP setting information.\\ \\  It is the number of registered internal numbers in the extension phone book at the extended VoIP setting information.\\ \\ 
-37. //​reserved//​ \\  +37. //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]]) ​ | 
 +38. //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  |5  |unused ​ |Unassigned ​ |  
 +39. //​visualFaceTemplateVersion//​ \\ 
 +For visual face devices, indicates template version information supported/​processed by the device. \\ \\ 
 +40. //unused2// \\ 
 +Reserved space.\\ \\ 
 +41. //​reserved//​ \\  
 +Reserved space.\\ \\