Light - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

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

API	概要
GET /gotapi/light	ライトを識別するIDなどを取得するAPI。
POST /gotapi/light	ライトを点灯するAPI。
PUT /gotapi/light	ライトのステータスを変更するAPI。
DELETE /gotapi/light	ライトを消灯するAPI。

one-shot

ライトを識別するIDなどを取得するAPI。

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

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス

論理名		物理名	データ型	必須	説明
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ライト一覧		lights	array(object)	Yes	ライト一覧を格納する配列。
	ライトID	lightId	string	Yes	ライトを識別するID。
	ライト名	name	string	Yes	ライト名。
	ライトの点灯状態	on	boolean	Yes	ライトの点灯状態を示す。 点灯 : true 消灯 : false
	コンフィグ	config	string	Yes	ライトに設定がある場合には、ここに文字列としてデータが格納されている。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "lights" : [ {
    "config" : "Bridge-1",
    "on" : false,
    "name" : "Example Light 1",
    "lightId" : "0"
  }, {
    "config" : "Bridge-1",
    "on" : true,
    "name" : "Example Light 2",
    "lightId" : "1"
  } ]
}

one-shot

ライトを点灯するAPI。

点灯するライトは、GET/serviceDiscoveryあるいはGET/lightで取得したもの。 lightIdが省略された場合は、GET/lightで一番最初に見つかるライトを点灯する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
lightId	string	No	ライトID。操作の対象となるライト。 省略された場合、デフォルトのライトが選択される。
brightness	float	No	ライトの明るさ。ライトの明るさを0.0-1.0で表す。
color	string	No	ライトの色。RGB形式の16進数で指定。
flashing	array(long)	No	ライトの点滅間隔。 点滅間隔をカンマ区切りのmsecで点灯、消灯を繰り返し指定できる。 このパラメータを指定しなかった場合は、 常時点灯。

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

one-shot

ライトのステータスを変更するAPI。

ライトの色、明るさ及び、名前の変更ができる。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
lightId	string	No	ライトID。操作の対象となるライト。 省略された場合、デフォルトのライトが選択される。
name	string	Yes	ライト名。
brightness	float	No	ライトの明るさ。ライトの明るさを0.0-1.0で表す。
color	string	No	ライトの色。RGB形式の16進数で指定。
flashing	array(long)	No	ライトの点滅間隔。 点滅間隔をカンマ区切りのmsecで点灯、消灯を繰り返し指定できる。 このパラメータを指定しなかった場合は、 常時点灯。

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

one-shot

ライトを消灯するAPI。

消灯するライトは、GET/serviceDiscoveryあるいはGET/lightで取得したもの。 lightIdが省略された場合は、GET/lightで一番最初に見つかるライトを消灯する。

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
lightId	string	No	ライトID。操作の対象となるライト。 省略された場合、デフォルトのライトが選択される。

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}