Krill SDK/krill.zone.shared.node/NodeState

NodeState

@Serializable

enum NodeState : Enum<NodeState> (source)

Lifecycle / status state for every Krill node.

Consumed widely: the UI colours node chips by this value, processors gate work on it (e.g., PAUSED suppresses execution), the SSE layer emits changes as STATE_CHANGE events, and downstream logic (triggers, filters) reacts to specific transitions.

Both enum names and ordinals are part of the public wire contract and are observed by clients across JVM, Android, iOS, and wasmJs — do not rename or reorder without a coordinated migration.

Use isInvokable to check whether a node in this state may receive a deliberate invocation (via krill.zone.shared.node.NodeHttp.invokeNode).

Entries

PAUSED

Processing is suspended by user action; the node exists but is not running.

INFO

Informational status — the node is healthy and has a non-alarm message to surface in the UI.

WARN

A warning-level condition the operator should see but no immediate intervention is required.

SEVERE

A severe condition — node may still be running but degraded; prompts attention.

ERROR

A hard error condition — the node failed to execute, connect, or read.

PAIRING

The node is in a pairing / discovery handshake (e.g., a Zigbee device being joined).

NONE

Default idle state — the node exists and has nothing noteworthy to report.

PROCESSING

The node is actively executing its work (reading a sensor, firing an executor, etc.).

EXECUTED

The node just completed a successful execution; often a transient state visible briefly in the UI.

DELETING

The node is in the middle of being deleted; shown briefly so clients can animate the removal.

CREATE_OR_OVERWRITE

The node was just created; shown briefly to allow the UI to fade it in, or it changed in a way where it needs to be completely refreshed

USER_EDIT

The user has opened the node in the editor but has not yet submitted changes.

USER_SUBMIT

The user has submitted edits; the node will transition away once the server acknowledges.

SNAPSHOT_UPDATE

A snapshot (historical time-series payload) arrived for this node; used to invalidate cached views on the client side so the next read pulls fresh data.

UNAUTHORISED

The caller lacks authorisation to view or mutate this node (missing/invalid API key).

EDITING

The node is currently being edited by some client; used as a soft lock so concurrent editors can see a Someone else is editing this hint.

RESET

The node was reset to its initial / cleared state by a krill.zone.shared.node.NodeAction.RESET action; parallel to EXECUTED for the reset execution path.

Properties

entries

val entries: EnumEntries<NodeState>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

isInvokable

fun NodeState.isInvokable(): Boolean

Returns true when a node in this state may receive a deliberate invocation.

valueOf

fun valueOf(value: String): NodeState

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<NodeState>

Returns an array containing the constants of this enum type, in the order they're declared.