Skip to content

Alarm handling with AMSG #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pheest wants to merge 2 commits into
base: master
Choose a base branch
from
+129 −17
Open

Alarm handling with AMSG #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f70f1e6
Copied from old fork.
pheest Jul 30, 2026
1b2fec0
Accepted changes to ci-scripts-build.yml made by Windows support pull…
pheest Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/ci-scripts-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,39 @@ jobs:
python: "3.7"
container: "python:3.7"
profile: deb10

- os: windows-latest
cmp: vs2026
configuration: default
base: "3.15"
python: "3.11"
profile: latest
test: yes

- os: windows-latest
cmp: vs2026
configuration: default
base: "7.0"
python: "3.11"
profile: latest
test: yes

- os: windows-latest
cmp: vs2026
configuration: default
base: "7.0"
python: "3.12"
profile: latest
test: yes

- os: windows-latest
cmp: vs2026
configuration: default
base: "7.0"
python: "3.13"
profile: latest
test: yes

steps:
- uses: actions/checkout@v3
with:
Expand All @@ -169,6 +202,7 @@ jobs:
with:
python-version: ${{ matrix.python }}
- name: More Setup Python
shell: bash
run: |
python --version
python -m pip --version
Expand Down
18 changes: 13 additions & 5 deletions devsupApp/src/dbrec.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,11 @@ static PyObject* pyRecord_setSevr(pyRecord *self, PyObject *args, PyObject *kws)
{
dbCommon *prec = self->entry.precnode->precord;

static char* names[] = {"sevr", "stat", NULL};
static char* names[] = {"sevr", "stat", "amsg", NULL};
short sevr = INVALID_ALARM, stat=COMM_ALARM;
const char *amsg = NULL;

if(!PyArg_ParseTupleAndKeywords(args, kws, "|hh", names, &sevr, &stat))
if(!PyArg_ParseTupleAndKeywords(args, kws, "|hhz", names, &sevr, &stat, &amsg))
return NULL;

if(sevr<firstEpicsAlarmSev || sevr>lastEpicsAlarmSev
Expand All @@ -137,7 +138,13 @@ static PyObject* pyRecord_setSevr(pyRecord *self, PyObject *args, PyObject *kws)
PyErr_Format(PyExc_ValueError, "%s: Can't set alarms %d %d", prec->name, sevr, stat);
return NULL;
}

// @since 7.0.6
#ifdef HAS_ALARM_MESSAGE
if(amsg) {
recGblSetSevrMsg(prec, stat, sevr, "%s", amsg);
Py_RETURN_NONE;
}
#endif
recGblSetSevr(prec, stat, sevr);
Py_RETURN_NONE;
}
Expand Down Expand Up @@ -317,8 +324,9 @@ static PyMethodDef pyRecord_methods[] = {
"infos() -> {'name':'value'}\n"
"Return a dictionary of all infos for this record."},
{"setSevr", (PyCFunction)pyRecord_setSevr, METH_VARARGS|METH_KEYWORDS,
"setSevr(sevr=INVALID_ALARM, stat=COMM_ALARM)\n"
"Set alarm new alarm severity/status. Record must be locked!"},
"setSevr(sevr=INVALID_ALARM, stat=COMM_ALARM, amsg=None)\n"
"Set alarm new alarm severity/status. Record must be locked!\n"
"amsg requires EPICS Base >= 7.0.6."},
{"setTime", (PyCFunction)pyRecord_setTime, METH_VARARGS,
"Set record timestamp if TSE==-2. Record must be locked!"},
{"scan", (PyCFunction)pyRecord_scan, METH_VARARGS|METH_KEYWORDS,
Expand Down
31 changes: 19 additions & 12 deletions devsupApp/src/devsup/ptable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
_tables = {}

from .db import IOScanListThread
from . import INVALID_ALARM, UDF_ALARM
from . import INVALID_ALARM, UDF_ALARM, NO_ALARM

__all__ = [
'Parameter',
Expand Down Expand Up @@ -161,6 +161,8 @@ def __init__(self, table, name, scan):
self.name = name
self.table, self.scan, self._value = table, scan, None
self.alarm, self.actions = 0, []
self.stat = UDF_ALARM
self.amsg = None
self._groups = set()
def _get_value(self):
return self._value
Expand Down Expand Up @@ -221,6 +223,10 @@ def __init__(self, inst, rec, info):
self.vdata = None
if len(self.vfld)>1:
self.vdata = self.vfld.getarray()
if rec.PINI == "YES":
# record processing will have updated the field.
sel.inst.stat = NO_ALARM

def detach(self, rec):
pass
def allowScan(self, rec):
Expand All @@ -232,19 +238,19 @@ def process(self, rec, reason=None):
"""Read a value from the table into the record
"""
with self.inst.table.lock:
nval, alrm = self.inst.value, self.inst.alarm
self.inst.table.log.debug('%s -> %s (%s)', self.inst.name, rec.NAME, nval)
value, alarm, stat, amsg = self.inst.value, self.inst.alarm, self.inst.stat, self.inst.amsg
self.inst.table.log.debug('%s -> %s (%s)', self.inst.name, rec.NAME, value)

if nval is not None:
if value is not None:
if self.vdata is None:
self.vfld.putval(nval)
self.vfld.putval(value)
else:
if len(nval)>len(self.vdata):
if len(value)>len(self.vdata):
nval = nval[:len(self.vdata)]
self.vdata[:len(nval)] = nval
self.vfld.putarraylen(len(nval))
if alrm:
rec.setSevr(alrm)
self.vdata[:len(value)] = value
self.vfld.putarraylen(len(value))
if alarm:
rec.setSevr(alarm, stat, amsg)
else:
# undefined value
rec.setSevr(INVALID_ALARM, UDF_ALARM)
Expand All @@ -271,8 +277,9 @@ def process(self, rec, reason=None):

# Execute actions
self.inst._exec(oval)
for G in self.inst._groups:
G._exec()
rec.setSevr(self.inst.alarm, self.inst.stat, self.inst.amsg)
for G in self.inst._groups:
G._exec()

class TableBase(object):
"""Base class for all parameter tables.
Expand Down
63 changes: 63 additions & 0 deletions devsupApp/src/devsup/test/test_db.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,66 @@ def test_increment(self):
with rec:
self.assertEqual(rec.VAL, 1)
self.assertEqual(rec.UDF, 0)

class TestAlarm(IOCHelper):
db = """
record(longin, "rec:inalarm:amsg") {
field(PINI, "YES")
}
record(longin, "rec:inalarm:plain") {
field(PINI, "YES")
}
record(longout, "rec:outalarm:amsg") {
field(PINI, "YES")
field(VAL, "0")
}
record(longout, "rec:outalarm:plain") {
field(PINI, "YES")
field(VAL, "0")
}
"""
def test_setin_severity_message(self):
rec = getRecord("rec:inalarm:amsg")
with rec:
self.assertEqual(rec.SEVR, _dbapi.NO_ALARM)
self.assertEqual(rec.STAT, _dbapi.NO_ALARM)
if _dbapi.epicsver[:4] >= (7, 0, 6, 0):
self.assertEqual(rec.AMSG, "")
self.assertEqual(rec.setSevr(_dbapi.MAJOR_ALARM, _dbapi.HIHI_ALARM, amsg="Meaningful input alarm message"), None)
self.assertEqual(rec.scan(sync=True), 0)
self.assertEqual(rec.STAT, _dbapi.HIHI_ALARM)
if _dbapi.epicsver[:4] >= (7, 0, 6, 0):
self.assertEqual(rec.AMSG, "Meaningful input alarm message")

def test_setin_severity_without_message(self):
rec = getRecord("rec:inalarm:plain")
with rec:
self.assertEqual(rec.SEVR, _dbapi.NO_ALARM)
self.assertEqual(rec.STAT, _dbapi.NO_ALARM)
self.assertEqual(rec.setSevr(_dbapi.MAJOR_ALARM, _dbapi.COMM_ALARM), None)
self.assertEqual(rec.scan(sync=True), 0)
self.assertEqual(rec.SEVR, _dbapi.MAJOR_ALARM)
self.assertEqual(rec.STAT, _dbapi.COMM_ALARM)

def test_setout_severity_message(self):
rec = getRecord("rec:outalarm:amsg")
with rec:
self.assertEqual(rec.SEVR, _dbapi.NO_ALARM)
self.assertEqual(rec.STAT, _dbapi.NO_ALARM)
if _dbapi.epicsver[:4] >= (7, 0, 6, 0):
self.assertEqual(rec.AMSG, "")
self.assertEqual(rec.setSevr(_dbapi.MAJOR_ALARM, _dbapi.HIHI_ALARM, amsg="Meaningful output alarm message"), None)
self.assertEqual(rec.scan(sync=True), 0)
self.assertEqual(rec.STAT, _dbapi.HIHI_ALARM)
if _dbapi.epicsver[:4] >= (7, 0, 6, 0):
self.assertEqual(rec.AMSG, "Meaningful output alarm message")

def test_setout_severity_without_message(self):
rec = getRecord("rec:outalarm:plain")
with rec:
self.assertEqual(rec.SEVR, _dbapi.NO_ALARM)
self.assertEqual(rec.STAT, _dbapi.NO_ALARM)
self.assertEqual(rec.setSevr(_dbapi.MAJOR_ALARM, _dbapi.COMM_ALARM), None)
self.assertEqual(rec.scan(sync=True), 0)
self.assertEqual(rec.SEVR, _dbapi.MAJOR_ALARM)
self.assertEqual(rec.STAT, _dbapi.COMM_ALARM)