Skip to main content

Module class

Module class 

Source
Expand description

What each command does to a device: read, write or device management (#972). One table serves the one-shot commands and the TUI’s safety levels (#964), so a command can’t be guarded in one front end and not in another.

  • Read: discovery, reads, finite COV subscriptions and foreign-device registration, plus the commands that never reach a device (mstp-ports, capture, sc-check, help), and tui and mcp, which guard their own writes. A subscription and a registration do leave an entry on the remote side, but only to deliver what the client watches, and it lapses on its own: subscribe cancels its subscription when it stops, and a registration runs out with its TTL. The TUI makes both from its read-only level.
  • Write: anything that changes a value, an object, a file, an alarm’s acknowledgment, the device’s clock or a BBMD table, and a subscription that never expires (of_subscribe).
  • Device management: communication control and reinitialize, which change whether and how the device runs at all.

Enums§

Class
What a command does to a device.

Constants§

COMMANDS
Every subcommand, aliases included, with its class. A test in bacnet-cli checks this against the clap definitions in both directions.

Functions§

of
The class of a subcommand, by name or alias; None for a word that is neither.
of_subscribe
The class of subscribe (cov) asking for lifetime seconds. A finite subscription is renewed while the CLI watches and cancelled when it stops, so it is a read; one of 0 never expires (Clause 13.14.1.1.4) and outlives the CLI, so it is a write.