Interface ISensorSelection

Provides properties and methods to select, connect, and query sensors.

Namespace: Holoride.ElasticSDK

Assembly: Holoride.ElasticSDK.StateReceivers.dll

Syntax

public interface ISensorSelection : INotifyPropertyChanged

Properties

AvailableSensors

Gets the list of available sensor names.

Declaration

IReadOnlyList<string> AvailableSensors { get; }

Property Value

Type	Description
IReadOnlyList<><string>

ConnectionState

Gets the current connection state of the sensor.

Declaration

SensorConnectionState ConnectionState { get; }

Property Value

Type	Description
SensorConnectionState

IsConnected

Gets a value indicating whether a connection to the selected sensor is established.

Declaration

bool IsConnected { get; }

Property Value

Type	Description
bool

SelectedSensor

Gets the name of the currently selected sensor.

Declaration

string SelectedSensor { get; }

Property Value

Type	Description
string

Methods

Connect()

Connects to the selected sensor.

Declaration

void Connect()

Disconnect()

Disconnects from the selected sensor.

Declaration

void Disconnect()

Pair()

Initiates the pairing process for the selected sensor. This should typically be called after the PairingRequired event is fired and the user has confirmed that the device is in pairing mode.

Declaration

void Pair()

SelectSensor(string)

Selects a sensor by its name.

Declaration

void SelectSensor(string sensorName)

Parameters

Type	Name	Description
string	sensorName	The name of the sensor to select. Must not be null or empty, and should be one of the values listed in AvailableSensors.

Events

PairingRequired

Occurs when the selected sensor requires pairing before a connection can be established. The developer can hook into this callback to show a UI prompt instructing the user to put the device in pairing mode before calling Pair().

Declaration

event System.Action PairingRequired

Event Type

Type	Description
Action