Differences

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

--- en:configuration_api [2021/06/06 19:53]
kateyu
+++ en:configuration_api [2021/08/06 15:34]
kateyu [BS2RelayActionConfig]
@@ Line 78: / Line 78: @@
   * [[BS2_GetBarcodeConfig]]: [+ 2.8] ''X-Station 2'' Retrieves configuration of Barcode.
   * [[BS2_SetBarcodeConfig]]: [+ 2.8] ''X-Station 2'' Stores configuration of Barcode.
+  * [[BS2_GetInputConfigEx]]: [+ 2.8.1] ''IM-120'' Retrieves Expanded Configuration related to the Input.
+  * [[BS2_SetInputConfigEx]]: [+ 2.8.1] ''IM-120'' Retrieves Expanded Configuration related to the Input.
+  * [[BS2_GetRelayActionConfig]]: [+ 2.8.1] ''IM-120'' Retrieves Configuration related to the RelayAction.
+  * [[BS2_SetRelayActionConfig]]: [+ 2.8.1] ''IM-120'' Retrieves Configuration related to the RelayAction.
 \\
 ===== Structure =====
@@ Line 845: / Line 849: @@
 </code>
 **1. //supportConfig//** \\
-''[+V2.8]]'' If this value is 0, the device will ignore all settings related to Intelligent PD (Peripheral Device) below. \\
+''[+V2.8]'' If this value is 0, the device will ignore all settings related to Intelligent PD (Peripheral Device) below. \\
 useExceptionCode \\
 exceptionCode \\
@@ Line 852: / Line 856: @@
 **2. //useExceptionCode//** \\
-''[+V2.8]]'' This option is available to choose whether the exception code is sent or not.
+''[+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.\\
+''[+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.  \\
+''[+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.
+''[+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.\\
+''[+V2.8]'' Reserved space.\\
@@ Line 905: / Line 909: @@
 **15. //reserved//** \\
 Reserved space.\\ \\
-**16. //reserved//** \\
+**16. //intelligentInfo//** \\
-Reserved space.\\ \\
+''[+V2.8]'' This is Intelligent Slave Device Information\\
-**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.\\
+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 1714: / Line 1718: @@
 |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 2395: / Line 2405: @@
 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. \\
+==== BS2InputConfigEx ====
+<code cpp>
+typedef struct {
+    uint8_t    numInputs;
+    uint8_t    numSupervised;
+    uint8_t    reserved[18];
+    struct {
+        uint8_t    portIndex;
+        uint8_t    switchType;
+        uint16_t   duration;
+        uint8_t    reserved;
+        uint8_t    supervisedResister;
+        uint8_t    reserved1[16];
+        uint8_t    reserved2[26];
+    } inputs[BS2_MAX_INPUT_NUM_EX];
+    uint8_t    reserved2[200];
+} BS2InputConfigEx;
+</code>
+. //numInputs// \\
+Number of Input port. \\ \\
+. //numSupervised// \\
+Number of supervised input port. \\ \\
+. //reserved// \\
+Reserved Space. \\ \\
+. //portIndex// \\
+Input Port Number. \\ \\
+. //switchType// \\
+Input Signal Type. \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |Normally Open  |
+|1  |Normally Closed  |
+</WRAP>
+. //duration// \\
+Input Signal Duration Time Measurement is milliseconds(ms). \\ \\
+. //reserved// \\
+Reserved Space. \\ \\
+. //supervisedResister// \\
+You can set Supervised input resistance value type or unsupervise it. \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |1K Resistance  |
+|1  |2.2K Resistance  |
+|2  |4.7K Resistance  |
+|3  |10K Resistance  |
+|254  |Unsupervised(Default)  |
+</WRAP>
+. //reserved1// \\
+Reserved Space. \\ \\
+. //reserved2// \\
+Reserved Space. \\ \\
+. //reserved2// \\
+Reserved Space. \\ \\
+==== BS2RelayActionConfig ====
+<code cpp>
+typedef struct {
+    uint32_t        deviceID;				///< 4 bytes
+    uint8_t         reserved[16];			///< 16 bytes
+    struct {
+        uint8_t     port;				///< 1 byte (relay port)
+        uint8_t     reserved0;				///< 1 byte
+        uint8_t     disconnEnabled;			///< 1 byte (RS485 disconnection)
+        uint8_t     reserved[9];			///< 9 bytes
+        struct {
+            uint8_t port;				///< 1 byte (input port)
+            uint8_t type;				///< 1 byte (linkage/latching/release)
+            uint8_t mask;				///< 1 byte (alarm/fault)
+            uint8_t reserved[9];			///< 9 bytes
+        } input[BS2_MAX_RELAY_ACTION_INPUT];		///< 192 bytes
+    } items[BS2_MAX_RELAY_ACTION]; 			///< 816 bytes
+    uint8_t			reserved2[152];		///< 152 bytes
+} BS2RelayActionConfig;
+</code>
+. //deviceID// \\
+Device Identifier \\ \\
+. //reserved// \\
+Reserved Space. \\ \\
+. //items// \\
+Relay Setting Information \\ \\
+. //port// \\
+Relay port Number. \\ \\
+. //reserved0// \\
+Reserved Space. \\ \\
+. //disconnEnabled// \\
+If set to true, a signal is made when RS485 is disconnected. \\ \\
+. //reserved// \\
+Reserved Space. \\ \\
+. //input// \\
+Defines to which input ports the relay ports will take action. \\ \\
+. //port// \\
+Input port Identifier. \\ \\
+. //type// \\
+Defines in which input type the input will take action. \\
+If set to Linkage, signal can be made when alarm is set to mask. \\
+<WRAP group 50%>
+^type  ^Value  ^Description  ^
+|NONE  |0  |OFF  |
+|LINKAGE  |1  |Connect to the relay of the input  |
+|LATCHING  |2  |''Not Supported''  |
+|RELEASE  |3  |''Not Supported''  |
+</WRAP>
+. //mask// \\
+Set mask to Input Signal Info. \\
+<WRAP group 50%>
+^type  ^Value  ^Description ^
+|NONE  |0  |OFF  |
+|ALARM  |1  |Signal Made  |
+|FAULT  |2  |Signal Made when disconnected  |
+</WRAP>
+. //reserved// \\
+Reserved Space. \\ \\
+. //reserved2// \\
+Reserved Space. \\ \\