Octalarm Link: REST API for network-controlled alarms

Octalarm Link¹ is an additional licence for reporting large volumes of alertss via network-controlled alarms. The licence is suitable for the Touch Pro and is included as standard in ARA-Pro Next.

Good to know: realised interfaces integrated into relevant external process computer (in alphabetical order):
- DMP VEC
- Hoogendoorn iSii
- Hoogendoorn IIVO
- Ridder Growing Solutions

Good to know: interfaces realised via additional REST API:
- Priva Office (see Priva Office for ARA-Pro Next)

Note: support for installation and setup of Octalarm Link is done in collaboration with an engineer from Adésys (online via Microsoft Teams|duration: 1 half-day). This includes training the operator(s).

The REST API allows external devices to communicate with the Octalarm alarm dialler. These external devices use the REST API to initiate alarm messages with a specific alarm text and to monitor the connection to the alarm dialler.

Instead of creating all external alarms separately in the alarm dialler, they have been combined into a number of categories. Each category has its own specific alarm processing. The remote device uses the categories to initiate alarm messages with a specific alarm text.

Components to be set

REST API interface

For each device that wants to communicate with the Octalarm alarm dialler, you have to set up an interface. Communication with the REST API is monitored by periodic watchdog API requests. When the watchdog API requests from the remote device with Octalarm Link fail, the configured call list/service group receives a watchdog system failure. See Alarms|Configuring inputs: Link or create new call list (right-hand side) for further explanation.

One or more locations

For specific alarm processing by location or group.

Categories by location

To distribute the alarms among the different categories.

Tip: the best way to commission the REST API is to follow the sequence in this section. Using an example, we explain step by step:
1. which general methods and responses you use;
2. how to implement the REST API, locations and categories;
3. how to start alarm notifications via the REST API;
4. how to check the dialler settings.

Situation Diagram

In a greenhouse where tomatoes and peppers are grown, a process computer is used to control climate, irrigation and energy. This climate computer communicates via REST API with the Octalarm alarm dialler. To process alarms per location differently, different locations are created and alarms per location are divided into cultivation alarms (urgent or non-urgent) and technical alarms (urgent or non-urgent).