Class SerialConnection

Allows to connect to a Meshtastic device over WebSerial

Hierarchy (view full)

Constructors

constructor

Properties

configId connType deviceStatus events isConfigured log pendingSettingsChanges pipePromise? port portId preventLock? queue readerHack transformer? xModem

Methods

clearChannel commitEditSettings complete configure connect disconnect factoryReset getChannel getConfig getCurrentPort getMetadata getModuleConfig getOwner getPort getPorts handleFromRadio ping readFromRadio reboot rebootOta reconnect removeNodeByNum requestPosition resetNodes sendPacket sendRaw sendText sendWaypoint setChannel setConfig setModuleConfig setOwner setPosition shutdown traceRoute updateDeviceStatus writeToRadio

Events

onReleaseEvent

Constructors

constructor

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>

commitEditSettings

complete

  • complete(): void

  • Completes all Events

    Returns void

configure

  • configure(): Promise<number>

  • Triggers the device configure process

    Returns Promise<number>

connect

  • connect(__namedParameters): Promise<void>

  • Initiates the connect process to a Meshtastic device via Web Serial

    Parameters

    Returns Promise<void>

disconnect

  • disconnect(): Promise<undefined | SerialPort>

  • Disconnects from the serial port

    Returns Promise<undefined | SerialPort>

factoryReset

  • factoryReset(): Promise<number>

  • Factory resets the current node

    Returns Promise<number>

getChannel

  • getChannel(index): Promise<number>

  • Gets specified channel information from the radio

    Parameters

    • index: number

    Returns Promise<number>

getConfig

getCurrentPort

  • getCurrentPort(): undefined | SerialPort

  • Returns undefined | SerialPort

getMetadata

  • getMetadata(nodeNum): Promise<number>

  • Gets devices metadata

    Parameters

    • nodeNum: number

    Returns Promise<number>

getModuleConfig

getOwner

  • getOwner(): Promise<number>

  • Gets devices Owner

    Returns Promise<number>

getPort

  • getPort(filter?): Promise<SerialPort>

  • Opens browsers connection dialogue to select a serial port

    Parameters

    • Optional filter: SerialPortRequestOptions

    Returns Promise<SerialPort>

getPorts

  • getPorts(): Promise<SerialPort[]>

  • Gets list of serial ports that can be passed to connect

    Returns Promise<SerialPort[]>

Protected handleFromRadio

  • handleFromRadio(fromRadio): void

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

    Parameters

    • fromRadio: Uint8Array

    Returns void

ping

  • ping(): Promise<boolean>

  • Pings device to check if it is avaliable

    Returns Promise<boolean>

Private readFromRadio

  • readFromRadio(reader): Promise<void>

  • Reads packets from transformed serial port steam and processes them.

    Parameters

    • reader: ReadableStreamDefaultReader<Uint8Array>

    Returns Promise<void>

reboot

  • reboot(time): Promise<number>

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

    Parameters

    • time: number

    Returns Promise<number>

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>

reconnect

  • reconnect(): Promise<void>

  • Disconnects from the serial port

    Returns Promise<void>

removeNodeByNum

  • removeNodeByNum(nodeNum): Promise<number>

  • Removes a node from the internal NodeDB of the radio by node number

    Parameters

    • nodeNum: number

    Returns Promise<number>

requestPosition

  • requestPosition(destination): Promise<number>

  • Requests position from the designated node

    Parameters

    • destination: number

    Returns Promise<number>

resetNodes

  • resetNodes(): Promise<number>

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

    Returns Promise<number>

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>

sendRaw

  • sendRaw(toRadio, id?): Promise<number>

  • Sends raw packet over the radio

    Parameters

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

    Returns Promise<number>

sendText

  • sendText(text, destination?, wantAck?, channel?): Promise<number>

  • Sends a text over the radio

    Parameters

    Returns Promise<number>

sendWaypoint

  • sendWaypoint(waypointMessage, destination, channel?): Promise<number>

  • Sends a text over the radio

    Parameters

    Returns Promise<number>

setChannel

  • setChannel(channel): Promise<number>

  • Sets devices ChannelSettings

    Parameters

    Returns Promise<number>

setConfig

  • setConfig(config): Promise<number>

  • Writes config to device

    Parameters

    Returns Promise<number>

setModuleConfig

  • setModuleConfig(moduleConfig): Promise<number>

  • Writes module config to device

    Parameters

    Returns Promise<number>

setOwner

  • setOwner(owner): Promise<number>

  • Sets devices owner data

    Parameters

    Returns Promise<number>

setPosition

  • setPosition(positionMessage): Promise<number>

  • Parameters

    Returns Promise<number>

shutdown

  • shutdown(time): Promise<number>

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

    Parameters

    • time: number

    Returns Promise<number>

traceRoute

  • traceRoute(destination): Promise<number>

  • Sends a trace route packet to the designated node

    Parameters

    • destination: number

    Returns Promise<number>

updateDeviceStatus

Protected writeToRadio

  • writeToRadio(data): Promise<void>

  • Sends supplied protobuf message to the radio

    Parameters

    • data: Uint8Array

    Returns Promise<void>

Events

Private Readonly onReleaseEvent

onReleaseEvent: SimpleEventDispatcher<boolean>

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

onReleaseEvent

Settings

Member Visibility

Theme

On This Page

constructorconfigIdconnTypedeviceStatuseventsisConfiguredlogpendingSettingsChangespipePromiseportportIdpreventLockqueuereaderHacktransformerxModemclearChannelcommitEditSettingscompleteconfigureconnectdisconnectfactoryResetgetChannelgetConfiggetCurrentPortgetMetadatagetModuleConfiggetOwnergetPortgetPortshandleFromRadiopingreadFromRadiorebootrebootOtareconnectremoveNodeByNumrequestPositionresetNodessendPacketsendRawsendTextsendWaypointsetChannelsetConfigsetModuleConfigsetOwnersetPositionshutdowntraceRouteupdateDeviceStatuswriteToRadioonReleaseEvent

Generated using TypeDoc