Interface ESPNodeUpdateData

Standardized format for node parameter updates from any subscription channel. All subscription channels must transform their data into this format.

interface ESPNodeUpdateData {
    eventType: string;
    metadata?: Record<string, any>;
    nodeId: string;
    payload: Record<string, any>;
    source: string;
}

Properties

eventType metadata? nodeId payload source

Properties

eventType

eventType: string

Type of event (e.g., "rmaker.event.node_params_changed")

Optionalmetadata

metadata?: Record<string, any>

Optional metadata specific to the channel Examples:

  • Notification: { platform: "ios", notificationId: "123" }
  • Matter: { endpointId: 1, clusterId: 6 }
  • MQTT: { topic: "node/123/params", qos: 1 }

nodeId

nodeId: string

ID of the node that was updated

payload

payload: Record<string, any>

The actual parameter data Format: { deviceName: { paramName: value } }

source

source: string

Source channel that provided this update (e.g., "notification", "matter", "mqtt")

Settings

Member Visibility

On This Page

Properties