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/11/11 10:28] kkshin [BS2ThermalCameraConfig] |
en:configuration_api [2021/06/06 19:16] kateyu [Configuration API] |
||
---|---|---|---|
Line 76: | Line 76: | ||
* [[BS2_GetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera. | * [[BS2_GetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera. | ||
* [[BS2_SetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera. | * [[BS2_SetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera. | ||
+ | * [[BS2_GetBarcodeConfig]]: [+ 2.8] ''X-Station 2'' Retrieves configuration of Barcode. | ||
+ | * [[BS2_SetBarcodeConfig]]: [+ 2.8] ''X-Station 2'' Stores configuration of Barcode. | ||
\\ | \\ | ||
===== Structure ===== | ===== Structure ===== | ||
Line 375: | Line 376: | ||
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 415: | Line 417: | ||
</WRAP> | </WRAP> | ||
**6. //menuTimeout//** \\ | **6. //menuTimeout//** \\ | ||
- | Timeout in seconds for lock screen when the user is inactive. The timeout can be set from 0 to 255 seconds. 0 means no lock screen.\\ \\ | + | Timeout in seconds for lock screen when the user is inactive. The timeout can be set from 0 to 255 seconds. 0 means no lock screen.\\ |
+ | <WRAP group 50%> | ||
+ | ^Value ^Description ^ | ||
+ | |0 |No timeout. | | ||
+ | |10 |Menu timeout 10 sec. | | ||
+ | |20 |Menu timeout 20 sec. (Default) | | ||
+ | |30 |Menu timeout 30 sec. | | ||
+ | |40 |Menu timeout 40 sec. | | ||
+ | |50 |Menu timeout 50 sec. | | ||
+ | |60 |Menu timeout 60 sec. | | ||
+ | </WRAP> | ||
**7. //msgTimeout//** \\ | **7. //msgTimeout//** \\ | ||
- | Message timeout in milliseconds. The timeout can be set from 500 to 5000 milliseconds.\\ \\ | + | Message timeout in milliseconds. The timeout can be set from 500 to 5000 milliseconds.\\ |
+ | <WRAP group 50%> | ||
+ | ^Value ^Description ^ | ||
+ | |500 |Message timeout 500 msec. | | ||
+ | |1000 |Message timeout 1 sec. | | ||
+ | |2000 |Message timeout 2 sec. (Default) | | ||
+ | |3000 |Message timeout 3 sec. | | ||
+ | |4000 |Message timeout 4 sec. | | ||
+ | |5000 |Message timeout 5 sec. | | ||
+ | </WRAP> | ||
**8. //backlightTimeout//** \\ | **8. //backlightTimeout//** \\ | ||
- | Backlight timeout in seconds. \\ \\ | + | Backlight timeout in seconds. \\ |
+ | <WRAP group 50%> | ||
+ | ^Value ^Description ^ | ||
+ | |0 |Backlight timeout 0 sec. | | ||
+ | |10 |Backlight timeout 10 sec. | | ||
+ | |20 |Backlight timeout 20 sec. (Default) | | ||
+ | |30 |Backlight timeout 30 sec. | | ||
+ | |40 |Backlight timeout 40 sec. | | ||
+ | |50 |Backlight timeout 50 sec. | | ||
+ | |60 |Backlight timeout 60 sec. | | ||
+ | </WRAP> | ||
**9. //displayDateTime//** \\ | **9. //displayDateTime//** \\ | ||
Decides whether to display clock on screen. \\ \\ | Decides whether to display clock on screen. \\ \\ | ||
Line 449: | Line 480: | ||
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 845: | ||
</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 1636: | Line 1669: | ||
|1 |Outdoor | | |1 |Outdoor | | ||
|2 |Automatic | | |2 |Automatic | | ||
+ | |3 |[+V2.8] Not used ''(FaceStation F2)'' | | ||
</WRAP> | </WRAP> | ||
**3. //enrollThreshold//** \\ | **3. //enrollThreshold//** \\ | ||
Line 1658: | Line 1692: | ||
|0 |Off | | |0 |Off | | ||
|1 |Low | | |1 |Low | | ||
- | |2 |Basic | | + | |2 |Medium | |
|3 |High | | |3 |High | | ||
</WRAP> | </WRAP> | ||
Line 2240: | Line 2274: | ||
Reserved \\ \\ | Reserved \\ \\ | ||
6. //thermalThresholdLow// \\ | 6. //thermalThresholdLow// \\ | ||
+ | ''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. \\ | 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º). \\ | ||
+ | And you must set a value less than thermalThresholdHigh. \\ \\ | ||
7. //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. \\ | 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 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// \\ | 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. \\ | ||
Line 2271: | Line 2310: | ||
<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 2299: | Line 2339: | ||
The distance measured by the thermal imaging camera. The unit is cm, and the default is 100. \\ \\ | 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// \\ |