Class ESPRMNeoSubscriptionManager

Manages subscription channels and coordinates node update subscriptions. This is the central hub for all parameter update subscriptions from various sources (custom channels)

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

Subscription pattern: register one or more channels, set global channel order, then subscribeToNode(node, callback). Node must have .id; for channel selection it may have .type, .metadata, .subscriptionConfig.channelOrder. Callback receives ESPNodeUpdateData.

Example

// Register channels
await ESPRMNeoBase.subscriptionManager.registerChannel(new MQTTSubscriptionChannel());

// Set global channel order (applies to nodes without their own override)
ESPRMNeoBase.subscriptionManager.setGlobalChannelOrder(["mqtt"]);

// Subscribe to node updates (node can be an SDK node or a proxy with { id, nodeId, type, config, metadata })
await ESPRMNeoBase.subscriptionManager.subscribeToNode(node, (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 ESPRMNeoBase.subscriptionManager.dispose();

getAvailableChannelsForNode

getEffectiveChannelOrder

  • getEffectiveChannelOrder(node: NodeLike): string[]

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

    Parameters

    • node: NodeLike

      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 = ESPRMNeoBase.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 mqttChannel = new MQTTSubscriptionChannel();
    await ESPRMNeoBase.subscriptionManager.registerChannel(mqttChannel);

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 MQTT
    ESPRMNeoBase.subscriptionManager.setGlobalChannelOrder([
      "matter",
      "mqtt"
    ]);

subscribeToAllNodes

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

    Subscribe to updates for all nodes.

    Parameters

    • nodes: NodeLike[]

      Array of nodes to subscribe to

    • callback: (update: ESPNodeUpdateData) => void

      Function to call when any node is updated

    Returns Promise<void>

    Example

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

subscribeToNode

  • subscribeToNode(
        node: NodeLike,
        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

    • node: NodeLike

      The node to subscribe to

    • callback: (update: ESPNodeUpdateData) => void

      Function to call when updates are received

    Returns Promise<void>

    Throws

    Error if no channels are available or all channels fail

    Example

    await ESPRMNeoBase.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 ESPRMNeoBase.subscriptionManager.unregisterChannel("mqtt");

unsubscribeFromNode

  • unsubscribeFromNode(
        nodeId: string,
        callback?: (update: ESPNodeUpdateData) => void,
    ): Promise<void>

    Unsubscribe from updates for a specific node across all channels.

    Parameters

    • nodeId: string

      ID of the node to unsubscribe from.

    • Optionalcallback: (update: ESPNodeUpdateData) => void

      Optional specific subscriber to remove. When provided, only that callback is detached (the node's other subscribers keep receiving updates); when omitted, all subscribers for the node are removed AND the node's MQTT shadow binding on NodeMQTTOrchestrator is cleared — so the next subscribe re-registers a fresh shadow name (needed when app-side membership changes the node's shadow topic).

    Returns Promise<void>

    Example

    // Remove one subscriber (siblings keep receiving updates):
    await ESPRMNeoBase.subscriptionManager.unsubscribeFromNode("node-123", myCallback);
    // Remove every subscriber for the node + clear MQTT shadow binding:
    await ESPRMNeoBase.subscriptionManager.unsubscribeFromNode("node-123");

Settings

Member Visibility

On This Page

Constructors
Methods