Interface BLEApi

ReadonlylocalBluetoothManaged

connectGATT

• connectGATT(mac: string, pluginId: string): Promise<BLEGattConnection>

  Raw GATT connection (escape hatch)

  Parameters

  • mac: string
  • pluginId: string

  Returns Promise<BLEGattConnection>

getDevice

• getDevice(
      mac: string,
  ): Promise<
      | {
          connectable: boolean;
          lastSeen: number;
          mac: string;
          rssi: number;
          seenBy: { lastSeen: number; providerId: string; rssi: number }[];
          addressType?: "public" | "random";
          gattClaimedBy?: string | null;
          name?: string;
      }
      | null,
  >

  Single device lookup

  Parameters

  • mac: string

  Returns Promise<
      | {
          connectable: boolean;
          lastSeen: number;
          mac: string;
          rssi: number;
          seenBy: { lastSeen: number; providerId: string; rssi: number }[];
          addressType?: "public" | "random";
          gattClaimedBy?: string | null;
          name?: string;
      }
      | null,
  >

getDevices

• getDevices(): Promise<
      {
          connectable: boolean;
          lastSeen: number;
          mac: string;
          rssi: number;
          seenBy: { lastSeen: number; providerId: string; rssi: number }[];
          addressType?: "public" | "random";
          gattClaimedBy?: string | null;
          name?: string;
      }[],
  >

  All visible devices, deduplicated by MAC

  Returns Promise<
      {
          connectable: boolean;
          lastSeen: number;
          mac: string;
          rssi: number;
          seenBy: { lastSeen: number; providerId: string; rssi: number }[];
          addressType?: "public" | "random";
          gattClaimedBy?: string | null;
          name?: string;
      }[],
  >

getGATTClaims

• getGATTClaims(): Map<string, string>

  Current GATT claims: MAC → pluginId

  Returns Map<string, string>

onAdvertisement

• onAdvertisement(
      pluginId: string,
      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 a merged advertisement stream from all providers. pluginId is used to track consumer plugins in the BLE Manager UI. Returns an unsubscribe function.

  Parameters

  • pluginId: string
  • 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

register

• register(pluginId: string, provider: BLEProvider): void

  Parameters

  • pluginId: string
  • provider: BLEProvider

  Returns void

releaseGATTDevice

• releaseGATTDevice(mac: string, pluginId: string): Promise<void>

  Release a GATT claim. A claim whose subscribeGATT() or connectGATT() call has not returned yet is cancelled: its connection is closed as soon as it comes up, and the call rejects.

  Parameters

  • mac: string
  • pluginId: string

  Returns Promise<void>

subscribeGATT

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

  Set up a GATT subscription. The server selects the best provider (strongest RSSI, available slots) and handles failover.

  Parameters

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

  Returns Promise<GATTSubscriptionHandle>

unRegister

• unRegister(pluginId: string): void

  Parameters

  • pluginId: string

  Returns void