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 [2019/05/27 16:20] yjjung |
en:device_api [2021/06/06 20:35] kateyu [Device API] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Device API ====== | ====== Device API ====== | ||
| - | API that controls the device information or upgrade the firmware.\\ | + | API that controls the device information or upgrades the firmware.\\ |
| * [[BS2_GetDeviceInfo]]: Gets the device information. | * [[BS2_GetDeviceInfo]]: Gets the device information. | ||
| Line 19: | Line 19: | ||
| * [[BS2_GetAllAuthOperatorLevelEx]]: [+ 2.6.3] Gets all device operators. (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_SetAuthOperatorLevelEx]]: [+ 2.6.3] Sets device operator. (Support operator up to 1000) | ||
| - | * [[BS2_RemoveAuthOperatorLevelEx]]: [+ 2.6.3] Remove specified 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] Remove 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. | ||
| ===== Structure ===== | ===== Structure ===== | ||
| ==== BS2SimpleDeviceInfo ==== | ==== BS2SimpleDeviceInfo ==== | ||
| Line 177: | Line 178: | ||
| enum | enum | ||
| { | { | ||
| - | BS2_SUPPORT_RS485EX = 0x00000001, | + | BS2_SUPPORT_RS485EX = 0x00000001, |
| - | BS2_SUPPORT_CARDEX = 0x00000002, | + | BS2_SUPPORT_CARDEX = 0x00000002, |
| - | BS2_SUPPORT_DST = 0x00000004, | + | BS2_SUPPORT_DST = 0x00000004, |
| - | BS2_SUPPORT_ALL = BS2_SUPPORT_RS485EX | BS2_SUPPORT_CARDEX | BS2_SUPPORT_DST, | + | 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; | uint32_t supported; | ||
| uint8_t reserved[4]; | uint8_t reserved[4]; | ||
| Line 191: | Line 198: | ||
| The current device additionally obtains information beyond the functionality provided by BS2SimpleDeviceInfo.\\ | 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. | By bit masking with the values defined below, you can check if it is supported. | ||
| - | <WRAP group 50%> | + | <WRAP group 80%> |
| ^Definition ^Value ^Description ^ | ^Definition ^Value ^Description ^ | ||
| |BS2_SUPPORT_RS485EX |0x00000001 |Whether RS485 extensions are supported (In case of CoreStation 40) | | |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_CARDEX |0x00000002 |Whether iClass SEOS card is used | | ||
| |BS2_SUPPORT_DST |0x00000004 |Whether daylight savings time is used | | |BS2_SUPPORT_DST |0x00000004 |Whether daylight savings time is used | | ||
| - | |BS2_SUPPORT_ALL |0x00000007 |Whether to provide additional full information | + | |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> | </WRAP> | ||
| Line 255: | Line 266: | ||
| </code> | </code> | ||
| 1. //id// \\ | 1. //id// \\ | ||
| - | 장치 식별자입니다. \\ \\ | + | Device ID \\ \\ |
| 2. //reserved// \\ | 2. //reserved// \\ | ||
| - | 예약된 공간입니다. \\ \\ | + | Reserved space \\ \\ |
| 3. //bIPv6Mode// \\ | 3. //bIPv6Mode// \\ | ||
| - | 현 장치가 IP V6로 동작하는지 여부를 나타내는 flag입니다. \\ \\ | + | Flag to determine whether to work IPv6 mode or not. \\ \\ |
| 4. //ipv6Address// \\ | 4. //ipv6Address// \\ | ||
| - | 현재 장치의 IP V6 주소입니다. \\ \\ | + | IPv6 address of device \\ \\ |
| 5. //portV6// \\ | 5. //portV6// \\ | ||
| - | 현재 장치의 IP V6 포트 번호입니다. \\ \\ | + | IPv6 port of device \\ \\ |
| 6. //connectedIPV6// \\ | 6. //connectedIPV6// \\ | ||
| - | 장치가 연결된 서버의 IP V6 주소입니다. \\ \\ | + | IPv6 address of server which device is connected. \\ \\ |
| 7. //numOfAllocatedAddressV6// \\ | 7. //numOfAllocatedAddressV6// \\ | ||
| - | 현재 장치에 할당되어진 IP V6 주소의 갯수를 나타냅니다. \\ \\ | + | Number of IPv6 addresses currently allocated to device. |
| 8. //allocatedIpAddressV6// \\ | 8. //allocatedIpAddressV6// \\ | ||
| - | 현재 장치에 할당되어진 IP V6 주소입니다. numOfAllocatedAddressV6는 할당되어진 주소의 갯수를 나타냅니다. \\ \\ | + | IPv6 addresses currently allocated to device. |
| ==== BS2AuthOperatorLevel ==== | ==== BS2AuthOperatorLevel ==== | ||
| Line 282: | Line 293: | ||
| </code> | </code> | ||
| 1. //userID// \\ | 1. //userID// \\ | ||
| - | 사용자 식별자입니다. \\ \\ | + | User ID \\ \\ |
| 2. //level// \\ | 2. //level// \\ | ||
| - | 사용자가 인증되었을 때 식별자에 해당하는 권한을 지정합니다. \\ | + | Sets operator level when user authenticates. \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| - | ^값 ^설명 ^ | + | ^Value ^Description ^ |
| - | |0 |권한 없음 | | + | |0 |No auth | |
| - | |1 |관리자 권한 | | + | |1 |Administrator level | |
| - | |2 |시스템 구성을 변경할 수 있는 권한 | | + | |2 |System configuration level | |
| - | |3 |사용자 정보를 변경할 수 있는 권한 | | + | |3 |User information lelve | |
| </WRAP> | </WRAP> | ||
| 3. //reserved// \\ | 3. //reserved// \\ | ||
| - | 예약된 공간입니다. \\ | + | Reserved space \\ |