XDevice | SiteKiosk Online API

Index

Properties

address config name state type

Events

onError onStateChanged

Methods

ready start stop

Properties

address

address: Number

The address this device is connected to the Nexmosphere controller.

config

config: any

The device config.

name

name: string

The name of the device.

state

state: DeviceState

The device state.

type

type: string

The type of the device.

Events

onError

onError(callback: ((error: Error) => void)): EventSubscription
Registers a callback which will be triggered when the device encounters an error.
Parameters
- callback: ((error: Error) => void)
  
  The callback which will be called once the device encountered an error.
  - - (error: Error): void
    - Parameters
      
      error: Error
      
      Returns void
Returns EventSubscription

Inherited from Device.onError

onStateChanged

onStateChanged(callback: ((state: DeviceState) => void)): EventSubscription
Registers a callback which will be triggered when the device state changes.
Parameters
- callback: ((state: DeviceState) => void)
  
  The callback which will be called once the device changes its state.
  - - (state: DeviceState): void
    - Parameters
      
      state: DeviceState
      
      Returns void
Returns EventSubscription

Inherited from Device.onStateChanged

Methods

ready

ready(): Promise<any>
Returns a promise which is fulfilled when the device is started.

Returns Promise<any>

Inherited from Device.ready

start

start(): Promise<any>
Starts the device when needed and returns a promise which is fulfilled when the device is started.

Returns Promise<any>

Inherited from Device.start

stop

stop(): void
Stops the device.

Returns void

Inherited from Device.stop

Generated using TypeDoc