XSnapper | SiteKiosk Online API

Index

Properties

address config lastData name state type

Events

onData onError onStateChanged

Methods

ready setFunctionalityControl setLedBlinkPatternForPickup setLedBrightness setStatusLedBehaviour start stop

Properties

address

address: Number

The address this device is connected to the Nexmosphere controller.

config

config: any

The device config.

lastData

lastData: undefined | XSnapperSensorData

Returns the last data which was generated by the sensor.

name

name: string

The name of the device.

state

state: DeviceState

The device state.

type

type: string

The type of the device.

Events

onData

onData(callback: ((data: XSnapperSensorData) => void)): EventSubscription
Registers a callback which will be triggered when a sensors value has changed.
Parameters
- callback: ((data: XSnapperSensorData) => void)
  
  The callback which will be called once the sensor has generated new data.
  - - (data: XSnapperSensorData): void
    - Parameters
      
      data: XSnapperSensorData
      
      Returns void
Returns EventSubscription

Inherited from XSensor.onData

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 XSensor.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 XSensor.onStateChanged

Methods

ready

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

Returns Promise<any>

Inherited from XSensor.ready

setFunctionalityControl

setFunctionalityControl(functionalityControl: Number): void
Parameters
- functionalityControl: Number
Returns void

setLedBlinkPatternForPickup

setLedBlinkPatternForPickup(pattern: Number): void
Parameters
- pattern: Number
Returns void

setLedBrightness

setLedBrightness(brightness: Number): void
Parameters
- brightness: Number
Returns void

setStatusLedBehaviour

setStatusLedBehaviour(behavior: Number): void
Parameters
- behavior: Number
Returns void

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 XSensor.start

stop

stop(): Promise<any>
Stops the device.

Returns Promise<any>

Inherited from XSensor.stop

Generated using TypeDoc