Interface ConnectOptions

The options object passed into the connect function.

interface ConnectOptions {
    UUID: string;
    auto2MegPhy?: boolean;
    autoDiscoverAll?: boolean;
    autoMaxMTU?: boolean;
    onConnected?: ((data) => void);
    onDisconnected?: ((data) => void);
    priority?: number;
    serviceUUIDs?: string[];
    transport?: number;
}

Properties

UUID auto2MegPhy? autoDiscoverAll? autoMaxMTU? onConnected? onDisconnected? priority? serviceUUIDs? transport?

Properties

UUID

UUID: string

The UUID of the peripheral to connect to.

Optional auto2MegPhy

auto2MegPhy?: boolean

Selects 2M PHY when available (Android only)

Optional autoDiscoverAll

autoDiscoverAll?: boolean

Discover all services on connection. Default is false for faster connection

Optional autoMaxMTU

autoMaxMTU?: boolean

Selects maximum BLE MTU (247) (Android only)

Optional onConnected

onConnected?: ((data) => void)

Once the peripheral is connected this callback function is invoked.

Type declaration

    • (data): void

    • Once the peripheral is connected this callback function is invoked.

      Parameters

      • data: {
            UUID: any;
            advertismentData: AdvertismentData;
            name: string;
            services?: Service[];
            state: ConnectionState;
        }

      Returns void

Optional onDisconnected

onDisconnected?: ((data) => void)

Once the peripheral is disconnected this callback function is invoked.

Type declaration

    • (data): void

    • Once the peripheral is disconnected this callback function is invoked.

      Parameters

      • data: {
            UUID: any;
            name: string;
        }
        • UUID: any
        • name: string

      Returns void

Optional priority

priority?: number

request connection priority (Android only): https://developer.android.com/reference/android/bluetooth/BluetoothGatt.html#requestConnectionPriority(int)

Optional serviceUUIDs

serviceUUIDs?: string[]

Discover specified services on connection

Optional transport

transport?: number

transport selection (Android only)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc