Introduction to Alarm

Alarms are important tools for access control devices. This type of tool is capable of signaling improper user operations, invasion attempts, and danger situations for the user. Most alarm configurations are stored on database and can, therefore, be changed in the alarm object.

POST /alarm_status.fcgi

Command to change and get the current status of the alarm. It also makes it possible to deactivate the audible alarm of the device.

Parameters

• stop (bool): The default value is true. If true, it makes the alarm stops.

Response

• active (bool): Indicates if the alarm is active.
• cause (int): Indicates the cause of the alarm activation.
• 0: No cause
• 1: Alarm zone 1
• 2: Alarm zone 2
• 3: Alarm zone 3
• 4: Alarm zone 4
• 5: Alarm zone 5
• 6: Opened door
• 7: Door burglary
• 8: Panic finger
• 9: Device tampering
• 10: Panic card
• 11: Panic PIN
• 12: Panic Password
• 13: Monitored alarm zone no presence
• 14: Monitored alarm zone open

It's relevant to notice that causes 13 and 14 are exclusive to the iDFit and iDAccess equipments, as both have an internal lock activation relay (and door detection pins) as they are equipments prior to Secbox, therefore, support for Monitored Alarm Zone is a feature available only for devices without Secbox.

Example of status request

Parameters

• This request has no parameters.

Response

{
    "active": false,
    "cause": 0
}

Example of alarm deactivation

Parameters

{
  "stop": true
}

Response

• This request has no response.

POST /set_configuration.fcgi

Command to change alarm parameters. Enables the configuration of time intervals and activation/deactivation of alarm aspects.

Parameters

• device_violation_enabled: Enables/disables the device violation alarm.
• door_sensor_alarm_timeout_after_closure: Duration time that the alarm will indicate "door open alarm" after closing the door instead of indicating "break-in alarm" (in ms).
• door_sensor_delay: Delay time for door opening after identification detection (in ms).
• door_sensor_enabled: Enables/disables door sensor alarm.
• forced_access_debounce: Debounce time in case of forced access (in ms).
• forced_access_enabled: Enables/disables forced access alarm.
• panic_card_enabled: Enables/disables panic card alarm.
• panic_finger_delay: Delay time to indicate a coercion situation through the panic finger alarm.
• panic_finger_enabled: Enables/disables the panic finger alarm.
• panic_password_enabled: Enables/disables the panic password alarm.
• panic_pin_enabled: Enables/disables the panic pin alarm.

Message:

{
    "alarm": {
        device_violation_enabled: "0"
        door_sensor_alarm_timeout_after_closure: "0"
        door_sensor_delay: "5"
        door_sensor_enabled: "1"
        forced_access_debounce: "2"
        forced_access_enabled: "0"
        panic_card_enabled: "1"
        panic_finger_delay: "1"
        panic_finger_enabled: "1"
        panic_password_enabled: "1"
        panic_pin_enabled: "1"
    }
}

Response:

• The request has no response.