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 14:02] yjjung [BS2FaceConfig] |
en:configuration_api [2020/02/25 08:31] kkshin [BS2SystemConfig] |
||
|---|---|---|---|
| Line 123: | Line 123: | ||
| ==== BS2SystemConfig ==== | ==== BS2SystemConfig ==== | ||
| - | [[BS2_SetSystemConfig]] must be called after calling [[BS2_GetSystemConfig]] and completing necessary settings except for tamperOn. \\ | ||
| <code cpp> | <code cpp> | ||
| typedef struct { | typedef struct { | ||
| Line 153: | Line 152: | ||
| Reserved variable. \\ \\ | Reserved variable. \\ \\ | ||
| **5. //deviceLocked//** \\ | **5. //deviceLocked//** \\ | ||
| - | Decides whether to show lock screen in stand-by mode. \\ \\ | + | Indicates the current locked state of the device. (Read only filed) \\ \\ |
| **6. //useInterphone//** \\ | **6. //useInterphone//** \\ | ||
| Decides whether to use intercom. \\ \\ | Decides whether to use intercom. \\ \\ | ||
| Line 761: | Line 760: | ||
| 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 - fake fingerprint detection) sensitivity. \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^Value ^Description ^ | ^Value ^Description ^ | ||
| Line 1577: | Line 1576: | ||
| } BS2FaceConfig; | } BS2FaceConfig; | ||
| </code> | </code> | ||
| - | 1. //securityLevel// \\ | + | **1. //securityLevel//** \\ |
| Face authentication security level. This is used across the system. . \\ | Face authentication security level. This is used across the system. . \\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| Line 1585: | Line 1584: | ||
| |2 |Most highly secure | | |2 |Most highly secure | | ||
| </WRAP> | </WRAP> | ||
| - | 2. //lightCondition// \\ | + | **2. //lightCondition//** \\ |
| Configuration of the light condition.\\ | Configuration of the light condition.\\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| Line 1593: | Line 1592: | ||
| |2 |Automatic | | |2 |Automatic | | ||
| </WRAP> | </WRAP> | ||
| - | 3. //enrollThreshold// \\ | + | **3. //enrollThreshold//** \\ |
| Threshold of face enrollment.\\ | Threshold of face enrollment.\\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| Line 1608: | Line 1607: | ||
| |9 |THRESHOLD_9 | | |9 |THRESHOLD_9 | | ||
| </WRAP> | </WRAP> | ||
| - | 4. //detectSensitivity// \\ | + | **4. //detectSensitivity//** \\ |
| Configuration of sensitivity on detecting the face. \\ | Configuration of sensitivity on detecting the face. \\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| Line 1617: | Line 1616: | ||
| |3 |High | | |3 |High | | ||
| </WRAP> | </WRAP> | ||
| - | 5. //enrollTimeout// \\ | + | **5. //enrollTimeout//** \\ |
| Timeout period of face scanning which is 60 seconds by default.\\ \\ | Timeout period of face scanning which is 60 seconds by default.\\ \\ | ||
| - | 6. //reserved3// \\ | + | **6. //lfdLevel//** \\ |
| - | Reserved space.\\ \\ | + | [+ V2.6.3] Configuration for the LFD(Live Face Detection - fake face detection) sensitivity. \\ |
| + | <WRAP group 50%> | ||
| + | ^Value ^Description ^ | ||
| + | |0 |Not Use | | ||
| + | |1 |Strict | | ||
| + | |2 |More Strict | | ||
| + | |3 |Most Strict | | ||
| + | </WRAP> | ||
| + | **7. //quickEnrollment//** \\ | ||
| + | [+ V2.6.3] Quick face enrollment process. \\ | ||
| + | True - Face enrollment process with a single step.\\ | ||
| + | False - Face enrollment rpcoess with 3 steps.\\ | ||
| + | Please use false if you want to enroll with a high quality of face templates. \\ \\ | ||
| + | **8. //previewOption//** \\ | ||
| + | [+ V2.6.3] IR camera preview option when you authenticate with face. \\ | ||
| + | Only used to ''FaceLite''. \\ | ||
| + | <WRAP group 50%> | ||
| + | ^Value ^Description ^ | ||
| + | |0 |Preview not used | | ||
| + | |1 |Preview not used at frist of authentication, preview at 1/2 stage | | ||
| + | |2 |Preview of all stages on authentication | | ||
| + | </WRAP> | ||
| + | **9. //checkDuplicate//** \\ | ||
| + | [+ V2.6.4] Check whether the scanned face is duplicated in the device. \\ \\ | ||
| + | **10. //reserved//** \\ | ||
| + | Reserved space. \\ \\ | ||
| + | **11. //reserved2//** \\ | ||
| + | Reserved space. \\ \\ | ||
| ==== BS2Rs485ConfigEX ==== | ==== BS2Rs485ConfigEX ==== | ||
| <code cpp> | <code cpp> | ||