XRange2 | 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 | XRange2SensorData

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

deactivateAutoReload

deactivateAutoReload(): void
Returns void

eraseAll

eraseAll(tagNumber?: number): void
Parameters
- Optional tagNumber: number
Returns void

eraseLabels

eraseLabels(tagNumber?: number): void
Parameters
- Optional tagNumber: number
Returns void

eraseTagNumber

eraseTagNumber(tagNumber?: number): void
Parameters
- Optional tagNumber: number
Returns void

format

format(tagNumber?: number): void
Parameters
- Optional tagNumber: number
Returns void

lock

lock(tagNumber?: number): void
Parameters
- Optional tagNumber: 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

reload

reload(tagNumber?: number): void
Parameters
- Optional tagNumber: number
Returns void

requestLabel

requestLabel(label: number, tagNumber?: number): string
Parameters
- label: number
- Optional tagNumber: number
Returns string

requestTagNumber

requestTagNumber(): undefined | number
Returns undefined | number

requestUid

requestUid(tagNumber?: number): string
Parameters
- Optional tagNumber: number
Returns string

setAntennaGainLevel

setAntennaGainLevel(level: number): void
Parameters
- level: number
Returns void

setAutoReloadTagDataInterval

setAutoReloadTagDataInterval(interval: number): void
Parameters
- interval: number
Returns void

setCustomTriggerDetectedOutputFormat

setCustomTriggerDetectedOutputFormat(index: number, format: number): void
Parameters
- index: number
- format: number
Returns void

setCustomTriggerRemovedOutputFormat

setCustomTriggerRemovedOutputFormat(index: number, format: number): void
Parameters
- index: number
- format: number
Returns void

setInterferenceIndication

setInterferenceIndication(level: number): void
Parameters
- level: number
Returns void

setPassword

setPassword(password: string): void
Parameters
- password: string
Returns void

setPowerLevelForGhostPickups

setPowerLevelForGhostPickups(level: number): void
Parameters
- level: number
Returns void

setStatusLedBehaviour

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

setSuccessErrorOutput

setSuccessErrorOutput(level: number): void
Parameters
- level: number
Returns void

setTriggerMode

setTriggerMode(mode: number): void
Parameters
- mode: number
Returns void

setTriggerOutputFormat

setTriggerOutputFormat(format: number): void
Parameters
- format: 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

unlock

unlock(tagNumber?: number): void
Parameters
- Optional tagNumber: number
Returns void

writeLabel

writeLabel(label: number, text: string, tagNumber?: number): void
Parameters
- label: number
- text: string
- Optional tagNumber: number
Returns void

writeTagNumber

writeTagNumber(newTagNumber: number, tagNumber?: number): void
Parameters
- newTagNumber: number
- Optional tagNumber: number
Returns void

Events

onData

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