RemoteHome Backend

What's this?

家電の操作コマンドをWeb APIとして外部から叩けるようにしたもの

USB赤外線リモコンアドバンスの利用を想定

iOS用GUIアプリケーションはこちら

Setup

依存関係のインストール

$ npm install

ルートディレクトリにconfig.jsonを以下の内容で作成．

• pass：自分で設定するパスワード
• irDataDir：赤外線データの入ったディレクトリ

{
    "passphrase": "12345",
    "irDataDir": "$HOME/Documents"
}

実行 (3000番ポートを使用)

$ node index.js

データの追加

1. プロジェクトルート直下にdataを作成．
2. data内にtargets.jsonを以下のような内容で作成．
   • id: ID
   • name:家電の名前

[
    {
        "id": "light",
        "name": "照明"
    },
    {
        "id": "aircon",
        "name": "エアコン"
    },
    ...
]

3. 上でidとして指定した名前と同じファイル名のjsonファイルに操作を記載する． 例：light.json

[
   {
       "id": "on_off",
       "name" : "点灯/OFF"
   },
   {
       "id": "brightness_up",
       "name" : "明るく"
   },
   ...
]

data_sample以下にサンプルのjsonファイルを置いています．

API一覧

メソッド	パス	内容
GET	/api/v1/list	操作できる家電の一覧
GET	/api/v1/$name	$nameの操作一覧
POST	/api/v1/$name/$op	$opを実行．bodyにpassphraseが必要