Class SerialConnection

Allows to connect to a Meshtastic device over WebSerial

Hierarchy (view full)

MeshDevice
- SerialConnection

Constructors

constructor

new SerialConnection(configId?): SerialConnection
Parameters
- Optional configId: number
Returns SerialConnection
Overrides MeshDevice.constructor
- Defined in src/adapters/serialConnection.ts:36

Properties

configId

configId: number

Randomly generated number to ensure confiuration lockstep

connType

connType: ConnectionTypeName

Defines the connection type as serial

`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?

`Private` `Optional` pipePromise

pipePromise?: Promise<void>

Unfortunately, this is currently the only way to release the lock on a stream after piping it through a transform stream (https://stackoverflow.com/questions/71262432)

port

port: undefined | SerialPort

Serial port used to communicate with device.

`Protected` portId

portId: string

`Private` `Optional` preventLock

preventLock?: boolean

Should locks be prevented

queue

queue: Queue

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

`Private` readerHack

readerHack: undefined | ReadableStreamDefaultReader<Uint8Array>

`Private` `Optional` transformer

transformer?: TransformStream<Uint8Array, Uint8Array>

Transform stream for parsing raw serial data

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:454

commitEditSettings

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

complete

complete(): void
Completes all Events

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

configure

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

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

connect

connect(__namedParameters): Promise<void>
Initiates the connect process to a Meshtastic device via Web Serial
Parameters
- __namedParameters: SerialConnectionParameters
Returns Promise<void>
Overrides MeshDevice.connect
- Defined in src/adapters/serialConnection.ts:104

disconnect

disconnect(): Promise<undefined | SerialPort>
Disconnects from the serial port

Returns Promise<undefined | SerialPort>
Overrides MeshDevice.disconnect
- Defined in src/adapters/serialConnection.ts:172

factoryReset

factoryReset(): Promise<number>
Factory resets the current node

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

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:335

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:359

getCurrentPort

getCurrentPort(): undefined | SerialPort
Returns undefined | SerialPort
- Defined in src/adapters/serialConnection.ts:97

getMetadata

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

getModuleConfig

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

getOwner

getOwner(): Promise<number>
Gets devices Owner

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

getPort

getPort(filter?): Promise<SerialPort>
Opens browsers connection dialogue to select a serial port
Parameters
- Optional filter: SerialPortRequestOptions
Returns Promise<SerialPort>
- Defined in src/adapters/serialConnection.ts:93

getPorts

getPorts(): Promise<SerialPort[]>
Gets list of serial ports that can be passed to connect

Returns Promise<SerialPort[]>
- Defined in src/adapters/serialConnection.ts:86

`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:690

ping

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

Returns Promise<boolean>
Overrides MeshDevice.ping
- Defined in src/adapters/serialConnection.ts:191

`Private` readFromRadio

readFromRadio(reader): Promise<void>
Reads packets from transformed serial port steam and processes them.
Parameters
- reader: ReadableStreamDefaultReader<Uint8Array>
Returns Promise<void>
- Defined in src/adapters/serialConnection.ts:57

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:558

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:582

reconnect

reconnect(): Promise<void>
Disconnects from the serial port

Returns Promise<void>
- Defined in src/adapters/serialConnection.ts:164

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:655

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:516

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
- Optional replyId: number
- Optional emoji: number
Returns Promise<number>
Inherited from MeshDevice.sendPacket
- Defined in src/meshDevice.ts:149

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:208

sendText

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

sendWaypoint

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

setChannel

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

setConfig

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

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:257

setOwner

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

setPosition

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

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:537

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:642

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:666

`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/serialConnection.ts:198

Events

`Private` `Readonly` onReleaseEvent

onReleaseEvent: SimpleEventDispatcher<boolean>

Fires when disconnect() is called, used to instruct serial port and readers to release there locks

onReleaseEvent

Class SerialConnection

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Parameters

Returns SerialConnection

Properties

configId

connType

Protected deviceStatus

events

Protected isConfigured

Protected log

Protected pendingSettingsChanges

Private Optional pipePromise

port

Protected portId

Private Optional preventLock

queue

Private readerHack

Private Optional transformer

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 Promise<undefined | SerialPort>

factoryReset

Returns Promise<number>

getChannel

Parameters

Returns Promise<number>

getConfig

Parameters

Returns Promise<number>

getCurrentPort

Returns undefined | SerialPort

getMetadata

Parameters

Returns Promise<number>

getModuleConfig

Parameters

Returns Promise<number>

getOwner

Returns Promise<number>

getPort

Parameters

Returns Promise<SerialPort>

getPorts

Returns Promise<SerialPort[]>

Protected handleFromRadio

Parameters

Returns void

ping

Returns Promise<boolean>

Private readFromRadio

Parameters

Returns Promise<void>

reboot

Parameters

Returns Promise<number>

rebootOta

Parameters

Returns Promise<number>

reconnect

`Protected` deviceStatus

`Protected` isConfigured

`Protected` log

`Protected` pendingSettingsChanges

`Private` `Optional` pipePromise

`Protected` portId

`Private` `Optional` preventLock

`Private` readerHack

`Private` `Optional` transformer

`Protected` handleFromRadio

`Private` readFromRadio

`Protected` writeToRadio

`Private` `Readonly` onReleaseEvent