Class ESPRMNode

Represents a user node in the system, managing its configuration and connectivity status. Implements the ESPRMNodeInterface.

Implements

ESPRMNodeInterface

Constructors

constructor

new ESPRMNode(data: ESPRMNodeInterface): ESPRMNode
Creates an instance of ESPRMNode.
Parameters
- data: ESPRMNodeInterface
  An object containing the node details.
Returns ESPRMNode
- Defined in src/ESPRMNode.ts:114

Properties

availableTransports

availableTransports: Record<string, ESPTransportConfig> = {}

Available Transports with the node.

`Optional`connectivityStatus

connectivityStatus?: ESPRMConnectivityStatus

The connectivity status of the node.

`Optional`customTransportManagers

customTransportManagers?: Record<string, ESPTransportInterface>

Custom transport managers associated with the node.

Custom transport managers allow you to implement your own communication protocols (e.g., Bluetooth, WebSocket, custom protocols) alongside the built-in local and cloud transports. Each custom transport must implement the ESPTransportInterface and receives a reference to the node instance, providing full flexibility to access node metadata, configuration, devices, and connectivity status.

The SDK uses transports in the priority order specified in transportOrder:

If a transport mode exists in customTransportManagers, it uses the custom transport
If not, it falls back to the built-in transport (local/cloud)
If the transport fails, it moves to the next transport in the order
If all transports fail, an error is thrown

Example

const myCustomTransport = new MyCustomTransport();
const node = new ESPRMNode({
  id: "my-node-id",
  transportOrder: ["bluetooth", "local", "cloud"],
  availableTransports: {
    bluetooth: { type: "bluetooth", metadata: {} },
    local: { type: "local", metadata: { baseUrl: "http://192.168.1.100" } },
    cloud: { type: "cloud", metadata: {} }
  },
  customTransportManagers: {
    bluetooth: myCustomTransport
  }
});

Common use cases include:

Bluetooth Transport: Direct device communication via Bluetooth
WebSocket Transport: Real-time bidirectional communication
Custom Protocol: Implement proprietary protocols

id

id: string

The unique identifier of the node.

`Optional`isPrimaryUser

isPrimaryUser?: boolean

Indicates if the node is associated with a primary user.

`Optional`metadata

metadata?: Record<string, any>

Metadata associated with the node.

`Optional`nodeConfig

nodeConfig?: ESPRMNodeConfig

The configuration settings for the node.

`Optional`role

role?: string

Role of user associated with the node.

`Optional`subscriptionConfig

subscriptionConfig?: ESPNodeSubscriptionConfig

Subscription configuration for this node. Allows customization of subscription channel priority order.

If not set, the node will use the global channel order from ESPSubscriptionManager. Setting this allows per-node optimization of subscription channels.

Example

// Set custom channel order for this node
node.subscriptionConfig = {
  channelOrder: ["notification"]
};

`Optional`tags

tags?: string[]

Tags associated with the node.

transportOrder

transportOrder: string[] = []

Transport order associated with the node.

`Optional`type

type?: string

The type of the node.

Methods

addAutomation

addAutomation(automationDetails: ESPAutomationDetails): Promise<ESPAutomation>
Adds a new automation trigger for the node.
Parameters
- automationDetails: ESPAutomationDetails
  The details of the automation trigger and action to add.
Returns Promise<ESPAutomation>
A promise that resolves to an ESPAutomation instance containing details of the newly created automation.
- Defined in src/methods/ESPRMNode/AddAutomation.ts:34

attachTags

attachTags(tags: string[]): Promise<ESPAPIResponse>
Attaches tags to the node.
Parameters
- tags: string[]
  An array of tags to attach to the node.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API response.
- Defined in src/methods/ESPRMNode/AttachTags.ts:23

checkOTAUpdate

checkOTAUpdate(): Promise<ESPOTAUpdateResponse>
Checks if there is an Over-The-Air (OTA) update available for the node.

Returns Promise<ESPOTAUpdateResponse>
A promise that resolves to an ESPOTAUpdateResponse object containing details about the OTA update availability.
- Defined in src/methods/ESPRMNode/CheckOTAUpdate.ts:21

clearSubscriptionChannelOrder

clearSubscriptionChannelOrder(): void
Clear the node-specific subscription channel order. After calling this, the node will use the global channel order.

Returns void
Example
```
node.clearSubscriptionChannelOrder();
```
- Defined in src/methods/ESPRMNode/SubscriptionConfig.ts:55

delete

delete(): Promise<ESPAPIResponse>
Deletes the mapping of current node with user.

Returns Promise<ESPAPIResponse>
A promise that resolves to the API success response.
- Defined in src/methods/ESPRMNode/Delete.ts:26

deleteMetadata

deleteMetadata(): Promise<ESPAPIResponse>
Returns Promise<ESPAPIResponse>
- Defined in src/methods/ESPRMNode/DeleteMetadata.ts:18

getAutomations

getAutomations(): Promise<ESPPaginatedAutomationsResponse>
Retrieves a list of all automations for this node with optional pagination.

Returns Promise<ESPPaginatedAutomationsResponse>
A promise that resolves to a paginated response containing automation data.
- Defined in src/methods/ESPRMNode/GetAutomations.ts:20

getConnectivityStatus

getConnectivityStatus(): Promise<ESPRMConnectivityStatus>
Returns Promise<ESPRMConnectivityStatus>
- Defined in src/methods/ESPRMNode/GetConnectivityStatus.ts:19

getCustomParamSimpleTSData

getCustomParamSimpleTSData(
request: ESPCustomParamSimpleTSDataRequest,
): Promise<ESPSimpleTSDataResponse>
Retrieves simple time series data in a paginated format for a custom parameter.
Parameters
- request: ESPCustomParamSimpleTSDataRequest
  The request parameters for fetching time series data
Returns Promise<ESPSimpleTSDataResponse>
A promise that resolves to a paginated response containing time series data points
- Defined in src/methods/ESPRMNode/GetCustomParamSimpleTSData.ts:27

getCustomParamTSData

getCustomParamTSData(
request: ESPCustomParamTSDataRequest,
): Promise<ESPSimpleTSDataResponse>
Retrieves time series data in a paginated format for a custom parameter.
Parameters
- request: ESPCustomParamTSDataRequest
  The request parameters for fetching time series data
Returns Promise<ESPSimpleTSDataResponse>
A promise that resolves to a paginated response containing time series data points
- Defined in src/methods/ESPRMNode/GetCustomParamTSData.ts:27

getNodeConfig

getNodeConfig(): Promise<ESPRMNodeConfig>
Returns Promise<ESPRMNodeConfig>
- Defined in src/methods/ESPRMNode/GetNodeConfig.ts:19

getOTAUpdateStatus

getOTAUpdateStatus(otaJobId: string): Promise<ESPOTAUpdateStatusResponse>
Checks the status of a previously initiated Over-The-Air (OTA) update for the node.
Parameters
- otaJobId: string
  The ID of the OTA job for which the status is being checked.
Returns Promise<ESPOTAUpdateStatusResponse>
A promise that resolves to an ESPOTAUpdateStatusResponse object containing details about the OTA update status.

Throws
If the OTA job ID is missing or invalid.
- Defined in src/methods/ESPRMNode/GetOTAUpdateStatus.ts:32

getServices

getServices(): Promise<ESPRMService[]>
Fetches the services for the current node.

Returns Promise<ESPRMService[]>
A promise that resolves to an array of updated services.
- Defined in src/methods/ESPRMNode/GetServices.ts:24

getSubscriptionChannelOrder

getSubscriptionChannelOrder(): string[]
Get the effective subscription channel order for this node. Returns the node-specific order if set, otherwise returns the global order.

Returns string[]
Array of channel IDs in priority order
Example
```
const order = node.getSubscriptionChannelOrder();
console.log(`Channel order: ${order.join(", ")}`);
```
- Defined in src/methods/ESPRMNode/SubscriptionConfig.ts:44

pushOTAUpdate

pushOTAUpdate(otaJobId: string): Promise<ESPAPIResponse>
Initiates an Over-The-Air (OTA) update for the node using a specified OTA job ID.
Parameters
- otaJobId: string
  The ID of the OTA job to be used for the update.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse object confirming the successful initiation of the OTA update.

Throws
If the OTA job ID is missing or invalid.
- Defined in src/methods/ESPRMNode/PushOTAUpdate.ts:28

removeSharingFor

removeSharingFor(username: string): Promise<ESPAPIResponse>
Remove sharing of the current node for a specified user.
Parameters
- username: string
  The username of the user for whom the sharing is to be removed.
Returns Promise<ESPAPIResponse>
A promise that resolves to a success response upon successful removal.
- Defined in src/methods/ESPRMNode/RemoveSharingFor.ts:24

removeTags

removeTags(): Promise<ESPAPIResponse>
Returns Promise<ESPAPIResponse>
- Defined in src/methods/ESPRMNode/RemoveTags.ts:18

setMultipleParams

setMultipleParams(payload: NodePayload): Promise<ESPAPIResponse>
Sets multiple parameters for the node.
Parameters
- payload: NodePayload
  The payload containing the parameters to be set.
Returns Promise<ESPAPIResponse>
A promise that resolves to the API response.
- Defined in src/methods/ESPRMNode/SetMultipleParams.ts:21

setSubscriptionChannelOrder

setSubscriptionChannelOrder(channelIds: string[]): void
Set the subscription channel order for this node. This overrides the global channel order from ESPSubscriptionManager.

Channels are tried in the order specified until one succeeds. Only channels that support the node (via supportsNode()) will be used.
Parameters
- channelIds: string[]
  Array of channel IDs in priority order
Returns void
Example
```
// Prioritize Matter for this node
node.setSubscriptionChannelOrder(["matter", "notification", "mqtt"]);
```
- Defined in src/methods/ESPRMNode/SubscriptionConfig.ts:30

setTimeZone

setTimeZone(timeZoneString: string): Promise<ESPAPIResponse>
Set the timeZone for the node.
Parameters
- timeZoneString: string
  The timeZone string to set.
Returns Promise<ESPAPIResponse>
A promise that resolves to an ESPAPIResponse indicating the success of the operation.
- Defined in src/methods/ESPRMNode/SetTimeZone.ts:31

shareWith

shareWith(shareNodeWithRequestParams: ShareWithRequest): Promise<string>
Parameters
- shareNodeWithRequestParams: ShareWithRequest
Returns Promise<string>
- Defined in src/methods/ESPRMNode/ShareWith.ts:18

transferNode

transferNode(transferNodeRequestParams: TransferNodeRequest): Promise<string>
Create Transfer request of the current node to a specified user.
Parameters
- transferNodeRequestParams: TransferNodeRequest
  Parameters specifying the user and transfer options.
Returns Promise<string>
A promise that resolves to a requestId upon successful transfer request creation.
- Defined in src/methods/ESPRMNode/TransferNode.ts:24

updateMetadata

updateMetadata(metadata: Record<string, any>): Promise<ESPAPIResponse>
Parameters
- metadata: Record<string, any>
Returns Promise<ESPAPIResponse>
- Defined in src/methods/ESPRMNode/UpdateMetadata.ts:18

Class ESPRMNode

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ESPRMNode

Properties

availableTransports

OptionalconnectivityStatus

OptionalcustomTransportManagers

Example

id

OptionalisPrimaryUser

Optionalmetadata

OptionalnodeConfig

Optionalrole

OptionalsubscriptionConfig

Example

Optionaltags

transportOrder

Optionaltype

Methods

addAutomation

Parameters

Returns Promise<ESPAutomation>

attachTags

Parameters

Returns Promise<ESPAPIResponse>

checkOTAUpdate

Returns Promise<ESPOTAUpdateResponse>

clearSubscriptionChannelOrder

Returns void

Example

delete

Returns Promise<ESPAPIResponse>

deleteMetadata

Returns Promise<ESPAPIResponse>

getAutomations

Returns Promise<ESPPaginatedAutomationsResponse>

getConnectivityStatus

Returns Promise<ESPRMConnectivityStatus>

getCustomParamSimpleTSData

Parameters

Returns Promise<ESPSimpleTSDataResponse>

getCustomParamTSData

Parameters

Returns Promise<ESPSimpleTSDataResponse>

getNodeConfig

Returns Promise<ESPRMNodeConfig>

getOTAUpdateStatus

Parameters

Returns Promise<ESPOTAUpdateStatusResponse>

Throws

getServices

Returns Promise<ESPRMService[]>

getSubscriptionChannelOrder

Returns string[]

Example

pushOTAUpdate

Parameters

Returns Promise<ESPAPIResponse>

Throws

removeSharingFor

Parameters

Returns Promise<ESPAPIResponse>

removeTags

Returns Promise<ESPAPIResponse>

setMultipleParams

Parameters

Returns Promise<ESPAPIResponse>

setSubscriptionChannelOrder

Parameters

Returns void

Example

setTimeZone

Parameters

`Optional`connectivityStatus

`Optional`customTransportManagers

`Optional`isPrimaryUser

`Optional`metadata

`Optional`nodeConfig

`Optional`role

`Optional`subscriptionConfig

`Optional`tags

`Optional`type