keta – Docs – Module: DevicePolling

DevicePolling provider

Copyright:

Source:

<inner> pollDevices(eventBus, queryParameters, changeEventProcessor, intervalSeconds) → {void}

Poll devices defined by the query parameters in the specified interval.

If a device matching the query changes, an event is emitted to the processing function.

This function is intended as a temporary replacement for the removed registerDeviceSetListener endpoint of the device service.

Name	Type	Argument	Default	Description
`eventBus`	EventBus			An event bus instance to communicate with the device service
`queryParameters`	Object			An object containing the parameters for the device service endpoint to query devices
`changeEventProcessor`	function			A function receiving an emitted device event upon a change in matching devices
`intervalSeconds`	number	<optional>	15	The time between each query

Source:

void

<inner> pollTagValues(eventBus, queryParameters, tagValuesProcessor, intervalSeconds) → {void}

Poll tag values defined by the device query parameters in the specified interval.

If a device matching the query is added or changes, its tag values are emitted to the processing function.

This function is intended as a temporary replacement for the removed registerTagValueListener endpoint of the device service.

Name	Type	Argument	Default	Description
`eventBus`	EventBus			An event bus instance to communicate with the device service
`queryParameters`	Object			An object containing the parameters for the device service endpoint to query devices
`tagValuesProcessor`	function			A function receiving the emitted array of tag values upon changes in matching devices
`intervalSeconds`	number	<optional>	15	The time between each query

Source:

void