Nature Remo E 追加 API を一般向けに公開しました👐

Nature で事業開発を担当している海原 (うみはら) です。

前職はエンジニアをしていまして、エンジニアリングブログ初投稿できる機会を密かに伺っていました

本エントリの趣旨

　これまで法人向けにご提供してきました Nature Remo E 追加API を、この度一般向けに公開いたしました🎉

　「Nature Remo に関するAPI」「Nature Remo E / E lite のスマートメーターに関するAPI」は以前も公開しておりましたが、ついに Nature Remo E 追加 API も仲間入りしました。

　このエントリでは、一般公開した Nature Remo E 追加 API について一問一答形式でご紹介します！

Nature Remo E 追加 API について

Q. Nature Remo E って何ですか？

「Nature Remo E（ネイチャーリモイー）」は、コンセントに挿すだけで安価で手軽に導入できる次世代型HEMSです。

　電力の消費状況や太陽光発電システムの発電・売電状況、蓄電池の充電量・放電量をリアルタイムにスマートフォンの「Nature Remoアプリ」から確認でき、外出先から蓄電池やEVパワーステーションのコントロールも可能です。

　また、スマートリモコン「Nature Remoシリーズ」（別売）と組み合わせて使用することで、電力消費量に合わせた家電の自動制御が可能になります。なお、「Nature Remo E」は、通信プロトコル「ECHONET Lite」で機器（ECHONET Lite 機器）と通信します。

nature.global

Q. Nature Remo E とつながる ECHONET Lite 機器にはどんな種類がありますか？

　2023年3月24日時点では、Nature Remo E は以下のクラスを持つ ECHONET Lite 機器と接続可能です。

低圧スマート電力量メータークラス
- a.k.a. スマートメーター
太陽光発電クラス
- ECHONET Lite Appendix ver. H以降
蓄電池クラス
- ECHONET Lite Appendix ver. H以降
電気自動車用充放電器クラス
- ECHONET Lite Appendix ver. J以降
- a.k.a V2Hシステム
電気温水器クラス
- ECHONET Lite Appendix ver. J以降
- a.k.a エコキュート
スマート分電盤クラス
- ECHONET Lite Appendix ver. E以降

Q. Nature Remo E 追加 API の仕様はどこでみれますか？

　developer.nature.global の以下のエントリ記事からご覧いただけます。

developer.nature.global

Q. 今回公開された Nature Remo E 追加 API でできることは何ですか？

　今回の公開により、以下2種類のリクエストを利用できるようになりました。

Nature Remo E が取得済みの ECHONET Lite 機器のプロパティの値を入手する GETリクエスト
Nature Remo E から特定の ECHONET Lite 機器のプロパティの値の取得を要求する POSTリクエスト（refresh）

　なお、2023年3月24日時点では「Nature Remo E から ECHONET Lite 機器のプロパティの値の設定を要求する POST リクエスト（set）」は有償サポートオプションであり、今回の公開範囲ではご利用いただけません。今後の公開について検討中です。

Q. 想定ユースケースを1つ教えてください！

　例えば「現在の蓄電池に充電されている残量 [Wh] （蓄電残量1）の値を知りたい」場合「Nature Remo E へプロパティの値の取得を要求（refresh）」してから「取得済みのプロパティの値を入手」するリクエストを順番に送信することで入手可能です。

手順1. Nature Remo E 経由で蓄電残量1 の取得を要求する

POST /1/echonetlite/appliances/$uuid/refresh HTTP/1.1
...
Content-Type:  application/x-www-form-urlencoded
Authorization: Bearer ${アクセストークン}

epc=e2

手順2. 取得できた蓄電池の情報を取得する

　注. ECHONET Lite機器の仕様によってはプロパティの反映に時間がかかり Nature Remo E が値を取得できるまでに時間を要します。最新の情報が取得できているかどうかは、property の updated_at を確認すると参考になります。

GET /1/echonetlite/appliances HTTP/1.1
...
Authorization: Bearer ${アクセストークン}

{
    "appliances": 
        [
            {
                "id": "xxx-xxx-xxx...",
                "nickname": "蓄電池",
                "type": "EL_STORAGE_BATTERY",
                "properties": [
                    {
                        "epc": "cf",
                        "val": "46",
                        "updated_at": "2023-03-24T15:24:03Z"
                    },
                    {
                        "epc": "da",
                        "val": "46",
                        "updated_at": "2023-03-24T15:24:03Z"
                    }
                ],
                "device": {
                    "id": "xxx-xxx-xxx...",
                    "name": "remo-e",
                    "serial_number": "00000000000000",
                    ...
                }
            }
        ]
}

Q. Nature Remo E 追加 API の商用利用は可能ですか？

　商用利用をご検討の場合は、以下Webページのお問い合わせフォームから事前に Nature へご相談ください。商用利用に向けた各種検証については、ぜひこの度公開した API をお試しいただけますと幸いです。

nature.global

Q. API について質問をしたいのですが、お問い合わせ窓口はありますか？

　2023年3月24日時点では API に関するお問い合わせ窓口の用意がない状況です。今後 Nature Remo / Nature Remo E API 利用者向けのコミュニティを開設し、テクニカルサポートを実施することについて検討中です。