XEye200 | SiteKiosk Online API

Properties

address

address: Number

The address this device is connected to the Nexmosphere controller.

config

config: any

The device config.

lastData

lastData: undefined | XEye200SensorData

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.

Methods

fovQuickAdjust

fovQuickAdjust(gridSize: Number): void
Parameters
- gridSize: Number
Returns void

ready

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

Returns Promise<any>

Inherited from XSensor.ready

requestCurrentDistance

requestCurrentDistance(): void
Returns void

requestCurrentZone

requestCurrentZone(): void
Returns void

requestRawSensorData

requestRawSensorData(): void
Returns void

setAirButtonZoneEnabled

setAirButtonZoneEnabled(enabled: Number): void
Parameters
- enabled: Number
Returns void

setAirButtonZoneRange

setAirButtonZoneRange(rangeInCentimeter: Number): void
Parameters
- rangeInCentimeter: Number
Returns void

setErrorOutputFormat

setErrorOutputFormat(errorOutputFormat: Number): void
Parameters
- errorOutputFormat: Number
Returns void

setErrorStatusFiltering

setErrorStatusFiltering(errorStatusFilteringOption: Number): void
Parameters
- errorStatusFilteringOption: Number
Returns void

setHysteresisThreshold

setHysteresisThreshold(hysteresisThresholdInMillimeters: Number): void
Parameters
- hysteresisThresholdInMillimeters: Number
Returns void

setMaximumErrorDistanceForError8

setMaximumErrorDistanceForError8(distanceInCentimeter: Number): void
Parameters
- distanceInCentimeter: Number
Returns void

setMaximumSignalLevelForError8

setMaximumSignalLevelForError8(maxSignalLevel: Number): void
Parameters
- maxSignalLevel: Number
Returns void

setMinimumSignalLevelAbove150CentimeterDistance

setMinimumSignalLevelAbove150CentimeterDistance(signalLevel: Number): void
Parameters
- signalLevel: Number
Returns void

setMinimumSignalLevelFor0CentimeterDistance

setMinimumSignalLevelFor0CentimeterDistance(signalLevel: Number): void
Parameters
- signalLevel: Number
Returns void

setMinimumSignalNoiseRatio

setMinimumSignalNoiseRatio(minimumRatio: Number): void
Parameters
- minimumRatio: Number
Returns void

setNumberOfActiveColumns

setNumberOfActiveColumns(columns: Number): void
Parameters
- columns: Number
Returns void

setNumberOfActiveRows

setNumberOfActiveRows(rows: Number): void
Parameters
- rows: Number
Returns void

setOutputMode

setOutputMode(mode: Number): void
Parameters
- mode: Number
Returns void

setRangeOfInterest

setRangeOfInterest(rangeInTenCentimeters: Number): void
Parameters
- rangeInTenCentimeters: Number
Returns void

setSampleAveraging

setSampleAveraging(samples: Number): void
Parameters
- samples: Number
Returns void

setSensorMeasurementDuration

setSensorMeasurementDuration(sensorMeasurementDuration: Number): void
Parameters
- sensorMeasurementDuration: Number
Returns void

setStatusLedBehaviour

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

setXLocationCentreAnchor

setXLocationCentreAnchor(location: Number): void
Parameters
- location: Number
Returns void

setYLocationCentreAnchor

setYLocationCentreAnchor(location: Number): void
Parameters
- location: 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

Events

onData

onData(callback: ((data: XEye200SensorData) => void)): EventSubscription
Registers a callback which will be triggered when a sensors value has changed.
Parameters
- callback: ((data: XEye200SensorData) => void)
  
  The callback which will be called once the sensor has generated new data.
  - - (data: XEye200SensorData): void
    - Parameters
      
      data: XEye200SensorData
      
      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

Generated using TypeDoc