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 [2018/02/27 16:49] yjjung [BS2SimpleDeviceInfo] |
en:device_api [2020/08/28 12:35] yjjung [BS2SimpleDeviceInfoEx] |
||
---|---|---|---|
Line 4: | Line 4: | ||
* [[BS2_GetDeviceInfo]]: Gets the device information. | * [[BS2_GetDeviceInfo]]: Gets the device information. | ||
+ | * [[BS2_GetDeviceInfoEx]]: [+ 2.6.0] Gets additional device information. | ||
* [[BS2_GetDeviceTime]]: Gets the device time. | * [[BS2_GetDeviceTime]]: Gets the device time. | ||
* [[BS2_SetDeviceTime]]: Sets the device time. | * [[BS2_SetDeviceTime]]: Sets the device time. | ||
Line 14: | Line 15: | ||
* [[BS2_UpgradeFirmware]]: Upgrades the firmware. | * [[BS2_UpgradeFirmware]]: Upgrades the firmware. | ||
* [[BS2_UpdateResource]]: Updates the resource. | * [[BS2_UpdateResource]]: Updates the resource. | ||
+ | * [[BS2_GetSpecifiedDeviceInfo]]: [+ 2.6.3] Gets specified device information. | ||
+ | * [[BS2_GetAuthOperatorLevelEx]]: [+ 2.6.3] Gets specified device operator. (Support operator up to 1000) | ||
+ | * [[BS2_GetAllAuthOperatorLevelEx]]: [+ 2.6.3] Gets all device operators. (Support operator up to 1000) | ||
+ | * [[BS2_SetAuthOperatorLevelEx]]: [+ 2.6.3] Sets device operator. (Support operator up to 1000) | ||
+ | * [[BS2_RemoveAuthOperatorLevelEx]]: [+ 2.6.3] Removes specified device operator. (Support operator up to 1000) | ||
+ | * [[BS2_RemoveAllAuthOperatorLevelEx]]: [+ 2.6.3] Removes all device operators. (Support operator up to 1000) | ||
===== Structure ===== | ===== Structure ===== | ||
==== BS2SimpleDeviceInfo ==== | ==== BS2SimpleDeviceInfo ==== | ||
Line 163: | Line 170: | ||
Flag that notifies whether the device supports VoIP. \\ | Flag that notifies whether the device supports VoIP. \\ | ||
+ | ==== BS2SimpleDeviceInfoEx ==== | ||
+ | Retrieves BS2SimpleDeviceInfo and supported information.\\ | ||
+ | <code cpp> | ||
+ | typedef struct | ||
+ | { | ||
+ | enum | ||
+ | { | ||
+ | BS2_SUPPORT_RS485EX = 0x00000001, | ||
+ | BS2_SUPPORT_CARDEX = 0x00000002, | ||
+ | BS2_SUPPORT_DST = 0x00000004, | ||
+ | BS2_SUPPORT_DESFIREEX = 0x00000008, | ||
+ | BS2_SUPPORT_FACE_EX = 0x00000010, | ||
+ | |||
+ | BS2_SUPPORT_FINGER_SCAN = 0x00010000, | ||
+ | BS2_SUPPORT_FACE_SCAN = 0x00020000, | ||
+ | BS2_SUPPORT_FACE_EX_SCAN = 0x00040000, | ||
+ | |||
+ | 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, | ||
+ | }; | ||
+ | |||
+ | uint32_t supported; | ||
+ | uint8_t reserved[4]; | ||
+ | }BS2SimpleDeviceInfoEx; | ||
+ | </code> | ||
+ | |||
+ | **1. //supported//** \\ | ||
+ | The current device additionally obtains information beyond the functionality provided by BS2SimpleDeviceInfo.\\ | ||
+ | By bit masking with the values defined below, you can check if it is supported. | ||
+ | <WRAP group 80%> | ||
+ | ^Definition ^Value ^Description ^ | ||
+ | |BS2_SUPPORT_RS485EX |0x00000001 |Whether RS485 extensions are supported (In case of CoreStation 40) | | ||
+ | |BS2_SUPPORT_CARDEX |0x00000002 |Whether iClass SEOS card is used | | ||
+ | |BS2_SUPPORT_DST |0x00000004 |Whether daylight savings time is used | | ||
+ | |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_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_EX_SCAN |0x00040000 |Whether support face scan for FSF2 [+ V2.7.1] | | ||
+ | |BS2_SUPPORT_ALL |0x0000000F |Whether to provide additional full information | | ||
+ | </WRAP> | ||
+ | |||
+ | **2. //reserved//** \\ | ||
+ | Reserved space. \\ | ||
==== BS2ResourceElement ==== | ==== BS2ResourceElement ==== | ||
Line 179: | Line 229: | ||
**1. //type//** \\ | **1. //type//** \\ | ||
Resource data type. \\ | Resource data type. \\ | ||
- | <WRAP group 50%> | + | <WRAP group 100%> |
^Value ^Description ^Supported data format ^ | ^Value ^Description ^Supported data format ^ | ||
|0 |UI(Langauge pack) |Suprema language pack | | |0 |UI(Langauge pack) |Suprema language pack | | ||
Line 196: | Line 246: | ||
Binary resource data. \\ \\ | Binary resource data. \\ \\ | ||
+ | |||
+ | ==== BS2IPv6DeviceInfo ==== | ||
+ | <code cpp> | ||
+ | enum { | ||
+ | BS2_MAX_IPV6_ALLOCATED_ADDR = 8, | ||
+ | }; | ||
+ | |||
+ | typedef struct | ||
+ | { | ||
+ | BS2_DEVICE_ID id; | ||
+ | uint8_t reserved[1]; | ||
+ | uint8_t bIPv6Mode; | ||
+ | char ipv6Address[BS2_IPV6_ADDR_SIZE]; | ||
+ | uint16_t portV6; | ||
+ | char connectedIPV6[BS2_IPV6_ADDR_SIZE]; | ||
+ | uint8_t numOfAllocatedAddressV6; | ||
+ | char allocatedIpAddressV6[BS2_IPV6_ADDR_SIZE][BS2_MAX_IPV6_ALLOCATED_ADDR]; | ||
+ | }BS2IPv6DeviceInfo; | ||
+ | </code> | ||
+ | 1. //id// \\ | ||
+ | Device ID \\ \\ | ||
+ | 2. //reserved// \\ | ||
+ | Reserved space \\ \\ | ||
+ | 3. //bIPv6Mode// \\ | ||
+ | Flag to determine whether to work IPv6 mode or not. \\ \\ | ||
+ | 4. //ipv6Address// \\ | ||
+ | IPv6 address of device \\ \\ | ||
+ | 5. //portV6// \\ | ||
+ | IPv6 port of device \\ \\ | ||
+ | 6. //connectedIPV6// \\ | ||
+ | IPv6 address of server which device is connected. \\ \\ | ||
+ | 7. //numOfAllocatedAddressV6// \\ | ||
+ | Number of IPv6 addresses currently allocated to device. | ||
+ | 8. //allocatedIpAddressV6// \\ | ||
+ | IPv6 addresses currently allocated to device. | ||
+ | |||
+ | ==== BS2AuthOperatorLevel ==== | ||
+ | <code cpp> | ||
+ | typedef struct { | ||
+ | char userID[BS2_USER_ID_SIZE]; | ||
+ | uint8_t level; | ||
+ | uint8_t reserved[3]; | ||
+ | } BS2Operator; | ||
+ | |||
+ | typedef BS2Operator BS2AuthOperatorLevel; | ||
+ | </code> | ||
+ | 1. //userID// \\ | ||
+ | User ID \\ \\ | ||
+ | 2. //level// \\ | ||
+ | Sets operator level when user authenticates. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^Value ^Description ^ | ||
+ | |0 |No auth | | ||
+ | |1 |Administrator level | | ||
+ | |2 |System configuration level | | ||
+ | |3 |User information lelve | | ||
+ | </WRAP> | ||
+ | 3. //reserved// \\ | ||
+ | Reserved space \\ | ||