Skip to content

SolarNode Operational Modes

Matt Magoffin edited this page Jul 28, 2021 · 4 revisions

SolarNode supports a concept called operational modes. Modes are simple names like quiet and hyper that can be either active or inactive. Any number of modes can be active at a given time. In theory both quiet and hyper could be active simultaneously. Modes can be named anything you like.

Modes can be used by SolarNode plugins to alter the state of the node dynamically. For example a plugin might stop collecting data from a set of data sources if the quiet mode is active, or start collecting data at an increased frequency if hyper is active. Some SolarNode plugins might require specific names, which are described in their documentation. Plugins that allow configuring a required operational mode setting can also invert the requirement by adding a ! prefix to the mode name, for example !hyper can be thought of as "when hyper is not active". You can also specify exactly ! to match only when no mode is active.

The SolarNode UI will show the list of active operational modes on the Settings page:

SolarNode Operational Mode Service settings

The SolarUser Instruction API can be used to toggle operational modes on/off. The EnableOperationalModes instruction activates modes and DisableOperationalModes deactivates them.

Clone this wiki locally