osp-ip-rct
Overview
Warning
In the next paragraph the term alarm is used with the meaning of an alarm for the IP-RCT device and not with the meaning of an internal alarm in the OnSphere scope.
The IP-RCT is a device acting as a gateway for alarms coming from different protocols (ARCxml, DC-09, …) and transforming them into a unified format. Alarms are then transmitted to an external device (like OnSphere). This device, called AE, may or may not acknowledge the alarms. If an alarm is acknowledged, only then does the transmitting device receive the response from the IP-RCT.
The osp-ip-rct connector allows OnSphere to interface with one or multiple IP-RCT to receive alarms transmitted by them. All standard alarms are supported (fire, aggression, burglary…) as well as alarms related to devices connectivity.
The osp-ip-rct connector receives alarms transmitted by connected IP-RCTs and distributes them as values in hierarchies using device, alarm and criteria filters.
List of configuration files
Filename |
Short description |
Format |
Documentation |
|---|---|---|---|
module.service |
Each service is defined in a separate file and then combined into a unified compose stack file |
yml |
See the Swarm administration or Official documentation |
module.ip-rct |
Configuration of the module |
json |
|
cluster.ip-rct |
Definition of an IP-RCT cluster |
json |
|
server.ip-rct |
Configuration of the connection with an IP-RCT (as an AE) |
json |
|
device.ip-rct |
Defines an SPT |
json |
|
owner-device.ip-rct |
json |
||
owner-alarm.ip-rct |
json |
||
criteria.ip-rct |
Define conditions for criteria that informs if upcoming alarm have to be handled |
json |
|
owner-criteria.ip-rct |
json |
||
output.ip-rct |
Change a state on a IP-RCT based on the linked value. |
json |
Persistent storage
The osp-ip-rct plugin stores the state of the device and server as they will not be refreshed when the module restarts. The RCT will not resend the event corresponding to a connection loss because they are acknowledged when received.
The data are stored on /osp/data/store and this must be persisted between restart.
Note
See persistent storage section for more details
Environment Variables
All modules env variables
Variable Name |
Default Value |
Usage |
|---|---|---|
PROMETHEUS_PORT |
9100 |
The internal port used for Openmetrics exposition. |
DISPATCHER_HOST |
modules_configuration-dispatcher_main |
The hostname on which the modules can fetch the configuration. |
DISPATCHER_PORT |
10000 |
The port used by the module to listen for configuration request. |
USE_LEGACY_RESTART |
Not set |
When this flag is enabled, the container will terminate itself whenever a restart is needed (for example, after a configuration change). This is the legacy restart (before version 2.1.0). Otherwise, the system will simply restart the process running inside the container. |
CUSTOM_JVM_OPTIONS |
Not set |
Allow to inject JVM options. See Configuration changes for more information. |
ALLOW_VERSION_MISMATCH |
Not set |
Allow to disable the version check when a new configuration is published to a module. By default, a module will not be restarted if its configuration does not match its version. |
Dedicated variables