Alarm

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.3.1.5

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.cumulocity
Event Alarm

Alarm data.

Sent by the transport when a device or other application creates an Alarm, or updates an Alarm. Requires SubscribeMeasurements or configuration property subscribeToAllMeasurements. Sent to the cumulocity.measurements channel.

Examples:

 Alarm("22","c8y_UnavailabilityAlarm","12669915",1464365565.661,"No communication with device since 2016-05-27T18:11:23.886+02:00","ACKNOWLEDGED","MAJOR",1,{}) 
 Alarm("11","com_cumulocity_events_BatteryWarning","1122",1464365565.661,"Low battery level","ACTIVE","MINOR",1,{"history":{}})

Additionally, we can also create a new Alarm or update an existing Alarm for a device. To create/update an Alarm, send an Alarm event object to Alarm.CHANNEL.

Examples:

 Create an Alarm, send Alarm("","c8y_UnavailabilityAlarm","12669915",1464365565.661,"No communication with device since 2016-05-27T18:11:23.886+02:00","ACKNOWLEDGED","MAJOR",1,{}) to Alarm.CHANNEL; 
 You can update the text, status and severity fields. send Alarm("11","c8y_UnavailabilityAlarm","12669915",1464365565.661,"Low battery level","ACTIVE","MINOR",1,{}) to Alarm.CHANNEL;

Constant summary
`string`	`CHANNEL := "CumulocityIoT"` The channel for sending updates/ new Alarms to.

Member summary
`string`	`id` Unique identifier for this Alarm.
`string`	`type` The type of the Cumulocity event.
`string`	`source` Identifier of the source of the event.
`float`	`time` Timestamp of the event.
`string`	`text` Text or message of the Alarm.
`string`	`status` The status of the alarm: ACTIVE, ACKNOWLEDGED or CLEARED.
`string`	`severity` The severity of the alarm: CRITICAL, MAJOR, MINOR or WARNING. Must be upper-case.
`integer`	`count` The number of times this alarm has been sent.
`dictionary<string, any>`	`params` Any other propertiess available on the Alarm .

Constant detail

CHANNEL

string CHANNEL := "CumulocityIoT"

The channel for sending updates/ new Alarms to.

Member detail

count

integer count

The number of times this alarm has been sent.

id

string id

Unique identifier for this Alarm.

Supply as empty if creating a new Alarm.

params

dictionary<string, any> params

Any other propertiess available on the Alarm .

severity

string severity

The severity of the alarm: CRITICAL, MAJOR, MINOR or WARNING. Must be upper-case.

source

string source

Identifier of the source of the event.

status

string status

The status of the alarm: ACTIVE, ACKNOWLEDGED or CLEARED.

text

string text

Text or message of the Alarm.

time

float time

Timestamp of the event.

type

string type

The type of the Cumulocity event.