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 [2025/07/11 10:10]
kkshin [BS2AuthOperatorLevel]
en:device_api [2026/03/11 15:56] (current)
Line 23: Line 23:
   * [[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_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 107: 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 318: Line 330:
  
 ==== BS2AuthOperatorLevel ==== ==== BS2AuthOperatorLevel ====
-<callout type="​warning"​ icon="​true">​To use the Operator feature properly, **at least one administrator(//​OPERATOR_LEVEL_ADMIN//)** must be configured on the device.+<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>​ If no administrator is assigned, **any user will be able to access the device menu without restriction**.</​callout>​
 <code cpp> <code cpp>
Line 549: Line 561:
     uint16_t visualFaceTemplateVersion;​     uint16_t visualFaceTemplateVersion;​
     ​     ​
 +    //​-------------------------------------------------------------------------------- 2 byte
 +
     uint8_t authDenyMaskSupported:​ 1;     uint8_t authDenyMaskSupported:​ 1;
-    uint8_t ​unused7+    uint8_t ​mifareExSupported1
-     +    ​uint8_t lockOverrideSupported:​ 1; 
-    uint8_t ​unused2+    uint8_t ​doorModeOverrideSupported:​ 1
-     +    ​uint8_t alternateAccessTimerSupported:​ 1; 
-    uint8_t reserved[424];​ +    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;​ } BS2DeviceCapabilities;​
 </​code>​ </​code>​
Line 771: Line 798:
 39. //​visualFaceTemplateVersion//​ \\ 39. //​visualFaceTemplateVersion//​ \\
 [+2.9.8] For visual face devices, indicates template version information supported by the device. \\ \\ [+2.9.8] For visual face devices, indicates template version information supported by the device. \\ \\
-40. //​System ​support information ​4// \\ +40. //​System ​Support Information ​4// \\ 
-[+2.9.8It indicates ​the system information supported by the device in bit units as follows. +[+2.9.12Indicates ​the system information supported by the device in bit units as follows. ​\\ 
-^Bit position ​ ​^Number of bit  ​^Member ​ ^Description ​ ^ +^Bit Position ​ ​^Number of Bits  ​^Member ​Name  ​^Description ​ ^ 
-|0  |1  |authDenyMaskSupported ​ |Whether to support ​for the require no mask setting ​in facial authentication | +|0  |1  |authDenyMaskSupported ​ |Whether to support mask wearing prohibition ​in facial authentication ​ | 
-|1  |7  |unused ​ |Unassigned ​ | +|1  ​|1  |mifareExSupported ​ |Whether Mifare CardEx is supported ​ | 
-41. //unused2// \\ +|2  |1  |lockOverrideSupported ​ |Whether lock override is supported ​ | 
-Reserved space.\\ \\+|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  | |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//​ \\  42. //​reserved//​ \\ 
 Reserved space.\\ \\ Reserved space.\\ \\