能控云开放文档体系总览

能控云(AECC)围绕同一套数据采集器与能源管理设备生态(CT 电表、红外抄表器、P1 电表、智能插座、Linky 抄表器、储能逆变器等),面向不同接入方开放了五类文档。本文帮助开发者快速理解各文档的定位与适用场景,按需选择正确的接入方式。

一、文档速览

文档 接入方式 适用对象 主要能力 在线文档
APP SDK 蓝牙(本地近距离) 需要集成配网/采集能力的手机 App 开发者 设备发现、加密通信、WiFi 配网、采集器寄存器读写、联网状态监控 进入文档
云端 API 互联网 · HTTP 接口 需要主动查询与控制的第三方服务端 设备额定/实时数据查询、单点与批量参数设置、储能运行模式、分时电价 进入文档
云端 MQTT 互联网 · MQTT 订阅 需要被动实时同步设备数据的第三方平台 DMS 数据转发、主题订阅、设备额定数据与监控数据持续推送 进入文档
局域网 本地接口 局域网 · TCP 需要在现场本地接入设备的自有系统/网关 mDNS 发现、JSON 数据读写、能量控制参数、Modbus RTU/TCP 透传 进入文档
HomeAssistant 插件 局域网 · HA 插件 使用 Home Assistant 的智能家居用户 设备列表、实时功率、能量流向图、控制参数与诊断(HA-EMS 组件) 进入文档

二、文档说明

1. APP SDK 文档

面向终端 App 开发者的客户端接入方案,让自有 App 通过蓝牙直接与 AECC 智能数据采集器及其蓝牙模块产品通信。

  • 适用设备:AECC 智能数据采集器,以及使用 AECC 蓝牙模块的 CT 电表、红外抄表器、P1 电表、智能插座、Linky 抄表器等产品。
  • 核心能力:自动发现设备、蓝牙加密通信、WiFi 配网(扫描周边 WiFi → 下发 SSID/密码 → 查看配网进度)、通过协议命令读写采集器寄存器、监控采集器与路由器/服务器的连接状态。
  • 接入平台:Android(AAR/JAR)、iOS(framework)、Flutter、UniApp。
  • 前置条件:SDK 开发包、密钥与授权码请联系能控云官方获取。

2. 云端 API 文档

面向第三方服务端的 REST API 接入指南,通过 HTTP 接口对储能系统、电表等设备进行主动查询与控制,接口经签名鉴权保护。

  • 鉴权方式:调用方使用平台分配的 companyCode 与本地签名密钥 key;业务参数按 Unicode 升序排列并拼接时间戳后计算 MD5 签名,服务端校验时间窗与签名。
  • 动态电价接口/openApi/price/):设置储能运行模式、查询分时电价,无需设备序列号。
  • 设备服务接口/openApi/device/):按设备序列号查询额定参数与实时数据、设置单个或批量设备参数;查询类接口不要求设备在线,设置类要求在线。
  • 典型场景:远程配置储能/电表控制策略、查询额定与实时运行数据、批量下发参数、获取电价数据供智能调度使用。

3. 云端 MQTT 文档

面向第三方服务端的 MQTT 数据转发(DMS)接入指南,通过订阅主题被动接收设备实时上报数据。

  • 数据流向:设备 → 采集器 → 能控云 DMS(MQTT Broker)→ 第三方平台,推送 QoS 为 1。
  • 连接方式:使用平台分配的 mqttId / keyId / keySecret 连接,默认端口 8091,支持 TCP 与 SSL;主题由平台统一分配,以 SUB/ 为前缀。
  • 数据模型:设备额定数据(上电后传输一次,type=1)与设备监控数据(按上报间隔持续推送,type=2),外层公共字段含 msgId 用于消息幂等去重。
  • 扩展能力:支持共享订阅 $share/{消费组}/{主题} 实现多实例负载均衡。

4. 局域网 本地接口文档

面向自有系统的 局域网本地接口协议文档,帮助开发者在设备同网段环境下把 EMS 能源管理系统接入自有应用、仪表盘、网关或平台,全程无需云端账号。

  • 集成流程:先 mDNS 发现设备,再通过 JSON 读取数据确认连通,随后读写能量控制参数;已有工业协议的设备可走 Modbus 透传。
  • 协议通道:监听 TCP:8080,同时支持 JSON 格式与 Modbus RTU/TCP 透传;JSON 核心字段含 Get/Set/Response 等。
  • 提供能力:顶层汇总数据、储能/插座/充电桩/热泵等设备列表,以及系统最大功率限制、分时段功率、SOC 阈值、削峰配置等能量控制参数。
  • 适用设备:CT 电表、红外抄表器、P1 电表、智能插座、Linky 抄表器、储能系统、逆变器、电池、热泵、充电桩,以及使用 Energy Control Cloud WIFI 模块的产品。

5. HomeAssistant 插件文档

面向智能家居用户的 Home Assistant 插件(HA-EMS)安装与使用指南,将 EMS 设备接入本地 Home Assistant 进行可视化监控。

  • 工作方式:与 HA 处于同一局域网的设备经 mDNS 发现并通过 TCP 实时轮询,仅局域网工作、无需云账号。
  • 提供能力:设备列表、连接状态、实时功率、能量流向图、控制参数与诊断信息。
  • 安装方式:解压组件包至 /config、重启 HA、在设备与服务中添加 "HA EMS" 集成即可;支持手动注册仪表盘与卡片资源兜底。

三、接入方式对比

维度 APP SDK 云端 API 云端 MQTT 局域网 本地接口 HomeAssistant 插件
接入方形态 手机 App 第三方服务端/云平台 第三方服务端/云平台 自有本地系统/网关 Home Assistant
网络范围 蓝牙(本地近距离) 互联网(广域网) 互联网(广域网) 局域网 局域网
交互方向 双向(本地采集与配置) 主动查询 / 控制 被动接收推送 双向(本地读写) 监控为主,可读写控制参数
协议 / 通道 BLE + 私有命令 HTTP + 签名鉴权 MQTT(TCP/SSL,QoS 1) TCP:8080 JSON / Modbus HA 组件(mDNS + TCP)
是否需要云端账号 否(需官方 SDK 与授权)
典型动作 配网、读写寄存器 模式设置、数据查询、参数下发 订阅主题、接收设备数据 JSON 读写 + Modbus 透传 安装插件、添加集成、查看面板

四、如何选择

请根据您的集成对象与网络环境,对照选择对应文档:

我的场景 请阅读
自有 App 需要为用户完成设备配网与本地采集 APP SDK 文档
自研 App 已上线,希望扩展设备管理 / 数据采集模块 APP SDK 文档
第三方平台需要远程主动查询与控制储能/电表 云端 API 文档
根据分时电价自动调度储能充放电策略 云端 API 文档(动态电价接口)
第三方平台需要被动持续同步设备遥测数据 云端 MQTT 文档
第三方平台搭建发电量 / 用电量监控大屏,或基于故障码做告警与运维联动 云端 MQTT 文档(实时遥测 + 故障码字段)
客户现场局域网内集成,不经过云端 局域网 本地接口文档
开发智能网关,在本地发现并管理多台设备 局域网 本地接口文档(mDNS 发现 + JSON)
客户要求数据不出内网的私有化交付 局域网 本地接口文档
在 Home Assistant 中查看与控制储能设备 HomeAssistant 插件文档
既需要主动控制又需要实时数据 云端 API + 云端 MQTT 组合使用

五、凭据与账号说明

云端接入所需凭据由能控云平台统一分配,请通过官方渠道申请:

文档 所需凭据 用途
云端 API companyCodekey 请求头标识与本地签名密钥
云端 MQTT mqttIdkeyIdkeySecret MQTT 连接标识与账号密钥
APP SDK SDK 包、密钥、授权码 客户端集成与授权校验
局域网 本地接口 / HA 无需云端账号 局域网直连设备

六、更新与支持

各文档将随产品版本持续更新,若实际使用与文档存在差异,请以最新在线版本为准;接入过程中的问题,欢迎通过官网联系我们页面获取支持。

联系我们