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 described in its own file and then assembled	yml	See the Swarm administration or Official documentation
module.ip-rct	Configuration of the module	json	module.ip-rct
cluster.ip-rct	Definition of an IP-RCT cluster	json	cluster.ip-rct
server.ip-rct	Configuration of the connection with an IP-RCT (as an AE)	json	server.ip-rct
device.ip-rct	Defines an SPT	json	device.ip-rct
owner-device.ip-rct	Defines connection state between an SPT and the IP-RCT	json	owner-device.ip-rct
owner-alarm.ip-rct	Define link between alarms from SPT and the IP-RCT	json	owner-alarm.ip-rct
criteria.ip-rct	Define conditions for criteria that informs if upcoming alarm have to be handled	json	criteria.ip-rct
owner-criteria.ip-rct	Define link between criteria from SPT and the IP-RCT	json	owner-criteria.ip-rct
output.ip-rct	Change a state on a IP-RCT based on the linked value.	json	output.ip-rct

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