Class IHTTPConnection

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

Hierarchy

IMeshDevice
- IHTTPConnection

Index

Constructors

Properties

abortController configId connType deviceStatus isConfigured log onDeviceMetadataPacket onMyNodeInfo peningRequest queue readLoop receiveBatchRequests url

Constructors

constructor

new IHTTPConnection(configId?: number): IHTTPConnection
Parameters
- Optional configId: number
Returns IHTTPConnection
Overrides IMeshDevice.constructor
- Defined in iHttpConnection.ts:32

Properties

abortController

abortController: AbortController

configId

configId: number

Randomly generated number to ensure confiuration lockstep

connType

connType: string

Defines the connection type as http

`Protected` deviceStatus

deviceStatus: DeviceStatusEnum

Describes the current state of the device

`Protected` isConfigured

isConfigured: boolean

Describes the current state of the device

`Protected` log

log: ((scope: EmitterScope, emitter: Emitter, message: string, level: LogRecord_Level, packet?: Uint8Array) => void)

Type declaration

- (scope: EmitterScope, emitter: Emitter, message: string, level: LogRecord_Level, packet?: Uint8Array): void
- Logs to the console and the logging event emitter
  Parameters
  - scope: EmitterScope
  - emitter: Emitter
  - message: string
  - level: LogRecord_Level
  - Optional packet: Uint8Array
  Returns void

`Readonly` onDeviceMetadataPacket

onDeviceMetadataPacket: SubEvent<DeviceMetadataPacket> = ...

Fires when the device receives a Metadata packet

`Readonly` onMyNodeInfo

onMyNodeInfo: SubEvent<Protobuf.MyNodeInfo> = ...

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

peningRequest

peningRequest: boolean

queue

queue: Queue

Keeps track of all requests sent to the radio that have callbacks TODO: Update description

readLoop

readLoop: null | Timer

receiveBatchRequests

receiveBatchRequests: boolean

Enables receiving messages all at once, versus one per request

url

url: string

URL of the device that is to be connected to.

Events

`Readonly` onAtakPacket

onAtakPacket: SubEvent<AtakPacket> = ...

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

`Readonly` onChannelPacket

onChannelPacket: SubEvent<ChannelPacket> = ...

Fires when a new Channel message is recieved

`Readonly` onConfigPacket

onConfigPacket: SubEvent<ConfigPacket> = ...

Fires when a new Config message is recieved

`Readonly` onDeviceStatus

onDeviceStatus: SubEvent<DeviceStatusEnum> = ...

Fires when the devices connection or configuration status changes

`Readonly` onFromRadio

onFromRadio: SubEvent<Protobuf.FromRadio> = ...

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

`Readonly` onIpTunnelPacket

onIpTunnelPacket: SubEvent<IpTunnelPacket> = ...

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

`Readonly` onLogEvent

onLogEvent: SubEvent<LogEventPacket> = ...

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

`Readonly` onLogRecord

onLogRecord: SubEvent<Protobuf.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<Protobuf.MeshPacket> = ...

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

`Readonly` onMessagePacket

onMessagePacket: SubEvent<MessagePacket> = ...

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

`Readonly` onModuleConfigPacket

onModuleConfigPacket: SubEvent<ModuleConfigPacket> = ...

Fires when a new ModuleConfig message is recieved

`Readonly` onNodeInfoPacket

onNodeInfoPacket: SubEvent<NodeInfoPacket> = ...

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

`Readonly` onPingPacket

onPingPacket: SubEvent<PingPacket> = ...

Fires when a new MeshPacket message containing a Ping 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` onPrivatePacket

onPrivatePacket: SubEvent<PrivatePacket> = ...

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

`Readonly` onRangeTestPacket

onRangeTestPacket: SubEvent<RangeTestPacket> = ...

Fires when a new MeshPacket message containing a Store and Forward packet has been received from device

`Readonly` onRemoteHardwarePacket

onRemoteHardwarePacket: SubEvent<RemoteHardwarePacket> = ...

Fires when a new MeshPacket message containing a Remote Hardware 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` onSerialPacket

onSerialPacket: SubEvent<SerialPacket> = ...

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

`Readonly` onStoreForwardPacket

onStoreForwardPacket: SubEvent<StoreForwardPacket> = ...

Fires when a new MeshPacket message containing a Store and Forward packet has been received from device

`Readonly` onTelemetryPacket

onTelemetryPacket: SubEvent<TelemetryPacket> = ...

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

`Readonly` onUserPacket

onUserPacket: SubEvent<UserPacket> = ...

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

Methods

complete

complete(): void
Completes all SubEvents

Returns void
Inherited from IMeshDevice.complete
- Defined in iMeshDevice.ts:1200

configure

configure(): void
Triggers the device configure process

Returns void
Inherited from IMeshDevice.configure
- Defined in iMeshDevice.ts:1001

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>
Inherited from IMeshDevice.confirmSetChannel
- Defined in iMeshDevice.ts:720

confirmSetConfig

confirmSetConfig(callback?: ((id: number) => Promise<void>)): Promise<void>
Confirms the currently set config, 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>
Inherited from IMeshDevice.confirmSetConfig
- Defined in iMeshDevice.ts:603

connect

connect(parameters: HTTPConnectionParameters): Promise<void>
Initiates the connect process to a Meshtastic device via HTTP(S)
Parameters
- parameters: HTTPConnectionParameters
  
  http connection parameters
Returns Promise<void>
Overrides IMeshDevice.connect
- Defined in iHttpConnection.ts:47

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>
Inherited from IMeshDevice.deleteChannel
- Defined in iMeshDevice.ts:756

disconnect

disconnect(): void
Disconnects from the Meshtastic device

Returns void
Overrides IMeshDevice.disconnect
- Defined in iHttpConnection.ts:97

getAllChannels

getAllChannels(callback?: (() => Promise<void>)): Promise<void>
Gets all of the devices channels
Parameters
- Optional callback: (() => Promise<void>)
  
  If wantAck is true, callback is called when the ack is received
  - - (): Promise<void>
    - Returns Promise<void>
Returns Promise<void>
Inherited from IMeshDevice.getAllChannels
- Defined in iMeshDevice.ts:836

getChannel

getChannel(index: number, callback?: ((id: number) => Promise<void>)): Promise<void>
Gets specified channel information from the radio
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>
Inherited from IMeshDevice.getChannel
- Defined in iMeshDevice.ts:800

getConfig

getConfig(configType: AdminMessage_ConfigType, callback?: ((id: number) => Promise<void>)): Promise<void>
Gets devices config
Parameters
- configType: AdminMessage_ConfigType
- 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>
Inherited from IMeshDevice.getConfig
- Defined in iMeshDevice.ts:860

getMetadata

getMetadata(callback?: ((id: number) => Promise<void>)): Promise<void>
Gets devices metadata
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>
Inherited from IMeshDevice.getMetadata
- Defined in iMeshDevice.ts:967

getModuleConfig

getModuleConfig(configType: AdminMessage_ModuleConfigType, callback?: ((id: number) => Promise<void>)): Promise<void>
Gets devices config
Parameters
- configType: AdminMessage_ModuleConfigType
- 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>
Inherited from IMeshDevice.getModuleConfig
- Defined in iMeshDevice.ts:896

getOwner

getOwner(callback?: ((id: number) => Promise<void>)): Promise<void>
Gets devices Owner
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>
Inherited from IMeshDevice.getOwner
- Defined in iMeshDevice.ts:932

`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>
Inherited from IMeshDevice.handleFromRadio
- Defined in iMeshDevice.ts:1045

ping

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

Returns Promise<boolean>
Overrides IMeshDevice.ping
- Defined in iHttpConnection.ts:109

`Protected` readFromRadio

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

Returns Promise<void>
- Defined in iHttpConnection.ts:142

sendLocation

sendLocation(location: Protobuf.Location, destinationNum?: number, wantAck?: boolean, channel?: number, callback?: ((id: number) => Promise<void>)): Promise<void>
Sends a text over the radio
Parameters
- location: Protobuf.Location
  
  Location to send
- Optional destinationNum: number
  
  Node number of the destination node
- wantAck: boolean = false
  
  Whether or not acknowledgement is wanted
- channel: number = 0
- 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>
Inherited from IMeshDevice.sendLocation
- Defined in iMeshDevice.ts:326

sendPacket

sendPacket(byteData: Uint8Array, portNum: PortNum, destinationNum?: number, wantAck?: boolean, channel?: number, wantResponse?: boolean, echoResponse?: boolean, callback?: ((id: number) => Promise<void>), emoji?: number, location?: Protobuf.Location, replyId?: number): 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
- channel: number = 0
- 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>
- emoji: number = 0
- Optional location: Protobuf.Location
- replyId: number = 0
Returns Promise<void>
Inherited from IMeshDevice.sendPacket
- Defined in iMeshDevice.ts:366

sendRaw

sendRaw(id: number, toRadio: Uint8Array, callback?: ((id: number) => Promise<void>)): Promise<void>
Sends raw packet over the radio
Parameters
- id: number
- toRadio: Uint8Array
  
  binary data to send
- Optional callback: ((id: number) => Promise<void>)
  - - (id: number): Promise<void>
    - Parameters
      
      id: number
      
      Returns Promise<void>
Returns Promise<void>
Inherited from IMeshDevice.sendRaw
- Defined in iMeshDevice.ts:429

sendText

sendText(text: string, destinationNum?: number, wantAck?: boolean, channel?: number, 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
- channel: number = 0
- 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>
Inherited from IMeshDevice.sendText
- Defined in iMeshDevice.ts:289

setChannel

setChannel(channel: Protobuf.Channel, callback?: ((id: number) => Promise<void>)): Promise<void>
Sets devices ChannelSettings
Parameters
- channel: Protobuf.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>
Inherited from IMeshDevice.setChannel
- Defined in iMeshDevice.ts:679

setConfig

setConfig(config: Protobuf.Config, callback?: ((id: number) => Promise<void>)): Promise<void>
Writes config to device
Parameters
- config: Protobuf.Config
  
  config object
- 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>
Inherited from IMeshDevice.setConfig
- Defined in iMeshDevice.ts:464

setModuleConfig

setModuleConfig(config: Protobuf.ModuleConfig, callback?: ((id: number) => Promise<void>)): Promise<void>
Writes module config to device
Parameters
- config: Protobuf.ModuleConfig
  
  module config object
- 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>
Inherited from IMeshDevice.setModuleConfig
- Defined in iMeshDevice.ts:532

setOwner

setOwner(owner: Protobuf.User, callback?: ((id: number) => Promise<void>)): Promise<void>
Sets devices owner data
Parameters
- owner: Protobuf.User
  
  Owner data to apply to the device
- 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>
Inherited from IMeshDevice.setOwner
- Defined in iMeshDevice.ts:639

updateDeviceStatus

updateDeviceStatus(status: DeviceStatusEnum): void
Updates the device status eliminating duplicate status events
Parameters
- status: DeviceStatusEnum
Returns void
Inherited from IMeshDevice.updateDeviceStatus
- Defined in iMeshDevice.ts:1028

`Protected` writeToRadio

writeToRadio(data: Uint8Array): Promise<void>
Sends supplied protobuf message to the radio
Parameters
- data: Uint8Array
Returns Promise<void>
Overrides IMeshDevice.writeToRadio
- Defined in iHttpConnection.ts:190

Class IHTTPConnection

Hierarchy

Index

Constructors

Properties

Events

Methods

Constructors

constructor

Parameters

Optional configId: number

Returns IHTTPConnection

Properties

abortController

configId

connType

Protected deviceStatus

Protected isConfigured

Protected log

Type declaration

Parameters

scope: EmitterScope

emitter: Emitter

message: string

level: LogRecord_Level

Optional packet: Uint8Array

Returns void

Readonly onDeviceMetadataPacket

Readonly onMyNodeInfo

peningRequest

queue

readLoop

receiveBatchRequests

url

Events

Readonly onAtakPacket

Readonly onChannelPacket

Readonly onConfigPacket

Readonly onDeviceStatus

Readonly onFromRadio

Readonly onIpTunnelPacket

Readonly onLogEvent

Readonly onLogRecord

Readonly onMeshHeartbeat

Readonly onMeshPacket

Readonly onMessagePacket

Readonly onModuleConfigPacket

Readonly onNodeInfoPacket

Readonly onPingPacket

Readonly onPositionPacket

Readonly onPrivatePacket

Readonly onRangeTestPacket

Readonly onRemoteHardwarePacket

Readonly onRoutingPacket

Readonly onSerialPacket

Readonly onStoreForwardPacket

Readonly onTelemetryPacket

Readonly onUserPacket

Methods

complete

Returns void

configure

Returns void

confirmSetChannel

Parameters

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

Parameters

id: number

Returns Promise<void>

Returns Promise<void>

confirmSetConfig

Parameters

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

Parameters

id: number

Returns Promise<void>

Returns Promise<void>

connect

Parameters

parameters: HTTPConnectionParameters

`Optional` configId: number

`Protected` deviceStatus

`Protected` isConfigured

`Protected` log

`Optional` packet: Uint8Array

`Readonly` onDeviceMetadataPacket

`Readonly` onMyNodeInfo

`Readonly` onAtakPacket

`Readonly` onChannelPacket

`Readonly` onConfigPacket

`Readonly` onDeviceStatus

`Readonly` onFromRadio

`Readonly` onIpTunnelPacket

`Readonly` onLogEvent

`Readonly` onLogRecord

`Readonly` onMeshHeartbeat

`Readonly` onMeshPacket

`Readonly` onMessagePacket

`Readonly` onModuleConfigPacket

`Readonly` onNodeInfoPacket

`Readonly` onPingPacket

`Readonly` onPositionPacket

`Readonly` onPrivatePacket

`Readonly` onRangeTestPacket

`Readonly` onRemoteHardwarePacket

`Readonly` onRoutingPacket

`Readonly` onSerialPacket

`Readonly` onStoreForwardPacket

`Readonly` onTelemetryPacket

`Readonly` onUserPacket

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

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

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

`Optional` callback: (() => Promise<void>)

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

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

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

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

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

`Protected` handleFromRadio

`Protected` readFromRadio

`Optional` destinationNum: number

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