Class EstimoteBeaconProbe

Sensus uses Estimote Beacons to track fine-grained locations indoors. This Probe is available for Android and iOS and runs while the Sensus app is in the foreground and background. This Probe generates proximity event data in the form of EstimoteBeaconDatum (for proximity events) and EstimoteIndoorLocationDatum (for indoor x-y positioning).

Prerequisites

  • Purchase Proximity or Location beacons.
  • The beacons must be configured within the Estimote Cloud console. To generate proximity (EstimoteBeaconDatum) readings, the beacons must have tags attached to them.

More details are available here.

  • Having entered the App Id and App Token, the list of beacons and locations can be edited via the Edit Beacons and Edit Locations buttons in the Estimote Beacon Probe configuration.

Beacons

Each beacon definition contains the following:

  • Beacon Tag: Tag of the beacon to detect, as specified above.
  • Proximity (Meters): Number of meters desired for proximity.
  • Event Name: Name to be given to the proximity event.

Locations

Each location contains a name and identifier.

Inheritance
System.Object
Probe
ListeningProbe
EstimoteBeaconProbe
AndroidEstimoteBeaconProbe
iOSEstimoteBeaconProbe
Implements
System.ComponentModel.INotifyPropertyChanged
Inherited Members
Namespace: Sensus.Probes.Location
Assembly: SensusAndroid.dll
Syntax
public abstract class EstimoteBeaconProbe : ListeningProbe, INotifyPropertyChanged, IListeningProbe, IProbe

Constructors

EstimoteBeaconProbe()

Declaration
public EstimoteBeaconProbe()

Properties

Beacons

Declaration
public ConcurrentObservableCollection<EstimoteBeacon> Beacons { get; }
Property Value
Type Description
ConcurrentObservableCollection<EstimoteBeacon>

DatumType

Declaration
public override Type DatumType { get; }
Property Value
Type Description
System.Type
Overrides

DefaultKeepDeviceAwake

Declaration
protected override bool DefaultKeepDeviceAwake { get; }
Property Value
Type Description
System.Boolean
Overrides

DeviceAsleepWarning

Declaration
protected override string DeviceAsleepWarning { get; }
Property Value
Type Description
System.String
Overrides

DeviceAwakeWarning

Declaration
protected override string DeviceAwakeWarning { get; }
Property Value
Type Description
System.String
Overrides

DisplayName

Declaration
public override string DisplayName { get; }
Property Value
Type Description
System.String
Overrides

EstimoteCloudAppId

The App Id from the Estimote Cloud console that is associated with the beacons to be tracked.

Declaration
[EntryStringUiProperty("Estimote Cloud App Id:", true, 35, true)]
public string EstimoteCloudAppId { get; set; }
Property Value
Type Description
System.String

The Estimote Cloud app identifier.

EstimoteCloudAppToken

The App Token from the Estimote Cloud console that is associated with the beacons to be tracked.

Declaration
[EntryStringUiProperty("Estimote Cloud App Token:", true, 36, true)]
public string EstimoteCloudAppToken { get; set; }
Property Value
Type Description
System.String

The Estimote Cloud app token.

IndoorLocationUpdateIntervalMS

Gets or sets the indoor location update interval. This is currently known to impact Android.

Declaration
[EntryIntegerUiProperty("Indoor Location Update Interval (MS)", true, 37, true)]
public int IndoorLocationUpdateIntervalMS { get; set; }
Property Value
Type Description
System.Int32

The indoor location update interval, in milliseconds.

Location

Declaration
public EstimoteLocation Location { get; set; }
Property Value
Type Description
EstimoteLocation

Methods

GetBeaconTagsFromCloudAsync(Nullable<TimeSpan>)

Declaration
public Task<List<string>> GetBeaconTagsFromCloudAsync(Nullable<TimeSpan> timeout = null)
Parameters
Type Name Description
System.Nullable<System.TimeSpan> timeout
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.String>>

GetChartDataPointFromDatum(Datum)

Declaration
protected override ChartDataPoint GetChartDataPointFromDatum(Datum datum)
Parameters
Type Name Description
Datum datum
Returns
Type Description
Syncfusion.SfChart.XForms.ChartDataPoint
Overrides

GetChartPrimaryAxis()

Declaration
protected override ChartAxis GetChartPrimaryAxis()
Returns
Type Description
Syncfusion.SfChart.XForms.ChartAxis
Overrides

GetChartSecondaryAxis()

Declaration
protected override RangeAxisBase GetChartSecondaryAxis()
Returns
Type Description
Syncfusion.SfChart.XForms.RangeAxisBase
Overrides

GetChartSeries()

Declaration
protected override ChartSeries GetChartSeries()
Returns
Type Description
Syncfusion.SfChart.XForms.ChartSeries
Overrides

GetLocationsFromCloudAsync(Nullable<TimeSpan>)

Declaration
public Task<List<EstimoteLocation>> GetLocationsFromCloudAsync(Nullable<TimeSpan> timeout)
Parameters
Type Name Description
System.Nullable<System.TimeSpan> timeout
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<EstimoteLocation>>

InitializeAsync()

Declaration
protected override Task InitializeAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides

Implements

System.ComponentModel.INotifyPropertyChanged