Differences

This shows you the differences between two versions of the page.

--- en:configuration_api [2021/05/26 14:24]
kkshin [BS2DisplayConfig]
+++ en:configuration_api [2021/06/06 20:19]
kateyu [BS2Rs485Config]
@@ Line 76: / Line 76: @@
   * [[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_GetBarcodeConfig]]: [+ 2.8] ''X-Station 2'' Retrieves configuration of Barcode.
+  * [[BS2_SetBarcodeConfig]]: [+ 2.8] ''X-Station 2'' Stores configuration of Barcode.
 \\
 ===== Structure =====
@@ Line 816: / Line 817: @@
 ==== BS2Rs485Config ====
 <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 {
     uint32_t baudRate;
@@ Line 828: / Line 838: @@
     uint8_t mode;
     uint8_t numOfChannels;
     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];
 } BS2Rs485Config;
 </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. \\
 <WRAP group 50%>
@@ Line 843: / Line 882: @@
 |115200  |
 </WRAP>
-**2. //channelIndex//** \\
+**8. //channelIndex//** \\
 (non configurable index) Communication channel index of the RS-485 network. \\ \\
-**3. //useRegistance//** \\
+**9. //useRegistance//** \\
 Registance flag - no effect on operation. \\ \\
-**4. //numOfDevices//** \\
+**10. //numOfDevices//** \\
 Number of slave devices.\\ \\
-**5. //slaveDevices//** \\
+**11. //reserved//** \\
+Reserved space.\\ \\
+**12. //slaveDevices//** \\
 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.\\
 <WRAP group 50%>
@@ Line 860: / Line 901: @@
 |3  |Standalone  |
 </WRAP>
-**7. //numOfChannels//** \\
+**14. //numOfChannels//** \\
 Number of RS-485 channel.\\ \\
-**8. //reserved//** \\
+**15. //reserved//** \\
 Reserved space.\\ \\
-**9. //reserved1//** \\
+**16. //intelligentInfo//** \\
-Reserved space.\\ \\
+''[+V2.8]'' This is Intelligent Slave Device Information\\
-**10. //channels//** \\
+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.\\
+**17. //reserved1//** \\
+Reserved space.\\ \\
+**18. //channels//** \\
 List of RS-485 channels, which can be configured up to 4 channels.\\ \\
@@ Line 1668: / Line 1713: @@
 |1  |Outdoor  |
 |2  |Automatic  |
-|3  |[+V2.8] Not used ''(FaceStation F2)''  |
+|3  |[+V2.8] Not used ''(FaceStation F2 v1.1.0 or higher version)''  |
 </WRAP>
+[Note]\\
+FaceStation F2: v1.0.0 - v1.0.5 \\
+Ambient Brightness: Normal, High, ''Auto'' \\
+FaceStation F2: v1.1.0 or higher version \\
+Light Brightness: Normal, High, ''Not Used'' \\
 **3. //enrollThreshold//** \\
 Threshold of face enrollment. It determines how much movement of pose is allowed when enrolling the face.  \\
@@ Line 2349: / Line 2400: @@
 It must be as the value multiplied by 10 of the temperature to be set. The value is available -50 ~ +50 \\ \\
+==== BS2BarcodeConfig ====
+<code cpp>
+typedef struct {
+    uint8_t useBarcode;
+    uint8_t scanTimeout;
+    uint8_t reserved[14];
+} BS2BarcodeConfig;
+</code>
+. //useBarcode// \\
+This is the flag for enabling Barcode or disabling Barcode. \\ \\
+. //scanTimeout// \\
+This is Timeout(second) setting for scanning Barcode. \\
+Default second is 4 seconds. The time out can be set from 4 to 10 seconds. \\ \\
+. //reserved// \\
+Reserved space. \\