node-switchbot
    Preparing search index...

    Class BLEConnection

    BLE Connection for communicating with SwitchBot devices

    Index

    Constructors

    constructor

    Methods

    clearEncryption connect disconnect disconnectAll getConnectionCount isConnected markExpectedDisconnect read sendCommand setEncryption setPersistentConnectionTimeout subscribeNotifications unsubscribeNotifications write

    Constructors

    • Parameters

      • options: { logger?: Logger; logLevel?: number; noble?: any } = {}

      Returns BLEConnection

    Methods

    • Parameters

      • mac: string

      Returns void

    • Connect to a device

      Parameters

      • mac: string

      Returns Promise<void>

    • Disconnect from a device

      Parameters

      • mac: string

      Returns Promise<void>

    • Disconnect all devices

      Returns Promise<void>

    • Get connected device count

      Returns number

    • Check if connected to device

      Parameters

      • mac: string

      Returns boolean

    • Mark the next disconnect for this MAC as expected

      Parameters

      • mac: string

      Returns void

    • Read data from device

      Parameters

      • mac: string

      Returns Promise<Buffer<ArrayBufferLike>>

    • Parameters

      • mac: string
      • data: Buffer
      • options: {
            expectNotification?: boolean;
            expectResponse?: boolean;
            notificationTimeoutMs?: number;
            responseTimeoutMs?: number;
            validateResponse?: boolean;
        } = {}

      Returns Promise<Buffer<ArrayBufferLike> | undefined>

    • Parameters

      • mac: string
      • keyHex: string
      • ivHex: string
      • mode: "auto" | "ctr" | "gcm" = 'auto'

      Returns void

    • Parameters

      • timeoutMs: number

      Returns void

    • Parameters

      • mac: string
      • handler: (payload: Buffer) => void

      Returns Promise<void>

    • Parameters

      • mac: string
      • handler: (payload: Buffer) => void

      Returns void

    • Write data to device

      Parameters

      • mac: string
      • data: Buffer

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods