Click here for description of English.
DeviceConnect-AndroidはAndroid版のDevice Connectシステムのプラットフォームになります。
ここでは、以下のことについて解説していきます。
- クイックスタート
- プロジェクトの説明
- Device Connectアプリケーションの開発
- Device Connect SDKのJavadoc出力
- ビルドマニュアル
Device Connect システムについての詳細な説明は、こちらを参照してください。
Device Connect Managerをビルドして、簡単に動作させるまでを解説します。
ここでは、以下のコマンドがインストールされていることを前提としています。
- curl
- git
- adb
- Android SDK
git コマンドでソースコードをクローンします。
$ git clone https://github.com/DeviceConnect/DeviceConnect-Android.git
ビルドには、GitHubアカウントとトークンが必要になります。 以下の手順により、プロジェクトでGitHubアカウントとトークンの設定を行ってください。
- GitHubの[Settings] > [Developer settings] > [Personal access tokens] から作成します。
- scopeは
repo、write:packages、read:packagesにチェックを付けて生成してください。 - プロジェクトのルートディレクトリに
github.propertiesというファイルを作成して配置してください。 - github.propertiesにユーザ名とトークンを入力してください。
gpr.usr={ GitHubユーザ名 }
gpr.key={ トークン }
以下のように環境変数を設定することで、github.propertiesの追加を省略することができます。
$ export GPR_USER={ GitHubユーザ名 }
$ export GPR_API_KEY={ トークン }ビルド前にANDROID_SDK_ROOTの環境変数にAndroid SDKへのパスが設定されていることを確認してください。
$ echo 'export ANDROID_SDK_ROOT=<path>' >> ~/.bash_profile
<path>には、AndroidSDKへのパスを指定してください。
Device Connect Managerをビルドしてapkを作成します。
$ cd DeviceConnect-Android/dConnectManager/dConnectManager
$ ./gradlew assembleDebug
Device Connect Managerを端末にインストールします。
$ adb install dconnect-manager-app/build/outputs/apk/debug/dconnect-manager-app-debug.apk
ビルド前にANDROID_HOMEの環境変数にAndroid SDKへのパスが設定されていることを確認してください。
> setx ANDROID_HOME <path>
<path>には、AndroidSDKへのパスを指定してください。
Device Connect Managerをビルドしてapkを作成します。
> cd DeviceConnect-Android/dConnectManager/dConnectManager
> gradlew.bat assembleDebug
Device Connect Managerを端末にインストールします。
> adb install app/build/outputs/apk/app-debug.apk
Android端末のアプリケーション一覧画面から、Device Connect Managerのアイコンをタップして、起動します。
Device Connect Managerの画面が開いたら、メニューバーに存在するスイッチをONに変更し、Device Connect Managerを起動します。
画面にHostが表示されれば、起動したことが確認できます。
Hostが表示されない場合には、サービスを検索ボタンを押下してください。
外部のPCからアクセスしたい場合には、Device Connect Managerの設定画面で外部IPを許可を有効にしてからDevice Connect Managerを再起動します。
IPアドレスをDevice Connect Managerの設定画面で表示されているHostの値に設定して、以下のCURLコマンドを実行します。
curl -X GET \
-H 'Origin: localhost' \
http://192.168.xxx.xxx:4035/gotapi/availability
以下のようなレスポンスが返却されれば、Device Connect Managerが起動していることを確認することができます。
{
"result" : 0,
"product" : "Device Connect Manager",
"version":"v2.1.0
}
| プロジェクト名 | 内容 |
|---|---|
| dConnectDeviceHost | Androidのデバイスプラグイン。 |
| dConnectDeviceLinking | Linkingのデバイスプラグイン。 |
| dConnectDeviceUVC | UVCカメラのデバイスプラグイン。 |
| dConnectDeviceTest | DeviceConnectのテスト用のデバイスプラグイン。 |
| dConnectDevicePluginSDK | DevicePluginを作成するためのSDK。 dConnectSDKForAndroidが必要。 |
| プロジェクト名 | 内容 |
|---|---|
| dConnectManager | DeviceConnectのプラットフォーム本体。 |
| dConnectServer | DeviceConnectのWebサーバのインターフェースを定義したライブラリ。 |
| dConnectServerNanoHttpd | dConnectServerのインターフェースを実装したWebサーバのライブラリ。 |
| プロジェクト名 | 内容 |
|---|---|
| dConnectSDKForAndroid | DeviceConnectのSDK。DevicePlugin開発とアプリ開発用に使用するSDK。 |
Android版Device Connectを使用したアプリケーション開発および、デバイスプラグイン開発に関しましては、以下のページを参考にしてください。
-
アプリケーション開発マニュアル
Device Connect Managerを使用したアプリケーションを開発したい場合には、こちらのアプリケーション開発マニュアルをご参照ください。 -
デバイスプラグイン開発マニュアル
Device Connect Managerに対応したデバイスプラグインを開発したい場合には、こちらのデバイスプラグイン開発マニュアルをご参照ください。
$ cd DeviceConnect-Android/dConnectSDK/dConnectSDKForAndroid
$ ./gradlew generateJavadocForSDK
> cd DeviceConnect-Android/dConnectSDK/dConnectSDKForAndroid
> gradlew.bat generateJavadocForSDK
gradleを実行したディレクトリにDeviceConnectSDK-Javadocが作成され、Device Connect SDKのJavadocが出力されます。
$ cd DeviceConnect-Android/dConnectDevicePlugin/dConnectDevicePluginSDK
$ ./gradlew generateJavadocForPlugin
> cd DeviceConnect-Android/dConnectDevicePlugin/dConnectDevicePluginSDK
> gradlew.bat generateJavadocForPlugin
gradleを実行したディレクトリにDevicePluginSDK-Javadocが作成され、Device Plugin SDKのJavadocが出力されます。
Device Connect Managerや各デバイスプラグインを開発したい人は、こちらのビルド手順書に従ってビルドしてください。