プラグイン開発
Android編
ステップ1:プラグイン作成の準備
プラグインの作成に必要なツールおよびファイルを用意します。
GitHubのDeviceConnect Codegenページにアクセスし、スケルトンコード生成ツール(deviceconnect-codegen-project-X.X.X-dist.zip)をダウンロードします。
参考
スケルトンコード生成ツールの詳しい使い方については、上記URLの「リファレンス」以降を参照してください。
「プラグイン開発申請」ページにアクセスし、申請を行います。
プラグインの開発に必要なファイルの提供を行います。
プラグイン開発用の各種ファイルを取得します。
- Device Connect Manager向けプラグイン用SDK
- Device Connect Manager向けプラグイン用テンプレート
API定義ファイルを用意します。
API定義ファイルは、Swagger 2.0に準拠している必要があります。有効なフォーマットは、jsonまたはyaml形式です。
本チュートリアルでは、スケルトンコード生成ツールに含まれる「battery.json(¥samples¥sample-profile-specs¥swagger-files¥battery.json)」を使用する場合を例に説明します。
参考
API設計については、下記ページをご参考ください。
- API設計ガイドライン(https://github.com/DeviceConnect/DeviceConnect-Docs/wiki/Specification-Api-Guidelines)
- Swagger 定義(https://github.com/DeviceConnect/DeviceConnect-Spec/wiki/Swagger-Definitions)
API定義ファイルを作成する際は、Swagger Editor(http://editor.swagger.io/)を利用すると便利です。
手順①~③で取得したファイルを任意のフォルダに解凍し、手順④で作成したAPI定義ファイルと併せて下記の構成で配置します。
(任意のフォルダ) └ deviceconnect-codegen-project-X.X.X … 手順①のスケルトンコード生成ツール ├─ bin ├─ samples ├─ src │ ├─ output … スケルトンコードの出力フォルダを作成(新規作成) │ (空) │ ├─ apiDefs … 手順④のAPI定義ファイルを配置(新規作成) │ (任意の名前).json │ ├─ sdk … 手順③のDevice Connect Manager向けプラグイン用SDKを配置(新規作成) │├ dConnectDevicePluginSDK │├ dConnectSDKForAndroid │├ integratedlog │└ stacktraceutil │ └─ symTemplate … 手順③のDevice Connect Manager向けプラグイン用テンプレートを配置(新規作成) │ gradle.properties.mustache │ README.md.mustache │ ├ gradleFiles ├ java ├ manifest └ resource