Class BleConnection

Allows to connect to a Meshtastic device via bluetooth

Hierarchy (view full)

Constructors

Properties

configId: number

Randomly generated number to ensure confiuration lockstep

Defines the connection type as ble

device: undefined | BluetoothDevice

Currently connected BLE device

deviceStatus: DeviceStatusEnum

Describes the current state of the device

events: EventSystem
fromNumCharacteristic: undefined | BluetoothRemoteGATTCharacteristic

Short Description

fromRadioCharacteristic: undefined | BluetoothRemoteGATTCharacteristic

Short Description

gattServer: undefined | BluetoothRemoteGATTServer
isConfigured: boolean

Describes the current state of the device

log: Logger<unknown>

Logs to the console and the logging event emitter

pendingSettingsChanges: boolean

Are there any settings that have yet to be applied?

portId: string
queue: Queue

Packert queue, to space out transmissions and routing handle errors and acks

service: undefined | BluetoothRemoteGATTService

Short Description

timerUpdateFromRadio: null | Timeout = null
toRadioCharacteristic: undefined | BluetoothRemoteGATTCharacteristic

Short Description

xModem: Xmodem

Methods

  • Clears specific channel with the designated index

    Parameters

    • index: number

    Returns Promise<number>

  • Completes all SubEvents

    Returns void

  • Triggers the device configure process

    Returns Promise<number>

  • Initiates the connect process to a Meshtastic device via Bluetooth

    Parameters

    Returns Promise<void>

  • Disconnects from the Meshtastic device

    Returns void

  • Factory resets the current node

    Returns Promise<number>

  • Gets specified channel information from the radio

    Parameters

    • index: number

    Returns Promise<number>

  • Opens browser dialog to select a device

    Parameters

    • Optional filter: RequestDeviceOptions

    Returns Promise<BluetoothDevice>

  • Gets list of bluetooth devices that can be passed to connect

    Returns Promise<BluetoothDevice[]>

    Array of avaliable BLE devices

  • Gets devices metadata

    Parameters

    • nodeNum: number

    Returns Promise<number>

  • Gets devices Owner

    Returns Promise<number>

  • Gets called whenever a fromRadio message is received from device, returns fromRadio data

    Parameters

    • fromRadio: Uint8Array

    Returns void

  • Pings device to check if it is avaliable

    Returns Promise<boolean>

    Todo

    Implement

  • Short description

    Returns Promise<void>

  • Reboots the current node after the specified amount of time has elapsed.

    Parameters

    • time: number

    Returns Promise<number>

  • Reboots the current node into OTA mode after the specified amount of time has elapsed.

    Parameters

    • time: number

    Returns Promise<number>

  • Requests position from the designated node

    Parameters

    • destination: number

    Returns Promise<number>

  • Resets the internal NodeDB of the radio, usefull for removing old nodes that no longer exist.

    Returns Promise<number>

  • Sends packet over the radio

    Parameters

    • byteData: Uint8Array
    • portNum: PortNum
    • destination: Destination
    • channel: ChannelNumber = Types.ChannelNumber.Primary
    • wantAck: boolean = true
    • wantResponse: boolean = true
    • echoResponse: boolean = false
    • Optional replyId: number
    • Optional emoji: number

    Returns Promise<number>

  • Sends raw packet over the radio

    Parameters

    • toRadio: Uint8Array
    • id: number = ...

    Returns Promise<number>

  • Sends a text over the radio

    Parameters

    Returns Promise<number>

  • Sends a text over the radio

    Parameters

    Returns Promise<number>

  • Sets devices ChannelSettings

    Parameters

    Returns Promise<number>

  • Writes config to device

    Parameters

    Returns Promise<number>

  • Writes module config to device

    Parameters

    Returns Promise<number>

  • Sets devices owner data

    Parameters

    Returns Promise<number>

  • Parameters

    Returns Promise<number>

  • Shuts down the current node after the specified amount of time has elapsed.

    Parameters

    • time: number

    Returns Promise<number>

  • Gets web bluetooth support avaliability for the device

    Returns Promise<boolean>

  • Sends a trace route packet to the designated node

    Parameters

    • destination: number

    Returns Promise<number>

  • Sends supplied protobuf message to the radio

    Parameters

    • data: Uint8Array

    Returns Promise<void>

Generated using TypeDoc