Skip to content

AirConditioner Profile

Akira-Sasaki edited this page Oct 6, 2015 · 4 revisions

目次

API 機能概要
AirConditioner Get Power Status API スマートデバイスの電源状態を取得する。
AirConditioner Power On API スマートデバイスの電源を付ける。
AirConditioner Power Off API スマートデバイスの電源を消す。
AirConditioner Get Operation Power Saving API スマートデバイスの節電動作設定を取得する。
AirConditioner Set Operation Power Saving API スマートデバイスの節電動作設定を設定する。
AirConditioner Get Operation Mode Setting API スマートデバイスの運転モード設定を取得する。
AirConditioner Set Operation Mode Setting API スマートデバイスの運転モード設定を設定する。
AirConditioner Get Room Temperature API スマートデバイスの室温計測値を取得する。
AirConditioner Get Temperature Value API スマートデバイスの温度設定値を取得する。
AirConditioner Set Temperature Value API スマートデバイスの温度設定値を設定する。
AirConditioner Get Air Flow Value API スマートデバイスの風量設定値を取得する。
AirConditioner Set Air Flow Value API スマートデバイスの風量設定値を設定する。
AirConditioner Get ECHONET Lite Property API スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティの設定内容を取得する。(必須プロパティのみ)
AirConditioner Set ECHONET Lite Property API スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティに設定を行う。(必須プロパティのみ)

機能概要

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

参考API

なし

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

概要

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

リクエスト

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

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
電源状態 powerstate string - ON:電源オン
OFF:電源オフ
UNKNOWN:不明

リクエストサンプル

GET http://localhost:4035/gotapi/airconditioner&serviceId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0,
    "powerstate":"ON"
}
インターフェース名称 Version 種別
AirConditioner Power On API 2.0.0 同期I/F

概要

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

リクエスト

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

レスポンス

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

リクエストサンプル

PUT  http://localhost:4035/gotapi/airconditioner
PUTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0
}
インターフェース名称 Version 種別
AirConditioner Power Off API 2.0.0 同期I/F

概要

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

リクエスト

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

レスポンス

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

リクエストサンプル

DELETE  http://localhost:4035/gotapi/airconditioner
DELETEデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0
}
インターフェース名称 Version 種別
AirConditioner Get Operation Power Saving API 2.0.0 同期I/F

概要

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

リクエスト

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

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
節電動作設定 operationpowersaving string - PowerSaving:節電動作中
Normal:通常動作中
Unknown:不明

リクエストサンプル

GET http://localhost:4035/gotapi/airconditioner/operationpowersaving&serviceId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0,
    "operationpowersaving":"PowerSaving"
}
インターフェース名称 Version 種別
AirConditioner Set Operation Power Saving API 2.0.0 同期I/F

概要

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

リクエスト

HTTPメソッド URI
PUT /gotapi/airconditioner/operationpowersaving
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
節電動作設定 operationpowersaving string - PowerSaving:節電動作中
Normal:通常動作中

レスポンス

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

リクエストサンプル

PUT  http://localhost:4035/gotapi/airconditioner/operationpowersaving
PUTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&operationpowersaving=PowerSaving

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0
}
インターフェース名称 Version 種別
AirConditioner Get Operation Mode Setting API 2.0.0 同期I/F

概要

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

リクエスト

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

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
運転モード設定 operationmodesetting string - Automatic:自動
Cooling:冷房
Heating:暖房
Dehumidification:除湿
AirCirculator:送風
Other:その他

リクエストサンプル

GET http://localhost:4035/gotapi/airconditioner/operationmodesetting&serviceId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0,
    "operationmodesetting":"PowerSaving"
}
インターフェース名称 Version 種別
AirConditioner Set Operation Mode Setting API 2.0.0 同期I/F

概要

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

リクエスト

HTTPメソッド URI
PUT /gotapi/airconditioner/operationmodesetting
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
運転モード設定 operationmodesetting string - Automatic:自動
Cooling:冷房
Heating:暖房
Dehumidification:除湿
AirCirculator:送風
Other:その他

レスポンス

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

リクエストサンプル

PUT  http://localhost:4035/gotapi/airconditioner/operationmodesetting
PUTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&operationmodesetting=Automatic

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0
}
インターフェース名称 Version 種別
AirConditioner Get Room Temperature API 2.0.0 同期I/F

概要

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

リクエスト

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

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
室内温度計測値 roomtemperature number - -127〜125 (℃)

リクエストサンプル

GET http://localhost:4035/gotapi/airconditioner/roomtemperature&serviceId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0,
    "roomtemperature":24
}
インターフェース名称 Version 種別
AirConditioner Get Temperature Value API 2.0.0 同期I/F

概要

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

リクエスト

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

レスポンス

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

リクエストサンプル

GET http://localhost:4035/gotapi/airconditioner/temperaturevalue&serviceId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0,
    "temperaturevalue":24
}
インターフェース名称 Version 種別
AirConditioner Set Temperature Value API 2.0.0 同期I/F

概要

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

リクエスト

HTTPメソッド URI
PUT /gotapi/airconditioner/temperaturevalue
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
温度設定値 temperaturevalue number - 0〜50 (℃)

レスポンス

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

リクエストサンプル

PUT  http://localhost:4035/gotapi/airconditioner/temperaturevalue
PUTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&temperaturevalue=24

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0
}
インターフェース名称 Version 種別
AirConditioner Get Air Flow Value API 2.0.0 同期I/F

概要

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

リクエスト

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

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
風量設定値 airflowvalue number - 0.0〜1.0
風量自動モード設定 airflowauto boolean - “true” : 自動モード有効
“false” : 自動モード無効

リクエストサンプル

GET http://localhost:4035/gotapi/airconditioner/airflowvalue&serviceId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0,
    "airflowvalue":0.2,
    "airflowauto":true
}
インターフェース名称 Version 種別
AirConditioner Set Air Flow Value API 2.0.0 同期I/F

概要

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

リクエスト

HTTPメソッド URI
PUT /gotapi/airconditioner/airflowvalue
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
風量設定値 airflowvalue number ○(注1) 0.0〜1.0
風量自動モード設定 airflowauto boolean ○(注2) “true” : 自動モード有効
“false” : 自動モード無効
※(注1) 風量自動モード設定を"true"設定した時のみ省略可。
※(注2) 省略時及びfalse設定時は、「風量設定値」が反映される。

レスポンス

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

リクエストサンプル

PUT  http://localhost:4035/gotapi/airconditioner/airflowvalue
PUTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&airflowvalue=0.2&airflowauto=true

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0
}
インターフェース名称 Version 種別
AirConditioner Get ECHONET Lite Property API 2.0.0 同期I/F

概要

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

リクエスト

HTTPメソッド URI
PUT /gotapi/airconditioner/enlproperty
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
取得プロパティのEPC epc string - 取得するプロパティのEPCをカンマ区切りで列挙。10進または16進(0xXX)の値

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
プロパティ properties array - プロパティを格納する配列
EPC epc string - EPC
設定値 value string - 設定内容

リクエストサンプル

GET http://localhost:4035/gotapi/airconditioner/enlproperty&serviceId=localhost.deviceconnect.org&accessToken=xxxxx&epc=128,129

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "hmac":"yyyyy",
    "result":0,
    "properties":[
        {
           “epc”:"128",
            "value":"48"
        },
        {
           “epc”:"129",
            "value":"0"
        }
     ]
}
インターフェース名称 Version 種別
AirConditioner Set ECHONET Lite Property API 2.0.0 同期I/F

概要

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

リクエスト

HTTPメソッド URI
PUT /gotapi/airconditioner/enlproperty
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
EPC epc string - EPC
設定値 value string - 設定内容

レスポンス

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

リクエストサンプル

PUT  http://localhost:4035/gotapi/airconditioner/enlproperty
PUTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&epc=128&value=49

レスポンスサンプル

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

Clone this wiki locally