Tv

概要

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

目次

API	概要
GET /gotapi/tv	スマートデバイスの電源状態を取得する。
PUT /gotapi/tv	スマートデバイスの電源をオンにする。
DELETE /gotapi/tv	スマートデバイスの電源をオフにする。
PUT /gotapi/tv/broadcastWave	スマートデバイスの選択放送波を変更する。
PUT /gotapi/tv/channel	スマートデバイスのチャンネルを変更する。
GET /gotapi/tv/enlProperty	スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティの 設定内容を取得する（必須プロパティのみ）。
PUT /gotapi/tv/enlProperty	スマートデバイスがサポートしているECHONET Lite機器オブジェクトプロパティに 設定を行う（必須プロパティのみ）。
PUT /gotapi/tv/mute	スマートデバイスのミュートをONにする。
DELETE /gotapi/tv/mute	スマートデバイスのミュートをOFFにする。
PUT /gotapi/tv/volume	スマートデバイスの音量を変更する。

GET /gotapi/tv

種別

one-shot

概要

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

状態が不明の場合は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"
}

PUT /gotapi/tv

種別

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/tv

種別

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"
}

PUT /gotapi/tv/broadcastWave

種別

one-shot

概要

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

対応する放送波に関してはデバイス依存とする。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
select	string	Yes	放送波選択。 DTV : 地上波デジタル放送 BS : BS放送波 CS : CS放送波

レスポンス

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

PUT /gotapi/tv/channel

種別

one-shot

概要

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

チャンネル番号の拡張についてはデバイスプラグイン側に依存する。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
tuning	integer	No	選局。1〜12：チャンネル番号
control	string	No	操作。 next : 次局選局 previous : 前局選局

レスポンス

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

種別

one-shot

概要

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

※enlproperty:ECHONET Lite Propertyのこと。

リクエスト

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

レスポンス

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

PUT /gotapi/tv/mute

種別

one-shot

概要

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

すでにミュートが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/tv/mute

種別

one-shot

概要

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

すでにミュートが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"
}

PUT /gotapi/tv/volume

種別

one-shot

概要

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

変更できる音量の範囲については、デバイスの仕様に合わせる。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
control	string	Yes	操作。 up : 音量を上げる down : 音量を下げる

レスポンス

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