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 [2024/02/27 13:42] 127.0.0.1 external edit |
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_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. | ||
| + | * [[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 ===== | ===== Structure ===== | ||
| ==== BS2SimpleDeviceInfo ==== | ==== BS2SimpleDeviceInfo ==== | ||
| Line 106: | Line 110: | ||
| |0x25 |3rd party OSDP IO device | | |0x25 |3rd party OSDP IO device | | ||
| |0x26 |BioStation 2a | | |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> | </WRAP> | ||
| Line 317: | Line 330: | ||
| ==== BS2AuthOperatorLevel ==== | ==== 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> | <code cpp> | ||
| typedef struct { | typedef struct { | ||
| Line 537: | Line 552: | ||
| uint8_t ignoreInputAfterWiegandOut: 1; | uint8_t ignoreInputAfterWiegandOut: 1; | ||
| uint8_t setSlaveBaudrateSupported: 1; | uint8_t setSlaveBaudrateSupported: 1; | ||
| - | uint8_t unused: 5; | + | uint8_t rtspResolutionChangeSupported: 1; |
| + | uint8_t voipResolutionChangeSupported: 1; | ||
| + | uint8_t voipTransportChangeSupported: 1; | ||
| + | uint8_t authMsgUserInfoSupported: 1; | ||
| + | uint8_t scrambleKeyboardModeSupported: 1; | ||
| + | |||
| + | | ||
| uint16_t visualFaceTemplateVersion; | uint16_t visualFaceTemplateVersion; | ||
| - | uint8_t unused2[2]; | + | |
| + | //-------------------------------------------------------------------------------- 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 | ||
| - | uint8_t reserved[424]; | ||
| } BS2DeviceCapabilities; | } BS2DeviceCapabilities; | ||
| </code> | </code> | ||
| Line 751: | Line 791: | ||
| |1 |1 |ignoreInputAfterWiegandOut |Whether a feature to filter out repetitive re-entry of Wiegand output results is included. | | |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. | | |2 |1 |setSlaveBaudrateSupported |Whether to support baudrate setting of RS485 slave device. | | ||
| - | |3 |5 |unused |Unassigned | | + | |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// \\ | 39. //visualFaceTemplateVersion// \\ | ||
| - | For visual face devices, indicates template version information supported/processed by the device. \\ \\ | + | [+2.9.8] For visual face devices, indicates template version information supported by the device. \\ \\ |
| - | 40. //unused2// \\ | + | 40. //System Support Information 4// \\ |
| - | Reserved space.\\ \\ | + | [+2.9.12] Indicates the system information supported by the device in bit units as follows. \\ |
| - | 41. //reserved// \\ | + | ^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 | | ||
| + | 41. //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 | | ||
| + | 42. //reserved// \\ | ||
| Reserved space.\\ \\ | Reserved space.\\ \\ | ||