Skip to content

Commit

Permalink
docs/new-drivers.txt: in "Status data", stress the life-cycle of `ups…
Browse files Browse the repository at this point in the history
….status` flag tokens [networkupstools#2708]

Signed-off-by: Jim Klimov <[email protected]>
  • Loading branch information
jimklimov committed Dec 3, 2024
1 parent 6bf775c commit 32fcb3f
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions docs/new-drivers.txt
Original file line number Diff line number Diff line change
Expand Up @@ -244,9 +244,20 @@ Possible values for status_set:
BOOST -- UPS is boosting incoming voltage
FSD -- Forced Shutdown (restricted use, see the note below)

Anything else will not be recognized by the usual clients. Coordinate
with the nut-upsdev list before creating something new, since there will be
duplication and ugliness otherwise.
Anything else will not be recognized by the usual clients expecting a
particular NUT standard release. New tokens may appear over time, but
driver developers should coordinate with the nut-upsdev list before creating
something new, since there will be duplication and ugliness otherwise.
It is possible that eventually, due to hardware and software design evolution,
some concepts would be superseded by others. Fundamental meanings of the
flags listed above should not change (but these flags may become no longer
issued by the current NUT drivers; then may still be used e.g. in forks or
older packaged builds).

Clients however MUST accept any space-separated tokens in `ups.status`
without error or crash, and MUST treat those defined above with the
ascribed meanings, but MAY ignore unidentified tokens (quietly by default,
or acknowledge the skip with a debug log message).

[NOTE]
==============================================================================
Expand Down

0 comments on commit 32fcb3f

Please sign in to comment.