GotAPI-Kadecot plugin Technical Manual

株式会社ソニーコンピュータサイエンス研究所

GotAPI×Kadecot Plugin Technical Manual

大和田茂


×


概要

• GotAPIとKadecotの乗り入れを可能にするプラグインの解説 – GotAPI:OMA準拠のIoT向けWebAPIプロトコル仕様

– GotAPI⇒Kadecotと、Kadecot⇒GotAPIの相互呼び出しが可能になる予定（現在は前者のみ）

• GotAPI対応機器はウェアラブル機器が中心、Kadecotは家電中心なので、組み合わせることで対応機器の網羅度が一気に広がる (2015/7現在)

GotAPI : http://device-webapi.org/ Kadecot : http://kadecot.net/

http://device-webapi.org/



http://kadecot.net/


インストール

• GotAPIのサーバーアプリとKadecotを、同一のAndroid端末内にインストールする（どちらもGoogle Playで取得可能） – GotAPIサーバの例： GClue社「 Device Web API Manager 」

https://play.google.com/store/apps/details?id=org.deviceconnect.android.manager

– Kadecotはこちら： https://play.google.com/store/apps/details?id=com.sonycsl.Kadecot

• Kadecotで機器発見を行い、右上ボタンの設定から「開発者モードを有効にする」にチェックを入れる

http://kadecot.net/install/



https://play.google.com/store/apps/details?id=com.sonycsl.Kadecot

https://play.google.com/store/apps/details?id=com.sonycsl.Kadecot

http://kadecot.net/install/


GotAPI ⇒ Kadecot

GotAPIを使ってKadecotの機能を呼び出す方法についての解説


まずKadecot JSONP APIの理解を

• Kadecotでは、機器ごとに通し番号(deviceId)を割り当てている。

• Kadecotのプラグインの種類に応じて、protocolがいろいろある。(eg. echonetlite, sonytv, iremoconなど）

– プロトコル＝プラグインという理解でほぼ合っている

– 機器制御用のパラメータの形式は、JSONだということ以外は特に決めておらず、プロトコルごとに自由に決めている

• 各プラグインは、おおまかな機能のまとまりとして、procedureというものを提供している。

– 例えばECHONET Liteであればsetやget

• 機能の呼び出しは、deviceId + procedure + パラメータで行う

– プロトコルは明示的に呼び出しには出てこないが、存在しないprocedureを呼び出すとエラーが返される。

http://kadecot.net/blog/2750/ http://app.kadecot.net/docs/ProcTopic/

http://kadecot.net/blog/2750/

http://app.kadecot.net/docs/ProcTopic/


GotAPIとの対応

• Profile名は「kadecot」

• ServiceId = deviceId ※WebAPIからは、末尾にプラグインを表すハッシュ値が付与される

• Interface = protocol （省略可能）

• Attribute = procedure

• param = パラメータ (HTTPの引数）


Kadecotプロトコル情報

• KadecotのProcedureは実際には長い文字列。 – 例：com.sonycsl.kadecot.echonetlite.procedure.set – ピリオドで区切られている。

• 最後の単語がGotAPIで用いるprocedure • 最後から３番目の単語がGotAPIで用いるinterface

• ArgumentsKwが、GotAPIでのparamパラメータそのものとなる

• ECHONET Liteの表

(http://app.kadecot.net/docs/ProcTopic/echo_devices.html)にある「DEVICE_NAME」は、GotAPIの呼び出しには使わない。

http://app.kadecot.net/docs/ProcTopic/の表の中から、「Procedure」と「 ArgumentsKw 」を探す。



呼び出し例

• 照明をON

• エアコンを25℃に設定

※[ServerIP], [ServiceID]は適宜読み替えてください。 ※API使用前にサービスごと（Kadecotが発見している機器ごと）の認証が必要です。 https://github.com/DeviceConnect/DeviceConnect-JS などを参照してください。

http://[ServerIP]:4035/gotapi/kadecot/echonetlite/set/ ?params={“propertyName”:”OperationStatus”,”propertyValue”:[48]} &serviceId=[ServiceID]

http://[ServerIP]:4035/gotapi/kadecot/echonetlite/set/ ?params={“propertyName”:” SetTemperatureValue” ,”propertyValue”:[25]} &serviceId=[ServiceID]

https://github.com/DeviceConnect/DeviceConnect-JS




Kadecot ⇒ GotAPI

まだ不完全である


現状

• GotAPIのサーバーが起動しているときには「GotAPI」という機器が機器一覧に表示される。

– GotAPIのプラグイン認証に同意することが必要

• GotAPI配下のサービス（機器）が存在しているときも、Kadecot上では機器として表示される。

• それぞれ、Plug-in settingsからGotAPIのメイン画面を表示することができる。

• しかし、個別サービスへのコマンド送信はまだできない


その他開発情報


情報

• プラグインのソースはMITライセンスにてGitHubから公開済

• Kadecot JSONP API情報

• Kadecot Procedureリスト

• DevicePlugin Manual

https://github.com/SonyCSL/GotAPIPlugin



https://github.com/DeviceConnect/DeviceConnect-Android/wiki/1.2.2.DevicePlugin-Manual

https://github.com/SonyCSL/GotAPIPlugin









参考：ECHONET Liteとは


概要

• 国内白物家電の最も一般的なプロトコル – エアコン・照明・エコキュート・分電盤はじめ100種類以上の機器オブジェクトが規定されている。センサーも充実。最近は黒物家電も登場。

– メーカーをまたいだ相互接続性も実用的なレベル – OSI5層以上の規定だが、トランスポート（４層）のガイドラインは決まっており、IPv4のUDP実装が最も普及

• スマートメーター関連でも使用することが決定

– IPv6, Wi-SUNを用いる – デマンドレスポンス（ユーザーによる電力制御）関連オブジェクトも最近決定

• KadecotではすべてのECHONET Lite対応機器が扱える

エコーネットコンソーシアム http://www.echonet.gr.jp

http://www.echonet.gr.jp/


ECHONET Lite機器オブジェクト

ECHONET 機器オブジェクト詳細規定 Release Gより (2015年5月29日）

全103機器が規定済

※コンソ会員企業からのリクエストに応じて増やしている

※規定があっても作っているメーカーがあるとはらない




センサー４４種




空調機器１０種




住設機器３１種




調理・家事関連機器１０種




健康関連機器１種




DR・コントローラ機器３種




AV機器４種


Thank you

Technology

GotAPI-Kadecot plugin Technical Manual