Skip to content

Commit 6cd9592

Browse files
committed
docs/new-drivers.txt: clarify alarm state handling
Signed-off-by: desertwitch <[email protected]>
1 parent dfe6062 commit 6cd9592

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/new-drivers.txt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,10 @@ formatting string to those expectations. In this case, you would use
218218
char *fmt = "Mega-Zapper %d";
219219
dstate_setinfo_dynamic("ups.model", fmt, "%d", rating);
220220

221+
Please note that `ups.alarm` should no longer be manually set, but rather
222+
the appropriate alarm functions should be used instead. For more details,
223+
see below in the `UPS alarms` section.
224+
221225
Setting flags
222226
~~~~~~~~~~~~~
223227

@@ -261,9 +265,10 @@ Possible values for status_set:
261265
BOOST -- UPS is boosting incoming voltage
262266
FSD -- Forced Shutdown (restricted use, see the note below)
263267

264-
Internally, an `ALARM` value would be added (typically as first in the list)
265-
if the `ups.alarm` is currently not empty. For more details, see below in
266-
`alarm_set()` description.
268+
`ALARM` should no longer be raised through the UPS status.
269+
An `ALARM` value will be added internally (typically as first in the list)
270+
if an alarm was set and committed through the appropriate alarm functions.
271+
For more details, see below in the `UPS alarms` section.
267272

268273
[NOTE]
269274
======

0 commit comments

Comments
 (0)