Class BleConnection

Allows to connect to a Meshtastic device via bluetooth

Hierarchy (view full)

MeshDevice
- BleConnection

Constructors

constructor

new BleConnection(configId?): BleConnection
Parameters
- OptionalconfigId: number
Returns BleConnection
Overrides MeshDevice.constructor
- Defined in src/adapters/bleConnection.ts:39

Properties

configId

configId: number

Randomly generated number to ensure confiuration lockstep

connType

connType: ConnectionTypeName

Defines the connection type as ble

device

device: undefined | BluetoothDevice

Currently connected BLE device

`Protected`deviceStatus

deviceStatus: DeviceStatusEnum

Describes the current state of the device

events

events: EventSystem

`Protected`isConfigured

isConfigured: boolean

Describes the current state of the device

`Protected`log

log: Logger<unknown>

Logs to the console and the logging event emitter

`Protected`pendingSettingsChanges

pendingSettingsChanges: boolean

Are there any settings that have yet to be applied?

portId

portId: string

queue

queue: Queue

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

xModem

xModem: Xmodem

Methods

clearChannel

clearChannel(index): Promise<number>
Clears specific channel with the designated index
Parameters
- index: number
Returns Promise<number>
Inherited from MeshDevice.clearChannel
- Defined in src/meshDevice.ts:507

commitEditSettings

commitEditSettings(): Promise<number>
Returns Promise<number>
Inherited from MeshDevice.commitEditSettings
- Defined in src/meshDevice.ts:548

complete

complete(): void
Completes all Events

Returns void
Inherited from MeshDevice.complete
- Defined in src/meshDevice.ts:1002

configure

configure(): Promise<number>
Triggers the device configure process

Returns Promise<number>
Inherited from MeshDevice.configure
- Defined in src/meshDevice.ts:721

connect

connect(__namedParameters): Promise<void>
Initiates the connect process to a Meshtastic device via Bluetooth
Parameters
- __namedParameters: BleConnectionParameters
Returns Promise<void>
Overrides MeshDevice.connect
- Defined in src/adapters/bleConnection.ts:92

disconnect

disconnect(): void
Disconnects from the Meshtastic device

Returns void
Overrides MeshDevice.disconnect
- Defined in src/adapters/bleConnection.ts:197

enterDfuMode

enterDfuMode(): Promise<number>
Returns Promise<number>
Inherited from MeshDevice.enterDfuMode
- Defined in src/meshDevice.ts:350

factoryResetConfig

factoryResetConfig(): Promise<number>
Factory resets the current config

Returns Promise<number>
Inherited from MeshDevice.factoryResetConfig
- Defined in src/meshDevice.ts:700

factoryResetDevice

factoryResetDevice(): Promise<number>
Factory resets the current device

Returns Promise<number>
Inherited from MeshDevice.factoryResetDevice
- Defined in src/meshDevice.ts:679

getChannel

getChannel(index): Promise<number>
Gets specified channel information from the radio
Parameters
- index: number
Returns Promise<number>
Inherited from MeshDevice.getChannel
- Defined in src/meshDevice.ts:382

getConfig

getConfig(configType): Promise<number>
Gets devices config request
Parameters
- configType: AdminMessage_ConfigType
Returns Promise<number>
Inherited from MeshDevice.getConfig
- Defined in src/meshDevice.ts:406

getDevice

getDevice(filter?): Promise<BluetoothDevice>
Opens browser dialog to select a device
Parameters
- Optionalfilter: RequestDeviceOptions
Returns Promise<BluetoothDevice>
- Defined in src/adapters/bleConnection.ts:81

getDevices

getDevices(): Promise<BluetoothDevice[]>
Gets list of bluetooth devices that can be passed to connect

Returns Promise<BluetoothDevice[]>
Array of avaliable BLE devices
- Defined in src/adapters/bleConnection.ts:74

getMetadata

getMetadata(nodeNum): Promise<number>
Gets devices metadata
Parameters
- nodeNum: number
Returns Promise<number>
Inherited from MeshDevice.getMetadata
- Defined in src/meshDevice.ts:477

getModuleConfig

getModuleConfig(moduleConfigType): Promise<number>
Gets Module config
Parameters
- moduleConfigType: AdminMessage_ModuleConfigType
Returns Promise<number>
Inherited from MeshDevice.getModuleConfig
- Defined in src/meshDevice.ts:431

getOwner

getOwner(): Promise<number>
Gets devices Owner

Returns Promise<number>
Inherited from MeshDevice.getOwner
- Defined in src/meshDevice.ts:454

`Protected`handleFromRadio

handleFromRadio(fromRadio): void
Gets called whenever a fromRadio message is received from device, returns fromRadio data
Parameters
- fromRadio: Uint8Array
Returns void
Inherited from MeshDevice.handleFromRadio
- Defined in src/meshDevice.ts:804

heartbeat

heartbeat(): Promise<number>
Serial connection requires a heartbeat ping to stay connected, otherwise times out after 15 minutes

Returns Promise<number>
Inherited from MeshDevice.heartbeat
- Defined in src/meshDevice.ts:739

ping

ping(): Promise<boolean>
Pings device to check if it is avaliable

Returns Promise<boolean>
Todo
Implement
Overrides MeshDevice.ping
- Defined in src/adapters/bleConnection.ts:212

`Protected`readFromRadio

readFromRadio(): Promise<void>
Short description

Returns Promise<void>
- Defined in src/adapters/bleConnection.ts:217

reboot

reboot(time): Promise<number>
Reboots the current node after the specified amount of time has elapsed.
Parameters
- time: number
Returns Promise<number>
Inherited from MeshDevice.reboot
- Defined in src/meshDevice.ts:634

rebootOta

rebootOta(time): Promise<number>
Reboots the current node into OTA mode after the specified amount of time has elapsed.
Parameters
- time: number
Returns Promise<number>
Inherited from MeshDevice.rebootOta
- Defined in src/meshDevice.ts:658

removeNodeByNum

removeNodeByNum(nodeNum): Promise<number>
Removes a node from the internal NodeDB of the radio by node number
Parameters
- nodeNum: number
Returns Promise<number>
Inherited from MeshDevice.removeNodeByNum
- Defined in src/meshDevice.ts:592

requestPosition

requestPosition(destination): Promise<number>
Requests position from the designated node
Parameters
- destination: number
Returns Promise<number>
Inherited from MeshDevice.requestPosition
- Defined in src/meshDevice.ts:769

resetNodes

resetNodes(): Promise<number>
Resets the internal NodeDB of the radio, usefull for removing old nodes that no longer exist.

Returns Promise<number>
Inherited from MeshDevice.resetNodes
- Defined in src/meshDevice.ts:569

sendPacket

sendPacket(byteData, portNum, destination, channel?, wantAck?, wantResponse?, echoResponse?, replyId?, emoji?): 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
- OptionalreplyId: number
- Optionalemoji: number
Returns Promise<number>
Inherited from MeshDevice.sendPacket
- Defined in src/meshDevice.ts:152

sendRaw

sendRaw(toRadio, id?): Promise<number>
Sends raw packet over the radio
Parameters
- toRadio: Uint8Array
- id: number = ...
Returns Promise<number>
Inherited from MeshDevice.sendRaw
- Defined in src/meshDevice.ts:214

sendText

sendText(text, destination?, wantAck?, channel?): Promise<number>
Sends a text over the radio
Parameters
- text: string
- Optionaldestination: Destination
- OptionalwantAck: boolean
- Optionalchannel: ChannelNumber
Returns Promise<number>
Inherited from MeshDevice.sendText
- Defined in src/meshDevice.ts:96

sendWaypoint

sendWaypoint(waypointMessage, destination, channel?): Promise<number>
Sends a text over the radio
Parameters
- waypointMessage: Waypoint
- destination: Destination
- Optionalchannel: ChannelNumber
Returns Promise<number>
Inherited from MeshDevice.sendWaypoint
- Defined in src/meshDevice.ts:125

setCannedMessages

setCannedMessages(cannedMessages): Promise<number>
Parameters
- cannedMessages: CannedMessageModuleConfig
Returns Promise<number>
Inherited from MeshDevice.setCannedMessages
- Defined in src/meshDevice.ts:286

setChannel

setChannel(channel): Promise<number>
Sets devices ChannelSettings
Parameters
- channel: Channel
Returns Promise<number>
Inherited from MeshDevice.setChannel
- Defined in src/meshDevice.ts:331

setConfig

setConfig(config): Promise<number>
Writes config to device
Parameters
- config: Config
Returns Promise<number>
Inherited from MeshDevice.setConfig
- Defined in src/meshDevice.ts:236

setModuleConfig

setModuleConfig(moduleConfig): Promise<number>
Writes module config to device
Parameters
- moduleConfig: ModuleConfig
Returns Promise<number>
Inherited from MeshDevice.setModuleConfig
- Defined in src/meshDevice.ts:263

setOwner

setOwner(owner): Promise<number>
Sets devices owner data
Parameters
- owner: User
Returns Promise<number>
Inherited from MeshDevice.setOwner
- Defined in src/meshDevice.ts:311

setPosition

setPosition(positionMessage): Promise<number>
Parameters
- positionMessage: Position
Returns Promise<number>
Inherited from MeshDevice.setPosition
- Defined in src/meshDevice.ts:369

shutdown

shutdown(time): Promise<number>
Shuts down the current node after the specified amount of time has elapsed.
Parameters
- time: number
Returns Promise<number>
Inherited from MeshDevice.shutdown
- Defined in src/meshDevice.ts:613

supported

supported(): Promise<boolean>
Gets web bluetooth support avaliability for the device

Returns Promise<boolean>
- Defined in src/adapters/bleConnection.ts:65

traceRoute

traceRoute(destination): Promise<number>
Sends a trace route packet to the designated node
Parameters
- destination: number
Returns Promise<number>
Inherited from MeshDevice.traceRoute
- Defined in src/meshDevice.ts:756

updateDeviceStatus

updateDeviceStatus(status): void
Updates the device status eliminating duplicate status events
Parameters
- status: DeviceStatusEnum
Returns void
Inherited from MeshDevice.updateDeviceStatus
- Defined in src/meshDevice.ts:780

`Protected`writeToRadio

writeToRadio(data): Promise<void>
Sends supplied protobuf message to the radio
Parameters
- data: Uint8Array
Returns Promise<void>
Overrides MeshDevice.writeToRadio
- Defined in src/adapters/bleConnection.ts:249

Class BleConnection

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BleConnection

Properties

configId

connType

device

ProtecteddeviceStatus

events

ProtectedisConfigured

Protectedlog

ProtectedpendingSettingsChanges

portId

queue

xModem

Methods

clearChannel

Parameters

Returns Promise<number>

commitEditSettings

Returns Promise<number>

complete

Returns void

configure

Returns Promise<number>

connect

Parameters

Returns Promise<void>

disconnect

Returns void

enterDfuMode

Returns Promise<number>

factoryResetConfig

Returns Promise<number>

factoryResetDevice

Returns Promise<number>

getChannel

Parameters

Returns Promise<number>

getConfig

Parameters

Returns Promise<number>

getDevice

Parameters

Returns Promise<BluetoothDevice>

getDevices

Returns Promise<BluetoothDevice[]>

getMetadata

Parameters

Returns Promise<number>

getModuleConfig

Parameters

Returns Promise<number>

getOwner

Returns Promise<number>

ProtectedhandleFromRadio

Parameters

Returns void

heartbeat

Returns Promise<number>

ping

Returns Promise<boolean>

Todo

ProtectedreadFromRadio

Returns Promise<void>

reboot

Parameters

Returns Promise<number>

rebootOta

Parameters

Returns Promise<number>

removeNodeByNum

Parameters

`Protected`deviceStatus

`Protected`isConfigured

`Protected`log

`Protected`pendingSettingsChanges

`Protected`handleFromRadio

`Protected`readFromRadio

`Protected`writeToRadio