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/03 14:09] kkshin [BS2Action] |
en:configuration_api [2021/06/06 19:53] kateyu |
||
---|---|---|---|
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 784: | Line 817: | ||
==== BS2Rs485Config ==== | ==== BS2Rs485Config ==== | ||
<code cpp> | <code cpp> | ||
+ | typedef struct { | ||
+ | uint8_t supportConfig; | ||
+ | uint8_t useExceptionCode; | ||
+ | uint8_t exceptionCode[BS2_RS485_MAX_FAIL_CODE_LEN]; | ||
+ | uint8_t outputFormat; | ||
+ | uint8_t osdpID; | ||
+ | uint8_t reserved[4]; | ||
+ | } BS2IntelligentPDInfo; //Added 2.8.0 for Intelligent Slave Feature | ||
+ | |||
typedef struct { | typedef struct { | ||
uint32_t baudRate; | uint32_t baudRate; | ||
Line 796: | Line 838: | ||
uint8_t mode; | uint8_t mode; | ||
uint8_t numOfChannels; | uint8_t numOfChannels; | ||
- | uint8_t reserved[2]; | + | uint8_t reserved[2]; |
- | uint8_t reserved1[32]; | + | BS2IntelligentPDInfo intelligentInfo; //Updated to v2.8.0 |
+ | uint8_t reserved1[16]; | ||
BS2Rs485Channel channels[BS2_RS485_MAX_CHANNELS]; | BS2Rs485Channel channels[BS2_RS485_MAX_CHANNELS]; | ||
} BS2Rs485Config; | } BS2Rs485Config; | ||
</code> | </code> | ||
- | **1. //baudRate//** \\ | + | **1. //supportConfig//** \\ |
+ | ''[+V2.8]]'' If this value is 0, the device will ignore all settings related to Intelligent PD (Peripheral Device) below. \\ | ||
+ | useExceptionCode \\ | ||
+ | exceptionCode \\ | ||
+ | outputFormat \\ | ||
+ | osdpID \\ | ||
+ | |||
+ | **2. //useExceptionCode//** \\ | ||
+ | ''[+V2.8]]'' This option is available to choose whether the exception code is sent or not. | ||
+ | |||
+ | **3. //exceptionCode//** \\ | ||
+ | ''[+V2.8]]'' This function sends an exception code in case of authentication failure or authentication success but no card registered user.\\ | ||
+ | Set the exception code to be used at this time.\\ | ||
+ | If the exception code is 0 (0x0000000000000000), no exception code is generated.\\ | ||
+ | |||
+ | **4. //outputFormat//** \\ | ||
+ | ''[+V2.8]]'' Intelligent Slave device can send Card ID or User ID upon successful authentication. \\ | ||
+ | If it is 0, the card ID is output, if it is 1, the user ID is output. \\ | ||
+ | |||
+ | **5. //osdpID//** \\ | ||
+ | ''[+V2.8]]'' This is a value used to distinguish two or more Suprema Intelligent devices from each other when connecting to the RS485 port of the same third party controller. You can set and designate a unique value between 0 and 127. | ||
+ | The default OSDP ID for Suprema intelligent devices is 0. | ||
+ | |||
+ | |||
+ | **6. //reserved//** \\ | ||
+ | ''[+V2.8]]'' Reserved space.\\ | ||
+ | |||
+ | |||
+ | **7. //baudRate//** \\ | ||
The RS-485 communication speed which can be configured as below. \\ | The RS-485 communication speed which can be configured as below. \\ | ||
<WRAP group 50%> | <WRAP group 50%> | ||
Line 811: | Line 882: | ||
|115200 | | |115200 | | ||
</WRAP> | </WRAP> | ||
- | **2. //channelIndex//** \\ | + | **8. //channelIndex//** \\ |
- | Communication channel index of the RS-485 network. \\ \\ | + | (non configurable index) Communication channel index of the RS-485 network. \\ \\ |
- | **3. //useRegistance//** \\ | + | **9. //useRegistance//** \\ |
- | Decides whether to use a resistance. \\ \\ | + | Registance flag - no effect on operation. \\ \\ |
- | **4. //numOfDevices//** \\ | + | **10. //numOfDevices//** \\ |
Number of slave devices.\\ \\ | Number of slave devices.\\ \\ | ||
- | **5. //slaveDevices//** \\ | + | **11. //reserved//** \\ |
+ | Reserved space.\\ \\ | ||
+ | **12. //slaveDevices//** \\ | ||
List of slave devices, which can be configured up to 32 devices.\\ \\ | List of slave devices, which can be configured up to 32 devices.\\ \\ | ||
- | **6. //mode//** \\ | + | **13. //mode//** \\ |
Decides the operating mode on the RS-485 network.\\ | Decides the operating mode on the RS-485 network.\\ | ||
<WRAP group 50%> | <WRAP group 50%> | ||
Line 828: | Line 901: | ||
|3 |Standalone | | |3 |Standalone | | ||
</WRAP> | </WRAP> | ||
- | **7. //numOfChannels//** \\ | + | **14. //numOfChannels//** \\ |
Number of RS-485 channel.\\ \\ | Number of RS-485 channel.\\ \\ | ||
- | **8. //reserved//** \\ | + | **15. //reserved//** \\ |
Reserved space.\\ \\ | Reserved space.\\ \\ | ||
- | **9. //reserved1//** \\ | + | **16. //reserved//** \\ |
- | Reserved space.\\ \\ | + | Reserved space.\\ \\ |
- | **10. //channels//** \\ | + | **17. //intelligentInfo//** \\ |
+ | ''[+V2.8]'' This is Intelligent Slave Device Information\\ \\ | ||
+ | This only works when the device mode is RS485 default.\\ | ||
+ | Once the Suprema device is connected to a slave device to the 3rd party ACU through RS485(OSDP), the Suprema device becomes a Peripheral Device of the OSDP automatically.\\ | ||
+ | |||
+ | **18. //channels//** \\ | ||
List of RS-485 channels, which can be configured up to 4 channels.\\ \\ | List of RS-485 channels, which can be configured up to 4 channels.\\ \\ | ||
Line 1636: | Line 1714: | ||
|1 |Outdoor | | |1 |Outdoor | | ||
|2 |Automatic | | |2 |Automatic | | ||
+ | |3 |[+V2.8] Not used ''(FaceStation F2)'' | | ||
</WRAP> | </WRAP> | ||
**3. //enrollThreshold//** \\ | **3. //enrollThreshold//** \\ | ||
Line 1658: | Line 1737: | ||
|0 |Off | | |0 |Off | | ||
|1 |Low | | |1 |Low | | ||
- | |2 |Basic | | + | |2 |Medium | |
|3 |High | | |3 |High | | ||
</WRAP> | </WRAP> | ||
Line 2188: | Line 2267: | ||
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 2196: | Line 2276: | ||
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 2238: | Line 2318: | ||
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. \\ | ||
Line 2253: | Line 2341: | ||
|3 |Detection level (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 2267: | Line 2355: | ||
<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 2293: | Line 2382: | ||
</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// \\ |