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:configuration_api [2020/02/19 11:03] kkshin |
en:configuration_api [2020/02/19 14:18] yjjung [BS2FingerprintConfig] |
||
|---|---|---|---|
| Line 68: | Line 68: | ||
| * [[BS2_GetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Retrieves IPv6 configuration through UDP broadcast with host IP. | * [[BS2_GetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Retrieves IPv6 configuration through UDP broadcast with host IP. | ||
| * [[BS2_SetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Stores IPv6 configuration through UDP broadcast with host IP. | * [[BS2_SetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Stores IPv6 configuration through UDP broadcast with host IP. | ||
| + | * [[BS2_GetDesFireCardConfigEx]]: [+ V2.6.4] Retrieves DesFire advanced configuration from the device. | ||
| + | * [[BS2_SetDesFireCardConfigEx]]: [+ V2.6.4] Sets DesFire advanced configuration in the device. | ||
| \\ | \\ | ||
| ===== Structure ===== | ===== Structure ===== | ||
| Line 177: | Line 179: | ||
| **14. //reserved//** \\ | **14. //reserved//** \\ | ||
| Reserved space. \\ \\ | Reserved space. \\ \\ | ||
| - | 15. //useCardOperationMask// \\ | + | **15. //useCardOperationMask//** \\ |
| [+ V2.6.4] Provides a card selective option not to read all kinds of cards from the device. \\ | [+ V2.6.4] Provides a card selective option not to read all kinds of cards from the device. \\ | ||
| You can select multiple cards using MASK. The user can select or deselect of a specific card reading option using this option. \\ | You can select multiple cards using MASK. The user can select or deselect of a specific card reading option using this option. \\ | ||
| Line 691: | Line 693: | ||
| Reserved space. \\ | Reserved space. \\ | ||
| </WRAP> | </WRAP> | ||
| + | |||
| ==== BS2FingerprintConfig ==== | ==== BS2FingerprintConfig ==== | ||
| <code cpp> | <code cpp> | ||
| typedef struct { | typedef struct { | ||
| - | uint8_t securityLevel; | + | uint8_t securityLevel; |
| - | uint8_t fastMode; | + | uint8_t fastMode; |
| - | uint8_t sensitivity; | + | uint8_t sensitivity; |
| - | uint8_t sensorMode; | + | uint8_t sensorMode; |
| - | uint16_t templateFormat; | + | uint16_t templateFormat; |
| - | uint16_t scanTimeout; | + | uint16_t scanTimeout; |
| - | uint8_t successiveScan; | + | uint8_t successiveScan; |
| - | uint8_t advancedEnrollment; | + | uint8_t advancedEnrollment; |
| - | uint8_t showImage; | + | uint8_t showImage; |
| - | uint8_t lfdLevel; | + | uint8_t lfdLevel; |
| - | uint8_t reserved1[32]; | + | bool checkDuplicate; |
| + | |||
| + | uint8_t reserved3[31]; | ||
| } BS2FingerprintConfig; | } BS2FingerprintConfig; | ||
| </code> | </code> | ||
| Line 756: | Line 761: | ||
| Decides whether to display scanned fingerprint image on the screen. \\ \\ | Decides whether to display scanned fingerprint image on the screen. \\ \\ | ||
| **10. //lfdLevel//** \\ | **10. //lfdLevel//** \\ | ||
| - | Configuration for the LFD sensitivity. \\ | + | Configuration for the LFD(Live fingerprint detection) to detect fake fingerprints sensitivity. \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^Value ^Description ^ | ^Value ^Description ^ | ||
| Line 764: | Line 769: | ||
| |3 |Most Strict | | |3 |Most Strict | | ||
| </WRAP> | </WRAP> | ||
| - | **11. //reserved1//** \\ | + | **11. //checkDuplicate//** \\ |
| - | Reserved space. | + | [+ V2.6.4] If set to true, it will determine if the fingerprint is a duplicate. \\ \\ |
| + | **12. //reserved3//** \\ | ||
| + | Reserved space. \\ \\ | ||
| ==== BS2Rs485Config ==== | ==== BS2Rs485Config ==== | ||
| Line 1554: | Line 1561: | ||
| <code cpp> | <code cpp> | ||
| typedef struct { | typedef struct { | ||
| - | BS2_FACE_SECURITY_LEVEL securityLevel; | + | uint8_t securityLevel; |
| - | BS2_FACE_LIGHT_CONDITON lightCondition; | + | uint8_t lightCondition; |
| - | BS2_FACE_ENROLL_THRESHOLD enrollThreshold; | + | uint8_t enrollThreshold; |
| - | BS2_FACE_DETECT_SENSITIVITY detectSensitivity; | + | uint8_t detectSensitivity; |
| - | uint16_t enrollTimeout; | + | uint16_t enrollTimeout; |
| - | uint8_t reserved3[32]; | + | uint8_t lfdLevel; |
| + | bool quickEnrollment; | ||
| + | |||
| + | uint8_t previewOption; | ||
| + | bool checkDuplicate; | ||
| + | uint8_t reserved[2]; | ||
| + | |||
| + | uint8_t reserved2[26]; | ||
| } BS2FaceConfig; | } BS2FaceConfig; | ||
| </code> | </code> | ||
| Line 1824: | Line 1838: | ||
| |0xFFFFFFFF|All configuration| | |0xFFFFFFFF|All configuration| | ||
| </WRAP> | </WRAP> | ||
| + | |||
| + | ==== BS2IPV6Config ==== | ||
| + | <code cpp> | ||
| + | enum { | ||
| + | BS2_MAX_IPV6_ALLOCATED_ADDR = 8, | ||
| + | }; | ||
| + | |||
| + | typedef struct { | ||
| + | uint8_t useIPV6; | ||
| + | uint8_t reserved1; | ||
| + | uint8_t useDhcpV6; | ||
| + | uint8_t useDnsV6; | ||
| + | uint8_t reserved[1]; | ||
| + | char staticIpAddressV6[BS2_IPV6_ADDR_SIZE]; | ||
| + | char staticGatewayV6[BS2_IPV6_ADDR_SIZE]; | ||
| + | char dnsAddrV6[BS2_IPV6_ADDR_SIZE]; | ||
| + | char serverIpAddressV6[BS2_IPV6_ADDR_SIZE]; | ||
| + | uint16_t serverPortV6; | ||
| + | uint16_t sslServerPortV6; | ||
| + | uint16_t portV6; | ||
| + | uint8_t numOfAllocatedAddressV6; | ||
| + | uint8_t numOfAllocatedGatewayV6; | ||
| + | uint8_t reserved[8]; | ||
| + | char allocatedIpAddressV6[BS2_IPV6_ADDR_SIZE][BS2_MAX_IPV6_ALLOCATED_ADDR]; | ||
| + | char allocatedGatewayV6[BS2_IPV6_ADDR_SIZE][BS2_MAX_IPV6_ALLOCATED_ADDR]; | ||
| + | } BS2IpConfig; | ||
| + | </code> | ||
| + | 1. //useIPV6// \\ | ||
| + | Flag indicating whether to use IP V6. \\ \\ | ||
| + | 2. //reserved1// \\ | ||
| + | Reserved space. \\ \\ | ||
| + | 3. //useDhcpV6// \\ | ||
| + | Flag indicating whether to use DHCP. \\ \\ | ||
| + | 4. //useDnsV6// \\ | ||
| + | Decides whether to use server address or server URL. \\ \\ | ||
| + | 5. //staticIpAddressV6// \\ | ||
| + | Static IP V6 address of current device. \\ \\ | ||
| + | 6. //staticGatewayV6// \\ | ||
| + | Static IP V6 address of gateway. \\ \\ | ||
| + | 7. //dnsAddrV6// \\ | ||
| + | DNS address. \\ \\ | ||
| + | 8. //serverIpAddressV6// \\ | ||
| + | IP address of BioStar. Used only in the server mode. \\ \\ | ||
| + | 9. //serverPortV6// \\ | ||
| + | Port number of BioStar. Used only in the server mode. \\ \\ | ||
| + | 10. //sslServerPortV6// \\ | ||
| + | Used when the connectionMode is set as server SSL mode, which is the port of the SDK application. \\ \\ | ||
| + | 11. //portV6// \\ | ||
| + | Port number of the device. \\ \\ | ||
| + | 12. //numOfAllocatedAddressV6// \\ | ||
| + | The number of IP V6 address currently assigned to the device. \\ \\ | ||
| + | 13. //numOfAllocatedGatewayV6// \\ | ||
| + | The number of gateway address currently assigned to the device. \\ \\ | ||
| + | 14. //reserved// \\ | ||
| + | Reserved space. \\ \\ | ||
| + | 15. //allocatedIpAddressV6// \\ | ||
| + | The IP V6 address currently assigned to the device. \\ \\ | ||
| + | 16. //allocatedGatewayV6// \\ | ||
| + | The gateway address currently assigned to the device.\\ \\ | ||
| ==== BS2DesFireCardConfigEx ==== | ==== BS2DesFireCardConfigEx ==== | ||