Class IHTTPConnection

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

Hierarchy

IMeshDevice
- IHTTPConnection

Constructors

constructor

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

Properties

XModem

XModem: XModem

`Private` abortController

abortController: AbortController

configId

configId: number

Randomly generated number to ensure confiuration lockstep

connType

connType: ConnectionTypeName

Defines the connection type as http

`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

`Protected` pendingSettingsChanges

pendingSettingsChanges: boolean

Are there any settings that have yet to be applied?

`Private` peningRequest

peningRequest: boolean

`Protected` portId

portId: string

URL of the device that is to be connected to.

queue

queue: Queue

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

`Private` readLoop

readLoop: null | Timeout

`Private` receiveBatchRequests

receiveBatchRequests: boolean

Enables receiving messages all at once, versus one per request

Methods

clearChannel

clearChannel(index): Promise<number>
Clears specific channel with the designated index
Parameters
- index: number
Returns Promise<number>
Inherited from IMeshDevice.clearChannel
- Defined in src/iMeshDevice.ts:456

commitEditSettings

commitEditSettings(): Promise<number>
Returns Promise<number>
Inherited from IMeshDevice.commitEditSettings
- Defined in src/iMeshDevice.ts:497

complete

complete(): void
Completes all SubEvents

Returns void
Inherited from IMeshDevice.complete
- Defined in src/iMeshDevice.ts:864

configure

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

Returns Promise<number>
Inherited from IMeshDevice.configure
- Defined in src/iMeshDevice.ts:626

connect

connect(__namedParameters): Promise<void>
Initiates the connect process to a Meshtastic device via HTTP(S)
Parameters
- __namedParameters: HTTPConnectionParameters
Returns Promise<void>
Overrides IMeshDevice.connect
- Defined in src/adapters/iHttpConnection.ts:43

disconnect

disconnect(): void
Disconnects from the Meshtastic device

Returns void
Overrides IMeshDevice.disconnect
- Defined in src/adapters/iHttpConnection.ts:89

factoryReset

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

Returns Promise<number>
Inherited from IMeshDevice.factoryReset
- Defined in src/iMeshDevice.ts:605

getChannel

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

getConfig

getConfig(configType): Promise<number>
Gets devices config request
Parameters
- configType: AdminMessage_ConfigType
Returns Promise<number>
Inherited from IMeshDevice.getConfig
- Defined in src/iMeshDevice.ts:361

getMetadata

getMetadata(nodeNum): Promise<number>
Gets devices metadata
Parameters
- nodeNum: number
Returns Promise<number>
Inherited from IMeshDevice.getMetadata
- Defined in src/iMeshDevice.ts:432

getModuleConfig

getModuleConfig(moduleConfigType): Promise<number>
Gets Module config
Parameters
- moduleConfigType: AdminMessage_ModuleConfigType
Returns Promise<number>
Inherited from IMeshDevice.getModuleConfig
- Defined in src/iMeshDevice.ts:386

getOwner

getOwner(): Promise<number>
Gets devices Owner

Returns Promise<number>
Inherited from IMeshDevice.getOwner
- Defined in src/iMeshDevice.ts:409

`Protected` handleFromRadio

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

ping

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

Returns Promise<boolean>
Overrides IMeshDevice.ping
- Defined in src/adapters/iHttpConnection.ts:99

`Protected` readFromRadio

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

Returns Promise<void>
- Defined in src/adapters/iHttpConnection.ts:126

reboot

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

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>
Inherited from IMeshDevice.rebootOTA
- Defined in src/iMeshDevice.ts:584

requestPosition

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

resetPeers

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

Returns Promise<number>
Inherited from IMeshDevice.resetPeers
- Defined in src/iMeshDevice.ts:518

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>
Inherited from IMeshDevice.sendPacket
- Defined in src/iMeshDevice.ts:150

sendRaw

sendRaw(toRadio, id?): Promise<number>
Sends raw packet over the radio
Parameters
- toRadio: Uint8Array
- id: number = ...
Returns Promise<number>
Inherited from IMeshDevice.sendRaw
- Defined in src/iMeshDevice.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>
Inherited from IMeshDevice.sendText
- Defined in src/iMeshDevice.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>
Inherited from IMeshDevice.sendWaypoint
- Defined in src/iMeshDevice.ts:123

setChannel

setChannel(channel): Promise<number>
Sets devices ChannelSettings
Parameters
- channel: Channel
Returns Promise<number>
Inherited from IMeshDevice.setChannel
- Defined in src/iMeshDevice.ts:304

setConfig

setConfig(config): Promise<number>
Writes config to device
Parameters
- config: Config
Returns Promise<number>
Inherited from IMeshDevice.setConfig
- Defined in src/iMeshDevice.ts:232

setModuleConfig

setModuleConfig(moduleConfig): Promise<number>
Writes module config to device
Parameters
- moduleConfig: ModuleConfig
Returns Promise<number>
Inherited from IMeshDevice.setModuleConfig
- Defined in src/iMeshDevice.ts:259

setOwner

setOwner(owner): Promise<number>
Sets devices owner data
Parameters
- owner: User
Returns Promise<number>
Inherited from IMeshDevice.setOwner
- Defined in src/iMeshDevice.ts:284

setPosition

setPosition(positionMessage): Promise<number>
Parameters
- positionMessage: Position
Returns Promise<number>
Inherited from IMeshDevice.setPosition
- Defined in src/iMeshDevice.ts:324

shutdown

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

traceRoute

traceRoute(destination): Promise<number>
Sends a trace route packet to the designated node
Parameters
- destination: number
Returns Promise<number>
Inherited from IMeshDevice.traceRoute
- Defined in src/iMeshDevice.ts:644

updateDeviceStatus

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

`Protected` writeToRadio

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

Class IHTTPConnection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configId: number

Returns IHTTPConnection

Properties

XModem

Private abortController

configId

connType

Protected deviceStatus

events

Protected isConfigured

Protected log

Protected pendingSettingsChanges

Private peningRequest

Protected portId

queue

Private readLoop

Private receiveBatchRequests

Methods

clearChannel

Parameters

index: number

Returns Promise<number>

commitEditSettings

Returns Promise<number>

complete

Returns void

configure

Returns Promise<number>

connect

Parameters

__namedParameters: HTTPConnectionParameters

Returns Promise<void>

disconnect

Returns void

factoryReset

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

Protected handleFromRadio

Parameters

fromRadio: Uint8Array

Returns void

ping

Returns Promise<boolean>

Protected readFromRadio

Returns Promise<void>

reboot

Parameters

time: number

Returns Promise<number>

rebootOTA

Parameters

time: number

Returns Promise<number>

requestPosition

`Optional` configId: number

`Private` abortController

`Protected` deviceStatus

`Protected` isConfigured

`Protected` log

`Protected` pendingSettingsChanges

`Private` peningRequest

`Protected` portId

`Private` readLoop

`Private` receiveBatchRequests

`Protected` handleFromRadio

`Protected` readFromRadio

`Optional` replyId: number

`Optional` emoji: number

`Optional` destination: Destination

`Optional` wantAck: boolean

`Optional` channel: ChannelNumber

`Optional` channel: ChannelNumber

`Protected` writeToRadio