Options
All
  • Public
  • Public/Protected
  • All
Menu

Allows to connect to a Meshtastic device over HTTP(S)

Hierarchy

Index

Constructors

constructor

Events

Readonly onAdminPacket

onAdminPacket: SubEvent<AdminPacket> = ...

Fires when a new MeshPacket message containing a AndminMessage packet has been received from device

Readonly onDeviceStatus

onDeviceStatus: SubEvent<DeviceStatusEnum> = ...

Fires when the devices connection or configuration status changes

Readonly onFromRadio

onFromRadio: SubEvent<FromRadio> = ...

Fires when a new FromRadio message has been received from the device

Readonly onLogRecord

onLogRecord: SubEvent<LogRecord> = ...

Fires when a new FromRadio message containing a Text packet has been received from device

Readonly onMeshHeartbeat

onMeshHeartbeat: SubEvent<Date> = ...

Fires when the device receives a meshPacket, returns a timestamp

Readonly onMeshPacket

onMeshPacket: SubEvent<MeshPacket> = ...

Fires when a new FromRadio message containing a Data packet has been received from the device

Readonly onNodeInfoPacket

onNodeInfoPacket: SubEvent<NodeInfoPacket> = ...

Fires when a new MeshPacket message containing a NodeInfo packet has been received from device

Readonly onPositionPacket

onPositionPacket: SubEvent<PositionPacket> = ...

Fires when a new MeshPacket message containing a Position packet has been received from device

Readonly onRoutingPacket

onRoutingPacket: SubEvent<RoutingPacket> = ...

Fires when a new MeshPacket message containing a Routing packet has been received from device

Readonly onTextPacket

onTextPacket: SubEvent<TextPacket> = ...

Fires when a new MeshPacket message containing a Text packet has been received from device

Readonly onUserDataPacket

onUserDataPacket: SubEvent<User> = ...

Fires when a new NodeInfo message has been reveived that has the same node number as the device

Properties

Protected deviceStatus

deviceStatus: DeviceStatusEnum

Describes the current state of the device

Protected isConfigured

isConfigured: boolean

Describes the current state of the device

Readonly onMyNodeInfo

onMyNodeInfo: SubEvent<MyNodeInfo> = ...

Fires when a new MyNodeInfo message has been received from the device

Readonly onRadioConfig

onRadioConfig: SubEvent<RadioConfig> = ...

Fires when a new RadioConfig message has been received from the device

receiveBatchRequests

receiveBatchRequests: undefined | boolean

Enables receiving messages all at once, versus one per request

url

url: undefined | string

URL of the device that is to be connected to.

Methods

blinkLED

  • blinkLED(): Promise<void | Response>
  • Web API method: Make device LED blink

    todo,

    strongly type response

    Returns Promise<void | Response>

complete

  • complete(): void
  • Completes all SubEvents

    Returns void

configure

  • configure(): Promise<void>
  • Triggers the device configure process

    Returns Promise<void>

confirmSetChannel

  • confirmSetChannel(callback?: (id: number) => Promise<void>): Promise<void>
  • Confirms the currently set channels, and prevents changes from reverting after 10 minutes.

    Parameters

    • Optional callback: (id: number) => Promise<void>

      If wantAck is true, callback is called when the ack is received

        • (id: number): Promise<void>
        • Parameters

          • id: number

          Returns Promise<void>

    Returns Promise<void>

confirmSetPreferences

  • confirmSetPreferences(callback?: (id: number) => Promise<void>): Promise<void>
  • Confirms the currently set preferences, and prevents changes from reverting after 10 minutes.

    Parameters

    • Optional callback: (id: number) => Promise<void>

      If wantAck is true, callback is called when the ack is received

        • (id: number): Promise<void>
        • Parameters

          • id: number

          Returns Promise<void>

    Returns Promise<void>

connect

  • Initiates the connect process to a Meshtastic device via HTTP(S)

    Parameters

    Returns Promise<void>

deleteChannel

  • deleteChannel(index: number, callback?: (id: number) => Promise<void>): Promise<void>
  • Deletes specific channel via index

    Parameters

    • index: number

      Channel index to be deleted

    • Optional callback: (id: number) => Promise<void>

      If wantAck is true, callback is called when the ack is received

        • (id: number): Promise<void>
        • Parameters

          • id: number

          Returns Promise<void>

    Returns Promise<void>

deleteSPIFFS

  • Web API method: Delete SPIFFS file

    Parameters

    • file: string

    Returns Promise<void | WebSPIFFSResponse>

disconnect

  • disconnect(): void
  • Disconnects from the Meshtastic device

    Returns void

getChannel

  • getChannel(index: number, callback?: (id: number) => Promise<void>): Promise<void>
  • Gets devices ChannelSettings

    Parameters

    • index: number

      Channel index to be retrieved

    • Optional callback: (id: number) => Promise<void>

      If wantAck is true, callback is called when the ack is received

        • (id: number): Promise<void>
        • Parameters

          • id: number

          Returns Promise<void>

    Returns Promise<void>

getNetworks

  • Web API method: Scan for WiFi AP's

    Returns Promise<void | WebNetworkResponse>

getPreferences

  • getPreferences(): Promise<void>

getSPIFFS

  • Web API method: Fetch SPIFFS contents

    Returns Promise<void | WebSPIFFSResponse>

getStatistics

  • Web API method: Get airtime statistics

    Returns Promise<void | WebStatisticsResponse>

Protected handleFromRadio

  • handleFromRadio(fromRadio: Uint8Array): Promise<void>
  • Gets called whenever a fromRadio message is received from device, returns fromRadio data

    Parameters

    • fromRadio: Uint8Array

      Uint8Array containing raw radio data

    Returns Promise<void>

ping

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

    Returns Promise<boolean>

Protected readFromRadio

  • readFromRadio(): Promise<void>
  • Reads any avaliable protobuf messages from the radio

    Returns Promise<void>

restartDevice

  • restartDevice(): Promise<void>
  • Web API method: Restart device

    Returns Promise<void>

sendPacket

  • sendPacket(byteData: Uint8Array, portNum: PortNum, destinationNum?: number, wantAck?: boolean, wantResponse?: boolean, echoResponse?: boolean, callback?: (id: number) => Promise<void>): Promise<void>
  • Sends packet over the radio

    Parameters

    • byteData: Uint8Array
    • portNum: PortNum

      dataType Enum of protobuf data type

    • Optional destinationNum: number

      Node number of the destination node

    • wantAck: boolean = false

      Whether or not acknowledgement is wanted

    • wantResponse: boolean = false

      Used for testing, requests recpipient to respond in kind with the same type of request

    • echoResponse: boolean = false

      Sends event back to client

    • Optional callback: (id: number) => Promise<void>

      If wantAck is true, callback is called when the ack is received

        • (id: number): Promise<void>
        • Parameters

          • id: number

          Returns Promise<void>

    Returns Promise<void>

sendText

  • sendText(text: string, destinationNum?: number, wantAck?: boolean, callback?: (id: number) => Promise<void>): Promise<void>
  • Sends a text over the radio

    Parameters

    • text: string
    • Optional destinationNum: number

      Node number of the destination node

    • wantAck: boolean = false

      Whether or not acknowledgement is wanted

    • Optional callback: (id: number) => Promise<void>

      If wantAck is true, callback is called when the ack is received

        • (id: number): Promise<void>
        • Parameters

          • id: number

          Returns Promise<void>

    Returns Promise<void>

setChannel

  • setChannel(channel: Channel, callback?: (id: number) => Promise<void>): Promise<void>
  • Sets devices ChannelSettings

    Parameters

    • channel: Channel

      Channel data to be set

    • Optional callback: (id: number) => Promise<void>

      If wantAck is true, callback is called when the ack is received

        • (id: number): Promise<void>
        • Parameters

          • id: number

          Returns Promise<void>

    Returns Promise<void>

setOwner

  • setOwner(owner: User): Promise<void>
  • Sets devices owner data

    Parameters

    Returns Promise<void>

setPreferences

  • Writes radio config to device

    Parameters

    • preferences: Partial<RadioConfig_UserPreferences>

      Radio UserPreferences

    • Optional callback: (id: number) => Promise<void>

      If wantAck is true, callback is called when the ack is received

        • (id: number): Promise<void>
        • Parameters

          • id: number

          Returns Promise<void>

    Returns Promise<void>

updateDeviceStatus

Protected writeToRadio

  • writeToRadio(data: Uint8Array): Promise<void>
  • Sends supplied protobuf message to the radio

    Parameters

    • data: Uint8Array

    Returns Promise<void>

Generated using TypeDoc