Class BluetoothDeviceProximityProbe
Inheritance
System.Object
BluetoothDeviceProximityProbe
Implements
System.ComponentModel.INotifyPropertyChanged
Assembly: SensusAndroid.dll
Syntax
public abstract class BluetoothDeviceProximityProbe : PollingProbe, INotifyPropertyChanged, IPollingProbe, IProbe
Constructors
BluetoothDeviceProximityProbe()
Declaration
public BluetoothDeviceProximityProbe()
Fields
DEVICE_ID_CHARACTERISTIC_UUID
Declaration
public const string DEVICE_ID_CHARACTERISTIC_UUID = "2647AAAE-B7AC-4331-A3FF-0DF73288D3F7"
Field Value
| Type |
Description |
| System.String |
|
Properties
DatumType
Declaration
public override sealed Type DatumType { get; }
Property Value
| Type |
Description |
| System.Type |
|
Overrides
DisplayName
Declaration
public override sealed string DisplayName { get; }
Property Value
| Type |
Description |
| System.String |
|
Overrides
ReadAttemptCount
Declaration
public int ReadAttemptCount { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
ReadDurationMS
The length of time to read identifiers from scanned devices (in milliseconds). The longer the read, the
more likely it is that all scanned devices will be read. However, note that, if the Protocol
is configured to use push notifications, then the combination of
ScanDurationMS and ReadDurationMS should not exceed 20 seconds, as there is
limited time to complete all background processing. It is difficult to recommend a "best" value, but
10000ms seems like a reasonable read duration, all things considered.
Declaration
[EntryIntegerUiProperty("Read Duration (MS):", true, 5, true)]
public int ReadDurationMS { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
The read time ms.
|
ReadSuccessCount
Declaration
public int ReadSuccessCount { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
ScanDurationMS
The length of time to scan for devices in proximity (in milliseconds). The longer the scan, the
more likely it is that devices in the environment will be detected. However, a longer scan also
means that a detected device may go out of range before the scan completes and device identifiers
are read. Also note that, if the Protocol is configured to use push notifications,
then the combination of ScanDurationMS and ReadDurationMS should not
exceed 20 seconds, as there is limited time to complete all background processing. It is difficult
to recommend a "best" value, but 10000ms seems like a reasonable scan duration, all things considered.
Declaration
[EntryIntegerUiProperty("Scan Duration (MS):", true, 5, true)]
public int ScanDurationMS { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
The scan time ms.
|
Methods
CompleteReadAsync(TaskCompletionSource<String>, CancellationToken)
Declaration
public static Task<string> CompleteReadAsync(TaskCompletionSource<string> readCompletionSource, CancellationToken cancellationToken)
Parameters
| Type |
Name |
Description |
| System.Threading.Tasks.TaskCompletionSource<System.String> |
readCompletionSource |
|
| System.Threading.CancellationToken |
cancellationToken |
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task<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
InitializeAsync()
Declaration
protected override Task InitializeAsync()
Returns
| Type |
Description |
| System.Threading.Tasks.Task |
|
Overrides
PollAsync(CancellationToken)
Declaration
protected override sealed Task<List<Datum>> PollAsync(CancellationToken cancellationToken)
Parameters
| Type |
Name |
Description |
| System.Threading.CancellationToken |
cancellationToken |
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task<System.Collections.Generic.List<Datum>> |
|
Overrides
ProtectedStartAsync()
Declaration
protected override Task ProtectedStartAsync()
Returns
| Type |
Description |
| System.Threading.Tasks.Task |
|
Overrides
ProtectedStopAsync()
Declaration
protected override Task ProtectedStopAsync()
Returns
| Type |
Description |
| System.Threading.Tasks.Task |
|
Overrides
ReadPeripheralCharacteristicValuesAsync(CancellationToken)
Declaration
protected abstract Task<List<Tuple<string, DateTimeOffset>>> ReadPeripheralCharacteristicValuesAsync(CancellationToken cancellationToken)
Parameters
| Type |
Name |
Description |
| System.Threading.CancellationToken |
cancellationToken |
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task<System.Collections.Generic.List<System.Tuple<System.String, System.DateTimeOffset>>> |
|
ScanAsync(CancellationToken)
Declaration
protected abstract Task ScanAsync(CancellationToken cancellationToken)
Parameters
| Type |
Name |
Description |
| System.Threading.CancellationToken |
cancellationToken |
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task |
|
StartAdvertising()
Declaration
protected abstract void StartAdvertising()
StopAdvertising()
Declaration
protected abstract void StopAdvertising()
TestHealthAsync(List<AnalyticsTrackedEvent>)
Declaration
public override Task<HealthTestResult> TestHealthAsync(List<AnalyticsTrackedEvent> events)
Parameters
Returns
Overrides
Implements
System.ComponentModel.INotifyPropertyChanged