Configuration Parameters
Description of the device setting parameters:
general
General settings of the Access controllers.
| Field | Type | Description |
|---|---|---|
| auto_reboot_hour | string | Time at which the device restarts automatically. Values between "0" and "23". It is necessary to restart the device for changes in this parameter to take effect. |
| auto_reboot_minute | string | Minute in which the terminal performs the automatic restart. Values between "0" and "59". It is necessary to restart the device for changes in this parameter to take effect. |
| clear_expired_users | string | Parameter that configures the group of expired people to have their data cleared after the daily restart of the equipment. Values: "all" (users and visitors) or "visitors" (visitors only) or "disable" (disabled). It's necessary to restart the device for changes to this parameter to take effect. |
| url_reboot_enabled | string | Enables the possibility to immediately reboot the device from the "/reboot" endpoint. To disable "0", and to enable "1". |
| keep_user_image | int | Parameter responsible for keeping or not the user's photo after registration. Values: "1", default, user's photo is kept; or "0", user's photo is removed immediately after registration. |
| beep_enabled | string | Activates the device's beep sound. Values: "0" or "1". |
| beep_enabled | string | Activates the device's beep sound. Values: "0" or "1". |
| ssh_enabled | string | Activates the connection to the device over SSH, indicating that it can be accessed remotely for engineering diagnostics. To disable "0" and to enable "1". |
| relayN_enabled | string | Enables the use of relay N, in which N goes from 1 to 4 indicating the relay's identification number (the maximum number of relays depends on the product). To disable "0" and to enable "1". |
| relayN_timeout | string | Relay activation time in milliseconds, in which N goes from 1 to 4 indicating the relay's identification number (the maximum number of relays depends on the product). Example: "3000". |
| relayN_auto_close | int | This relay configuration allows it to be configured in two ways. In this case, N is the door's number (In the case of iDAccess it can be 0 or 1, in the case of the turnstile it is always 0 while the iDBox goes from 0 to 3) and its configuration can be "0" (Normal operation) and "1" (When door sensor opens, the relay will close) - Prevents the door from being open longer than necessary. |
| door_sensorN_enabled | string | Enables the use of the N port sensor, where N goes from 1 to 4 indicating the port (the maximum number depends on the product). To disable "0" and to enable "1". |
| door_sensorN_idle | string | Indicates the logic level of the N port sensor when it is closed, where N goes from 1 to 4 indicating the port (the maximum number depends on the product). Values: "0" or "1". |
| doorN_interlock | string | Number of the doors that are interlocked separated by commas (ex: "1,3"), where N goes from 1 to 4 indicating the door (the maximum number depends on the product). |
| bell_enabled | string | Enables or disables the bell. |
| bell_relay | string | Relay to which the buzzer is connected, the default is "2". |
| online | string | This parameter determines whether the device should operate online (Pro-Mode or Enterprise-Mode), i.e. with access release processed on an external server. Possible values are "0" or "1". |
| local_identification | string | When the device operates online, this parameter defines whether it is in Pro Mode, where identification is done in the terminal itself, or in Enterprise Mode, where identification is done in the external server. Possible values are "0" or "1". |
| exception_mode | string | This parameter - exclusive to the access line V3 - should be set when the device needs to remain with the input always released or always blocked, the options are emergency and lock_down. To exit these modes just set this setting to any other value, the default is none. When emergency is enabled the device remains with the input always released and the screen and identifications remain locked. When lock_down is enabled the device stays with the input always blocked and the screen and identifications remain locked. |
| doorN_exception_mode | string | This parameter configure the behavior of the door N, where N varies from 1 to 4, if the exception_mode is not emergency or lock_down. The possible options are the same as exception_mode (emergency and lock_down) - both options disable identifications but do not lock the screen. If the value is emergency the door remain released. When lock_down is enabled, the door remain blocked. Finally, for any other value the door returns to normal operation. |
| language | string | Used to change the language of the terminal and WEB interface, possible values are: pt_BR (Portuguese), spa_SPA (Spanish) and en_US (English). After changing the language, you must restart it. |
| daylight_savings_time_start | int | The date when daylight saving time starts (Unix timestamp). |
| daylight_savings_time_end | int | The end date of daylight saving time (Unix timestamp). |
| catra_timeout | string | Time that the turnstile is released for one turn in ms. Timeout equal to zero means infinite time, that is, released until the next turn (applicable only when the device is a turnstile). |
| password_only | string | When enabled and in online mode, the device will ask only for the entered password instead of asking for the ID and password for user identification through the device's GUI. The request new_user_id_and_password sent by the device does not change, the user_id will be reset. Use the values "1" or "0" to enable or disable respectively. |
| hide_password_only | string | When the value "0" is set for this parameter and password_only (described above) is enabled, the device will not hide the password that is entered. The default is "1". |
| password_only_tip | string | This setting changes the hint text that is shown when password_only is enabled. When empty, it shows the default message. The default value is empty. |
| hide_name_on_identification | string | Hide name on identification. Once enabled, the user's name will not be displayed on the identification badge for both authorized and unauthorized access. To disable "0", and to enable "1". |
| denied_transaction_code | int | Defines the code that will be sent by Wiegand if send_code_when_not_identified and/or send_code_when_not_authorized are enabled. If the out_mode parameter of sec_box has the value "RELAY_CARD", the denied transaction code is ignored. |
| send_code_when_not_identified | int | Enables sending of denied transaction code when an unidentified user event occurs. |
| send_code_when_not_identified | int | Enables sending of denied transaction code when an unauthorized user event occurs. |
| screen_always_on | int | When using iDFace, this parameter ensures the screen remains on. If set to "0" the screen will automatically turn off when the device is idle. |
catra
Specific turnstile settings.
| Field | Type | Description |
|---|---|---|
| anti_passback | string | Enables or disables the anti-passback |
| daily_reset | string | "0" or "1". Enables log reset for anti-passback control. Logs will be deleted every day at midnight. |
| gateway | string | Direction of entry. Should be "clockwise" or "anticlockwise" |
| operation_mode | string | Turnstile Operation Mode. Controls which directions of the turnstile will be controlled or released. Must be "blocked", "entrance_open", "exit_open", "both_open" (Both controlled, entrance released, exit released, and both released respectively). |
opening_times
This setting allows you to define the door opening time in milliseconds.
| Field | Type | Description |
|---|---|---|
| id | int 64 | Unique identifier of the special opening time rule. |
| user_id | int 64 | Integer indicating the user (reference to the users table). |
| door_id | int 64 | Integer indicating the port (initial value 1). |
| time | int | Differential opening time in milliseconds. |
RS485
Configuration parameters for the RS485 communication interface.
| Field | Type | Description |
|---|---|---|
| enabled | int | Enables or disables signal transmission via RS485 protocol. The possible input values are: "0" (disabled) or "1" (enabled). By default, the input value is "0", i.e., the standard communication will not occur via RS485 and will only be via the external module (MAE/Security Box). |
| legacy_mode | int | Sets the communication mode of the RS485 interface. Possible values are: "0", "1" or "2". For "0", the RS485 communication will be standard, according to a protocol provided by Control iD (please contact support). For "1", the ID, name, and registration of the authorized user will be sent in the given hexcadecimal format: "01 02 |
| receive_timeout | int | Timeout of data transmissions (in milliseconds). The default value of this parameter is 1000 ms. |
mifare
The MIFARE module setting allows the configuration of the number of bits that the device reader will read, which can be 24 or 32 bits.
| Field | Type | Description |
|---|---|---|
| byte_order | string | The byte_order has two possible values "W_26" (MIFARE w/ 24 bits of information) used to maintain backward compatibility with older plants and "LSB" (Least Significant Byte) where it reads 32 bits of data and reverses the byte order, any setting other than "W_26" will operate in "LSB" mode. |
| read_sector | string | Indicates which sector of the MIFARE card will automatically be read when approached by the reader. When empty, no sectors will be read. The default is empty. |
| read_block | string | Indicates which block of the MIFARE card will be automatically read when approached by the reader. When empty, no blocks will be read. The default is empty. |
| authentication_type | string | Key type that will be used for authentication of the block indicated by read_block. Can be "A" or "B". Default value is "A". |
| authentication_key | string | Base64 key value used to authenticate the block indicated by read_block. Default value: "////////" (or "ffffffffffff" in hexadecimal). |
RFID
The RFID module setting allows the configuration, for ASK cards, of the number of bits that the device reader will read, which can be 0 or 8 bits for site code size and 16, 24, 32 or 40 bits for user code size.
| Field | Type | Description |
|---|---|---|
| ask_site_code_size | string | Site code size has two possible values "0" bits and "8" bits. The value of "0" bits makes it possible for the user code size, indicated by ask_user_code_size, to be "40" bits. Default is "8" bits. |
| ask_user_code_size | string | User code size, has four possible values "16" bits, "24" bits, "32" bits and "40" bits. The value of "40" bits is only valid if the site code size, indicated by ask_site_code_size, is "0" bits. Default is "16" bits. |
HID
Configuration of the HID reading module. Enables the reader to operate with different card formats. During operation, only one format must be active ("1"), while the others remain deactivated ("0").
| Field | Type | Description |
|---|---|---|
| format_w37 | string | Sets up HID reader operation with W37 format. Values: "0" or "1". |
| w37_cardid_size | string | Defines number of W37 format identification bits, disregarding parity bits. Values: "19", "25" or "35". |
| format_w26 | string | Sets up HID reader operation with W26 format. Values: "0" or "1". |
| format_mifare | string | Sets up HID reader operation with Mifare format. Values: "0" or "1". |
| format_indala_b1 | string | Sets up HID reader operation with the Indala-B1 format. Values: "0" or "1". |
| format_ask | string | Sets up HID reader operation with ASK format. Values: "0" or "1". |
| ignore_facility | string | Allows ignoring bits referring to the facility code of the ASK card. If active "1", the bits are ignored, if not "0", the bits are considered. Values: "0" or "1". |
card_readerN
Configuration of the Wiegand entry, where the N in card_readerN represents the number of the Wiegand in. For example, in iDAccess, it is always zero, i.e. card_reader0, while in iDBlock you have the options 0 for main Wiegand and 1 for ballot box Wiegand, and in iDBox, 4 options (from 0 to 3), corresponding to the number of Wiegand readers.
| Field | Type | Description |
|---|---|---|
| mode | string | The mode setting can have two values, "WIN" for Wiegand and "MAG" for the magnetic card (ABA Track II, available on iDBlock H2, iDFit H2, and iDAccess H2 models). It is important to always restart the device after changing mode. |
| type | int | The type setting can have two states, LSB (Least Significant Byte). When the read is Wiegand 34, the byte order is reversed; for any other value ("") the reversal is not performed. |
alarm
Alarm configuration parameters.
| Field | Type | Description |
|---|---|---|
| door_sensor_enabled | string | Enables or disables the door sensor. Possible values are "0" or "1" for disabling and enabling respectively. |
| door_sensor_delay | string | Sets the time in seconds that the door must remain open before the door open alarm is generated. The default value is "5". |
| forced_access_enabled | string | Enables or disables door burglary detection. Possible values are "0" or "1" to disable and enable respectively. |
| siren_enabled | string | Enables or disables the siren (applicable only for iDAccess and iDFit). In order for the siren to be triggered by a relay it is necessary to specify the number via siren_relay parameter. Possible values are "0" or "1" for disabling and enable respectively. |
| siren_relay | string | Relay to which the siren is connected, default is "2" (applicable only for iDAccess and iDFit). |
| timed_alarm_timeout | int | Indicates the time in seconds that the device will set the siren to sound. |
identifier
Identifier settings.
| Field | Type | Description |
|---|---|---|
| card_identification_enabled | int | Available for iDFace devices starting with version 6.5.1. Determines whether card identification is enabled. Values: "0" for disabled or "1" for enabled. |
| face_identification_enabled | int | Available for iDFace devices starting with version 6.5.1. Determines whether face identification is enabled. Values: "0" for disabled or "1" for enabled. |
| qrcode_identification_enabled | int | Available for iDFace devices starting with version 6.5.1. Determines whether QR Code identification is enabled. Values: "0" for disabled or "1" for enabled. |
| pin_identification_enabled | int | At the moment it is only available for iDFace devices starting with version 6.9.0. It will soon be available for the V5 line of devices. Determines whether ID + Password mode or PIN mode is enabled. Values: "0" for only ID + Password mode enabled or "1" for only PIN mode enabled. |
| verbose_logging | string | If enabled, logs all types of access, including unidentified. Uses more memory. If disabled, logs only authorized and unauthorized accesses. Values: "0" or "1". |
| log_type | bool | This setting is only valid for iDFlex. (Although it exists for the other devices) and determines whether custom beats are enabled. (Beat types) |
| multi_factor_authentication | int | This setting determines whether multiple authentication should be used. For V5 access line:0 = Disabled 0 = Disabled |
| antipassback_enabled | string | Enables or disables the anti passback setting, which blocks access by the same person. Values: "0" or "1". |
| antipassback_mode | string | Anti-passback operation mode, by default, has the "timed" value. Values: "daily_catra" for daily turnstile access, "timed_catra" for time blocking for turnstiles, and "timed" for time blocking in another devices. |
| antipassback_timeout | int | Anti-passback blocking time when the "timed" or "timed_catra" modes are in use. Value specified in minutes. |
bio_id
Device biometrics settings.
| Field | Type | Description |
|---|---|---|
| similarity_threshold_1ton | string | The higher the number set, the more accurate the identification will be. Increasing this number will decrease the false acceptance rate and increase the false rejection rate, decreasing it will have the opposite effect. Default value: "12300". |
online_client
Settings of the client (device) when in enterprise mode.
| Field | Type | Description |
|---|---|---|
| server_id | int 64 | Id of the access server in the table devices, which indicates to whom the identification events will be sent. |
| extract_template | string | Configures if in case of biometric identification, the terminal will extract the template from the fingerprint and send it or if it will send the image of the fingerprint. Values: "0" or "1". |
| contingency_enabled | int | Indicates whether or not the terminal should go into contingency when there is a communication failure with the access server. Values: 0 or 1. Value 0 indicates contingency mode disabled, value 1 indicates contingency mode enabled. |
| max_request_attempts | int | The number of attempts the device makes to communicate with the server before entering contingency mode. |
| request_timeout | int | Indicates the timeout time in milliseconds that the device will wait for the response to requests. The maximum allowed time is 5000 ms. |
| alive_interval | int | Indicates the time interval in milliseconds that the device will attempt to return to online mode when in contingency (device_is_alive). |
monitor
Configuration parameters of the Monitor.
| Field | Type | Description |
|---|---|---|
| request_timeout | int | The time in ms for the request to timeout. |
| hostname | string | The address where the request will be sent to, for example, the IP of the server. |
| port | string | The port to which the request will be sent. |
| path | string | This parameter defines the path that makes up the endpoint where monitor events are notified. The default value of this parameter is "API/notifications". |
| inform_access_event_id | int | This parameter determines whether the id from the corresponding entry in the table access_events should be reported when executing catra_event, door and secbox endpoints. |
push_server
Configuration parameters of Push.
| Field | Type | Description |
|---|---|---|
| push_request_timeout | int | Timeout of requests from the device to the server in milliseconds. |
| push_request_period | int | Period between push requests in seconds. |
| push_remote_address | string | IP address and port on which the server is running, separated by ':'. Example: 192.168.120.94:80 |
uhf
Specific configuration parameters of the iDUHF antenna.
| Field | Type | Description |
|---|---|---|
| identification_bits | int | Indicates how many bits will be used to identify the UHF tags, this value varies depending on the operating modes: "Standard" or "Extended". If the "Standard" mode is selected, the value will be equal to the Wiegand output value in bits, which can be 26, 32, 34 or 66 bits. If "Extended" mode is selected, 96 bits will be used. Default: 26 bits in "Standard" mode. |
| reader_type | string | Defines the byte order, which can have the following values: "lsb" or "default". Default: "default". |
| read_interval | int | Sets the minimum interval, in milliseconds, for two consecutive readings from the SAME tag to be considered different readings, avoiding accidental duplicate readings. Minimum value: 100. Maximum value: 30000. Default: 5000. |
| read_interval_diff_tags | int | Defines the minimum interval, in milliseconds, for two consecutive readings from DIFFERENT tags to be considered different readings, avoiding accidental duplicate readings. Minimum value: 250. Maximum value: 30000. Default: 100. |
| transmit_power | int | Sets the transmission power of the antenna. This value is divided by 100 to obtain the value in dBm. Minimum value: 1500. Maximum value: 2400. Default: 2400. |
| work_channel | string | Defines the antenna operation channels that will be used. Example: enable channels 1, 2, 3, 4, 5, 7, 8, 9, and 10: "1-5;7-10". |
| operation_mode | string | Sets the operation mode, "continuous" for continuous mode, "trigger" for trigger mode and "inhibit" for inhibition mode. At continuous mode, the device will perform tag reading regardless of trigger pin state. At trigger mode, reading will be performed during the timeout period whenever there is a falling edge (pulse) on the trigger pin. At inhibition mode, the device will not read while trigger pin is activated. When the pin is deactivated, after the timeout period, the device will resume reading the tags.Default: "continuous". |
| trigger_timeout | int | Sets the trigger timeout, in milliseconds. Used only when operation_mode is set to trigger mode. Minimum value: 250. Maximum value: 60000. Default: disabled. |
| trig_idle | int | Indicates the logic level of the trigger when it is idle. Values: "0" or "1". Default: 1. |
| tag_detector_enabled | int | Indicates the operating mode of the iDUHF internal relay. If "0", the device assumes the default behavior regarding the opening of the internal relay. If "1", whenever a tag is visible, the relay will be active. So, as long as one or more tags are in front of the antenna, the relay will be active. If enabled, the iDUHF internal relay is reserved for this functionality. Default: 0. |
sec_boxs
Most of the external drive module (MAE/Security Box) settings used in iDFlex, iDAccess Pro, iDAccess Nano, and iDFace, as they are stored in the database, need to be changed through the object sec_boxs, and handled through the object handling functions. The other settings, internal to the module, are described below.
| Field | Type | Description |
|---|---|---|
| mode | string | Indicates the position of the most significant bit in the Wiegand protocol. Assumes the value ("LSB") if the most significant bit is on the right and ("") if it is on the left (MSB, Default). |
| wiegand_out_size | string | Sets the number of output bits of the Wiegand protocol. Values: "26", "32", "34", "35", "37", "40", "42", "66". |
| out_mode | string | Sets the output data type via Wiegand protocol, ("") for ID transmission (Default), "CARD" for transmission of authorized cards, and "CARD_RELAY" for transmission of any card. |
w_out0
Configuration parameters related to wiegand output of devices without the external drive module (MAE/Security Box). Through this module, you can configure the output mode and size of its protocol.
| Field | Type | Description |
|---|---|---|
| size | string | Sets the number of output bits of the Wiegand protocol. Values: "26", "32", "34", "35", "37", "40", "42", "66". |
| data | string | Sets the output data type via Wiegand protocol, ("") for ID transmission (Default), "CARD" for transmission of authorized cards, and "CARD_RELAY" for transmission of any card. |
gpio
Configuration parameters related to the GPIOs of the devices. Through this module, you can configure the relays of Control iD's turnstiles.
| Field | Type | Description |
|---|---|---|
| catra_relay_1_enabled | int | Indicates if relay 1 of the turnstile is enabled. Values: "0" for disabled and "1" for enabled. |
| catra_relay_1_enable_direction | string | Indicates the direction of turnstile arm rotation release that will cause relay 1 to activate if parameter catra_relay_1_enabled is enabled. Values: "left" for counterclockwise rotation and "right" for clockwise rotation. |
| catra_relay_2_enabled | int | Indicates if relay 2 of the turnstile is enabled. Values: "0" for disabled and "1" for enabled. |
| catra_relay_2_enable_direction | string | Indicates the direction of turnstile arm rotation release that will cause relay 2 to activate if parameter catra_relay_2_enabled is enabled. Values: "left" for counterclockwise rotation and "right" for clockwise rotation. |
onvif
Configuration parameters referring to Streaming iDFace. Through this module it is possible to configure the operating modes, the desired resolution and the orientation of the stream that will be displayed.
| Field | Type | Description |
|---|---|---|
| rtsp_enabled | int | Indicates if RTSP streaming is enabled. Values: "0" for disabled and "1" for enabled. |
| rtsp_rgb | int | Changes the used stream camera. Values: "0" for IR and "1" for RGB. |
| rtsp_username | string | Changes the user credentials so that streaming will only be enabled when the correct user and password are entered. |
| rtsp_password | string | Changes the password credentials so that streaming will only be enabled when the correct user and password are entered. |
| rtsp_port | int | Changes the user transmission port. |
| rtsp_codec | string | Changes the video used transmission codec. Values: "mjpeg" for MJPEG codec and "h264" for H.264 codec |
| rtsp_flipped | int | Enables video mirroring. Values: "0" for disabled and "1" for enabled. |
| onvif_enabled | int | Enables ONVIF standard transmission. Values: "0" for disabled and "1" for enabled. |
| onvif_port | int | Changes the used port for ONVIF standard transmission. |
ntp
NTP module configuration parameters. Through this module, it is possible to configure the time-zone and daylight saving time (for countries adopting the measure).
| Field | Type | Description |
|---|---|---|
| enabled | int | Indicates if NTP protocol is enabled. Values: "0" for disabled and "1" for enabled. |
| timezone | string | Sets local time in relation to Universal Time Coordinate (UTC). Value range: "UTC-12" to "UTC+12". |