Interface ConnectOptions

The options object passed into the connect function.

interface ConnectOptions {
    auto2MegPhy?: boolean;
    autoDiscoverAll?: boolean;
    autoMaxMTU?: boolean;
    onConnected?: (
        data: {
            advertismentData: AdvertismentData;
            name: string;
            services?: Service[];
            state: ConnectionState;
            UUID: any;
        },
    ) => void;
    onDisconnected?: (data: { name: string; UUID: any }) => void;
    priority?: number;
    serviceUUIDs?: string[];
    transport?: number;
    UUID: string;
}

Properties

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

Properties

Optionalauto2MegPhy

auto2MegPhy?: boolean

Selects 2M PHY when available (Android only)

OptionalautoDiscoverAll

autoDiscoverAll?: boolean

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

OptionalautoMaxMTU

autoMaxMTU?: boolean

Selects maximum BLE MTU (247) (Android only)

OptionalonConnected

onConnected?: (
    data: {
        advertismentData: AdvertismentData;
        name: string;
        services?: Service[];
        state: ConnectionState;
        UUID: any;
    },
) => void

Once the peripheral is connected this callback function is invoked.

OptionalonDisconnected

onDisconnected?: (data: { name: string; UUID: any }) => void

Once the peripheral is disconnected this callback function is invoked.

Optionalpriority

priority?: number

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

OptionalserviceUUIDs

serviceUUIDs?: string[]

Discover specified services on connection

Optionaltransport

transport?: number

transport selection (Android only)

UUID

UUID: string

The UUID of the peripheral to connect to.

Settings

Member Visibility

On This Page

Properties