libbeacon/fr.maxcom.beacon.plugin/ADevicePlugin

ADevicePlugin

abstract class ADevicePlugin<D : ADevice> : APlugin

Implementation common to Processor and Explorer plugins, mainly related to device management.

Parameters

The model for the kind of device to manage.

Inheritors

AExplorerPlugin

AProcessorPlugin

Constructors

ADevicePlugin

constructor()

Functions

addDevice

protected fun addDevice(device: D)

Adds a device to the managed collection.

addFilterCriteria

protected abstract fun addFilterCriteria(sfb: ScanFilter.Builder)

Called by the engine during the build of a fr.maxcom.beacon.configuration.ScanContext to give the plugin the opportunity to set its filter criteria, typically based on the Service Data or the Manufacturer Specific Data.

clear

open fun clear()

Clears any cache or persisted data from a previous run.

lookupDevice

protected fun lookupDevice(btDevice: BluetoothDevice): D?

Lookups for a device in the managed collection.

mismatch

protected fun mismatch(data: ByteArray?, minLength: Int, prefix: ByteArray): Boolean

Performs an evaluation for non validity about a frame pattern recognition.

onLost

protected open fun onLost(device: D)

A hook called when a device is deemed lost. This default implementation does nothing.

refreshDevice

protected fun refreshDevice(device: D, rssi: Int)

Refreshes the knowledge of a device already in the managed collection.

removeLostDevices

protected fun removeLostDevices(shiftedTimeMillis: Long)

Removes lost devices from the managed collection.

setDeviceFilters

open fun setDeviceFilters(filters: List<DeviceFilter>)

Sets filters.