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/09/29 10:56] yjjung [Configuration API] |
en:configuration_api [2021/03/16 11:07] yjjung [BS2FaceConfigExt] |
||
---|---|---|---|
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_GetDesFireCardConfigEx]]: [+ 2.6.4] Retrieves DesFire advanced configuration from the device. |
- | * [[BS2_SetDesFireCardConfigEx]]: [+ V2.6.4] Sets DesFire advanced configuration in the device. | + | * [[BS2_SetDesFireCardConfigEx]]: [+ 2.6.4] Sets DesFire advanced configuration in the device. |
- | * [[BS2_GetAuthConfigExt]]: ''FaceStation F2'' Retrieves authentication settings from the device. [+ V2.7.1] | + | * [[BS2_GetAuthConfigExt]]: [+ 2.7.1] ''FaceStation F2'' Retrieves authentication settings from the device. |
- | * [[BS2_SetAuthConfigExt]]: ''FaceStation F2'' Stores authentication settings from the device. [+ V2.7.1] | + | * [[BS2_SetAuthConfigExt]]: [+ 2.7.1] ''FaceStation F2'' Stores authentication settings from the device. |
- | * [[BS2_GetFaceConfigExt]]: ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera and mask detection. [+ V2.7.1] | + | * [[BS2_GetFaceConfigExt]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera and mask detection. |
- | * [[BS2_SetFaceConfigExt]]: ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera and mask detection. [+ V2.7.1] | + | * [[BS2_SetFaceConfigExt]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera and mask detection. |
- | * [[BS2_GetThermalCameraConfig]]: ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera. [+ V2.7.1] | + | * [[BS2_GetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera. |
- | * [[BS2_SetThermalCameraConfig]]: ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera. [+ V2.7.1] | + | * [[BS2_SetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera. |
\\ | \\ | ||
Line 375: | Line 375: | ||
uint8_t shortcutHome[BS2_MAX_SHORTCUT_HOME]; | uint8_t shortcutHome[BS2_MAX_SHORTCUT_HOME]; | ||
uint8_t tnaIcon[16]; | uint8_t tnaIcon[16]; | ||
- | uint8_t reserved1[32]; | + | uint8_t useScreenSaver; |
+ | uint8_t reserved1[31]; | ||
} BS2DisplayConfig; | } BS2DisplayConfig; | ||
</code> | </code> | ||
Line 449: | Line 450: | ||
Home screen layout(Going to apply later, not used currently). \\ \\ | Home screen layout(Going to apply later, not used currently). \\ \\ | ||
**16. //tnaIcon//** \\ | **16. //tnaIcon//** \\ | ||
- | Icon displayed on the device corresponding to the job code. \\ \\ | + | Icon displayed on the device corresponding TNA key. \\ \\ |
- | **17. //reserved1//** \\ | + | **17. //useScreenSaver//** \\ |
+ | ''FaceStation 2'', ''FaceStation F2'' If set true, you can activate the screensaver. \\ \\ | ||
+ | **18. //reserved1//** \\ | ||
Reserved space. \\ | Reserved space. \\ | ||
Line 812: | Line 815: | ||
</WRAP> | </WRAP> | ||
**2. //channelIndex//** \\ | **2. //channelIndex//** \\ | ||
- | Communication channel index of the RS-485 network. \\ \\ | + | (non configurable index) Communication channel index of the RS-485 network. \\ \\ |
**3. //useRegistance//** \\ | **3. //useRegistance//** \\ | ||
- | Decides whether to use a resistance. \\ \\ | + | Registance flag - no effect on operation. \\ \\ |
**4. //numOfDevices//** \\ | **4. //numOfDevices//** \\ | ||
Number of slave devices.\\ \\ | Number of slave devices.\\ \\ | ||
Line 860: | Line 863: | ||
uint16_t wiegandCardMask; | uint16_t wiegandCardMask; | ||
uint8_t wiegandCSNIndex; | uint8_t wiegandCSNIndex; | ||
- | uint8_t reserved[27]; | + | uint8_t useWiegandUserID; |
+ | uint8_t reserved[26]; | ||
} BS2WiegandConfig; | } BS2WiegandConfig; | ||
</code> | </code> | ||
Line 930: | Line 934: | ||
**16. //wiegandCSNIndex//** \\ | **16. //wiegandCSNIndex//** \\ | ||
Index that determines in which format the device will send out a wiegand ouput after the card has been read. This field is used only for Mifare and EM devices. Please check the //useWiegandFormat// field of the [[configuration api#BS2CardConfig]] structure before configuring. \\ \\ | Index that determines in which format the device will send out a wiegand ouput after the card has been read. This field is used only for Mifare and EM devices. Please check the //useWiegandFormat// field of the [[configuration api#BS2CardConfig]] structure before configuring. \\ \\ | ||
- | **17. //reserved//** \\ | + | **17. //useWiegandUserID//** \\ |
- | Reserved space\\ \\ | + | The flag you can select whether card ID or user ID to be sent via Wiegand output. \\ |
+ | <WRAP group 50%> | ||
+ | ^Value ^Description ^ | ||
+ | |0 |Not use | | ||
+ | |1 |Card ID | | ||
+ | |2 |User ID | | ||
+ | </WRAP> | ||
+ | **18. //reserved//** \\ | ||
+ | Reserved space.\\ | ||
Line 1335: | Line 1347: | ||
26. //type// \\ | 26. //type// \\ | ||
Action types. \\ | Action types. \\ | ||
+ | <WRAP round important 60%> | ||
+ | <wrap em>[DoorModule-20, CoreStation-40]</wrap> \\ | ||
+ | If the action type is relay or TTL (Output) and the action device is DM20, CS40, | ||
+ | Action type should be set only as relay action (6). (TTL setting not possible) \\ \\ | ||
+ | <wrap em>[DM20]</wrap> \\ | ||
+ | * Action type : Relay | ||
+ | * relay.relayIndex : 0 ~ 3 (RELAY 0 ~ 3) | ||
+ | * relay.relayIndex : 4 ~ 9 (OUTPUT 0 ~ 5) | ||
+ | <wrap em>[CS40]</wrap> \\ | ||
+ | * Action type : Relay | ||
+ | * relay.relayIndex : 0 ~ 3 (RELAY 0 ~ 3) | ||
+ | * relay.relayIndex : 4 ~ 11 (OUTPUT 0 ~ 7) | ||
+ | </WRAP> | ||
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Description ^ | ^Value ^Description ^ | ||
Line 1636: | Line 1661: | ||
|0 |Off | | |0 |Off | | ||
|1 |Low | | |1 |Low | | ||
- | |2 |Basic | | + | |2 |Medium | |
|3 |High | | |3 |High | | ||
</WRAP> | </WRAP> | ||
Line 2166: | Line 2191: | ||
uint8_t thermalFormat; | uint8_t thermalFormat; | ||
- | uint8_t reserved2[3]; | + | uint8_t reserved2; |
- | uint16_t thermalThreshold; | + | uint16_t thermalThresholdLow; |
+ | uint16_t thermalThresholdHigh; | ||
uint8_t maskDetectionLevel; | uint8_t maskDetectionLevel; | ||
uint8_t auditTemperature; | uint8_t auditTemperature; | ||
Line 2174: | Line 2200: | ||
uint8_t useRejectSound; | uint8_t useRejectSound; | ||
uint8_t useOverlapThermal; | uint8_t useOverlapThermal; | ||
- | uint8_t reserved4; | + | uint8_t useDynamicROI; |
uint8_t faceCheckOrder; | uint8_t faceCheckOrder; | ||
} BS2FaceConfigExt; | } BS2FaceConfigExt; | ||
Line 2182: | Line 2208: | ||
When set to HARD, access is denied if exceeding the thermalThreshold. \\ | When set to HARD, access is denied if exceeding the thermalThreshold. \\ | ||
When set to SOFT, access is not affected even if exceeding the thermalThreshold but leaves a related log. \\ | When set to SOFT, access is not affected even if exceeding the thermalThreshold but leaves a related log. \\ | ||
+ | If thermalCheckMode is set to No use(0), \\ | ||
+ | The settings of thermalFormat, thermalThreshold, auditTemperature, and useOverlapThermal are ignored. \\ | ||
+ | And the reject sound due to thermal check by useRejectSound, the temperature check by faceCheckOrder is ignored. \\ | ||
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Description ^Default ^ | ^Value ^Description ^Default ^ | ||
Line 2192: | Line 2221: | ||
''FaceStation 2'' This setting is ignored. \\ | ''FaceStation 2'' This setting is ignored. \\ | ||
When set to HARD, access is denied if not detecting any mask on the face based on maskDetectionLevel. \\ | When set to HARD, access is denied if not detecting any mask on the face based on maskDetectionLevel. \\ | ||
- | When set to SOFT, access is not affected even if not detecting any mask on the face based on maskDetectionLeve but leaves a related log. \\ | + | When set to SOFT, access is not affected even if not detecting any mask on the face based on maskDetectionLevel but leaves a related log. \\ |
+ | If maskCheckMode is set to No use(0), \\ | ||
+ | The setting of maskDetectionLevel is ignored. \\ | ||
+ | And the reject sound due to mask detection check by useRejectSound, the mask detection check by faceCheckOrder is ignored. \\ | ||
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Description ^Default ^ | ^Value ^Description ^Default ^ | ||
Line 2210: | Line 2242: | ||
5. //reserved2// \\ | 5. //reserved2// \\ | ||
Reserved \\ \\ | Reserved \\ \\ | ||
- | 6. //thermalThreshold// \\ | + | 6. //thermalThresholdLow// \\ |
- | This is the standard value for determining high temperature and must be entered as a value multiplied by 100 of the temperature to be set. \\ | + | ''Supported version'' : ''FaceStation F2 V1.0.2'', ''FaceStation 2 V1.5.0'' \\ |
+ | This is the range value for determining high temperature and must be entered as a value multiplied by 100 of the temperature to be set. \\ | ||
Also, you can only enter in degrees Celsius. \\ | Also, you can only enter in degrees Celsius. \\ | ||
- | This value is the basis for the denial of authentication, and the setting range is between 3000(30º) and 4500(45º). \\ \\ | + | This value is the basis for the denial of authentication, and the setting range is between 100 (1º) and 4500 (45º). \\ |
- | + | The default value is 3200 (32º), and if a value larger or smaller than the setting range is entered, the default value a set to 3200 (32º). \\ | |
- | 7. //maskDetectionLevel// \\ | + | And you must set a value less than thermalThresholdHigh. \\ \\ |
+ | 7. //thermalThresholdHigh// \\ | ||
+ | This is the range value for determining high temperature and must be entered as a value multiplied by 100 of the temperature to be set. \\ | ||
+ | Also, you can only enter in degrees Celsius. \\ | ||
+ | This value is the basis for the denial of authentication, and the setting range is between 100 (1º) and 4500 (45º). \\ | ||
+ | The default value is 3800 (38º), and if a value larger or smaller than the setting range is entered, the default value a set to 3800 (38º). \\ | ||
+ | And you must set a value greater than thermalThresholdLow. \\ \\ | ||
+ | 8. //maskDetectionLevel// \\ | ||
''FaceStation F2'' Sets the mask detection level. The detecting level is based on internal setting value. \\ | ''FaceStation F2'' Sets the mask detection level. The detecting level is based on internal setting value. \\ | ||
''FaceStation 2'' This setting is ignored. \\ | ''FaceStation 2'' This setting is ignored. \\ | ||
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Description ^Default ^ | ^Value ^Description ^Default ^ | ||
- | |0 |No use |Default | | + | |0 |No detection |Default | |
- | |1 |Normal | | | + | |1 |Detection level (Normal) | | |
- | |2 |High | | | + | |2 |Detection level (High) | | |
- | |3 |Very high | | | + | |3 |Detection level (Very high) | | |
</WRAP> | </WRAP> | ||
- | 8. //auditTemperature// \\ | + | 9. //auditTemperature// \\ |
Decides whether the measured temperature is recorded in the log or not. \\ \\ | Decides whether the measured temperature is recorded in the log or not. \\ \\ | ||
- | 9. //useRejectSound// \\ | + | 10. //useRejectSound// \\ |
Decides whether it sounds when rejecting a user due to thermalThreshold or maskDetectionLevel. \\ \\ | Decides whether it sounds when rejecting a user due to thermalThreshold or maskDetectionLevel. \\ \\ | ||
- | 10. //useOverlapThermal// \\ | + | 11. //useOverlapThermal// \\ |
Displays a thermal image overlaid on the screen. \\ \\ | Displays a thermal image overlaid on the screen. \\ \\ | ||
- | 11. //reserved4// \\ | + | 12. //useDynamicROI// \\ |
- | Reserved \\ \\ | + | When set to true, when measuring temperature, the user's forehead is found and measured, not a fixed area. \\ \\ |
- | 12. //faceCheckOrder// \\ | + | 13. //faceCheckOrder// \\ |
It defines the sequence of thermal check and mask detection and authentication. \\ | It defines the sequence of thermal check and mask detection and authentication. \\ | ||
Because the user should touch the device in the case of ID combination authentication or PIN combination authentication,\\ | Because the user should touch the device in the case of ID combination authentication or PIN combination authentication,\\ | ||
Line 2239: | Line 2279: | ||
<WRAP group 50%> | <WRAP group 50%> | ||
^Value ^Description ^Default ^ | ^Value ^Description ^Default ^ | ||
- | |0 |Temperature check or Mask detection check before authentication | Default | | + | Authentication before Temperature check or Mask detection check |
- | |1 |Authentication before Temperature check or Mask detection check | | | + | |0 |Check after authentication | Default | |
- | |2 |No authentication. Only Temperature check or Mask detection check | | | + | |1 |Check before authentication | | |
+ | |2 |No authentication, check only | | | ||
</WRAP> | </WRAP> | ||
Line 2265: | Line 2306: | ||
</code> | </code> | ||
1. //distance// \\ | 1. //distance// \\ | ||
- | The distance measured by the thermal imaging camera. The unit is cm, and the default is 70. \\ \\ | + | The distance measured by the thermal imaging camera. The unit is cm, and the default is 100. \\ \\ |
2. //emissionRate// \\ | 2. //emissionRate// \\ | ||
- | The rate of the subject reflecting heat. \\ | + | The emissivity of the subject reflecting heat. \\ |
It is recommended to enter within the [95/97/98] range. If the subject is a human, 98 is recommended. \\ \\ | It is recommended to enter within the [95/97/98] range. If the subject is a human, 98 is recommended. \\ \\ | ||
3. //roi// \\ | 3. //roi// \\ |