Gecco | SiteKiosk Online API

Index

Properties

config device lastData manufacturer name state type

Methods

executeActionAsync executeActionsAsync ready start stop

Events

onData onError onStateChanged

Properties

config

config: GeccoConfig

The device config.

device

device: string

lastData

lastData: undefined | GeccoSensorData

Returns the last data which was generated by the sensor.

manufacturer

manufacturer: string

name

name: string

The name of the device.

state

state: DeviceState

The device state.

type

type: string

The type of the device.

Methods

executeActionAsync

executeActionAsync(actionName: string): Promise<void>
Parameters
- actionName: string
Returns Promise<void>

Inherited from RawGecco.executeActionAsync

executeActionsAsync

executeActionsAsync(wasSessionReset: boolean): Promise<void>
Internal
Parameters
- wasSessionReset: boolean
Returns Promise<void>

Inherited from RawGecco.executeActionsAsync

ready

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

Returns Promise<any>

Inherited from RawGecco.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 RawGecco.start

stop

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

Returns Promise<any>

Inherited from RawGecco.stop

Events

onData

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

Inherited from RawGecco.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 RawGecco.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 RawGecco.onStateChanged

Generated using TypeDoc