Class IHTTPConnection

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

Hierarchy

IMeshDevice
- IHTTPConnection

Index

Constructors

Properties

abortController configId connType deviceStatus isConfigured log pendingSettingsChanges 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:22

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: Logger<unknown>

Logs to the console and the logging event emitter

`Protected` pendingSettingsChanges

pendingSettingsChanges: boolean

Are there any settings that have yet to be applied?

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

onAtakPacket

`Readonly` onChannelPacket

onChannelPacket: SubEvent<ChannelPacket> = ...

Fires when a new Channel message is recieved

onChannelPacket

`Readonly` onConfigPacket

onConfigPacket: SubEvent<ConfigPacket> = ...

Fires when a new Config message is recieved

onConfigPacket

`Readonly` onDeviceDebugLog

onDeviceDebugLog: SubEvent<Uint8Array> = ...

Outputs any debug log data (currently serial connections only)

onDeviceDebugLog

`Readonly` onDeviceMetadataPacket

onDeviceMetadataPacket: SubEvent<DeviceMetadataPacket> = ...

Fires when the device receives a Metadata packet

onDeviceMetadataPacket

`Readonly` onDeviceStatus

onDeviceStatus: SubEvent<DeviceStatusEnum> = ...

Fires when the devices connection or configuration status changes

onDeviceStatus

`Readonly` onFromRadio

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

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

onFromRadio

`Readonly` onIpTunnelPacket

onIpTunnelPacket: SubEvent<IpTunnelPacket> = ...

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

onIpTunnelPacket

`Readonly` onLogEvent

onLogEvent: SubEvent<LogEventPacket> = ...

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

onLogEvent

`Readonly` onLogRecord

onLogRecord: SubEvent<Protobuf.LogRecord> = ...

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

onLogRecord

`Readonly` onMeshHeartbeat

onMeshHeartbeat: SubEvent<Date> = ...

Fires when the device receives a meshPacket, returns a timestamp

onMeshHeartbeat

`Readonly` onMeshPacket

onMeshPacket: SubEvent<Protobuf.MeshPacket> = ...

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

onMeshPacket

`Readonly` onMessagePacket

onMessagePacket: SubEvent<MessagePacket> = ...

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

onMessagePacket

`Readonly` onModuleConfigPacket

onModuleConfigPacket: SubEvent<ModuleConfigPacket> = ...

Fires when a new ModuleConfig message is recieved

onModuleConfigPacket

`Readonly` onMyNodeInfo

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

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

onMyNodeInfo

`Readonly` onNodeInfoPacket

onNodeInfoPacket: SubEvent<NodeInfoPacket> = ...

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

onNodeInfoPacket

`Readonly` onPingPacket

onPingPacket: SubEvent<PingPacket> = ...

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

onPingPacket

`Readonly` onPositionPacket

onPositionPacket: SubEvent<PositionPacket> = ...

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

onPositionPacket

`Readonly` onPrivatePacket

onPrivatePacket: SubEvent<PrivatePacket> = ...

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

onPrivatePacket

`Readonly` onRangeTestPacket

onRangeTestPacket: SubEvent<RangeTestPacket> = ...

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

onRangeTestPacket

`Readonly` onRemoteHardwarePacket

onRemoteHardwarePacket: SubEvent<RemoteHardwarePacket> = ...

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

onRemoteHardwarePacket

`Readonly` onRoutingPacket

onRoutingPacket: SubEvent<RoutingPacket> = ...

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

onRoutingPacket

`Readonly` onSerialPacket

onSerialPacket: SubEvent<SerialPacket> = ...

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

onSerialPacket

`Readonly` onStoreForwardPacket

onStoreForwardPacket: SubEvent<StoreForwardPacket> = ...

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

onStoreForwardPacket

`Readonly` onTelemetryPacket

onTelemetryPacket: SubEvent<TelemetryPacket> = ...

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

onTelemetryPacket

`Readonly` onUserPacket

onUserPacket: SubEvent<UserPacket> = ...

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

onUserPacket

`Readonly` onWaypointPacket

onWaypointPacket: SubEvent<WaypointPacket> = ...

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

onWaypointPacket

Methods

beginEditSettings

beginEditSettings(): Promise<void>
Returns Promise<void>
Inherited from IMeshDevice.beginEditSettings
- Defined in iMeshDevice.ts:962

clearChannel

clearChannel(__namedParameters: clearChannelProps): Promise<void>
Clears specific channel with the designated index
Parameters
- __namedParameters: clearChannelProps
Returns Promise<void>
Inherited from IMeshDevice.clearChannel
- Defined in iMeshDevice.ts:895

commitEditSettings

commitEditSettings(): Promise<void>
Returns Promise<void>
Inherited from IMeshDevice.commitEditSettings
- Defined in iMeshDevice.ts:979

complete

complete(): void
Completes all SubEvents

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

configure

configure(): void
Triggers the device configure process

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

confirmSetChannel

confirmSetChannel(callback?: confirmSetChannelProps): Promise<void>
Confirms the currently set channels, and prevents changes from reverting after 10 minutes.
Parameters
- Optional callback: confirmSetChannelProps
  
  If wantAck is true, callback is called when the ack is received
Returns Promise<void>
Inherited from IMeshDevice.confirmSetChannel
- Defined in iMeshDevice.ts:936

confirmSetConfig

confirmSetConfig(callback?: confirmSetConfigProps): Promise<void>
Confirms the currently set config, and prevents changes from reverting after 10 minutes.
Parameters
- Optional callback: confirmSetConfigProps
  
  If wantAck is true, callback is called when the ack is received
Returns Promise<void>
Inherited from IMeshDevice.confirmSetConfig
- Defined in iMeshDevice.ts:1003

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:48

disconnect

disconnect(): void
Disconnects from the Meshtastic device

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

getChannel

getChannel(__namedParameters: getChannelProps): Promise<void>
Gets specified channel information from the radio
Parameters
- __namedParameters: getChannelProps
Returns Promise<void>
Inherited from IMeshDevice.getChannel
- Defined in iMeshDevice.ts:725

getConfig

getConfig(__namedParameters: getConfigProps): Promise<void>
Gets devices config
Parameters
- __namedParameters: getConfigProps
Returns Promise<void>
Inherited from IMeshDevice.getConfig
- Defined in iMeshDevice.ts:759

getMetadata

getMetadata(__namedParameters: getMetadataProps): Promise<void>
Gets devices metadata
Parameters
- __namedParameters: getMetadataProps
Returns Promise<void>
Inherited from IMeshDevice.getMetadata
- Defined in iMeshDevice.ts:858

getModuleConfig

getModuleConfig(__namedParameters: getModuleConfigProps): Promise<void>
Gets Module config
Parameters
- __namedParameters: getModuleConfigProps
Returns Promise<void>
Inherited from IMeshDevice.getModuleConfig
- Defined in iMeshDevice.ts:794

getOwner

getOwner(callback?: getOwnerProps): Promise<void>
Gets devices Owner
Parameters
- Optional callback: getOwnerProps
  
  If wantAck is true, callback is called when the ack is received
Returns Promise<void>
Inherited from IMeshDevice.getOwner
- Defined in iMeshDevice.ts:827

`Protected` handleFromRadio

handleFromRadio(fromRadio: handleFromRadioProps): Promise<void>
Gets called whenever a fromRadio message is received from device, returns fromRadio data
Parameters
- fromRadio: handleFromRadioProps
  
  Uint8Array containing raw radio data
Returns Promise<void>
Inherited from IMeshDevice.handleFromRadio
- Defined in iMeshDevice.ts:1115

ping

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

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

`Protected` readFromRadio

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

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

resetPeers

resetPeers(callback?: resetPeersProps): Promise<void>
Resets the internal NodeDB of the radio, usefull for removing old nodes that no longer exist.
Parameters
- Optional callback: resetPeersProps
  
  If wantAck is true, callback is called when the ack is received
Returns Promise<void>
Inherited from IMeshDevice.resetPeers
- Defined in iMeshDevice.ts:1039

sendPacket

sendPacket(__namedParameters: sendPacketProps): Promise<void>
Sends packet over the radio
Parameters
- __namedParameters: sendPacketProps
Returns Promise<void>
Inherited from IMeshDevice.sendPacket
- Defined in iMeshDevice.ts:404

sendRaw

sendRaw(__namedParameters: sendRawProps): Promise<void>
Sends raw packet over the radio
Parameters
- __namedParameters: sendRawProps
Returns Promise<void>
Inherited from IMeshDevice.sendRaw
- Defined in iMeshDevice.ts:469

sendText

sendText(__namedParameters: sendTextProps): Promise<void>
Sends a text over the radio

Returns
Parameters
- __namedParameters: sendTextProps
Returns Promise<void>
Inherited from IMeshDevice.sendText
- Defined in iMeshDevice.ts:320

sendWaypoint

sendWaypoint(__namedParameters: sendWaypointProps): Promise<void>
Sends a text over the radio

Returns
Parameters
- __namedParameters: sendWaypointProps
Returns Promise<void>
Inherited from IMeshDevice.sendWaypoint
- Defined in iMeshDevice.ts:360

setChannel

setChannel(__namedParameters: setChannelProps): Promise<void>
Sets devices ChannelSettings
Parameters
- __namedParameters: setChannelProps
Returns Promise<void>
Inherited from IMeshDevice.setChannel
- Defined in iMeshDevice.ts:675

setConfig

setConfig(__namedParameters: setConfigProps): Promise<void>
Writes config to device
Parameters
- __namedParameters: setConfigProps
Returns Promise<void>
Inherited from IMeshDevice.setConfig
- Defined in iMeshDevice.ts:501

setModuleConfig

setModuleConfig(__namedParameters: setModuleConfigProps): Promise<void>
Writes module config to device
Parameters
- __namedParameters: setModuleConfigProps
Returns Promise<void>
Inherited from IMeshDevice.setModuleConfig
- Defined in iMeshDevice.ts:567

setOwner

setOwner(__namedParameters: setOwnerProps): Promise<void>
Sets devices owner data
Parameters
- __namedParameters: setOwnerProps
Returns Promise<void>
Inherited from IMeshDevice.setOwner
- Defined in iMeshDevice.ts:641

setPosition

setPosition(__namedParameters: setPositionProps): Promise<void>
Parameters
- __namedParameters: setPositionProps
Returns Promise<void>
Inherited from IMeshDevice.setPosition
- Defined in iMeshDevice.ts:707

updateDeviceStatus

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

`Protected` writeToRadio

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

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

Protected pendingSettingsChanges

peningRequest

queue

readLoop

receiveBatchRequests

url

Events

Readonly onAtakPacket

Readonly onChannelPacket

Readonly onConfigPacket

Readonly onDeviceDebugLog

Readonly onDeviceMetadataPacket

Readonly onDeviceStatus

Readonly onFromRadio

Readonly onIpTunnelPacket

Readonly onLogEvent

Readonly onLogRecord

Readonly onMeshHeartbeat

Readonly onMeshPacket

Readonly onMessagePacket

Readonly onModuleConfigPacket

Readonly onMyNodeInfo

Readonly onNodeInfoPacket

Readonly onPingPacket

Readonly onPositionPacket

Readonly onPrivatePacket

Readonly onRangeTestPacket

Readonly onRemoteHardwarePacket

Readonly onRoutingPacket

Readonly onSerialPacket

Readonly onStoreForwardPacket

Readonly onTelemetryPacket

Readonly onUserPacket

Readonly onWaypointPacket

Methods

beginEditSettings

Returns Promise<void>

clearChannel

Parameters

__namedParameters: clearChannelProps

Returns Promise<void>

commitEditSettings

Returns Promise<void>

complete

Returns void

configure

Returns void

confirmSetChannel

Parameters

Optional callback: confirmSetChannelProps

Returns Promise<void>

confirmSetConfig

Parameters

Optional callback: confirmSetConfigProps

Returns Promise<void>

connect

Parameters

parameters: HTTPConnectionParameters

Returns Promise<void>

disconnect

Returns void

`Optional` configId: number

`Protected` deviceStatus

`Protected` isConfigured

`Protected` log

`Protected` pendingSettingsChanges

`Readonly` onAtakPacket

`Readonly` onChannelPacket

`Readonly` onConfigPacket

`Readonly` onDeviceDebugLog

`Readonly` onDeviceMetadataPacket

`Readonly` onDeviceStatus

`Readonly` onFromRadio

`Readonly` onIpTunnelPacket

`Readonly` onLogEvent

`Readonly` onLogRecord

`Readonly` onMeshHeartbeat

`Readonly` onMeshPacket

`Readonly` onMessagePacket

`Readonly` onModuleConfigPacket

`Readonly` onMyNodeInfo

`Readonly` onNodeInfoPacket

`Readonly` onPingPacket

`Readonly` onPositionPacket

`Readonly` onPrivatePacket

`Readonly` onRangeTestPacket

`Readonly` onRemoteHardwarePacket

`Readonly` onRoutingPacket

`Readonly` onSerialPacket

`Readonly` onStoreForwardPacket

`Readonly` onTelemetryPacket

`Readonly` onUserPacket

`Readonly` onWaypointPacket

`Optional` callback: confirmSetChannelProps

`Optional` callback: confirmSetConfigProps

`Optional` callback: getOwnerProps

`Protected` handleFromRadio

`Protected` readFromRadio

`Optional` callback: resetPeersProps