Skip to content

Light Profile

Jump to bottom
Onuzimoyr edited this page Nov 17, 2015 · 4 revisions

目次

API 機能概要
Light Status API ライトを識別するIDなどを取得する。
Light On API ライトを点灯する。
Light Off API ライトを消灯する。
Light Status Change API ライトのステータスを変更する。
Light Group Status API ライトのグループを識別するIDなどを取得する。
Light Group On API 指定されたライトのグループを点灯する
Light Group Off API 指定されたライトのグループを消灯する。
Light Group Status Change API 指定されたライトのグループの色を指定する。
Light Group Create API ライトのグループを作成する。
Light Group Clear API ライトのグループを削除する。

機能概要

スマートデバイスのライト機能を提供するAPI。

参考API

なし

Light Status API

インターフェース名称 Version 種別
Light Status API 2.0.0 同期I/F

概要

ライトを識別するIDなどを取得するAPI。 スマートデバイスが認識しているライトデバイスの一覧を取得する。 取得できる情報には、ライトの識別子、ライトの名前と状態を持つ。

リクエスト

HTTPメソッド URI
GET /gotapi/light
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
ライト一覧 lights array - ライト一覧を格納する配列。
ライトID lightId string - ライトを識別するID。
ライト名 name string - ライト名。
ライトの点灯状態 on boolean - ライトの点灯状態を示す。
true: 点灯
false: 消灯
コンフィグ config string - ライトに設定がある場合には、ここに文字列としてデータが格納されている。

リクエストサンプル

GET  http://localhost:4035/gotapi/light?servieId=localhost.dconnect.com&accessToken=xxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "lights":[
        {
            "lightId":"0",
            "name":"LightLamp1",
            "on":true,
            "config":""
        },
        {
            "lightId":"1",
            "name":"LightLamp2",
            "online":false,
            "config":""
        }
    ]
}

Light On API

インターフェース名称 Version 種別
Light On API 2.0.0 同期I/F

概要

スマートデバイスが持つライトを点灯する。

リクエスト

HTTPメソッド URI
POST /gotapi/light
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 対象スマートデバイス
ライトID lightId string - 対象ライト
ライトの明るさ brightness string ○ ライトの明るさを0.0-1.0で表す。
ライトの色 color string ○ RGB形式の16進数で指定。
ライトの点滅間隔 flashing string ○ 点滅間隔をカンマ区切りの msecで点灯、消灯を繰り返し指定できる。このパラメータを指定しなかった場合は、 常時点灯。

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

POST http://localhost:4035/gotapi/light
POSTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&lightId=1&color=FF0000

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}

Light Off API

インターフェース名称 Version 種別
Light Off API 2.0.0 同期I/F

概要

スマートデバイスが持つライトを消灯する。

リクエスト

HTTPメソッド URI
DELETE /gotapi/light
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス
ライトID lightId string - 対象ライト

レスポンス

論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

DELETE http://localhost:4035/gotapi/light?serviceId=localhost.deviceconnect.org&accessToken=xxxxx&lightId=1

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}

Light Status Change API

インターフェース名称 Version 種別
Light Status Change API 2.0.0 同期I/F

概要

スマートデバイスが持つライトのステータスを変更する。 ライトの色、明るさ及び、名前の変更ができる。

リクエスト

HTTPメソッド URI
PUT /gotapi/light
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 対象スマートデバイス
ライトID lightId string - 対象ライト
ライト名 name string - ライト名
ライトの明るさ brightness string ○ ライトの明るさを0.0-1.0で表す。
ライトの色 color string ○ RGB形式の16進数で指定。
ライトの点滅間隔 flashing string ○ 点滅間隔をカンマ区切りの msecで点灯、消灯を繰り返し指定できる。このパラメータを指定しなかった場合は、 常時点灯。

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT http://localhost:4035/gotapi/light
PUTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&lightId=1&name=living%20room%20lamp1

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}

Light Group Status API

インターフェース名称 Version 種別
Light Group Status API 2.0.0 同期I/F

概要

ライトのグループを識別するIDなどを取得するAPI。 スマートデバイスが認識しているライトグループの一覧を取得する。 取得できる情報には、ライトグループの識別子と名前、ライトグループの情報。

リクエスト

HTTPメソッド URI
GET /gotapi/light/group
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200 
<td>ライトグループ一覧</td>
<td colspan="3" text-align="center">lightGroups</td>
<td>array</td>
<td>-</td>
<td>ライトグループ一覧を格納する配列</td>

<td >ライトグループID</td>
<td rowspan="8"></td>
<td colspan="2">groupId</td>
<td>string</td>
<td>-</td>
<td>ライトグループを示すID</td>

<td >ライトグループ名</td>
<td colspan="2">name</td>
<td>string</td>
<td>-</td>
<td>ライトグループ名</td>

<td >追加されているライトの一覧</td>
<td colspan="2">lights</td>
<td>array</td>
<td>○</td>
<td>ライトグループに追加されているライトの配列</td>

<td>ライトID</td>
<td rowspan="4"></td>
<td >lightId</td>
<td>string</td>
<td>○</td>
<td>ライトを示すID</td>

<td>ライト名</td>
<td >name</td>
<td>string</td>
<td>○</td>
<td>ライト名</td>

<td>ライト点灯状態</td>
<td >on</td>
<td>boolean</td>
<td>○</td>
<td>ライトの点灯状態を示す<br>true: 点灯<br>false: 消灯</td>

<td>ライトコンフィグ</td>
<td >config</td>
<td>string</td>
<td>○</td>
<td>ライトに設定がある場合には、ここに文字列としてデータが格納されている</td>
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
ライトグループコンフィグ config string ○ ライトグループに設定がある場合には、ここに文字列としてデータが格納されている

リクエストサンプル

GET  http://localhost:4035/gotapi/light/group?servieId=localhost.dconnect.com&accessToken=xxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "lightGroups":[
    	{
	    	"groupId":"0",
	    	"name":"living room",
	    	"lights":[
		        {
		            "lightId":"0",
		            "name":"LightLamp1",
		            "on":true,
		            "config":""
		        },
		        {
		            "lightId":"1",
		            "name":"LightLamp2",
		            "online":false,
		            "config":""
		        }
		   ],
		   "config":""
		},
    	{
	    	"groupId":"1",
	    	"name":"bed room",
	    	"lights":[
		        {
		            "lightId":"2",
		            "name":"LightLamp3",
		            "on":false,
		            "config":""
		        },
		        {
		            "lightId":"3",
		            "name":"LightLamp4",
		            "online":false,
		            "config":""
		        }
		   ],
		   "config":""
		},

    ]
}

Light Group On API

インターフェース名称 Version 種別
Light Group On API 2.0.0 同期I/F

概要

スマートデバイスが持つライトグループを点灯する。

リクエスト

HTTPメソッド URI
POST /gotapi/light/group
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 対象スマートデバイス
ライトグループID groupId string - 対象ライトグループ
ライトグループの明るさ brightness string ○ ライトの明るさを0.0-1.0で表す。
ライトグループの色 color string ○ RGB形式の16進数で指定。
ライトグループの点滅間隔 flashing string ○ 点滅間隔をカンマ区切りの msecで点灯、消灯を繰り返し指定できる。このパラメータを指定しなかった場合は、 常時点灯。

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

POST http://localhost:4035/gotapi/light/group
POSTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&groupId=1&color=FF0000

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}

Light Group Off API

インターフェース名称 Version 種別
Light Group Off API 2.0.0 同期I/F

概要

スマートデバイスが持つライトグループを消灯する。

リクエスト

HTTPメソッド URI
DELETE /gotapi/light/group
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス
ライトグループID groupId string - 対象ライトグループ

レスポンス

論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

DELETE http://localhost:4035/gotapi/light/group?serviceId=localhost.deviceconnect.org&accessToken=xxxxx&groupId=1

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}

Light Group Status Change API

インターフェース名称 Version 種別
Light Group Status Change API 2.0.0 同期I/F

概要

スマートデバイスが持つライトグループのステータスを変更する。 ライトの色、明るさ及び、名前の変更ができる。

リクエスト

HTTPメソッド URI
PUT /gotapi/light/group
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 対象スマートデバイス
ライトグループID groupId string - 対象ライトグループ
ライトグループ名 name string - ライトグループ名
ライトグループの明るさ brightness string ○ ライトの明るさを0.0-1.0で表す。
ライトグループの色 color string ○ RGB形式の16進数で指定。
ライトグループの点滅間隔 flashing string ○ 点滅間隔をカンマ区切りの msecで点灯、消灯を繰り返し指定できる。このパラメータを指定しなかった場合は、 常時点灯。

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT http://localhost:4035/gotapi/light/group
PUTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&groupId=1&name=living%20room

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}

Light Group Create API

インターフェース名称 Version 種別
Light Group Create API 2.0.0 同期I/F

概要

スマートデバイスが持つライトのグループを作成する。

リクエスト

HTTPメソッド URI
POST /gotapi/light/group/create
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 対象スマートデバイス
ライトID lightIds string - 追加するライトのIDをカンマ区切りで追加する。
例)
1,2,3
ライトグループ名 groupName string - ライトグループの名前。

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
ライトグループID groupId string - ライトグループのID

リクエストサンプル

POST http://localhost:4035/gotapi/light/group/create
POSTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&groupId=1&color=FF0000

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}

Light Group Clear API

インターフェース名称 Version 種別
Light Group Clear API 2.0.0 同期I/F

概要

スマートデバイスが持つライトで作成したグループを削除する。

リクエスト

HTTPメソッド URI
DELETE /gotapi/light/group/clear
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス
ライトグループID groupId string - 対象ライトグループ

レスポンス

論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

DELETE http://localhost:4035/gotapi/light/group/clear?serviceId=localhost.deviceconnect.org&accessToken=xxxxx&groupId=1

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}
  1. アプリケーション開発マニュアル
  2. 単体テスト動作マニュアル

Clone this wiki locally