Package io.heraldprox.herald.sensor

Interface SensorDelegate

All Known Implementing Classes:

CalibrationLog, ContactLog, DefaultSensorDelegate, DetectionLog, EventTimeIntervalLog, Interactions, RssiHistogram, SocialDistance, StatisticsLog

public interface SensorDelegate

Sensor delegate for receiving sensor events.

Method Summary

Modifier and Type	Method	Description
void	sensor(SensorType sensor, ImmediateSendData didReceive, TargetIdentifier fromTarget)	Receive written immediate send data from target, e.g.
void	sensor(SensorType sensor, Location didVisit)	Detection of time spent at location, e.g.
void	sensor(SensorType sensor, PayloadData didRead, TargetIdentifier fromTarget)	Read payload data from target, e.g.
void	sensor(SensorType sensor, Proximity didMeasure, TargetIdentifier fromTarget)	Measure proximity to target, e.g.
void	sensor(SensorType sensor, Proximity didMeasure, TargetIdentifier fromTarget, PayloadData withPayload)	Measure proximity to target with payload data.
void	sensor(SensorType sensor, SensorState didUpdateState)	Sensor state update
void	sensor(SensorType sensor, TargetIdentifier didDetect)	Detection of a target with an ephemeral identifier, e.g.
void	sensor(SensorType sensor, java.util.List<PayloadData> didShare, TargetIdentifier fromTarget)	Read payload data of other targets recently acquired by a target, e.g.

Method Detail

sensor

void sensor(@NonNull
            SensorType sensor,
            @NonNull
            TargetIdentifier didDetect)

Detection of a target with an ephemeral identifier, e.g. BLE central detecting a BLE peripheral.

Parameters:

sensor -

didDetect -

sensor

void sensor(@NonNull
            SensorType sensor,
            @NonNull
            PayloadData didRead,
            @NonNull
            TargetIdentifier fromTarget)

Read payload data from target, e.g. encrypted device identifier from BLE peripheral after successful connection.

Parameters:

sensor -

didRead -

fromTarget -

sensor

void sensor(@NonNull
            SensorType sensor,
            @NonNull
            ImmediateSendData didReceive,
            @NonNull
            TargetIdentifier fromTarget)

Receive written immediate send data from target, e.g. important timing signal.

Parameters:

sensor -

didReceive -

fromTarget -

sensor

void sensor(@NonNull
            SensorType sensor,
            @NonNull
            java.util.List<PayloadData> didShare,
            @NonNull
            TargetIdentifier fromTarget)

Read payload data of other targets recently acquired by a target, e.g. Android peripheral sharing payload data acquired from nearby iOS peripherals.

Parameters:

sensor -

didShare -

fromTarget -

sensor

void sensor(@NonNull
            SensorType sensor,
            @NonNull
            Proximity didMeasure,
            @NonNull
            TargetIdentifier fromTarget)

Measure proximity to target, e.g. a sample of RSSI values from BLE peripheral.

Parameters:

sensor -

didMeasure -

fromTarget -

sensor

void sensor(@NonNull
            SensorType sensor,
            @NonNull
            Location didVisit)

Detection of time spent at location, e.g. at specific restaurant between 02/06/2020 19:00 and 02/06/2020 21:00

Parameters:

sensor -

didVisit -

sensor

void sensor(@NonNull
            SensorType sensor,
            @NonNull
            Proximity didMeasure,
            @NonNull
            TargetIdentifier fromTarget,
            @NonNull
            PayloadData withPayload)

Measure proximity to target with payload data. Combines didMeasure and didRead into a single convenient delegate method

Parameters:

sensor -

didMeasure -

fromTarget -

withPayload -

sensor

void sensor(@NonNull
            SensorType sensor,
            @NonNull
            SensorState didUpdateState)

Sensor state update

Parameters:

sensor -

didUpdateState -