WPC3700 的 API
名词缩写 WPC:Wi-Fi 功率控制器
WPC 系列功率控制器 API
本文主要介绍 WPC 系列功率控制器 提供的 API。通过这些 API,用户可以执行以下操作:
- 配置 WPC 参数
- 控制 WPC 输出功率
谁应该阅读本文
将本节放在开头是因为,虽然我们撰写了本文,但实际上它与大多数 WPC 用户无关。
如果您已获得 WPC 系列功率控制器,可能有以下几种使用模式:
- 您已在电网侧安装 IAMMETER 电能表,并直接将 WPC3700 与 IAMMETER 电能表 配合使用(WPC3700 工作在自动模式),让 WPC3700 在太阳能盈余驱动下持续工作,即 IAMMETER 解决方案 光伏加热控制系统。
- 您没有 IAMMETER 电能表,但熟悉 Home Assistant 或 Node-RED,已将 WPC3700 集成到 HA 或 Node-RED 自动化系统中(使用最新 IAMMETER 固件 (i.76.058.8) 在 Home Assistant 中启用 MQTT 自动发现)。
- 您需要调用 API 将 WPC3700 集成到自己的系统中。
只有需要第三种操作模式的用户才应阅读本文。
/api/setpower
/api/setpower?x=100
简介
此 API 用于控制 WPC 的输出功率。
注意:此参数也可以通过 setadv API(HTTP POST 调用,setPower 参数)进行修改。
由于 setPower 参数可能需要根据实时电网功率读数频繁修改,因此额外提供了此 HTTP GET API 接口。
URL 与方法
URL:http://{{IP}}/api/setpower
方法:HTTP GET
| 参数名 | 示例值 | 单位 | 必需 | 类型 | 说明 |
|---|---|---|---|---|---|
| x | 100 | W | 是 | int | 表示 WPC 的功率输出。与 setadv 中的 setPower 参数相同。 |
/api/setadv
简介
此 API 用于设置 WPC 的参数。
注意:所有参数均可直接通过 UI 设置。只有少数需要将 WPC 系列产品集成到自有系统中的客户会使用此 API。
URL 与方法
- URL:
http://{{WPC 的本地 IP}}/api/setadv - 方法:HTTP POST
请求参数
以下是 setadv 参数的示例。
注意:执行 setadv 时,无需提交所有参数,只需提交需要修改的参数。不需要修改的参数无需提交。您可以先使用 getadv 读取当前配置,然后仅提交需要修改的参数。
{
"maxPower": 3500,
"setPower": 0,
"restorePower": 0,
"setPowerMode": 0,
"meterAddress": "10.10.30.35",
"threshold": 30,
"hysteresis": 50,
"startHour": 8,
"stopHour": 18,
"tzOffset": 8,
"meterType": 0,
"meterConfig": "3,2,1",
"ntpServer": "ntp.aliyun.com",
"haDiscovery": 1,
"mqttEnabled": 1,
"mqttAddress": "10.10.30.89:1883",
"mqttUsername": "test",
"mqttPassword": "123456",
"uploadInterval": 6
}
响应
{
"successful": 1,
"message": "ok"
}
参数说明
| 参数名 | 类型 | 单位 | 说明 |
|---|---|---|---|
| maxPower | int | W | 受控负载的最大功率,必须小于 3700 |
| setPower | int | W | WPC 的功率输出 |
| restorePower | int | W | 退出自动模式控制后的功率 |
| setPowerMode | int | 操作模式选择:0:手动,1:自动 | |
| threshold | int | W | 自动模式下,根据电网功率进行调整的阈值 |
| hysteresis | int | W | 自动模式下,根据电网功率进行调整的迟滞值 |
| startHour | int | 小时 | 自动模式开始时间 |
| stopHour | int | 小时 | 自动模式结束时间 |
| tzOffset | int | 时区偏移 | |
| meterType | int | 自动模式下电网测量的电能表品牌选择:0:iMeter,1:virtualTCP | |
| meterConfig | string | 自动模式下电网测量的电能表型号选择:3:三相,2:使用 B 相,1:变比 | |
| ntpServer | string | NTP 服务器地址 | |
| haDiscovery | int | 启用 Home Assistant MQTT 自动发现:0:禁用,1:启用 | |
| mqttEnabled | int | 启用 MQTT:0:禁用,1:启用 | |
| meterAddress | string | MQTT 代理地址,集成 Home Assistant 时需要:192.168.1.22:1833 | |
| mqttUsername | string | MQTT 用户名 | |
| mqttPassword | string | MQTT 密码 | |
| uploadInterval | int | s | 上传间隔时间 |
/api/getadv
简介
此 API 读取 WPC 的所有参数(此处可读取 setadv API 中的所有参数)。
URL 与方法
- URL:
http://{{WPC 的本地 IP}}/api/getadv - 方法:HTTP GET
响应
{
"maxPower": 3500,
"setPower": 0,
"restorePower": 0,
"setPowerMode": 0,
"setPowerModeList": "Manual,Auto",
"meterAddress": "10.10.30.35",
"threshold": 20,
"hysteresis": 30,
"startHour": 8,
"stopHour": 18,
"tzOffset": 8,
"meterType": 0,
"meterConfig": "3,2,1",
"meterList": "iMeter,virtualTCP",
"ntpServer": "ntp.aliyun.com",
"haDiscovery": 0,
"mqttEnabled": 0,
"mqttAddress": "192.168.1.22:1833",
"mqttUsername": "test",
"mqttPassword": "123456",
"uploadInterval": 60
}
参数说明请参考 setadv 中的参数描述。
/api/setwifiadv
简介
此 API 用于配置 WPC/WEM 设备的 Wi-Fi 参数。
URL 与方法
- URL:
http://{{WPC 的本地 IP}}/api/setwifiadv - 方法:HTTP POST
请求参数
{
"ssid":"xxxx",
"pwd":"xxxx",
"ip":"xxxx",
"netmask":"xxxxx",
"gw":"xxxx",
"dns":"192.168.1.1",
"dhcp":true,
"runMode":"cloud", // cloud, tcp, http
"uploadAddress":"http://myserver.com/upload" // Useful only if runMode is non-cloud
}
响应
{
"successful": true,
"message": "ok"
}
参数说明
| 参数名 | 类型 | 单位 | 说明 |
|---|---|---|---|
| ssid | string | WLAN 连接的 Wi-Fi AP 名称 | |
| pwd | string | WLAN 连接的 Wi-Fi 密码 | |
| ip | string | 静态 IP;如果使用 DHCP 模式则不需要 | |
| netmask | string | 子网掩码;如果使用 DHCP 模式则不需要 | |
| gw | string | 网关;如果使用 DHCP 模式则不需要 | |
| dns | string | DNS 服务器;如果使用 DHCP 模式则不需要 | |
| dhcp | bool | false:禁用 DHCP,true:启用 DHCP |
参考文档
欢迎在我们的论坛上分享您的想法:https://imeter.club
关于 IAMMETER
IAMMETER 是一家专注于能源管理产品与服务的公司,提供智能电能表、管理应用和云平台。
我们的目标是通过智能监测与分析,帮助客户有效管理、利用和节约能源,降低电费支出。
解决方案
产品
- IAMMETER 电能表概览
- WEM3080T – 三相/分相 Wi-Fi 电能表
- WEM3080 – 单相 Wi-Fi 电能表
- WEM3050T – 三相电能表
- WEM3046T – 带 5A 标准 CT 输入的三相 Wi-Fi 电能表