Class Device

Represents a single NextMind device.

Implements

System.IEquatable<Device>

Namespace: NextMind.Devices

Assembly: NextMind.dll

Syntax

public class Device : IEquatable<Device>

Fields

contactGradeEvent

Events triggered when a new contact grade is available

Declaration

public ContactGradeEvent contactGradeEvent

Field Value

Type	Description
ContactGradeEvent

onConnectionStatusChanged

Event triggered when the Bluetooth connection status of this Device changed.

Declaration

public DeviceConnectionStatusEvent onConnectionStatusChanged

Field Value

Type	Description
DeviceConnectionStatusEvent

Properties

ConnectionStatus

The status of this Device regarding its Bluetooth connection to the system.

Declaration

public ConnectionStatus ConnectionStatus { get; }

Property Value

Type	Description
ConnectionStatus

ID

The Device's ID.

Declaration

public uint ID { get; }

Property Value

Type	Description
System.UInt32	A unique identifier.

IsCalibrated

Has a user already performed a calibration using this device?

Declaration

public bool IsCalibrated { get; }

Property Value

Type	Description
System.Boolean	true if the device already obtained a calibration score. false otherwise

Remarks

If this property returns false, users will not be able to interact with NeuroTags.

IsConnected

Is this Device currently connected?

Declaration

public bool IsConnected { get; }

Property Value

Type	Description
System.Boolean	true if the device is connected, false otherwise.

Name

The Device's name.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String	The name from the Bluetooth inteface.

Paired

Is this Device paired?

Declaration

public bool Paired { get; }

Property Value

Type	Description
System.Boolean	true if the device is paired.

Methods

Equals(Device)

Declaration

public bool Equals(Device other)

Parameters

Type	Name	Description
Device	other

Returns

Type	Description
System.Boolean

GetAverageContactQuality()

Returns the average electrodes' contact quality.

Declaration

[Obsolete("GetAverageContactQuality is deprecated, please call GetContactGrade, GetNormalizedContactGrade or connect to contactGradeEvent instead.")]
public Device.ContactQuality GetAverageContactQuality()

Returns

Type	Description
Device.ContactQuality	The average contact quality

GetBatteryLevel()

Get the battery level (in %) for this device.

Declaration

public uint GetBatteryLevel()

Returns

Type	Description
System.UInt32	A value between 0 and 100.

GetCalibrationResults()

Get the last calibration results.

Declaration

public CalibrationResults GetCalibrationResults()

Returns

Type	Description
CalibrationResults	The last calibration results.

GetContact(UInt32)

Get the contact quality of the given electrode for this Device.

Declaration

public float GetContact(uint electrodeID)

Parameters

Type	Name	Description
System.UInt32	electrodeID	The electrode identifier

Returns

Type	Description
System.Single	A value between: 0:absence of contact 1:perfect contact

GetContactGrade()

Returns the current contact grade.

Declaration

public ContactEvent.Type GetContactGrade()

Returns

Type	Description
NextMind.Core.Event.ContactEvent.Type	The current contact grade

GetHashCode()

Get the hash code of this Device from its ID.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	The hash.

Overrides

System.Object.GetHashCode()

GetNormalizedContactGrade()

Returns the current contact grade value normalized between 0 and 1.

Declaration

public float GetNormalizedContactGrade()

Returns

Type	Description
System.Single	The current contact grade

GetTrackingResults(NeuroTag)

Get the tracking values (confidence, hit) of this Device tracking the given neuroTag.

Declaration

public TrackingResults GetTrackingResults(NeuroTag neuroTag)

Parameters

Type	Name	Description
NeuroTag	neuroTag	The NeuroTag.

Returns

Type	Description
TrackingResults	If the neuroTag is not registered:0 - false If the neuroTag is registered:[0-1] - [true or false]

IsCalibrating()

Is this device currently calibrating?

Declaration

public bool IsCalibrating()

Returns

Type	Description
System.Boolean	true if a calibration is running, false otherwise.

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

Implements

System.IEquatable<T>