Class ESPRMNeoNode

constructor

• new ESPRMNeoNode(
      config: NodeConfigAPI,
      groupId: string,
      subgroupIdOrIds?: string | string[],
  ): ESPRMNeoNode

  Parameters

  • config: NodeConfigAPI
  • groupId: string
  • OptionalsubgroupIdOrIds: string | string[]

  Returns ESPRMNeoNode

availableTransports

config

connectivityStatus

OptionalcustomTransportManagers

devices

groupId

nodeId

services

subgroupIds

OptionalsubscriptionConfig

transportOrder

addCustomTransportManager

• addCustomTransportManager(mode: string, manager: ESPTransportInterface): void

  Registers (or replaces) a custom transport manager for a mode. The transport handler prefers it over the built-in backend for that mode. Pair with addTransport so the mode also appears in availableTransports and participates in transportOrder.

  Parameters

  • mode: string

    Transport mode key the manager handles.
  • manager: ESPTransportInterface

    Implementation of ESPTransportInterface.

  Returns void

addTransport

• addTransport(mode: string, config: ESPTransportConfig): void

  Adds (or replaces) an available transport for this node, keyed by mode. Works for built-in modes (ESPTransportMode) and custom string modes. For a custom transport, also register its implementation via addCustomTransportManager.

  Parameters

  • mode: string

    Transport mode key (e.g. local, mqtt, or a custom string).
  • config: ESPTransportConfig

    The transport config ({ type, metadata }).

  Returns void

applyNodeConfig

• applyNodeConfig(config: NodeConfigAPI): void

  Replaces config and rebuilds devices/services (used after cloud sync).

  Sets config so config.devices / config.services are the same live ESPRMNeoDevice / ESPRMNeoService instances as devices / services.

  Parameters

  • config: NodeConfigAPI

  Returns void

clearSubscriptionChannelOrder

• clearSubscriptionChannelOrder(): void

  Clears the node-specific channel order so the node falls back to the global order.

  Returns void

createSchedule

• createSchedule(schedule: ScheduleItem): Promise<ESPRMNeoSchedule>

  Creates schedules on this node.

  • Pass a single ScheduleItem to append it while preserving existing schedules (GET current list, then PUT the merged list).
  • Pass an array to replace all schedules in one PUT. Pass [] to clear.

  Calls PUT /v1/groups/{groupId}/nodes/{nodeId}/schedules.

  Single-item append is not safe under concurrent calls to the same node — two simultaneous creates can read the same existing list and the later PUT wins. Callers appending many schedules should build the array locally and pass it once.

  Parameters

  • schedule: ScheduleItem

  Returns Promise<ESPRMNeoSchedule>

  The created schedule, or the full list after a replace-all PUT.

  Throws

  If the argument is invalid, or a single schedule's id is missing / already exists.

  Throws

  If the API request fails.

• createSchedule(schedules: ScheduleItem[]): Promise<ESPRMNeoSchedule[]>

  Parameters

  • schedules: ScheduleItem[]

  Returns Promise<ESPRMNeoSchedule[]>

createTrigger

• createTrigger(trigger: TriggerItem): Promise<ESPRMNeoTrigger>

  Creates triggers on this node.

  • Pass a single TriggerItem to append it while preserving existing triggers (GET current list, then PUT the merged list).
  • Pass an array to replace all triggers in one PUT. Pass [] to clear.

  Calls PUT /v1/groups/{groupId}/nodes/{nodeId}/triggers.

  Single-item append is not safe under concurrent calls to the same node — two simultaneous creates can read the same existing list and the later PUT wins. Callers appending many triggers should build the array locally and pass it once.

  Parameters

  • trigger: TriggerItem

  Returns Promise<ESPRMNeoTrigger>

  The created trigger, or the full list after a replace-all PUT.

  Throws

  If the argument is invalid, or a single trigger's id is missing / already exists.

  Throws

  If the API request fails.

• createTrigger(triggers: TriggerItem[]): Promise<ESPRMNeoTrigger[]>

  Parameters

  • triggers: TriggerItem[]

  Returns Promise<ESPRMNeoTrigger[]>

delete

• delete(): Promise<ESPAPIResponse>

  Fully disassociates this node from the cloud account. Calls DELETE /v1/groups/{groupId}/nodes/{nodeId} at the root group.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response when the node has been deleted.

  Throws

  If the deletion fails or the API request fails.

getConfig

• getConfig(): NodeConfig

  Returns the node configuration currently held on this instance (the last snapshot loaded from cache or fetched via sync). Synchronous — does not hit the cloud. Call sync for a fresh fetch.

  Returns NodeConfig

  The current node configuration.

OptionalgetCustomParamLatestTSData

• getCustomParamLatestTSData(
      deviceName: string,
      paramName: string,
      options?: ESPRMNeoTSDataOptions,
  ): Promise<ESPRMNeoTSDataResult>

  Gets the most recent time-series sample for a device param from GET /v1/groups/{groupId}/nodes/{nodeId}/timeseries/latest.

  Parameters

  • deviceName: string

    Device name.
  • paramName: string

    Parameter name.
  • Optionaloptions: ESPRMNeoTSDataOptions

    Query options (only dataType override is used).

  Returns Promise<ESPRMNeoTSDataResult>

  Promise resolving to time-series data with at most one point in data (empty when the param has no samples yet).

OptionalgetCustomParamRawTSData

• getCustomParamRawTSData(
      deviceName: string,
      paramName: string,
      options?: ESPRMNeoTSDataOptions,
  ): Promise<ESPRMNeoTSDataResult>

  Gets raw time-series samples for a device param (newest first) from GET /v1/groups/{groupId}/nodes/{nodeId}/timeseries/raw.

  Parameters

  • deviceName: string

    Device name.
  • paramName: string

    Parameter name.
  • Optionaloptions: ESPRMNeoTSDataOptions

    Query options; startTs (Unix ms) is required, endTs defaults to now. Paginate via pageSize/startKey or the result's fetchNext().

  Returns Promise<ESPRMNeoTSDataResult>

  Promise resolving to raw time-series data.

OptionalgetCustomParamTSData

• getCustomParamTSData(
      deviceName: string,
      paramName: string,
      options?: ESPRMNeoTSDataOptions,
  ): Promise<ESPRMNeoTSDataResult>

  Gets aggregated time-series data for a device param from GET /v1/groups/{groupId}/nodes/{nodeId}/timeseries/aggregates.

  Query modes (all require options.window):

  • no date options: current (live) window
  • date: one completed historical window
  • startDate + endDate: paginated range of completed windows

  Parameters

  • deviceName: string

    Device name.
  • paramName: string

    Parameter name.
  • Optionaloptions: ESPRMNeoTSDataOptions

    Query options (window required; date or startDate/endDate for historical windows; paginate via pageSize/startKey or the result's fetchNext()).

  Returns Promise<ESPRMNeoTSDataResult>

  Promise resolving to time-series data with aggregates populated.

getParamsTopic

• getParamsTopic(): string

  RainMaker params channel: rainmaker/nodes/{nodeId}/user/{shadowName}/params

  Returns string

getSchedules

• getSchedules(): Promise<ESPRMNeoSchedule[]>

  Retrieves all schedules for this node.

  Calls GET /v1/groups/{groupId}/nodes/{nodeId}/schedules.

  Returns Promise<ESPRMNeoSchedule[]>

  A promise that resolves to an array of ESPRMNeoSchedule instances.

  Throws

  If retrieving schedules fails or the API request fails.

getShadowName

• getShadowName(): string

  Returns string

getSubscriptionChannelOrder

• getSubscriptionChannelOrder(): string[]

  Returns the effective subscription channel order for this node (node-specific order if set, otherwise the global order).

  Returns string[]

  Channel ids in priority order.

getTriggers

• getTriggers(): Promise<ESPRMNeoTrigger[]>

  Retrieves all triggers for this node.

  Calls GET /v1/groups/{groupId}/nodes/{nodeId}/triggers.

  Returns Promise<ESPRMNeoTrigger[]>

  A promise that resolves to an array of ESPRMNeoTrigger instances.

  Throws

  If the API request fails.

removeAllSchedules

• removeAllSchedules(): Promise<ESPAPIResponse>

  Removes all schedules for this node in a single call.

  Calls DELETE /v1/groups/{groupId}/nodes/{nodeId}/schedules.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response when all schedules are successfully removed.

  Throws

  If the API request fails.

removeAllTriggers

• removeAllTriggers(): Promise<ESPAPIResponse>

  Removes all triggers for this node in a single call.

  Calls DELETE /v1/groups/{groupId}/nodes/{nodeId}/triggers.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response when all triggers are successfully removed.

  Throws

  If the API request fails.

removeCustomTransportManager

• removeCustomTransportManager(mode: string): void

  Removes the custom transport manager registered for a mode (if any).

  Parameters

  • mode: string

    Transport mode key to clear.

  Returns void

removeSchedule

• removeSchedule(scheduleId: string): Promise<ESPAPIResponse>

  Removes a schedule from this node by id, preserving other schedules.

  RainMaker's schedules API is replace-all, so this method does two round trips: a GET to fetch the current list, then a PUT of the filtered list.

  Parameters

  • scheduleId: string

    Id of the schedule to remove.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response when the schedule is removed.

  Throws

  If scheduleId is missing or no matching schedule exists.

  Throws

  If the API request fails.

removeTransport

• removeTransport(mode: string): void

  Removes an available transport for this node by mode.

  Parameters

  • mode: string

    Transport mode key to remove.

  Returns void

removeTrigger

• removeTrigger(triggerId: string): Promise<ESPAPIResponse>

  Removes a trigger from this node by id, preserving other triggers.

  RainMaker's triggers API is replace-all, so this method does two round trips: a GET to fetch the current list, then a PUT of the filtered list.

  Parameters

  • triggerId: string

    Id of the trigger to remove.

  Returns Promise<ESPAPIResponse>

  A promise that resolves with the API response when the trigger is removed.

  Throws

  If triggerId is missing or no matching trigger exists.

  Throws

  If the API request fails.

setParams

• setParams(params: Record<string, any>): Promise<ESPAPIResponse>

  Publishes a parameter update to this node via the best available transport (local control first when reachable, otherwise MQTT).

  The returned response indicates the publish was accepted by the transport (local ack or MQTT publish resolved). It does not guarantee that the device received or applied the params — cloud publishes are fire-and-forget over AWS IoT.

  Parameters

  • params: Record<string, any>

    A record of device/service names to param maps.

  Returns Promise<ESPAPIResponse>

  A promise that resolves once the transport publish is accepted.

  Throws

  If params is empty.

  Throws

  If all available transports fail.

setSubscriptionChannelOrder

• setSubscriptionChannelOrder(channelIds: string[]): void

  Sets the subscription channel order for this node, overriding the global order on ESPRMNeoBase.subscriptionManager. Channels are tried in order until one succeeds; only channels that support the node are used.

  Parameters

  • channelIds: string[]

    Channel ids in priority order, e.g. ["matter", "mqtt"].

  Returns void

  Example

  node.setSubscriptionChannelOrder(["matter", "mqtt"]);
  Copy

setTransportOrder

• setTransportOrder(order: string[]): void

  Overrides the transport priority order for this node only.

  Parameters

  • order: string[]

    Non-empty ordered list of transport modes.

  Returns void

  Throws

  If the order is empty or not an array.

sync

• sync(): Promise<ESPRMNeoNode>

  Fetches the latest node config from the cloud, applies it to this instance (config, devices, services), then updates the local cache.

  Calls:

  • Root membership: GET /v1/groups/{groupId}/nodes/{nodeId}/config
  • Subgroup membership: GET /v1/groups/{groupId}/subgroups/{subGroupId}/nodes/{nodeId}/config

  Returns Promise<ESPRMNeoNode>

  Throws

  If the API request fails.

unsubscribeFromMqttUpdates

• unsubscribeFromMqttUpdates(): void

  Stops receiving MQTT shadow updates for this node.

  Specifically:

  • Unregisters the node from NodeMQTTOrchestrator
  • Removes the node's MQTT shadow listeners
  • Unsubscribes the shared shadow MQTT topics if no other registered nodes still use them

  Call this before dropping the last reference to the node instance so orchestrator registrations and MQTT subscriptions are not left behind. This does not clear local storage, node config cache, or other SDK resources.

  Returns void