◇はじめに
本記事はRPA(ロボティック・プロセス・オートメーション) Advent Calendar 2023の12日目の記事です。
今回は、iPhoneとSwitchBotデバイスを組み合わせて、iPhoneの充電を80%超えたら停止させるといった処理を自動化させてみました。
◇開発環境等
- 使用バイス:
- iPhoneSE2
- SwitchBot プラグミニ(JP)
- 使用アプリ・ツール:
- Azure Functions
- iPhoneショートカットアプリ
- iPhone App「Scriptable」
◇作成した背景
iPhoneに限らずですが、スマホの過充電・過放電は良くないと言われています。
そのため、iPhoneでもiOS13以降では、「バッテリー充電の最適化」といった機能によってiPhoneがフル充電される時間をできるだけ減らすようにすることができます。
また、iPhone 15では、さらに「上限80%」という項目が追加され、充電を80%で止めることもできるようになったようです。以下の文章は先ほどのサイトからの引用文です。
iPhone 15 モデルの「上限 80%」について
iPhone 15 モデルでは、「バッテリー充電の最適化」「上限 80%」「なし」のいずれかを選択できます。
「上限 80%」を選択した場合、iPhone はバッテリー残量が 80 パーセントになったところで充電を停止します。バッテリーの残量が 75 パーセントを下回ると充電が再開し、再び 80 パーセントになると停止します。「上限 80%」を有効にしている場合も、iPhone はバッテリーの充電状態の推測精度を維持するため、ときどき 100 パーセントまで充電されます。
そこで、今回はiPhone 15以外のモデルで擬似的に同様のことができないか試してみました。
◇実装
構成
まず、iPhoneを充電するコンセントに、SwitchBot社のSwitchBotプラグミニ(JP)を繋ぎます。
- SwitchBotプラグミニ(JP)経由でiPhoneを充電する
- iPhoneの充電が80%を超えると、ショートカットアプリのオートメーションが走る
- オートメーションのフロー内で、iPhoneアプリの「Scriptable」を起動する
- 予め「Scriptable」内で作成しておいた、Azure FunctionsにHTTPリクエストを発行するスクリプトを実行する
- Azure Functionsはリクエストを受け取ると、SwitchBot APIを使用して、SwitchBotプラグミニ(JP)の給電を停止する
といった流れになります。
この後に、詳細を説明していきます。
iPhoneショートカットアプリで、オートメーションを作成する
実際の実装順とは異なりますが、イメージがしやすいように、処理が行われる順序で説明しています。
実装する際は逆から実装していかないと、テストがしにくいので注意ください。
ショートカットアプリは公式サイトには以下のような説明があります。
ショートカットとは
ショートカットは、アプリでの1つまたは複数の作業を素早く完了するための機能です。ショートカットアプリでは、複数の手順を組み合わせた独自のショートカットを作成できます。例えば、海の波情報を取り込み、ビーチまでの所要時間をチェックし、サーフミュージックのプレイリストを再生する、という「サーフタイム」ショートカットを構築できます。
まず、ショートカットアプリを開き、オートメーションを選択します。次に、右上にある➕ボタンをクリックして、新規作成します。オートメーションの種類は、「個人用」と「ホームハブ」の2種類がありますが、今回は個人用を選択します。
次に、オートメーションを実行するトリガを選択します。
「バッテリー残量」を選択し、「80%より上」に設定して「次へ」をクリックします。
トリガ条件を設定したので、次に実行するアクションを入力していきます。
「アクションを追加」を選択後、「Scriptable」アプリを選択します。
※「Scriptable」アプリの実装内容については次の項で説明します。
「Run Script」内で、予め作成しておいたスクリプト(今回は「給電オフ命令」スクリプト)を選択します。今回は、スクリプト実行時のパラメータは特に指定せずに「次へ」をクリックします。
最後に、以下の設定にして完了をクリックします。
「実行の前に尋ねる」項目はオフにしておかないと自動で給電が停止されないため必須ですが、「実行時に通知」項目は好みで選んで問題ないと思います。
- 実行の前に尋ねる:オフ📴
- 実行時に通知:オン🔛
「Scriptable」アプリからAzure FunctionsにHTTPリクエストを発行する
ショートカットアプリから呼び出す「Scriptable」アプリ上にスクリプトを追加していきます。
「Scriptable」アプリは公式ページに以下の記載がひと言で書かれており、iOS上でJavaScriptプログラムを走らせることができる非常に単純明快なアプリです。
Automate iOS using JavaScript
アプリのダウンロードの判断については、自己責任でお願いします。
まず、アプリを立ち上げて、「Scripts」側を選択した状態で右上の➕ボタンをクリックして、新規作成します(左下のキャプチャ画面は既にスクリプトがありますが、これは無視してください)。
なお、今回は使用しませんが、「Gallery」を選択すると、色々なスクリプトサンプルがありますので、これをベースにして、修正していくことも可能です。
➕ボタンをクリックすると、Blank状態の画面が表示されますので、ここにコードを書いていきます。
左下の「📄」ボタンをクリックすると、Documentationを閲覧することもできます。なお、Documentationは、以下のサイトでも閲覧可能です。
iPhone上で直接コーディングするのは現実的ではないため、PCのエディタ上で作ったコードを持ってくるなりすることをお勧めします。
今回、「Scripts」では、Azure FunctionsにHTTPリクエストを発行するスクリプトを作成します。
HTTPリクエストを送るには、左下画像にあるRequest
クラスを使用します。
最低限のコードですが、実装したものを以下に記載します。
url
の部分はこの後説明するAzure Functionsで生成されるURLを入力します。
let url = "**********";
let req = new Request(url);
req.method = 'GET';
let res = req.loadString();
console.log(res);
最後に、スクリプト名をわかりやすい名称に設定して完了です。
前述のショートカットアプリでは、ここで設定したスクリプト名を選択するようにします。
Azure Functionsの作成
Azure Functions上でSwitchBot APIを制御する関数を追加します。
まず、Azure上に環境を構築していきますが、具体的な手順は公式ドキュメントの通りのため、割愛します。
参考とした公式ドキュメントのURLを以下に載せておきます。
なお、今回こちらで作成した環境条件は以下のようになります。
Python
を選んでいますが、自分が使いやすいプログラミング言語で問題ありません。
- 地域:Japan East(東日本)
- OS:Linux
- プログラミング言語:Python(v2)
- ホスティング オプション:従量課金プラン
- テンプレート:HTTP trigger
- 承認レベル:function
実装に当たっては、以前書いたPostmanの記事を参考にしています。
Postman上でSwitchBotデバイスを制御するAPIリクエストを作成した後、コード出力する機能を使って、Python用のコードを出力しています。
コード生成については、Postmanのドキュメントを参照ください。
また、生成されたコードとこちらの記事も参考にしつつ、Azure Functions上に関数を作成しました。
本来であれば、ここに作成したPythonコードを載せるところですが、Advent Calendar 2023に間に合わせるために突貫でプログラミングした関係で、トークンや各種IDをコードに直接埋め込み、HTTPレスポンスが正しく返ってこない不具合などがあるため、コードは後日追記したいと思います😅。
関数の作成が完了すると、Azure上から、関数URLの取得ができるようになるため、前述の「Scriptable」アプリのスクリプト上にそのURLをコピペします。
テスト
最後に、
- ショートカットアプリのオートメーション
- 「Scriptable」アプリのスクリプト
- Azure Functionsの関数
を全て有効化した状態で、実際にSwitchBotプラグミニ経由でiPhoneを充電してみます。
バッテリーが81%に充電された状態で以下の通知が表示され、SwitchBotプラグミニの給電がオフされていることを確認できました。
なお、「オートメーションを実行できませんでした」という通知が出ていますが、これは先ほど書いたように、Azure Functions上のコードが正しい応答を返していないためです。実際には、SwitchBot APIは正しく呼び出せています(後日要修正)。
何度かオートメーションを実行させた後のiPhoneバッテーリ状態のキャプチャ画面になります。赤枠で囲んだ部分がオートメーションを有効化した部分になり、想定通りに動作していることが確認できます。
◇おわりに
とりあえず目的の自動化は行えましたが、他にも色々考慮すべき点があり、今後の課題です。
<今後の課題>
- Azure Functions上の関数が未完成
⏩もう少しAzure Functions学んだら作り直す - SwitchBotプラグミニが給電オフ時にこのオートメーションが動作するとエラーになる
⏩Azure Functions上で現在の状態を取得する処理が必要 - SwitchBotプラグミニ経由で充電していない場合(外出先など)でもオートメーションが動作する
⏩GPSや接続しているWi-Fi情報での判断分岐である程度対応可能?
といった感じです。少しRPAとは離れるかもしれませんが、自動化といえなくはないので、RPA(ロボティック・プロセス・オートメーション) Advent Calendar 2023に掲載させて頂きました。
何かしらの参考になれば幸いです。