Class ESPSubscriptionManager

Manages subscription channels and coordinates node update subscriptions. This is the central hub for all parameter update subscriptions from various sources (notifications, Matter, MQTT, BLE, custom channels, etc.)

The manager uses a priority-based approach:

  1. For each node, it determines the effective channel order (node-specific or global)
  2. It filters channels based on availability and node support
  3. It tries channels in order until one succeeds

Example

// Register channels
await ESPRMBase.subscriptionManager.registerChannel(new NotificationSubscriptionChannel());
await ESPRMBase.subscriptionManager.registerChannel(new MatterSubscriptionChannel());

// Set global channel order
ESPRMBase.subscriptionManager.setGlobalChannelOrder(["matter", "notification"]);

// Subscribe to node updates
const nodes = await user.getNodes();
await ESPRMBase.subscriptionManager.subscribeToAllNodes(nodes, (update) => {
  console.log(`Node ${update.nodeId} updated via ${update.source}`);
});

Constructors

constructor

Methods

dispose getAvailableChannelsForNode getEffectiveChannelOrder getGlobalChannelOrder getRegisteredChannels initialize registerChannel setGlobalChannelOrder subscribeToAllNodes subscribeToNode unregisterChannel unsubscribeFromNode

Constructors

constructor

Methods

dispose

  • dispose(): Promise<void>

  • Cleanup all subscriptions and dispose channels. Should be called when app is closing or SDK is being torn down.

    Returns Promise<void>

    Example

    await ESPRMBase.subscriptionManager.dispose();

getAvailableChannelsForNode

  • getAvailableChannelsForNode(node: ESPRMNode): ESPSubscriptionChannelInterface[]

  • Get available channels for a node. Filters channels based on:

    • Channel is registered
    • Channel supports the node (via supportsNode())
    • Channel is in the effective order

    Parameters

    Returns ESPSubscriptionChannelInterface[]

    Array of available channels in priority order

    Example

    const channels = ESPRMBase.subscriptionManager.getAvailableChannelsForNode(node);
    console.log(`Available channels: ${channels.map(c => c.channelId).join(", ")}`);

getEffectiveChannelOrder

  • getEffectiveChannelOrder(node: ESPRMNode): string[]

  • Get the effective channel order for a node. Priority: node.subscriptionConfig.channelOrder > global channel order

    Parameters

    • node: ESPRMNode

      The node to get channel order for

    Returns string[]

    Array of channel IDs in priority order

getGlobalChannelOrder

getRegisteredChannels

  • getRegisteredChannels(): string[]

  • Get all registered channel IDs.

    Returns string[]

    Array of channel IDs

    Example

    const channels = ESPRMBase.subscriptionManager.getRegisteredChannels();
    console.log(`Registered channels: ${channels.join(", ")}`);

initialize

  • initialize(): Promise<void>

  • Initialize the subscription manager. This initializes all registered channels. Should be called during SDK initialization.

    Returns Promise<void>

    Promise that resolves when initialization is complete

registerChannel

  • registerChannel(
        channel: ESPSubscriptionChannelInterface,
        autoInitialize?: boolean,
    ): Promise<void>

  • Register a new subscription channel.

    Parameters

    • channel: ESPSubscriptionChannelInterface

      The channel to register

    • autoInitialize: boolean = true

      Whether to initialize the channel immediately (default: true)

    Returns Promise<void>

    Throws

    Error if a channel with the same ID is already registered

    Example

    const matterChannel = new MatterSubscriptionChannel();
    await ESPRMBase.subscriptionManager.registerChannel(matterChannel);

setGlobalChannelOrder

  • setGlobalChannelOrder(channelIds: string[]): void

  • Set the global default channel order. This order is used for all nodes unless they have a custom order in subscriptionConfig.

    Parameters

    • channelIds: string[]

      Array of channel IDs in priority order (first = highest priority)

    Returns void

    Example

    // Try Matter first, then notifications, then MQTT
    ESPRMBase.subscriptionManager.setGlobalChannelOrder([
      "matter",
      "notification",
      "mqtt"
    ]);

subscribeToAllNodes

  • subscribeToAllNodes(
        nodes: ESPRMNode[],
        callback: (update: ESPNodeUpdateData) => void,
    ): Promise<void>

  • Subscribe to updates for all nodes. This is used by the global ESPRMEventType.nodeUpdates subscription.

    Parameters

    • nodes: ESPRMNode[]

      Array of nodes to subscribe to

    • callback: (update: ESPNodeUpdateData) => void

      Function to call when any node is updated

    Returns Promise<void>

    Example

    const nodes = await user.getNodes();
    await ESPRMBase.subscriptionManager.subscribeToAllNodes(nodes, (update) => {
      console.log(`Node ${update.nodeId} updated`);
    });

subscribeToNode

  • subscribeToNode(
        node: ESPRMNode,
        callback: (update: ESPNodeUpdateData) => void,
    ): Promise<void>

  • Subscribe to updates for a specific node using priority-based channel selection. Tries channels in order until one succeeds.

    Parameters

    Returns Promise<void>

    Throws

    Error if no channels are available or all channels fail

    Example

    await ESPRMBase.subscriptionManager.subscribeToNode(node, (update) => {
      console.log(`Update from ${update.source}:`, update.payload);
    });

unregisterChannel

  • unregisterChannel(channelId: string): Promise<void>

  • Unregister a subscription channel. This will dispose the channel and remove it from the manager.

    Parameters

    • channelId: string

      ID of the channel to unregister

    Returns Promise<void>

    Example

    await ESPRMBase.subscriptionManager.unregisterChannel("mqtt");

unsubscribeFromNode

  • unsubscribeFromNode(nodeId: string): Promise<void>

  • Unsubscribe from updates for a specific node. This will unsubscribe from all channels for the node.

    Parameters

    • nodeId: string

      ID of the node to unsubscribe from

    Returns Promise<void>

    Example

    await ESPRMBase.subscriptionManager.unsubscribeFromNode("node-123");

Settings

Member Visibility

On This Page

Constructors
Methods