跳到主要内容

订阅存储

SubscriptionStore 是 CDF 的实时事件网关。它把 RainMaker SDK 的推送事件(云端更新、本地发现)接到应用内可观察的节点状态上。

功能说明​

当云端发来设备更新,或发现本地传输时,SubscriptionStore 通过两个入口接收:

  • nodeUpdates.listen(event) — 处理参数变更、连接状态更新和用户-节点操作
  • transport.listen(config) — 注册新的本地传输(Wi-Fi、BLE、Thread 等)

这些监听器把事件交给 nodeEventHandlers,由后者更新 NodeStore 中的可观察对象。界面组件通过 observer() 观察这些可观察对象,并自动重新渲染。

不要直接调用 SDK 来获取更新。 适配器负责订阅生命周期,并把 SDK 回调接到这些监听器。这样可以保证单一数据来源,也便于追踪事件流向。

事件流​

分步说明:

  1. 云端推送 — RainMaker 后端发送设备更新
  2. 订阅 — 适配器通过 ESPCDFUser.subscribeToNodeUpdates() 注册回调
  3. 监听 — 回调把事件转发给 subscriptionStore.nodeUpdates.listen()
  4. 处理 — 事件处理函数处理有效载荷(参数、连接状态、用户-节点变更)
  5. 获取节点 — 处理函数在 NodeStore 中查找节点
  6. 更新 — 处理函数通过 @action 更新可观察属性
  7. 界面更新 — 使用 observer() 的组件自动重新渲染

API 参考​

nodeUpdates.listen(event)​

接收来自 SDK 的节点更新事件,并路由到事件处理函数。

espCDF.subscriptionStore.nodeUpdates.listen({
nodeId: "abc123",
event_type: "params_updated",
params: { power: "on", brightness: 80 }
});

transport.listen({ nodeId, transportDetails })​

为节点注册新发现的本地传输(Wi-Fi、BLE、Thread 等)。

espCDF.subscriptionStore.transport.listen({
nodeId: "abc123",
transportDetails: { type: "local", host: "192.168.1.10", port: 80 }
});

说明: 此存储不管理订阅生命周期(startNodeUpdates、stopNodeUpdates)。该职责属于适配器和 ESPCDFUser。

使用方法​

接入节点更新(适配器设置)​

用户登录后,适配器应注册 SDK 回调,并把事件转发到存储:

// 写在适配器或用户转换器中,不要写在 UI 代码里
const onNodeUpdate = (event: unknown) => {
espCDF.subscriptionStore.nodeUpdates.listen(event);
};

await user.subscribeToNodeUpdates({ onNodeUpdate });

适配器持有订阅。退出登录时,调用 user.unsubscribeFromNodeUpdates() 拆除 SDK 订阅并清除状态。

注册本地传输​

SDK 发现本地传输(BLE、Wi-Fi、Thread 等)时,将其注册到存储:

espCDF.subscriptionStore.transport.listen({
nodeId: "device-abc123",
transportDetails: { type: "local", host: "192.168.1.10", port: 80 },
});

存储会更新节点的 availableTransports,并通过属性变更事件同步 _raw。

在界面中读取节点状态​

监听节点的可观察对象,而不是原始 SDK 回调。使用 observer() 响应变化:

import { observer } from "mobx-react-lite";
import type { ESPCDF } from "@espressif/rainmaker-base-cdf";

const IsConnected = observer(function IsConnected({
espCDF,
nodeId,
}: {
espCDF: ESPCDF;
nodeId: string;
}) {
const node = espCDF.nodeStore.getNodeById(nodeId);
return <StatusDot connected={node?.connectivityStatus?.connected ?? false} />;
});

事件处理函数​

存储在内部调用事件处理函数(来自 services/nodeEventHandlers),把更新应用到节点状态:

处理函数用途
handleNodeUpdateEvent分发参数变更、连接状态和用户-节点操作
handleNodeTransportUpdate在 availableTransports 中添加或更新本地传输
handleNodeParamsChanged更新节点上的参数值
handleNodeConnected / handleNodeDisconnected跟踪在线/离线状态

所有处理函数都是 MobX action:它们从 NodeStore 解析节点、更新可观察属性,并通过属性变更事件同步 _raw。

另请参阅​

核心概念

  • 节点存储 — 保存订阅所更新的可观察节点
  • ESPCDFUser — 负责订阅生命周期(subscribeToNodeUpdates、unsubscribeFromNodeUpdates)

源代码

API 参考

On this page