Interface BLEProviderMethods

OptionalpluginId

availableGATTSlots

• availableGATTSlots(): number

  Number of available GATT connection slots

  Returns number

getDevices

• getDevices(): Promise<string[]>

  Return MACs of currently visible devices

  Returns Promise<string[]>

onAdvertisement

• onAdvertisement(
      callback: (
          adv: {
              mac: string;
              providerId: string;
              rssi: number;
              timestamp: number;
              addressType?: "public" | "random";
              connectable?: boolean;
              manufacturerData?: { [key: number]: string };
              name?: string;
              serviceData?: { [key: string]: string };
              serviceUuids?: string[];
              txPower?: number;
          },
      ) => void,
  ): () => void

  Subscribe to advertisements from this provider. Returns an unsubscribe function.

  Parameters

  • callback: (
        adv: {
            mac: string;
            providerId: string;
            rssi: number;
            timestamp: number;
            addressType?: "public" | "random";
            connectable?: boolean;
            manufacturerData?: { [key: number]: string };
            name?: string;
            serviceData?: { [key: string]: string };
            serviceUuids?: string[];
            txPower?: number;
        },
    ) => void

  Returns () => void

startDiscovery

• startDiscovery(): Promise<void>

  Start scanning for BLE advertisements

  Returns Promise<void>

stopDiscovery

• stopDiscovery(): Promise<void>

  Stop scanning

  Returns Promise<void>

subscribeGATT

• subscribeGATT(
      descriptor: GATTSubscriptionDescriptor,
      callback: (charUuid: string, data: Buffer) => void,
  ): Promise<GATTSubscriptionHandle>

  Execute a GATT subscription descriptor. The provider handles connect, discover, subscribe, periodic writes, and reconnection autonomously.

  Parameters

  • descriptor: GATTSubscriptionDescriptor
  • callback: (charUuid: string, data: Buffer) => void

  Returns Promise<GATTSubscriptionHandle>

supportsGATT

• supportsGATT(): boolean

  Whether this provider supports GATT connections

  Returns boolean

OptionalconnectGATT

• connectGATT?(mac: string): Promise<BLEGattConnection>

  Raw GATT connection (optional — not all providers support this)

  Parameters

  • mac: string

  Returns Promise<BLEGattConnection>

OptionaltotalGATTSlots

• totalGATTSlots?(): number

  Total number of GATT connection slots (optional)

  Returns number