EchonetLite

概要

スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティ の設定内容を操作する。

目次

API	概要
GET /gotapi/echonetLite/property	スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティ の設定内容を取得する。
PUT /gotapi/echonetLite/property	スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティ に設定を行う。

GET /gotapi/echonetLite/property

種別

one-shot

概要

スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティ の設定内容を取得する。

EPC:ECHONET Property Code

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
epc	array(string)	Yes	取得プロパティのEPC。 取得するプロパティのEPCをカンマ区切りで列挙。 10進または16進(0xXX)の値

レスポンス

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

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "properties" : [ {
    "epc" : "OperationStatus",
    "value" : "49"
  }, {
    "epc" : "InstallationLocation",
    "value" : "0"
  } ]
}

PUT /gotapi/echonetLite/property

種別

one-shot

概要

スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティ に設定を行う。

EPC:ECHONET Property Code

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
epc	string	Yes	EPC。 ECHONET Property Code
value	string	Yes	EPCの設定値。

レスポンス

論理名	物理名	データ型	必須	説明
処理結果	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",
  "epc" : "OperationStatus",
  "value" : "49"
}