Api

株式会社ソニーコンピュータサイエンス研究所
Kadecot API概要
大和田茂
http://kadecot.net/webapi

株式会社ソニーコンピュータサイエンス研究所株式会社ソニーコンピュータサイエンス研究所
概要
• AndroidアプリKadecot (http://kadecot.net)
のWebAPIについて解説します。
ECHONET Lite家電機器やセンサー、ソニー製機器、
Hue、IRKitなどをブラウザからJavaScriptで制御可能
Google PlayからダウンロードしAndroidで動作
オープンソースの無料ソフトウェア
標準提供以外のプロトコルも、プラグインとして外部から
追加可能
基本機能
● 接続機器一覧取得
● 機器へのコマンド送信
● 機器の状態取得
● 機器の変化通知
APIサーバー
Kadecot
（カデコ）

WebAPIとは？
• あるWebサービスの機能を他のWebサービス
などから利用するためのアクセスポイント
• 多くはJavaScriptから簡単に利用できるように
作られている
Google Maps API 楽天API

家電にもAPIがある
• Roomba, Hue, スマート体重計など
• 東芝・パナソニック・シャープなど各社ネット
対応家電
• iRemocon・IRKitなど
問題① 各社ばらばらの体系で協調動作させづらい

ブラウザから家電ネットワークには
直接アクセスできないことが多い
Web SSDP
ECHONET Lite
HTTP UDP/TCP
プロトコルが違う
問題② Webアプリとの連携がしづらいものもある
※Webベースのものも増えてきてます

Kadecotの提供する機能
WebAPI
アクセス仲介用
Webサーバ
Web
HTTP
SSDP
ECHONET Lite
UDP/TCP
様々なプロトコルをまとめてWebに提供する仲介サーバ

KadecotのWeb APIは二種類
• JSONP API
– 簡単
– 低速（アクセスごとに接続切断）
– セキュリティなし
– 機器からの通知は受け取れない（要ポーリング）
• WebSocket API
– WebSocket接続が必要
– 高速（常時接続）
– 認証あり
– 機器からの通知を非同期に受けとれる

WAMPメッセージング概要
RPC パターン
• 機器に操作コマンドや情報
リクエストを送るとサーバか
ら返答が返ってくるというも
の
• 普通の関数呼び出しに近い
PubSub パターン
• サーバが任意のタイミングで
情報を出力
• あらかじめ購読登録しておい
た機器に情報が伝達される
Webアプリ
Kadecot
Server
呼び出し
返答
Webアプリ
Kadecot
Server
購読
通知
（タイミングは
サーバ側が決
める）

WebSocket APIの使い方 [初期化]
<script src="http://g.lifedesign-app.org/js/kadecot.js"></script>
<script>
kadecot_init(
"com.sonycsl.kadecot"
, function( devs , wamp ){
// [ここに必要な処理を実装する]
}
, function(){
alert("Disconnected") ;
} ) ;
</script>
このWebページのURL引数として k=[Kadecot IP address]とすると、Kadecotや
μKadecotに直接接続を試みる。
URL引数kがない場合は、エミュレータが立ち上がる。
スコープという文字列。いつも同じです
接続成功時に呼ばれるコールバック
デバイスの一覧今後のメッセージ送受信に用いるwampオブジェクト
接続切断時に呼ばれるコールバック

機器一覧の例
[
{
"deviceId": 1,
"protocol": "echonetlite",
"deviceType": "GeneralLighting",
"status": true,
"nickname": "GeneralLighting",
"description": "GeneralLighting",
"ip_addr": "192.168.10.209"
},
{
"deviceId": 6,
"protocol": "echonetlite",
"deviceType": "HomeAirConditioner",
"status": true,
"nickname": "HomeAirConditioner",
"description": "HomeAirConditioner",
"ip_addr": "192.168.10.205"
}
]
デバイスID （ Kadecotサーバーがつける番号
プロトコル（ ≒プラグインID
説明文（何が来るかわからない）
ニックネーム（Kadecotサーバ上で任意につけた名前
機器の種類名（プロトコル内
認識されているかどうか
プロトコル固有の情報
・機器の特定は、deviceIdで行う。
・機器の種類の特定は、protocolとdeviceTypeで行う

WebSocket APIの使い方 [RPC]
// hueを点灯させるコード例
wamp.sendCall(
{"deviceId":1}
,"com.sonycsl.kadecot.hue.procedure.lights.state.set"
,[]
, {"on":true,"sat":255,"bri":0,"hue":46920}
,function(){}
);
wamp.sendCall()という関数呼び出しを使う
↑ 「プロシージャ」と呼ばれる文字列。関数名に相当
（コールバック関数。この例では使用しない）
←操作対象デバイスID
←パラメータ
wamp.sendCall( デバイスID , プロシージャ , [] , パラメータ , コールバック ) ;

WebSocket APIの使い方[PubSub]
• 関心がある対象（トピックと呼ぶ）を指定し、コールバック関数を設定するだけでOK
• PubSub非対応機器もある（トピックが存在しない）
• トピックは機器ごとに設定されているわけではなく、同じ種類の機器全てからコール
バックを受け取ってしまうので、自分が興味のある機器からのメッセージかを判別す
る必要がある
wamp.sendSubscribe(
{}
,"com.sonycsl.kadecot.echonetlite.topic.HomeAirConditioner.OperationStatus"
,function(r){
console.log('Value changed :’+JSON.stringify(r));
if( r[4].deviceId != 1 ) return ;
}
,function(){
console.log('Subscribed : '+JSON.stringify(arguments));
}
;
// ↓「トピック」
// コールバック１：機器が値をPublishしたときに呼ばれる（都度
// コールバック２：sendSubscribeが成功したとき一度だけ呼ばれる
// 興味がない機器を除外
wamp.sendSubscribe() を用いる

参考文献1
JSON/WAMP RPCで使用可能なプロシージャ+引数と、
WAMP PubSubで使用可能なECHONET Liteのトピックの
データベースです。
(現在PubSubが実装されているのはECHONET Lite
のみです）
http://app.kadecot.net/docs/ProcTopic/

参考文献２
• Procedureに書ける文字列に
ついては、API Toolを使って
確認できる
– Kadecotのデバイス一覧画面
右下にあるAppsボタンを押す
と、アプリの一つとして表示さ
れる
– Kadecotが認識した実機器の
情報のみ表示される。対応機
器をお持ちでない方はエミュ
レータを使用してください
• KadecotのIPアドレスが必要
だが以下のURLでもアクセス
可能
http://g.lifedesign-app.org/Apps/APITool/?k=[Kadecot IP]

参考文献３：オープンソース
• KadecotCore + ECHONET Lite Plugin (MITライセンス)
– Kadecotのソースコード
• OpenECHO for Java / C++ （MITライセンス）
– ECHONET Lite用クラスライブラリ（ミドルウェア）
• ECHONET Lite - Object Database （CC0：パブリックドメイン）
– CSV版ECHONET Lite機器データベース
– OpenECHOの生成に利用
– Release C
• MoekadenRoom （MITライセンス）
– PC用のECHONET Liteエミュレータ
– http://kadecot.net/blog/1479/
https://github.com/SonyCSL/から公開中！

Thank you
http://kadecot.net/
@kadecot_dev

support.main機器Procedure
com.sonycsl.kadecot.support.procedure.setLux
com.sonycsl.kadecot.support.procedure.setHue
com.sonycsl.kadecot.support.procedure.setSaturation
com.sonycsl.kadecot.support.procedure.setTemperature
※set系は、新しい値をvalueにセットする。
com.sonycsl.kadecot.support.procedure.getLux
com.sonycsl.kadecot.support.procedure.getHue
com.sonycsl.kadecot.support.procedure.getSaturation
com.sonycsl.kadecot.support.procedure.getTemperature
com.sonycsl.kadecot.support.procedure.getPower
com.sonycsl.kadecot.support.procedure.getPowerHistory
※引数としてdayを与えてもよい。-1から-99まで。

support.main機器Topics
com.sonycsl.kadecot.support.topic.power
com.sonycsl.kadecot.support.topic.powerHistory
com.sonycsl.kadecot.support.topic.lux
com.sonycsl.kadecot.support.topic.hue
com.sonycsl.kadecot.support.topic.saturation
com.sonycsl.kadecot.support.topic.temperature

よくつかうECHONET系の値

KadecotのWeb API
• JSONP API
– 簡単
– 低速（アクセスごとに接続切断）
– 機器からの非同期通知は受け取れない（要ポーリング）
• WebSocket API
– 高速（常時接続）
– 機器からの通知を非同期に受けとれる
– WAMPなどの前提知識が必要

JSONP API
• JSONP : JSON with Paddingの略。
– クロスドメイン問題（後述）がない<script>タグを
用いてHTTPベースで機能の呼び出しを行う手法
– ブラウザのURLフィールドにコマンドを打ち込んで使える
• Kadecotの設定画面から、「開発者モード」にチェックを入れ
ることで使用可能になる
• セキュリティは何もなく、制約なくすべての機能が使える
⇒使用時には十分注意が必要。つけっぱなしにして忘れた
りするとかなり危険
• 後述WAMPのRPC機能のみ利用

ブラウザで家電を動かせる
• List
http://[Kadecot IP]:31413/jsonp/v1/devices/
• Set
http://[KadecotIP]:31413/jsonp/v1/devices/[Device ID]
?procedure=set
&params={"propertyName":“OperationStatus","propertyValue":[0x30]}
• Get
http://[KadecotIP]:31413/jsonp/v1/devices/[Device ID]
?procedure=get
&params={"propertyName":“OperationStatus"}
http://kadecot.net/blog/1633/
※Device IDはKadecotの機器アイコンに表示されています。
※procedureがSetとGetだけなのはECHONET Liteだけ

WebSocket API
• ブラウザから使えるソケットである
WebSocketを使ったインターフェース
– WebSocket: 通常のソケット＋ハンドシェイク
• ハンドシェイクが終了すれば普通のソケット
• さらに上位のプロトコル（サブプロトコル）
としてWAMP (The Web Application
Messaging Protocol)を使用
– WAMP: Webアプリ間の情報の授受方式を
定めたもの
– http://wamp.ws
UDP
WebSocket
WAMP
Kadecot
WebSock
API

Api

Recommandé

Recommandé

Contenu connexe

Similaire à Api

Similaire à Api (20)

Plus de sonycsl

Plus de sonycsl (20)

Dernier

Dernier (9)

Api