API 入門

本章では、API の基本的な使い方について説明し、FIRERPA の別の活用方法をご紹介します。

FIRERPA は 160 以上のプログラミング用 API インターフェースを提供しており、コマンド実行、システム設定、システム状態、アプリ関連、自動化、プロキシ、ファイルなど、十数カテゴリにわたるインターフェースを通じて、Android デバイスをきめ細かく管理・操作できます。完全な Python ライブラリがパッケージ化されており、すぐに使い始めることができます。始める前に、お使いのスマートフォンで FIRERPA のサーバーが正常に動作しており、FIRERPA のクライアントライブラリ lamda が要件通りにインストールされていることを確認してください。

ヒント

FIRERPA Python クライアントライブラリが提供する API インターフェースの多くは、ネイティブな proto クラスを返します。出力結果の属性から直接フィールド値にアクセスしたり、rpc ディレクトリ内の proto 定義を確認して、異なる結果にどのような属性が含まれているかを把握できます。たとえば、あるインターフェースの戻り値が次のような場合、例のようにして特定のフィールドにアクセスできます。

>>> result = status.get_battery_info()
>>> print (result)
batt_charging: true
batt_percent: 100
batt_temperature: 26.899999618530273
>>> print (result.batt_temperature)
26.899999618530273

デバイスへの接続

デバイスに接続する前に、スマートフォンに接続できる IP アドレスや、FIRERPA 起動時にサーバー証明書を使用したかどうかなど、必要な情報を準備する必要があります。これらの情報が準備できたら、次の手順に進んでください。

デバイスをインスタンス化します。デフォルトでは、アクセス可能な IP アドレスを指定するだけです。

from lamda.client import *
d = Device("192.168.0.2")

FIRERPA サーバー起動時にサービス証明書を有効にした場合やポートを変更する必要がある場合は、次のように接続します。

from lamda.client import *
d = Device("192.168.0.2", certificate="/path/to/lamda.pem", port=65000)

以降、本文中の変数 d は常にこの Device インスタンスを指します。

簡単なウォームアップ

それでは、以下のコードを実行してください。設定アプリが起動します。

d.application('com.android.settings').start()

また、以下のインターフェースを使用すると、デバイスからビープ音を鳴らすことができます。複数のデバイスがある場合、そのデバイスを簡単に特定できます。

d.beep()

これで、基本的な使い方を理解できました。引き続き読み進めて、その他の利用可能なインターフェースについて確認してください。