Class CharacteristicExplorationOptions

Namespace

Bluetooth.Abstractions.Scanning.Options

Assembly

Bluetooth.Abstractions.Scanning.dll

Represents options for exploring Bluetooth characteristics within a service.

public record CharacteristicExplorationOptions : IEquatable<CharacteristicExplorationOptions>

Inheritance

object

CharacteristicExplorationOptions

Implements

IEquatable<CharacteristicExplorationOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Characteristic exploration discovers all characteristics available within a specific service.

Properties

CharacteristicUuidFilter

Gets or sets a filter to apply when exploring characteristics. Only characteristics matching this filter will be explored.

public Func<Guid, bool>? CharacteristicUuidFilter { get; init; }

Property Value

Func<Guid, bool>

Remarks

This can be used to limit exploration to specific characteristics of interest. Default: null (explore all characteristics)

CharacteristicsOnly

Creates exploration options for discovering only characteristics (no descriptors).

public static CharacteristicExplorationOptions CharacteristicsOnly { get; }

Property Value

CharacteristicExplorationOptions

ExploreDescriptors

Gets or sets a value indicating whether to automatically explore descriptors after discovering characteristics.

public bool ExploreDescriptors { get; init; }

Property Value

bool

Remarks

When enabled, each discovered characteristic will have its descriptors explored automatically. Default: false

Full

Creates exploration options for full discovery (characteristics and descriptors).

public static CharacteristicExplorationOptions Full { get; }

Property Value

CharacteristicExplorationOptions

UseCache

Gets or sets a value indicating whether to skip exploration if characteristics have already been discovered.

public bool UseCache { get; init; }

Property Value

bool

Remarks

When enabled, if the service already has characteristics in its collection, exploration is skipped. Default: true