Class MeshDeviceAbstract

Base class for connection methods to extend

Hierarchy (view full)

Constructors

  • Parameters

    • Optional configId: number

    Returns MeshDevice

Properties

configId: number

Randomly generated number to ensure confiuration lockstep

Abstract property that states the connection type

deviceStatus: DeviceStatusEnum

Describes the current state of the device

events: EventSystem
isConfigured: boolean

Describes the current state of the device

log: Logger<unknown>

Logs to the console and the logging event emitter

myNodeInfo: MyNodeInfo

Device's node number

pendingSettingsChanges: boolean

Are there any settings that have yet to be applied?

portId: string
queue: Queue

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

xModem: Xmodem

Methods

  • Returns Promise<number>

  • Clears specific channel with the designated index

    Parameters

    • index: number

    Returns Promise<number>

  • Returns Promise<number>

  • Completes all SubEvents

    Returns void

  • Triggers the device configure process

    Returns Promise<number>

  • Abstract method that connects to the radio

    Parameters

    Returns Promise<void>

  • Abstract method that disconnects from the radio

    Returns void

  • Factory resets the current node

    Returns Promise<number>

  • Generates random packet identifier

    Returns number

    Random packet ID

  • Gets specified channel information from the radio

    Parameters

    • index: number

    Returns Promise<number>

  • Gets devices config request

    Parameters

    Returns Promise<number>

  • Gets devices metadata

    Parameters

    • nodeNum: number

    Returns Promise<number>

  • Gets Module config

    Parameters

    Returns Promise<number>

  • Gets devices Owner

    Returns Promise<number>

  • Parameters

    Returns void

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

    Parameters

    • fromRadio: Uint8Array

    Returns void

  • Gets called when a MeshPacket is received from device

    Parameters

    Returns void

  • Abstract method that pings the radio

    Returns Promise<boolean>

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

    Parameters

    • time: number

    Returns Promise<number>

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

    Parameters

    • time: number

    Returns Promise<number>

  • Requests position from the designated node

    Parameters

    • destination: number

    Returns Promise<number>

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

    Returns 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>

  • Sends raw packet over the radio

    Parameters

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

    Returns Promise<number>

  • Sends a text over the radio

    Parameters

    Returns Promise<number>

  • Sends a text over the radio

    Parameters

    Returns Promise<number>

  • Sets devices ChannelSettings

    Parameters

    Returns Promise<number>

  • Writes config to device

    Parameters

    Returns Promise<number>

  • Writes module config to device

    Parameters

    Returns Promise<number>

  • Sets devices owner data

    Parameters

    Returns Promise<number>

  • Parameters

    Returns Promise<number>

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

    Parameters

    • time: number

    Returns Promise<number>

  • Sends a trace route packet to the designated node

    Parameters

    • destination: number

    Returns Promise<number>

  • Updates the device status eliminating duplicate status events

    Parameters

    Returns void

  • Abstract method that writes data to the radio

    Parameters

    • data: Uint8Array

    Returns Promise<void>

Generated using TypeDoc