Light Profile

目次

API	機能概要
Light Status API	ライトを識別するIDなどを取得する。
Light On API	ライトを点灯する。
Light Off API	ライトを消灯する。
Light Status Change 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
}