Class BluetoothDevice

Bluetooth Device

Represents a single Bluetooth device with connection state tracking.

Lifecycle:

Construction - Bind to GnomeBluetooth.Device
Active - Monitor device properties and connection state
Disposal - Disconnect property signals

Fires

changed - Emitted when device state changes

Hierarchy (View Summary)

default
- BluetoothDevice

Implements

Disposable

Index

Accessors

address

get address(): any
The Bluetooth hardware address (MAC).

Returns any
- Defined in src/service/bluetooth.ts:107

alias

get alias(): any
The user-facing alias for this device.

Returns any
- Defined in src/service/bluetooth.ts:112

battery_level

get battery_level(): any
Coarse battery level (0-100 or -1 if unknown).

Returns any
- Defined in src/service/bluetooth.ts:117

battery_percentage

get battery_percentage(): any
Battery percentage (0-100 or -1 if unknown).

Returns any
- Defined in src/service/bluetooth.ts:122

connected

get connected(): any
Whether the device is currently connected.

Returns any
- Defined in src/service/bluetooth.ts:127

connecting

get connecting(): boolean
Whether a connection attempt is currently in progress.

Returns boolean
- Defined in src/service/bluetooth.ts:157

device

get device(): Device
The underlying GnomeBluetooth.Device instance.

Returns Device
- Defined in src/service/bluetooth.ts:67

icon_name

get icon_name(): any
Icon name representing the device type.

Returns any
- Defined in src/service/bluetooth.ts:132

isDisposed

get isDisposed(): boolean
Check if service has been disposed

Returns boolean
Inherited from Service.isDisposed
- Defined in src/service.ts:411

name

get name(): any
The reported device name.

Returns any
- Defined in src/service/bluetooth.ts:137

paired

get paired(): any
Whether the device is paired.

Returns any
- Defined in src/service/bluetooth.ts:142

trusted

get trusted(): any
Whether the device is trusted.

Returns any
- Defined in src/service/bluetooth.ts:147

type

get type(): any
Human-readable device type string.

Returns any
- Defined in src/service/bluetooth.ts:152

Constructors

constructor

new BluetoothDevice(device: Device): BluetoothDevice
Parameters
- device: Device
Returns BluetoothDevice
Overrides default.constructor
- Defined in src/service/bluetooth.ts:71

Methods

bind

bind<Prop extends any>(
prop: Prop,
): Binding<BluetoothDevice, Prop, BluetoothDevice[Prop]>
Creates a Binding for a property on this service.
Type Parameters
- Prop extends any
Parameters
- prop: Prop
  The property to bind
Returns Binding<BluetoothDevice, Prop, BluetoothDevice[Prop]>
A Binding that can be used in widget constructors
Example
```
const label = Widget.Label({
    label: audio.bind('volume').as(v => `${Math.round(v * 100)}%`),
});
```
Inherited from default.bind
- Defined in src/service.ts:348

changed

changed(property: string): void
Notifies listeners that a property changed and emits the 'changed' signal.
Parameters
- property: string
  The property name that changed
Returns void
Inherited from default.changed
- Defined in src/service.ts:330

close

close(): void
Returns void
- Defined in src/service/bluetooth.ts:101

connect

connect(signal?: string, callback: (_: this, ...args: any[]) => void): number
Connects a callback to a signal on this service.
Parameters
- signal: string = 'changed'
  The signal name (defaults to 'changed')
- callback: (_: this, ...args: any[]) => void
  The callback to invoke when the signal is emitted
Returns number
The signal connection ID
Inherited from default.connect
- Defined in src/service.ts:272

diffBind

diffBind<Item, Prop extends any>(
    prop: Prop,
    opts: {
        create: (item: Item) => Widget;
        key: (item: Item) => string | number;
        update?: (widget: Widget, item: Item) => void;
    },
): Binding<BluetoothDevice, Prop, Widget[]>
Creates an incremental list binding that reuses existing widgets.

Instead of recreating all widgets on every update, this method caches widgets by a key function and only creates new widgets for new items, destroying widgets for removed items.
Type Parameters
- Item
- Prop extends any
Parameters
- prop: Prop
  The property containing the item array
- opts: {
      create: (item: Item) => Widget;
      key: (item: Item) => string | number;
      update?: (widget: Widget, item: Item) => void;
  }
  Key extractor, widget factory, and optional update callback
Returns Binding<BluetoothDevice, Prop, Widget[]>
A Binding that produces an array of widgets
Example
```
const children = audio.diffBind('speakers', {
    key: (s) => s.name,
    create: (s) => Widget.Label({ label: s.description }),
    update: (w, s) => { w.label = s.description; },
});
```
Inherited from default.diffBind
- Defined in src/service.ts:472

`Protected`disconnectAll

disconnectAll(): void
Clean up all tracked signal connections Call this in service-specific dispose implementations

Returns void
Inherited from default.disconnectAll
- Defined in src/service.ts:380

dispose

dispose(): void
Dispose of service resources Override in subclasses to add specific cleanup

Returns void
Implementation of Disposable.dispose
Overrides default.dispose
- Defined in src/service/bluetooth.ts:175

emit

emit(signal: string, ...args: any[]): void
Emits a signal, warning if the signal was not registered via Service.register.

The warning is cheap (a Set lookup per emit) and helps catch typos and missing signal declarations that silently break .bind().
Parameters
- signal: string
- ...args: any[]
Returns void
Inherited from default.emit
- Defined in src/service.ts:283

`Protected`retryWithBackoff

retryWithBackoff<T>(
    operation: () => Promise<T>,
    maxRetries?: number,
    baseDelay?: number,
): Promise<T>
Retry a DBus operation with exponential backoff
Type Parameters
- T
Parameters
- operation: () => Promise<T>
- maxRetries: number = 3
- baseDelay: number = 100
Returns Promise<T>
Inherited from default.retryWithBackoff
- Defined in src/service.ts:418

`Readonly`setConnection

setConnection(connect: boolean): void
Initiates or terminates a connection to this device.
Parameters
- connect: boolean
  True to connect, false to disconnect
Returns void
- Defined in src/service/bluetooth.ts:166

`Protected`trackConnection

trackConnection(emitter: Object, id: number): void
Track a signal connection for automatic cleanup
Parameters
- emitter: Object
  The object the signal is connected to (defaults to this)
- id: number
  The signal connection ID
Returns void
Inherited from default.trackConnection
- Defined in src/service.ts:361
trackConnection(id: number): void
Track a signal connection for automatic cleanup
Parameters
- id: number
  The signal connection ID
Returns void
Inherited from default.trackConnection
- Defined in src/service.ts:362

updateProperty

updateProperty(prop: string, value: unknown): void
Updates a property value and emits a notify signal if the value changed.

Performs a deep equality check via JSON serialization to avoid unnecessary notifications.
Parameters
- prop: string
  The property name in kebab-case
- value: unknown
  The new value
Returns void
Inherited from default.updateProperty
- Defined in src/service.ts:315

`Static`import

import<S extends keyof Services>(service: S): Promise<Services[S]>
Dynamically imports a built-in service by name.
Type Parameters
- S extends keyof Services
Parameters
- service: S
  The service name to import
Returns Promise<Services[S]>
The default export of the service module
Example
```
const Audio = await Service.import('audio');
const Battery = await Service.import('battery');
```
Inherited from default.import
- Defined in src/service.ts:234

`Static`pspec

pspec(name: string, type?: PspecType, handle?: PspecFlag): ParamSpec<unknown>
Creates a GObject property specification.
Parameters
- name: string
  The property name in kebab-case
- type: PspecType = 'jsobject'
  The property type (defaults to 'jsobject')
- handle: PspecFlag = 'r'
  The access flag: 'r', 'w', or 'rw' (defaults to 'r')
Returns ParamSpec<unknown>
A GObject.ParamSpec
Inherited from default.pspec
- Defined in src/service.ts:246

`Static`register

register(
    service: new (...args: any[]) => Object,
    signals?: { [signal: string]: PspecType[] },
    properties?: { [prop: string]: [type?: PspecType, handle?: PspecFlag] },
): void
Registers a GObject subclass with signals and properties.
Parameters
- service: new (...args: any[]) => Object
  The class constructor to register
- Optionalsignals: { [signal: string]: PspecType[] }
  Map of signal names to their parameter types
- Optionalproperties: { [prop: string]: [type?: PspecType, handle?: PspecFlag] }
  Map of property names to [type, accessFlag] tuples
Returns void
Inherited from default.register
- Defined in src/service.ts:257

Class BluetoothDevice

Fires

Hierarchy (View Summary)

Implements

Index

Accessors

Constructors

Methods

Accessors

address

Returns any

alias

Returns any

battery_level

Returns any

battery_percentage

Returns any

connected

Returns any

connecting

Returns boolean

device

Returns Device

icon_name

Returns any

isDisposed

Returns boolean

name

Returns any

paired

Returns any

trusted

Returns any

type

Returns any

Constructors

constructor

Parameters

Returns BluetoothDevice

Methods

bind

Type Parameters

Parameters

Returns Binding<BluetoothDevice, Prop, BluetoothDevice[Prop]>

Example

changed

Parameters

Returns void

close

Returns void

connect

Parameters

Returns number

diffBind

Type Parameters

Parameters

Returns Binding<BluetoothDevice, Prop, Widget[]>

Example

ProtecteddisconnectAll

Returns void

dispose

Returns void

emit

Parameters

Returns void

ProtectedretryWithBackoff

Type Parameters

Parameters

Returns Promise<T>

ReadonlysetConnection

Parameters

Returns void

ProtectedtrackConnection

Parameters

Returns void

Parameters

Returns void

updateProperty

Parameters

Returns void

`Protected`disconnectAll

`Protected`retryWithBackoff

`Readonly`setConnection

`Protected`trackConnection

`Static`import

`Static`pspec

`Static`register