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/12/01 10:09] kkshin [BS2ResourceElement] |
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_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 384: | 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 519: | 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 525: | 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 reserved[429]; | + | 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]; | ||
+ | | ||
} BS2DeviceCapabilities; | } BS2DeviceCapabilities; | ||
</code> | </code> | ||
Line 580: | Line 606: | ||
|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 594: | Line 619: | ||
|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 719: | Line 749: | ||
^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 |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. | | ||
+ | 39. //visualFaceTemplateVersion// \\ | ||
+ | [+2.9.8] For visual face devices, indicates template version information supported by the device. \\ \\ | ||
+ | 40. //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 | | ||
+ | 41. //unused2// \\ | ||
+ | Reserved space.\\ \\ | ||
+ | 42. //reserved// \\ | ||
Reserved space.\\ \\ | Reserved space.\\ \\ |