WPC3700 の API
略語の説明 WPC:Wi-Fi 電源コントローラー
WPC シリーズ電源コントローラーの API
この記事では、WPC シリーズ電源コントローラー が提供する API を主に紹介します。これらの API を通じて、ユーザーは以下の操作を実行できます:
- WPC パラメータの設定
- WPC 出力電力の制御
この記事を読むべき人
このセクションを冒頭に配置したのは、この記事を執筆したものの、実際にはほとんどの WPC ユーザーには関係がないためです。
WPC シリーズ電源コントローラーを入手した場合、考えられる運用モードはいくつかあります:
- 系統側に IAMMETER メーターをすでに設置しており、WPC3700 を IAMMETER メーター と組み合わせて直接使用している(WPC3700 は自動モードで動作)。太陽光の余剰電力に駆動されて WPC3700 を継続的に稼働させることができ、これは IAMMETER のソリューションである PV ヒーター制御システム です。
- IAMMETER メーターは持っていないが、Home Assistant や Node-RED に詳しく、WPC3700 を HA または Node-RED の自動化システムに統合している(Enable MQTT discovery in Home Assistant with the latest IAMMETER firmware (i.76.058.8))。
- API を呼び出して WPC3700 を自社のシステムに統合する必要がある。
この記事を読むべきなのは、3 番目の運用モードが必要なユーザーのみです。
/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://{{Local IP of the WPC}}/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 | hour | 自動モードの開始時刻 |
| stopHour | int | hour | 自動モードの終了時刻 |
| tzOffset | int | タイムゾーンオフセット | |
| meterType | int | 自動モードでの系統計測用メーターブランドの選択:0:iMeter、1:virtualTCP | |
| meterConfig | string | 自動モードでの系統計測用メーターモデルの選択:3:三相、2:phaseB を使用、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://{{Local IP of the WPC}}/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://{{Local IP of the WPC}}/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 エネルギー計量器