Class BleNusTransportOptions
Configuration for BleNusTransport.
Inheritance
Namespace: HFI.Wss
Assembly: WSS.Transport.BLE.dll
Syntax
public sealed class BleNusTransportOptionsRemarks
When AutoSelectDevice is false, callers must provide either DeviceId or DeviceName. Scan-based operations honor ScanTimeout when a timeout is configured.
Properties
AutoSelectDevice
When true, scans for compatible BLE devices and auto-selects the best valid candidate. Auto-selection only accepts devices that expose the configured service and both required characteristics with the expected properties, then prefers stronger RSSI. When false, the caller must provide DeviceId or DeviceName.
Declaration
public bool AutoSelectDevice { get; init; }Property Value
| Type | Description |
|---|---|
| bool |
DeviceId
Explicit BLE device identifier to connect to when AutoSelectDevice is disabled. When provided, it takes precedence over DeviceName.
Declaration
public string? DeviceId { get; init; }Property Value
| Type | Description |
|---|---|
| string |
DeviceName
Exact BLE device name to scan for when AutoSelectDevice is disabled and DeviceId is not provided.
Declaration
public string? DeviceName { get; init; }Property Value
| Type | Description |
|---|---|
| string |
NotifyCharacteristicUuid
Required BLE notification characteristic UUID. Auto-select rejects devices that do not expose it with notify or indicate support.
Declaration
public Guid NotifyCharacteristicUuid { get; init; }Property Value
| Type | Description |
|---|---|
| Guid |
ScanTimeout
Maximum scan duration used for configured-name lookup and auto-selection.
Declaration
public TimeSpan? ScanTimeout { get; init; }Property Value
| Type | Description |
|---|---|
| TimeSpan? |
ServiceUuid
Required BLE service UUID. Auto-select only considers devices that expose this service.
Declaration
public Guid ServiceUuid { get; init; }Property Value
| Type | Description |
|---|---|
| Guid |
WriteCharacteristicUuid
Required BLE write characteristic UUID. Auto-select rejects devices that do not expose it with write-with-response support.
Declaration
public Guid WriteCharacteristicUuid { get; init; }Property Value
| Type | Description |
|---|---|
| Guid |