Class MeshDeviceAbstract

Base class for connection methods to extend

Hierarchy (view full)

Constructors

constructor

Properties

configId connType deviceStatus events isConfigured log myNodeInfo pendingSettingsChanges portId queue xModem

Methods

beginEditSettings clearChannel commitEditSettings complete configure connect disconnect factoryResetConfig factoryResetDevice generateRandId getChannel getConfig getMetadata getModuleConfig getOwner handleDecodedPacket handleFromRadio handleMeshPacket ping reboot rebootOta removeNodeByNum requestPosition resetNodes sendPacket sendRaw sendText sendWaypoint setCannedMessages setChannel setConfig setModuleConfig setOwner setPosition shutdown traceRoute updateDeviceStatus writeToRadio

Constructors

constructor

  • new MeshDevice(configId?): MeshDevice

  • Parameters

    • Optional configId: number

    Returns MeshDevice

Properties

configId

configId: number

Randomly generated number to ensure confiuration lockstep

Protected Abstract connType

connType: ConnectionTypeName

Abstract property that states the connection type

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

Private myNodeInfo

myNodeInfo: MyNodeInfo

Device's node number

Protected pendingSettingsChanges

pendingSettingsChanges: boolean

Are there any settings that have yet to be applied?

Protected Abstract portId

portId: string

queue

queue: Queue

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

xModem

xModem: Xmodem

Methods

Private beginEditSettings

  • beginEditSettings(): Promise<number>

  • Returns Promise<number>

clearChannel

  • clearChannel(index): Promise<number>

  • Clears specific channel with the designated index

    Parameters

    • index: number

    Returns Promise<number>

commitEditSettings

  • commitEditSettings(): Promise<number>

  • Returns Promise<number>

complete

  • complete(): void

  • Completes all Events

    Returns void

configure

  • configure(): Promise<number>

  • Triggers the device configure process

    Returns Promise<number>

Protected Abstract connect

  • connect(parameters): Promise<void>

  • Abstract method that connects to the radio

    Parameters

    Returns Promise<void>

Protected Abstract disconnect

  • disconnect(): void

  • Abstract method that disconnects from the radio

    Returns void

factoryResetConfig

  • factoryResetConfig(): Promise<number>

  • Factory resets the current config

    Returns Promise<number>

factoryResetDevice

  • factoryResetDevice(): Promise<number>

  • Factory resets the current device

    Returns Promise<number>

Private generateRandId

  • generateRandId(): number

  • Generates random packet identifier

    Returns number

    Random packet ID

getChannel

  • getChannel(index): Promise<number>

  • Gets specified channel information from the radio

    Parameters

    • index: number

    Returns Promise<number>

getConfig

  • getConfig(configType): Promise<number>

  • Gets devices config request

    Parameters

    Returns Promise<number>

getMetadata

  • getMetadata(nodeNum): Promise<number>

  • Gets devices metadata

    Parameters

    • nodeNum: number

    Returns Promise<number>

getModuleConfig

  • getModuleConfig(moduleConfigType): Promise<number>

  • Gets Module config

    Parameters

    Returns Promise<number>

getOwner

  • getOwner(): Promise<number>

  • Gets devices Owner

    Returns Promise<number>

Private handleDecodedPacket

  • handleDecodedPacket(dataPacket, meshPacket): void

  • Parameters

    Returns void

Protected handleFromRadio

  • handleFromRadio(fromRadio): void

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

    Parameters

    • fromRadio: Uint8Array

    Returns void

Private handleMeshPacket

  • handleMeshPacket(meshPacket): void

  • Gets called when a MeshPacket is received from device

    Parameters

    Returns void

Protected Abstract ping

  • ping(): Promise<boolean>

  • Abstract method that pings the radio

    Returns Promise<boolean>

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>

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>

setCannedMessages

  • setCannedMessages(cannedMessages): Promise<number>

  • 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

  • updateDeviceStatus(status): void

  • Updates the device status eliminating duplicate status events

    Parameters

    Returns void

Protected Abstract writeToRadio

  • writeToRadio(data): Promise<void>

  • Abstract method that writes data to the radio

    Parameters

    • data: Uint8Array

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorconfigIdconnTypedeviceStatuseventsisConfiguredlogmyNodeInfopendingSettingsChangesportIdqueuexModembeginEditSettingsclearChannelcommitEditSettingscompleteconfigureconnectdisconnectfactoryResetConfigfactoryResetDevicegenerateRandIdgetChannelgetConfiggetMetadatagetModuleConfiggetOwnerhandleDecodedPackethandleFromRadiohandleMeshPacketpingrebootrebootOtaremoveNodeByNumrequestPositionresetNodessendPacketsendRawsendTextsendWaypointsetCannedMessagessetChannelsetConfigsetModuleConfigsetOwnersetPositionshutdowntraceRouteupdateDeviceStatuswriteToRadio

Generated using TypeDoc