Skip to content

TV Profile

Jump to bottom
TakayukiHoshi1984 edited this page Mar 27, 2017 · 3 revisions

目次

API 機能概要
TV Get Power Status API スマートデバイスの電源状態を取得する。
TV Power On API スマートデバイスの電源をオンにする。
TV Power Off API スマートデバイスの電源をオフにする。
TV Change Channel API スマートデバイスのチャンネルを変更する。
TV Change Volume API スマートデバイスの音量を変更する。
TV Change Broadcast Wave API スマートデバイスの選択放送波を変更する。
TV Mute On API スマートデバイスのミュートをオンにする。
TV Mute Off API スマートデバイスのミュートをオフにする。
TV Get ECHONET Lite Property API スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティの設定内容を取得する。（必須プロパティのみ）
TV Set ECHONET Lite Property API 該当デバイスがサポートしているECHONET Lite 機器オブジェクトプロパティに設定を行う。（必須プロパティのみ）

機能概要

スマートデバイスが持つTV機器を操作する機能を提供するAPI。
※TV:television

参考API

ECHONET Lite

http://echonet.jp/spec_g/

TV Get Power Status API

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

概要

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

リクエスト

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

レスポンス

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

リクエストサンプル

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

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "powerstate":"ON"
}

TV Power On API

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

概要

スマートデバイスの電源をオンにする。

リクエスト

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

レスポンス

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

リクエストサンプル

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

レスポンスサンプル

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

TV Power Off API

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

概要

スマートデバイスの電源をオフにする。

リクエスト

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

レスポンス

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

リクエストサンプル

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

レスポンスサンプル

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

TV Change Channel API

インターフェース名称 Version 種別
TV Change Channel API 2.0.0 同期I/F

概要

スマートデバイスのチャンネルを変更する。

リクエスト

HTTPメソッド URI
PUT /gotapi/tv/channel
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
選局 tuning string ○ “1”〜”12”：チャンネル番号
操作 control string ○ “next”:次局選局
“previous”:前局選局

レスポンス

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

リクエストサンプル

PUT  http://localhost:4035/gotapi/tv/channel
PUTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&action=next

レスポンスサンプル

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

TV Change Volume API

インターフェース名称 Version 種別
TV Change Volume API 2.0.0 同期I/F

概要

スマートデバイスの音量を変更する。

リクエスト

HTTPメソッド URI
PUT /gotapi/tv/volume
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
操作 control string - “up”:ボリュームを上げる
“down”:ボリュームを下げる

レスポンス

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

リクエストサンプル

PUT  http://localhost:4035/gotapi/tv/volume
PUTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&action=up

レスポンスサンプル

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

TV Change Broadcast Wave API

インターフェース名称 Version 種別
TV Change Broadcast Wave API 2.0.0 同期I/F

概要

スマートデバイスの選択放送波を変更する。

リクエスト

HTTPメソッド URI
PUT /gotapi/tv/broadcastwave
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
放送波選択 select string - “DTV”:地上波デジタル放送
“BS”:BS放送波
“CS”:CS放送波

レスポンス

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

リクエストサンプル

PUT  http://localhost:4035/gotapi/tv/broadcastwave
PUTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&select=DTV

レスポンスサンプル

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

TV Mute On API

インターフェース名称 Version 種別
TV Mute On API 2.0.0 同期I/F

概要

スマートデバイスのミュートをオンにする。

リクエスト

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

レスポンス

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

リクエストサンプル

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

レスポンスサンプル

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

TV Mute Off API

インターフェース名称 Version 種別
TV Mute Off API 2.0.0 同期I/F

概要

スマートデバイスのミュートをオフにする。

リクエスト

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

レスポンス

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

リクエストサンプル

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

レスポンスサンプル

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

TV Get ECHONET Lite Property API

インターフェース名称 Version 種別
TV Get ECHONET Lite Property API 2.0.0 同期I/F

概要

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

リクエスト

HTTPメソッド URI
GET /gotapi/tv/enlproperty
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象デバイス
取得プロパティのEPC epc string ○ 取得するプロパティのEPCをカンマ区切りで列挙。

レスポンス

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

リクエストサンプル

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

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "properties":[
        {
           “epc”:"128",
            "value":"48"
        },
        {
           “epc”:"129",
            "value":"0"
        }
     ]
}

TV Set ECHONET Lite Property API

インターフェース名称 Version 種別
TV Set ECHONET Lite Property API 2.0.0 同期I/F

概要

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

リクエスト

HTTPメソッド URI
PUT /gotapi/tv/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/tv/enlproperty
PUTデータ
serviceId=localhost.deviceconnect.org&accessToken=xxxxx&epc=128&value=49

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}
  1. アプリケーション開発マニュアル
  2. 単体テスト動作マニュアル

Clone this wiki locally