API  2.2
TSmarT Software Library
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
tsmart_carriots_alarm_t Struct Reference

Alarm structure. More...

#include <tsmart_carriots.h>

Data Fields

uint8_t description [PR_TSMART_CARRIOTS_ALARM_SIZE]
 
uint8_t severity
 
uint8_t state [PR_TSMART_CARRIOTS_ALARM_ST_SIZE]
 
uint8_t enabled
 
uint8_t entity_type [PR_TSMART_CARRIOTS_ALARM_TYPE_SIZE]
 

Detailed Description

Alarm structure.

Examples:
carriots_2g.c, and carriots_wifi.c.

Field Documentation

uint8_t description[PR_TSMART_CARRIOTS_ALARM_SIZE]

Alarm description

Examples:
carriots_2g.c, and carriots_wifi.c.
uint8_t enabled

Boolean. Valid values: 0 or 1

Examples:
carriots_2g.c, and carriots_wifi.c.
uint8_t entity_type[PR_TSMART_CARRIOTS_ALARM_TYPE_SIZE]

Entity type. It shall be:

  • TSMART_CARRIOTS_ALARM_TYPE_DEVICE
  • TSMART_CARRIOTS_ALARM_TYPE_GROUP
  • TSMART_CARRIOTS_ALARM_TYPE_SERVICE
  • TSMART_CARRIOTS_ALARM_TYPE_PROJECT
Examples:
carriots_2g.c, and carriots_wifi.c.
uint8_t severity

Alarm severity. It is an integer.

Examples:
carriots_2g.c, and carriots_wifi.c.
uint8_t state[PR_TSMART_CARRIOTS_ALARM_ST_SIZE]

Alarm state. It shall be:

  • TSMART_CARRIOTS_ALARM_ST_ACTIVE
  • TSMART_CARRIOTS_ALARM_ST_ACKNOWLEDGED
  • TSMART_CARRIOTS_ALARM_ST_CLOSED
  • TSMART_CARRIOTS_ALARM_ST_DISABLED
Examples:
carriots_2g.c, and carriots_wifi.c.