Software Overview  |  Sitemap  |  Downloads  |  Developers  |  Forums
Small_clear_logo_llc

Terminals Created by the Alarm Script

The Alarm Device has a set of terminals which are created when running the basic "Alarm" Script. These terminals are named "alarm", "command", "disabled_inputs", "enabled", "input_status", "messages", and "trigger".

"alarm" Output Terminal

When an Alarm Device is stimulated by an alarm condition, it will set its "alarm" output terminal to on. The "alarm" output terminal will remain on for the amount of time determined by the Alarm Device "duration" parameter (see Creating an Alarm Device section), and then it will be set to off. If the Alarm Device receives another alarm stimulus while the alarm is still on, the alarm will remain on for the "duration" starting at the time of this most recent stimulus.

"enabled" Output Terminal

The "enabled" terminal says whether the Alarm Device is on or off. If the "enabled" terminal is off, the "alarm" output terminal will be off and never turn on. If the enabled terminal is on, the Alarm Device will function normally.

The Alarm Device enables and disables itself when responding to commands on its "command" terminal.

"command" Input Terminal

The Alarm Device responds to a set of commands on its "command" terminal. Commands come from other Devices over wires connected to the "command" terminal. Each command will generate a message on the "messages" terminal (see messages Terminal section). Commands are double quoted strings and are one of the following (case insensitive):

  • reset : sets the Alarm Device "alarm" terminal to off and tells the Alarm Device to rearm itself. The "reset" command is useful when one wants to cut short an alarm and wait for new triggers.

  • on : enables the Alarm Device. The Alarm Device will set its "enabled" terminal to on.

  • off : disables the Alarm Device. The Alarm Device will set its "enabled" terminal to off.

  • status : generates a message on the "messages" terminal with the state of the Alarm Device (see messages Terminal section).

"messages" Output Terminal

When the Alarm Device receives a command (see "command" Terminal section), or senses alarm conditions, it writes a message to its "messages" terminal. Messages are double quoted strings suitable for wiring to other Devices or for just reading from a web status screen. The messages sent on the "messages" terminal are as follows:

  • when there is an alarm : a message saying the alarm is on, which user defined input terminal caused the alarm, and the state of all the user defined input terminals.

  • after a "reset" command : an acknowledgement that a reset occurred.

  • after an "on" command : an acknowledgement that the Alarm Device is enabled.

  • after an "off" command : an acknowledgement that the Alarm Device is disabled.

  • after a "status" command : a message giving the state of the alarm, whether the alarm is enabled, and the state of all the user defined inputs.

  • all other commands : an error message saying the command is unknown, and a list of possible commands.

"input_status" Output Terminal

This terminal has a real time status of all the Alarm Device input terminals. The status is a double quoted string suitable for wiring to other Devices. It is updated all the time, even when the Alarm Device is disabled.

"trigger" Output Terminal

This terminal has a double quoted string describing the most recent trigger condition. Triggers are reported on this terminal whether the Alarm Device is on or off (useful when debugging a system which is off) and whether the "alarm" output is on or off. The message on the "messages" terminal when an alarm occurs also has this trigger information.

Catalina Computing, LLC.

Copyright © Catalina Computing, LLC. (2013-2017)




Page last updated: Wed Jan 7 16:07:02 2015 (UTC)