alarm.h

Alarm severity and status/condition values.

These alarm definitions must match the related menuAlarmSevr.dbd and menuAlarmStat.dbd files found in the IOC database module.

Author

Bob Dalesio and Marty Kraimer

Original macros for alarm severity values

firstEpicsAlarmSev
MINOR_ALARM
MAJOR_ALARM
INVALID_ALARM
lastEpicsAlarmSev

Original macros for alarm status/condition values

firstEpicsAlarmCond
READ_ALARM
WRITE_ALARM
HIHI_ALARM
HIGH_ALARM
LOLO_ALARM
LOW_ALARM
STATE_ALARM
COS_ALARM
COMM_ALARM
TIMEOUT_ALARM
HW_LIMIT_ALARM
CALC_ALARM
SCAN_ALARM
SOFT_ALARM
BAD_SUB_ALARM
UDF_ALARM
DISABLE_ALARM
SIMM_ALARM
READ_ACCESS_ALARM
WRITE_ACCESS_ALARM
lastEpicsAlarmCond

Defines

NO_ALARM

The NO_ALARM value can be used as both a severity and a status.

Enums

enum epicsAlarmSeverity

Alarm severity values.

Note

These must match the choices in menuAlarmSevr.dbd

Values:

enumerator epicsSevNone

No alarm

enumerator epicsSevMinor

Minor alarm severity

enumerator epicsSevMajor

Major alarm severity

enumerator epicsSevInvalid

Invalid alarm severity

enumerator ALARM_NSEV

Number of alarm severities

enum epicsAlarmCondition

Alarm status/condition values.

Note

These must match the choices in menuAlarmStat.dbd

Values:

enumerator epicsAlarmNone

No alarm

enumerator epicsAlarmRead

Read alarm (read error)

enumerator epicsAlarmWrite

Write alarm (write error)

enumerator epicsAlarmHiHi

High high limit alarm

enumerator epicsAlarmHigh

High limit alarm

enumerator epicsAlarmLoLo

Low low limit alarm

enumerator epicsAlarmLow

Low limit alarm

enumerator epicsAlarmState

State alarm (e.g. off/on)

enumerator epicsAlarmCos

Change of state alarm

enumerator epicsAlarmComm

Communication alarm

enumerator epicsAlarmTimeout

Timeout alarm

enumerator epicsAlarmHwLimit

Hardware limit alarm

enumerator epicsAlarmCalc

Calculation expression error

enumerator epicsAlarmScan

Scan alarm, e.g. record not processed (10 times) or not in desired scan list

enumerator epicsAlarmLink

Link alarm

enumerator epicsAlarmSoft

Soft alarm, e.g. in sub record if subroutine gives error

enumerator epicsAlarmBadSub

Bad subroutine alarm, e.g. in sub record subroutine not defined

enumerator epicsAlarmUDF

Undefined value alarm, e.g. record never processed

enumerator epicsAlarmDisable

Record disabled using DISV/DISA fields

enumerator epicsAlarmSimm

Record is in simulation mode

enumerator epicsAlarmReadAccess

Read access permission problem

enumerator epicsAlarmWriteAccess

Write access permission problem

enumerator ALARM_NSTATUS

Number of alarm conditions

Variables

const char *epicsAlarmSeverityStrings[ALARM_NSEV]

How to convert an alarm severity into a string.

const char *epicsAlarmConditionStrings[ALARM_NSTATUS]

How to convert an alarm condition/status into a string.