AirConditioner - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

概要

スマートデバイスが持つエアーコンディショナー機器を操作する機能を提供するAPI。

目次

API 概要
GET /gotapi/airConditioner スマートデバイスの電源状態を取得する。
PUT /gotapi/airConditioner スマートデバイスの電源を点ける。
DELETE /gotapi/airConditioner スマートデバイスの電源を消す。
GET /gotapi/airConditioner/airFlow スマートデバイスの風量設定値を取得する。
PUT /gotapi/airConditioner/airFlow スマートデバイスの風量設定値を設定する。
GET /gotapi/airConditioner/enlProperty スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティの 設定内容を取得する（必須プロパティのみ）。
PUT /gotapi/airConditioner/enlProperty スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティに 設定を行う（必須プロパティのみ）。
GET /gotapi/airConditioner/modeSetting スマートデバイスの運転モード設定を取得する。
PUT /gotapi/airConditioner/modeSetting スマートデバイスの運転モード設定を設定する。
GET /gotapi/airConditioner/powerSaving スマートデバイスの節電動作設定を取得する。
PUT /gotapi/airConditioner/powerSaving スマートデバイスの節電動作設定を設定する。
GET /gotapi/airConditioner/roomTemperature スマートデバイスの室温計測値を取得する。
GET /gotapi/airConditioner/targetTemperature スマートデバイスの温度設定値を取得する。
PUT /gotapi/airConditioner/targetTemperature スマートデバイスの温度設定値を設定する。

GET /gotapi/airConditioner

種別

one-shot

概要

スマートデバイスの電源状態を取得する。

スマートデバイスの電源がONかOFFであるかを返す。状態を取得できない場合はUNKNOWNを返す。

リクエスト

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

レスポンス

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

レスポンスサンプル

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

PUT /gotapi/airConditioner

種別

one-shot

概要

スマートデバイスの電源を点ける。

スマートデバイスの電源をONにする。取得に失敗した場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービス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"
}

DELETE /gotapi/airConditioner

種別

one-shot

概要

スマートデバイスの電源を消す。

スマートデバイスの電源をOFFにした結果を返す。取得に失敗した場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービス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"
}

GET /gotapi/airConditioner/airFlow

種別

one-shot

概要

スマートデバイスの風量設定値を取得する。

スマートデバイスの風量設定値を取得する。失敗した場合はエラーを返す。

リクエスト

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

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
風量設定値 airflow float Yes 0.0〜1.0
風量自動モード設定 airflowauto boolean No true:自動モード有効
false:自動モード無効
※(注1)風量自動モード設定をtrue設定した時のみ省略可。
※(注2) 省略時及びfalse設定時は、「風量設定値」が反映される。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "airflowauto" : "true",
  "airflow" : "0.0"
}

PUT /gotapi/airConditioner/airFlow

種別

one-shot

概要

スマートデバイスの風量設定値を設定する。

スマートデバイスの風量設定値を設定する。失敗した場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス
airflow float No 風量設定値。
0.0〜1.0
airflowauto boolean No 風量自動モード設定。
true : 自動モード有効
false : 自動モード無効

レスポンス

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

GET /gotapi/airConditioner/enlProperty

種別

one-shot

概要

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

※enlproperty:ECHONET Lite Propertyのこと。

リクエスト

物理名 データ型 必須 説明
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/airConditioner/enlProperty

種別

one-shot

概要

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

※enlproperty:ECHONET Lite Propertyのこと。

リクエスト

物理名 データ型 必須 説明
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"
}

GET /gotapi/airConditioner/modeSetting

種別

one-shot

概要

スマートデバイスの運転モード設定を取得する。

スマートデバイスの運転モード設定を取得する。失敗した場合はエラーを返す。

リクエスト

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

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
運転モード設定 modesetting string Yes Automatic:自動
Cooling:冷房
Heating:暖房
Dehumidification:除湿
AirCirculator:送風
Other:その他

レスポンスサンプル

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

PUT /gotapi/airConditioner/modeSetting

種別

one-shot

概要

スマートデバイスの運転モード設定を設定する。

スマートデバイスの運転モード設定を設定する。失敗した場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス
modesetting string Yes 運転モード設定。
Automatic:自動
Cooling:冷房
Heating:暖房
Dehumidification:除湿
AirCirculator:送風
Other:その他

レスポンス

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

GET /gotapi/airConditioner/powerSaving

種別

one-shot

概要

スマートデバイスの節電動作設定を取得する。

スマートデバイスの節電動作設定を取得する。取得に失敗した場合はエラーを返す。

リクエスト

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

レスポンス

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

レスポンスサンプル

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

PUT /gotapi/airConditioner/powerSaving

種別

one-shot

概要

スマートデバイスの節電動作設定を設定する。

スマートデバイスの節電動作設定を設定する。失敗した場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス
powersaving string Yes 節電動作設定。
PowerSaving：節電動作中
Normal：通常動作中
Unknown：不明

レスポンス

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

GET /gotapi/airConditioner/roomTemperature

種別

one-shot

概要

スマートデバイスの室温計測値を取得する。

スマートデバイスの室温計測値を取得する。失敗した場合はエラーを返す。

リクエスト

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

レスポンス

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

レスポンスサンプル

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

GET /gotapi/airConditioner/targetTemperature

種別

one-shot

概要

スマートデバイスの温度設定値を取得する。

スマートデバイスの温度設定値を取得する。失敗した場合はエラーを返す。

リクエスト

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

レスポンス

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

レスポンスサンプル

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

PUT /gotapi/airConditioner/targetTemperature

種別

one-shot

概要

スマートデバイスの温度設定値を設定する。

スマートデバイスの温度設定値を設定する。失敗した場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス
temperature integer Yes 温度設定値。
0〜50 (℃)

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 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"
}
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️