Standard MAL API

Note

daqOcmServer hosts the standard commands stdif.StdCmds under URI path /std.

The standard interface is documented in the RAD User Manual and should be consulted for details and only a brief overview is provided here.

Interfaces

class stdif.StdCmds

Standard command interface.

Stop() → str
Init() → str
Reset() → str
Enable() → str
Disable() → str
GetState() → str

Returns application state string with orthogonal states separated by ; and state hiearchy separated by :: {state}[:{substate}][[;{state}]:{substate}]]`.

Note

Because the standard state machine model have unnamed main region in each state {state}:{unnamed}:{substate} this result in {state}::{substate} .

E.g. On::Operational::Idle tells us the state is Idle inside an unnamed region, inside state Operational and so on.

GetStatus() → str

Returns status string compatible with IFW System Supervisor in the form {state};{substate}. Effectively it returns the last two named states from GetState().

State On::Operational::Idle returns Operational;Idle.

GetVersion() → str
Exit() → str
SetLogLevel(info: LogInfo) → str

Data Structures

class stdif.LogInfo
level: str
logger: str
class stdif.State
state: str
source: str
class stdif.Status
status: str
source: str