Interface StatePropOptions

Configuration options for StateProp model instances.

This interface defines the configuration options for the StateProp model, specifying which state path and attribute the model should monitor for focused property access.

Example: Basic Usage

const deviceOnline = StateProp.instance('device-online')
  .options({
    path: 'device.operational.status',
    attribute: 'online'
  })
  .build();
interface StatePropOptions {
    path: string;
    attribute: string;
}

Properties

path attribute

Properties

path

path: string

State path to monitor, matching the StateBean path structure. Uses dot notation hierarchy corresponding to /kos/state/{path} WebSocket topic.

Example

"device.operational.status"

Example

"assembly.pumps.pump1"

Example

"system.health.metrics"

attribute

attribute: string

Specific attribute name within the state path to access. This corresponds to a property key within the StateBean's properties Map.

Example

"online"

Example

"temperature"

Example

"flowRate"

Example

"active"

Settings

Member Visibility

Theme

On This Page

pathattribute