《卒FIT》ポータブル電源自動充電システム – EcoFlow開発者プラットフォーム 充電設定変更編

  // ① リクエストURL
  const host = "https://api-e.ecoflow.com";
  const requestUrl = host + "/iot-open/sign/device/quota";

EcoFlow IoT Developer Platform（開発者プラットフォーム）にリクエストするためのURLを定義しています。
開発者プラットフォーム（API）のホスト名はhttps://api-e.ecoflow.comです。
そこに今回取得したいデバイス情報取得のURL:/iot-open/sign/device/quotaを組み合わせて、最終的なURLを作っています。
　https://api-e.ecoflow.com/iot-open/sign/device/quota

  // ② アクセスキー、シークレットキーとシリアルナンバー
  const accessKey = "※開発者プラットフォームで発行したアクセスキー";
  const secretKey = "※開発者プラットフォームで発行したシークレットキー";
  const serialNo = "※ポータブル電源のシリアルナンバー";

EcoFlow IoT Developer Platform（開発者プラットフォーム）から発行した、ご自身のアクセスキーとシークレットキー および ポータブル電源のシリアルナンバーをここに設定してください。

今回はわかりやすいようにアクセスキーとシークレットキー、シリアルナンバーを直接ソースコードに記載していますが、本来はセキュリティを考慮し、ソースコードと別で管理することをお勧めします。
Google Apps Script（GAS）のプロパティサービス等の利用を検討してください。

まだアクセスキーとシークレットキーを発行していないようであれば、以下の記事を参考に発行してください。

《卒FIT》ポータブル電源自動充電システム – EcoFlow開発者プラットフォーム申請編

以下の記事で、私が構築したポータブル電源自動充電システムのシステム構成とメリット・デメリットを紹介しました。今回は、ポータブル電源自動充電システムに必要な EcoFlow IoT Developer Platform（開発者プラットフォーム...

tetokichi.com

2024.09.07

ポータブル電源のシリアルナンバーはスマホアプリから確認するか、開発者プラットフォームからデバイスリストを取得することで確認ができます。

《卒FIT》ポータブル電源自動充電システム – EcoFlow開発者プラットフォーム デバイスリスト取得編

前回の記事では、ポータブル電源自動充電システムに必要な EcoFlow IoT Developer Platform（開発者プラットフォーム）の署名生成について解説しました。 今回からは、作成した署名を利用して実際に開発者プラットフォーム（...

tetokichi.com

2024.09.15

  // ③ nonceとタイムスタンプを生成
  let nonce = String(Math.floor(Math.random() * 900000) + 100000);
  let timestamp = String((new Date).getTime());

③ではnonceとtimestampの作成を行っています。
順に見ていきましょう。

nonceの採番（生成）方法については、必ずしも上記の実装である必要はありません。
ようは6桁数整数文字列が作成できれば良いので、他のやり方でも構いません。

  // ④ リクエストボディー値
  const id = 123;
  const version = "1.0";
  const moduleType = 3;
  const operateType = "acChgCfg";
  let fastChgWatts = 1800;  // X-Stream急速充電の充電スピードを設定
  let slowChgWatts = 400;   // カスタム充電の充電スピードを設定
  let chgPauseFlag = 0;     // AC充電をONにする場合は0、一時停止する場合は1を設定

④では設定変更API(device/quota)を利用してAC充電設定を変更するためのリクエストボディーの値を設定しています。
constで定義している部分は固定値（変更は不要）です。

• fastChgWatts
  　X-Stream急速充電の充電スピードになります。
  　基本的に充電スピードの設定は、低速充電（カスタム充電）に対して行います。
  　こちらの設定値は変更不要となります。
• slowChgWatts
  　低速充電（カスタム充電）の充電スピードになります。
  　こちらの設定を任意の値に変更することで、充電速度の変更が行えます。
  　スマホアプリ上からだと200w～1600wまでの設定範囲となっていますが、
  　APIから設定する場合には範囲外（例えば100wなど）の設定も可能なようです。
• chgPauseFlag
  　充電のON/OFFを切り替えることが出来ます。
  　AC充電をONにする場合は0、一時停止する場合は1を設定します。

基本的に充電スピードの設定は、低速充電（カスタム充電）に対して行います。
以下の画像（ポータブル電源のマニュアル）に従い、充電設定を「カスタム充電」に変更してください。

  // ⑤ 署名用パラメータ
  let signParam = "id=" + id
                + "&moduleType=" + moduleType
                + "&operateType=" + operateType
                + "&params.chgPauseFlag=" + chgPauseFlag
                + "&params.fastChgWatts=" + fastChgWatts
                + "&params.slowChgWatts=" + slowChgWatts
                + "&sn=" + serialNo
                + "&version=" + version
                + "&accessKey=" + accessKey
                + "&nonce=" + nonce
                + "&timestamp=" + timestamp;

⑤では署名生成用のパラメータ文字列を作成しています。
文字列の作成ルールは以下の記事にて紹介しています。

《卒FIT》ポータブル電源自動充電システム – EcoFlow開発者プラットフォーム 署名生成チュートリアル編

前回の記事では、ポータブル電源自動充電システムに必要な EcoFlow IoT Developer Platform（開発者プラットフォーム）への申請とアクセスキーの発行までを紹介しました。 今回は、チュートリアルとして開発者プラットフォー...

tetokichi.com

2024.09.11

  // ⑥ 暗号化して16進文字列に変換
  let signature = Utilities.computeHmacSha256Signature(signParam, secretKey);
  let sign = signature.reduce(function(str,chr){
      chr = (chr < 0 ? chr + 256 : chr).toString(16);
      return str + (chr.length==1?'0':'') + chr;
    },'');

ここでは署名用パラメータを暗号化して、署名（署名値）を作成しています。
以前の記事でも記載していますが、この部分の実装は難解ですので、一旦はお決まりとして「こういうものなんだなー」と思っていただければOKだと思います。

  // ⑦ リクエストヘッダー
  let requestHeaders = {
      'accessKey': accessKey
      ,'timestamp': timestamp
      ,'nonce': nonce
      ,'sign':sign
  }

EcoFlow IoT Developer Platform（開発者プラットフォーム）にリクエストするためのHTTPヘッダーを作成しています。
開発者プラットフォームではHTTPヘッダーに以下を設定してAPIを呼び出すルール（仕様）になっています。

• アクセスキー（accesskey）
• タイムスタンプ（timestamp）
• ナンス／ノンス（nonce）
• 署名（sign）

  // ⑧ リクエストデータ
  let data = {
    "id":id,
    "version":version,
    "sn":serialNo,
    "moduleType":moduleType,
    "operateType":operateType,
    "params":{
      "fastChgWatts":fastChgWatts,
      "slowChgWatts":slowChgWatts,
      "chgPauseFlag":chgPauseFlag
    }
  };
  let payload = JSON.stringify(data);

こちらはAPIへリクエストするためのデータ部の定義になります。
JSONという形式の文字列として定義し、次の「⑨リクエストオプション」の1つとして指定します。

  // ⑨ リクエストオプション
  let requestOptions = {
      "method" : "PUT",
      "contentType": "application/json",
      "headers" : requestHeaders,
      "payload": payload,
      "muteHttpExceptions" : true
  }

こちらはリクエストのオプション設定になります。

• method
  今までの記事で紹介したデバイス情報の取得などと違い、
  設定を変更する場合にはPUTを指定します。
• headers
  ⑦で作成したHTTPヘッダーを指定します。
• payload
  ⑧で作成したリクエストデータを指定します。

他、以下の指定はおまけ程度です（とりあえず無くても動くと思います）

• muteHttpExceptions
  trueを指定することで、HTTPリクエスト時のエラー（例外）を抑制するオプションです。
  ※すべての例外を抑制できるわけではないという事と、例外が発生しないだけでエラー処理が不要になる訳では無い（本来は適切にエラー処理が必要）というところは注意が必要です。

  // ⑩ API実行（開発者プラットフォームへのリクエスト）
  let response = UrlFetchApp.fetch(requestUrl, requestOptions);

ここでは実際にAPI（開発者プラットフォームへのリクエスト）の実行を行っています。
ここまでで作成したリクエストURLとリクエスト用のオプションを指定して、UrlFetchApp.fetch()を呼び出すことで、実際の通信が行われ、結果のレスポンスがresponse（変数）に格納されます。

  // ⑪ 結果（レスポンス）を取得
  let responseCode = response.getResponseCode();
  let responseText = response.getContentText();

ここではHTTPステータスとAPIの実行結果レスポンスをそれぞれ変数に格納しています。

  // ⑫ ログ出力
  Logger.log("responseCode=" + responseCode);
  Logger.log("responseText=" + responseText);

HTTPステータスとAPIの実行結果をログに出力しています。