Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:device_api [2023/08/16 15:51] mashin [BS2DeviceCapabilities] |
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 380: | 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 515: | Line 525: | ||
| uint8_t maxVoipExtensionNumbers; ///< 1 byte | uint8_t maxVoipExtensionNumbers; ///< 1 byte | ||
| + | |||
| uint8_t osdpStandardCentralSupported : 1; ///< 1 byte | uint8_t osdpStandardCentralSupported : 1; ///< 1 byte | ||
| uint8_t enableLicenseFuncSupported : 1; ///< 1 byte | uint8_t enableLicenseFuncSupported : 1; ///< 1 byte | ||
| Line 521: | Line 532: | ||
| uint8_t customSmartCardSupported: 1; | uint8_t customSmartCardSupported: 1; | ||
| uint8_t tomSupported: 1; | uint8_t tomSupported: 1; | ||
| - | uint8_t unused2: 2; ///< 1 byte | + | 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[429]; | + | uint8_t reserved[424]; |
| } BS2DeviceCapabilities; | } BS2DeviceCapabilities; | ||
| </code> | </code> | ||
| - | 1. //maxUsers// \\ | + | 1. //maxUsers// \\ |
| Indicates the maximum number of information that can be stored on the device. (User) \\ \\ | Indicates the maximum number of information that can be stored on the device. (User) \\ \\ | ||
| - | 2. //maxEventLogs// \\ | + | 2. //maxEventLogs// \\ |
| Indicates the maximum number of information that can be stored on the device. (Event log) \\ \\ | Indicates the maximum number of information that can be stored on the device. (Event log) \\ \\ | ||
| - | 3. //maxImageLogs// \\ | + | 3. //maxImageLogs// \\ |
| Indicates the maximum number of information that can be stored on the device. (Image log) \\ \\ | Indicates the maximum number of information that can be stored on the device. (Image log) \\ \\ | ||
| 4. //maxBlacklists// \\ | 4. //maxBlacklists// \\ | ||
| Line 536: | Line 556: | ||
| 5. //maxOperators// \\ | 5. //maxOperators// \\ | ||
| Indicates the maximum number of information that can be stored on the device. (Operator) \\ \\ | Indicates the maximum number of information that can be stored on the device. (Operator) \\ \\ | ||
| - | 6. //maxCards// \\ | + | 6. //maxCards// \\ |
| Indicates the maximum number of information that can be stored on the device. (Card) \\ \\ | Indicates the maximum number of information that can be stored on the device. (Card) \\ \\ | ||
| - | 7. //maxFaces// \\ | + | 7. //maxFaces// \\ |
| Indicates the maximum number of information that can be stored on the device. (Face) \\ \\ | Indicates the maximum number of information that can be stored on the device. (Face) \\ \\ | ||
| - | 8. //maxFingerprints// \\ | + | 8. //maxFingerprints// \\ |
| Indicates the maximum number of information that can be stored on the device. (Fingerprint) \\ \\ | Indicates the maximum number of information that can be stored on the device. (Fingerprint) \\ \\ | ||
| 9. //maxUserNames// \\ | 9. //maxUserNames// \\ | ||
| Line 576: | Line 596: | ||
| |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 590: | 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 710: | Line 734: | ||
| |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. //System support information 2// \\ | 37. //System support information 2// \\ | ||
| 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 |osdpStandardCentralSupported |Whether OSDP Standard is supported. ([[configuration_api#BS2OsdpStandardConfig|BS2OsdpStandardConfig]]) | | |0 |1 |osdpStandardCentralSupported |Whether OSDP Standard is supported. ([[configuration_api#BS2OsdpStandardConfig|BS2OsdpStandardConfig]]) | | ||
| - | |1 |1 |enableLicenseFuncSupported |Whether Device license is supported. ([[configuration_api#BS2LicenseConfig|BS2LicenseConfig]]) | | + | |1 |1 |enableLicenseFuncSupported |Whether Device license is supported.([[configuration_api#BS2LicenseConfig|BS2LicenseConfig]]) | |
| |2 |1 |keypadBacklightSupported |Whether Keypad backlight is supported. | | |2 |1 |keypadBacklightSupported |Whether Keypad backlight is supported. | | ||
| |3 |1 |uzWirelessLockDoorSupported |Whether U&Z wireless lock is supported. | | |3 |1 |uzWirelessLockDoorSupported |Whether U&Z wireless lock is supported. | | ||
| |4 |1 |customSmartCardSupported |Whether Custom card is supported. ([[configuration_api#BS2CustomCardConfig|BS2CustomCardConfig]]) | | |4 |1 |customSmartCardSupported |Whether Custom card is supported. ([[configuration_api#BS2CustomCardConfig|BS2CustomCardConfig]]) | | ||
| |5 |1 |tomSupported |Whether ToM is supported. | | |5 |1 |tomSupported |Whether ToM is supported. | | ||
| - | |6 |2 |unused2 |Unassigned | | + | |6 |1 |tomEnrollSupported |Whether ToM enrollment is supported. | |
| - | 38. //reserved// \\ | + | |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.\\ \\ | Reserved space.\\ \\ | ||