Session Status
The Session Status widget shows a simple status indicator that reflects whether a session is active or inactive, with visual feedback through colours. It provides a clear indication of the session state with customisable text labels.
The background changes colour according to the received state (green for active, red for inactive) and updates are reflected in real time as new messages arrive.
Features
- Visual status indication: green background for active sessions, red for inactive ones and white when there is no state.
- Customisable text: lets you define your own texts for the active and inactive states.
- Responsive layout: text size adapts to different screen sizes.
- Real-time updates: the status updates automatically from the incoming messages.
- High contrast: text colours optimised for readability.
Configuration
| Property | Description | Default |
|---|---|---|
| Name | Node name shown in the editor. | '' (empty) |
| Group | Dashboard group where the widget is displayed. | — |
| Size (width / height) | Widget width and height (0 = fit automatically to the group). | 0 / 0 |
| Session On Text | Text shown when the session is active. | SESSION ON |
| Session Off Text | Text shown when the session is inactive. | SESSION OFF |
Input
This node has 1 input.
The state is controlled through the payload.status property (boolean):
true: active session (shows the active session text on a green background).false: inactive session (shows the inactive session text on a red background).null/undefined: no state (white background and no text).
msg.payload = { status: true };Updates are reflected in the interface immediately when new messages are received.
Output
This node does not emit messages. It is a display-only component that shows the session status.
Usage example
An inject node or a function that sends the session state to the widget:
msg.payload = { status: true };
return msg;Sending { status: false } switches the session to inactive, and { status: null } clears the status display.
A typical case is connecting the output of an inspection process or a control system: when the work session starts, { status: true } is sent and the panel turns green; when it finishes, { status: false } is sent and the panel turns red, giving the operator an immediate visual cue about the system state.