Interface DeviceOptions

Configuration options for Device model instances.

Defines device identity and node-specific parameters for KOS device modeling. Device models represent the physical device identity and node configuration within a KOS system deployment.

Example: Basic Device Configuration

const deviceOptions: DeviceOptions = {
  serialNumber: 'KOS-DEVICE-12345',
  name: 'Main Beverage Dispenser',
  nodeId: 'primary-node-01'
};

const device = Device.factory(deviceOptions);
interface DeviceOptions {
    serialNumber?: string;
    name?: string;
    nodeId?: string;
}

Properties

serialNumber? name? nodeId?

Properties

Optional serialNumber

serialNumber?: string

Unique device serial number from hardware.

Retrieved from the device's hardware identification system. Used for warranty tracking, support, and device-specific configuration.

Optional name

name?: string

Human-readable device name for identification.

Typically configured during device setup and used in administrative interfaces for device identification and management.

Optional nodeId

nodeId?: string

Node identifier within the KOS deployment.

Identifies the specific node role and instance within a multi-node KOS deployment. Format typically follows 'type-instance' pattern.

Settings

Member Visibility

Theme

On This Page

serialNumbernamenodeId