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 [2021/06/06 19:53] kateyu |
en:configuration_api [2021/06/06 20:20] kateyu [BS2Rs485Config] |
||
|---|---|---|---|
| Line 845: | Line 845: | ||
| </code> | </code> | ||
| **1. //supportConfig//** \\ | **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 \\ | useExceptionCode \\ | ||
| exceptionCode \\ | exceptionCode \\ | ||
| Line 852: | Line 852: | ||
| **2. //useExceptionCode//** \\ | **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//** \\ | **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.\\ | Set the exception code to be used at this time.\\ | ||
| If the exception code is 0 (0x0000000000000000), no exception code is generated.\\ | If the exception code is 0 (0x0000000000000000), no exception code is generated.\\ | ||
| **4. //outputFormat//** \\ | **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. \\ | If it is 0, the card ID is output, if it is 1, the user ID is output. \\ | ||
| **5. //osdpID//** \\ | **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. | The default OSDP ID for Suprema intelligent devices is 0. | ||
| **6. //reserved//** \\ | **6. //reserved//** \\ | ||
| - | ''[+V2.8]]'' Reserved space.\\ | + | ''[+V2.8]'' Reserved space.\\ |
| Line 905: | Line 905: | ||
| **15. //reserved//** \\ | **15. //reserved//** \\ | ||
| Reserved space.\\ \\ | 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.\\ | 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//** \\ | **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 1714: | Line 1714: | ||
| |1 |Outdoor | | |1 |Outdoor | | ||
| |2 |Automatic | | |2 |Automatic | | ||
| - | |3 |[+V2.8] Not used ''(FaceStation F2)'' | | + | |3 |[+V2.8] Not used ''(FaceStation F2 v1.1.0 or higher version)'' | |
| </WRAP> | </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//** \\ | **3. //enrollThreshold//** \\ | ||
| Threshold of face enrollment. It determines how much movement of pose is allowed when enrolling the face. \\ | Threshold of face enrollment. It determines how much movement of pose is allowed when enrolling the face. \\ | ||
| Line 2395: | Line 2401: | ||
| It must be as the value multiplied by 10 of the temperature to be set. The value is available -50 ~ +50 \\ \\ | 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> | ||
| + | 1. //useBarcode// \\ | ||
| + | This is the flag for enabling Barcode or disabling Barcode. \\ \\ | ||
| + | 2. //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. \\ \\ | ||
| + | 3. //reserved// \\ | ||
| + | Reserved space. \\ | ||