Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
en:device_api [2021/06/06 20:58] kateyu [BS2DeviceCapabilities] |
en:device_api [2023/09/25 09:23] kkshin |
||
---|---|---|---|
Line 67: | Line 67: | ||
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Description ^ | ^Value ^Description ^ | ||
+ | |0x00 |Unknown Type | | ||
|0x01 |BioEntry Plus | | |0x01 |BioEntry Plus | | ||
|0x02 |BioEntry W | | |0x02 |BioEntry W | | ||
Line 80: | Line 81: | ||
|0x0C |BioStation L2 | | |0x0C |BioStation L2 | | ||
|0x0D |BioEntry W2 | | |0x0D |BioEntry W2 | | ||
- | |0x0E |CoreStation | | + | |0x0E |CoreStation 40 | |
- | |0x0F |Output Module| | + | |0x0F |Output Module | |
- | |0x10 |Input Module| | + | |0x10 |Input Module | |
- | |0x11 |BioEntry P2| | + | |0x11 |BioEntry P2 | |
- | |0x0F |OM-120 | | + | |0x12 |BioLite N2 | |
+ | |0x13 |XPass2 | | ||
+ | |0x14 |XPass S3 | | ||
+ | |0x15 |BioEntry R2 | | ||
+ | |0x16 |XPass D2 | | ||
+ | |0x17 |Door Module 21 | | ||
+ | |0x18 |XPass D2 Keypad | | ||
+ | |0x19 |FACELITE | | ||
+ | |0x1A |XPass2 Keypad | | ||
+ | |0x1B |XPass D2 Revision | | ||
+ | |0x1C |XPass D2 Keypad Revision | | ||
+ | |0x1D |FaceStation F2 Finger | | ||
+ | |0x1E |FaceStation F2 | | ||
+ | |0x1F |XStation 2 QR | | ||
+ | |0x20 |XStation 2 | | ||
+ | |0x21 |Input Module 120 | | ||
+ | |0x22 |XStation 2 Finger | | ||
+ | |0x23 |BioStation 3 | | ||
+ | |0x24 |3rd party OSDP device | | ||
+ | |0x25 |3rd party OSDP IO device | | ||
+ | |0x26 |BioStation 2a | | ||
</WRAP> | </WRAP> | ||
Line 183: | Line 204: | ||
BS2_SUPPORT_DESFIREEX = 0x00000008, | BS2_SUPPORT_DESFIREEX = 0x00000008, | ||
BS2_SUPPORT_FACE_EX = 0x00000010, | BS2_SUPPORT_FACE_EX = 0x00000010, | ||
+ | BS2_SUPPORT_QR = 0x00000020, | ||
BS2_SUPPORT_FINGER_SCAN = 0x00010000, | BS2_SUPPORT_FINGER_SCAN = 0x00010000, | ||
BS2_SUPPORT_FACE_SCAN = 0x00020000, | BS2_SUPPORT_FACE_SCAN = 0x00020000, | ||
BS2_SUPPORT_FACE_EX_SCAN = 0x00040000, | BS2_SUPPORT_FACE_EX_SCAN = 0x00040000, | ||
+ | BS2_SUPPORT_QR_SCAN = 0x00080000, | ||
- | BS2_SUPPORT_ALL = BS2_SUPPORT_RS485EX | BS2_SUPPORT_CARDEX | BS2_SUPPORT_DST | BS2_SUPPORT_DESFIREEX | BS2_SUPPORT_FACE_EX | BS2_SUPPORT_FINGER_SCAN | BS2_SUPPORT_FACE_SCAN | BS2_SUPPORT_FACE_EX_SCAN, | + | BS2_SUPPORT_ALL = BS2_SUPPORT_RS485EX | |
+ | BS2_SUPPORT_CARDEX | | ||
+ | BS2_SUPPORT_DST | | ||
+ | BS2_SUPPORT_DESFIREEX | | ||
+ | BS2_SUPPORT_FACE_EX | | ||
+ | BS2_SUPPORT_QR | | ||
+ | BS2_SUPPORT_FINGER_SCAN | | ||
+ | BS2_SUPPORT_FACE_SCAN | | ||
+ | BS2_SUPPORT_FACE_EX_SCAN | | ||
+ | BS2_SUPPORT_QR_SCAN, | ||
}; | }; | ||
uint32_t supported; | uint32_t supported; | ||
Line 205: | Line 237: | ||
|BS2_SUPPORT_DESFIREEX |0x00000008 |Whether DesFire advanced setting is supported [+2.6.4] | | |BS2_SUPPORT_DESFIREEX |0x00000008 |Whether DesFire advanced setting is supported [+2.6.4] | | ||
|BS2_SUPPORT_FACE_EX |0x00000010 |Whether support face matching for FSF2 [+ V2.7.1] | | |BS2_SUPPORT_FACE_EX |0x00000010 |Whether support face matching for FSF2 [+ V2.7.1] | | ||
+ | |BS2_SUPPORT_QR |0x00000020 |Whether support QR matching ''XStation 2 QR'' [+ V2.8.0] | | ||
|BS2_SUPPORT_FINGER_SCAN |0x00010000 |Whether support fingerprint scan [+ V2.7.1] | | |BS2_SUPPORT_FINGER_SCAN |0x00010000 |Whether support fingerprint scan [+ V2.7.1] | | ||
|BS2_SUPPORT_FACE_SCAN |0x00020000 |Whether support face scan for FS2 and FL [+ V2.7.1] | | |BS2_SUPPORT_FACE_SCAN |0x00020000 |Whether support face scan for FS2 and FL [+ V2.7.1] | | ||
|BS2_SUPPORT_FACE_EX_SCAN |0x00040000 |Whether support face scan for FSF2 [+ V2.7.1] | | |BS2_SUPPORT_FACE_EX_SCAN |0x00040000 |Whether support face scan for FSF2 [+ V2.7.1] | | ||
- | |BS2_SUPPORT_ALL |0x0000000F |Whether to provide additional full information | | + | |BS2_SUPPORT_QR_SCAN |0x00080000 |Whether support QR scan ''XStation 2'' [+ V2.8.0] | |
+ | |BS2_SUPPORT_ALL |0x000FFFFF |Whether to provide additional full information | | ||
</WRAP> | </WRAP> | ||
Line 304: | Line 338: | ||
</WRAP> | </WRAP> | ||
3. //reserved// \\ | 3. //reserved// \\ | ||
- | Reserved space \\ | + | Reserved space \\ \\ |
+ | |||
==== BS2DeviceCapabilities ==== | ==== BS2DeviceCapabilities ==== | ||
Line 474: | Line 510: | ||
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 unused2: 2; ///< 1 byte | ||
+ | |||
+ | uint8_t reserved[429]; | ||
} BS2DeviceCapabilities; | } BS2DeviceCapabilities; | ||
</code> | </code> | ||
Line 519: | Line 570: | ||
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 | | ||
Line 552: | Line 603: | ||
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 566: | Line 617: | ||
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 573: | Line 624: | ||
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 583: | Line 634: | ||
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 589: | Line 640: | ||
|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 604: | Line 655: | ||
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 614: | Line 665: | ||
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 634: | Line 685: | ||
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 653: | Line 704: | ||
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 |Intelligent Slave Support or not | | + | |0 |1 |intelligentPDSupported |Whether Intelligent PD is supported. ([[configuration api#BS2Rs485Config|BS2Rs485Config]]) | |
- | |1 |7 |unused2 |Unassigned | | + | |1 |1 |updateUserSupported |Whether User information update is supported. | |
- | 36. //reserved// \\ | + | |2 |1 |simulatedUnlockSupported |Whether simulated button unlock is supported. | |
- | Reserved space.\\ \\ | + | |3 |1 |smartCardByteOrderSupported |Whether smartCardByteOrder is supported. ([[configuration api#BS2CardConfig|BS2CardConfig]]) | |
+ | |4 |1 |treatAsCSNSupported |Whether treatAsCSN is supported. ([[configuration api#BS2BarcodeConfig|BS2BarcodeConfig]]) | | ||
+ | |5 |1 |rtspSupported |Whether RTSP is supported. ([[configuration api#BS2RtspConfig|BS2RtspConfig]]) | | ||
+ | |6 |1 |lfdSupported |Whether LFD is supported. | | ||
+ | |7 |1 |visualQRSupported |Whether Visual QR is supported. | | ||
+ | 36. //maxVoipExtensionNumbers// \\ | ||
+ | It is the number of registered internal numbers in the extension phone book at the extended VoIP setting information.\\ \\ | ||
+ | 37. //System support information 2// \\ | ||
+ | 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 |2 |unused2 |Unassigned | | ||
+ | 38. //reserved// \\ | ||
+ | Reserved space.\\ \\ |