Class IMeshDevice`Abstract`

Base class for connection methods to extend

Hierarchy

IMeshDevice

Constructors

constructor

new IMeshDevice(configId?): IMeshDevice
Parameters
- Optional configId: number
Returns IMeshDevice
- Defined in src/meshDevice.ts:44

Properties

XModem

XModem: Xmodem

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

Methods

`Private` beginEditSettings

beginEditSettings(): Promise<number>
Returns Promise<number>
- Defined in src/meshDevice.ts:479

clearChannel

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

commitEditSettings

commitEditSettings(): Promise<number>
Returns Promise<number>
- Defined in src/meshDevice.ts:496

complete

complete(): void
Completes all SubEvents

Returns void
- Defined in src/meshDevice.ts:863

configure

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

Returns Promise<number>
- Defined in src/meshDevice.ts:625

`Protected` `Abstract` connect

connect(parameters): Promise<void>
Abstract method that connects to the radio
Parameters
- parameters: ConnectionParameters
Returns Promise<void>
- Defined in src/meshDevice.ts:81

`Protected` `Abstract` disconnect

disconnect(): void
Abstract method that disconnects from the radio

Returns void
- Defined in src/meshDevice.ts:86

factoryReset

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

Returns Promise<number>
- Defined in src/meshDevice.ts:604

`Private` generateRandId

generateRandId(): number
Generates random packet identifier

Returns number
Random packet ID
- Defined in src/meshDevice.ts:678

getChannel

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

getConfig

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

getMetadata

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

getModuleConfig

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

getOwner

getOwner(): Promise<number>
Gets devices Owner

Returns Promise<number>
- Defined in src/meshDevice.ts:408

`Private` handleDecodedPacket

handleDecodedPacket(dataPacket, meshPacket): void
Parameters
- dataPacket: Data
- meshPacket: MeshPacket
Returns void
- Defined in src/meshDevice.ts:925

`Protected` handleFromRadio

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

`Private` handleMeshPacket

handleMeshPacket(meshPacket): void
Gets called when a MeshPacket is received from device
Parameters
- meshPacket: MeshPacket
Returns void
- Defined in src/meshDevice.ts:898

`Protected` `Abstract` ping

ping(): Promise<boolean>
Abstract method that pings the radio

Returns Promise<boolean>
- Defined in src/meshDevice.ts:89

reboot

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

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>
- Defined in src/meshDevice.ts:583

requestPosition

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

resetPeers

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

Returns Promise<number>
- Defined in src/meshDevice.ts:517

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>
- Defined in src/meshDevice.ts:150

sendRaw

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

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>
- Defined in src/meshDevice.ts:94

sendWaypoint

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

setChannel

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

setConfig

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

setModuleConfig

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

setOwner

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

setPosition

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

shutdown

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

traceRoute

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

updateDeviceStatus

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

`Protected` `Abstract` writeToRadio

writeToRadio(data): Promise<void>
Abstract method that writes data to the radio
Parameters
- data: Uint8Array
Returns Promise<void>
- Defined in src/meshDevice.ts:78

Class IMeshDeviceAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configId: number

Returns IMeshDevice

Properties

XModem

configId

Protected Abstract connType

Protected deviceStatus

events

Protected isConfigured

Protected log

Private myNodeInfo

Protected pendingSettingsChanges

Protected Abstract portId

queue

Methods

Private beginEditSettings

Returns Promise<number>

clearChannel

Parameters

index: number

Returns Promise<number>

commitEditSettings

Returns Promise<number>

complete

Returns void

configure

Returns Promise<number>

Protected Abstract connect

Parameters

parameters: ConnectionParameters

Returns Promise<void>

Protected Abstract disconnect

Returns void

factoryReset

Returns Promise<number>

Private generateRandId

Returns number

getChannel

Parameters

index: number

Returns Promise<number>

getConfig

Parameters

configType: AdminMessage_ConfigType

Returns Promise<number>

getMetadata

Parameters

nodeNum: number

Returns Promise<number>

getModuleConfig

Parameters

moduleConfigType: AdminMessage_ModuleConfigType

Returns Promise<number>

getOwner

Returns Promise<number>

Private handleDecodedPacket

Parameters

dataPacket: Data

meshPacket: MeshPacket

Returns void

Protected handleFromRadio

Parameters

fromRadio: Uint8Array

Returns void

Private handleMeshPacket

Parameters

meshPacket: MeshPacket

Returns void

Protected Abstract ping

Returns Promise<boolean>

reboot

Class IMeshDevice`Abstract`

`Optional` configId: number

`Protected` `Abstract` connType

`Protected` deviceStatus

`Protected` isConfigured

`Protected` log

`Private` myNodeInfo

`Protected` pendingSettingsChanges

`Protected` `Abstract` portId

`Private` beginEditSettings

`Protected` `Abstract` connect

`Protected` `Abstract` disconnect

`Private` generateRandId

`Private` handleDecodedPacket

`Protected` handleFromRadio

`Private` handleMeshPacket

`Protected` `Abstract` ping

`Optional` replyId: number

`Optional` emoji: number

`Optional` destination: Destination

`Optional` wantAck: boolean

`Optional` channel: ChannelNumber

`Optional` channel: ChannelNumber