Class ESPTransportManager

Manages the transport layer for ESP node communication, allowing configuration of local or cloud-based transport modes.

This class abstracts the underlying transport mechanism and provides methods for setting and retrieving node parameters.

Index

Constructors

Methods

getParams setParam

Constructors

constructor

new ESPTransportManager(
transportConfig?: ESPTransportConfig,
transportObj?: ESPTransportInterface,
): ESPTransportManager
Creates an instance of ESPTransportManager with a specified transport configuration.
Parameters
- OptionaltransportConfig: ESPTransportConfig
  The configuration specifying the type of transport (local or cloud) and any additional metadata.
- OptionaltransportObj: ESPTransportInterface
  The object representing custom transport.
Returns ESPTransportManager
- Defined in src/services/ESPTransport/ESPTransportManager.ts:35

Methods

getParams

getParams(payload: Record<string, any>): Promise<Record<string, any>>
Retrieves parameters from the node using the configured transport mechanism.
Parameters
- payload: Record<string, any>
  A record containing the data required to retrieve node parameters.
Returns Promise<Record<string, any>>
A promise that resolves to a record of the node parameters.
- Defined in src/services/ESPTransport/ESPTransportManager.ts:73

setParam

setParam(payload: Record<string, any>): Promise<ESPAPIResponse>
Sets a parameter on the node using the configured transport mechanism.
Parameters
- payload: Record<string, any>
  A record containing the parameter data to set on the node.
Returns Promise<ESPAPIResponse>
A promise that resolves to the response of the set operation.
- Defined in src/services/ESPTransport/ESPTransportManager.ts:63