Air Conditioner Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/airConditioner
PUT /gotapi/airConditioner
DELETE /gotapi/airConditioner
GET /gotapi/airConditioner/airFlow
PUT /gotapi/airConditioner/airFlow
GET /gotapi/airConditioner/enlProperty
PUT /gotapi/airConditioner/enlProperty
GET /gotapi/airConditioner/modeSetting
PUT /gotapi/airConditioner/modeSetting
GET /gotapi/airConditioner/powerSaving
PUT /gotapi/airConditioner/powerSaving
GET /gotapi/airConditioner/roomTemperature
GET /gotapi/airConditioner/temperature
PUT /gotapi/airConditioner/temperature

GET /gotapi/airConditioner

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

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

Example Response

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

PUT /gotapi/airConditioner

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/airConditioner

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/airConditioner/airFlow

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	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設定時は、「風量設定値」が反映される。

Example Response

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

PUT /gotapi/airConditioner/airFlow

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
airflow	float	No	風量設定値。 0.0〜1.0
airflowauto	boolean	No	風量自動モード設定。true : 自動モード有効 false : 自動モード無効

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/airConditioner/enlProperty

API Pattern

one-shot

Summary

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

Description

※enlproperty:ECHONET Lite Propertyのこと。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
epc	array(string)	Yes	取得プロパティのEPC。取得するプロパティのEPCをカンマ区切りで列挙。10進または16進(0xXX)の値

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		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の設定値。

Example Response

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

PUT /gotapi/airConditioner/enlProperty

API Pattern

one-shot

Summary

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

Description

※enlproperty:ECHONET Lite Propertyのこと。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
epc	string	Yes	EPC。 ECHONET Property Code
value	string	Yes	EPCの設定値。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/airConditioner/modeSetting

API Pattern

one-shot

Summary

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

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	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:その他

Example Response

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

PUT /gotapi/airConditioner/modeSetting

API Pattern

one-shot

Summary

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

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
modesetting	string	Yes	運転モード設定。 Automatic:自動 Cooling:冷房 Heating:暖房 Dehumidification:除湿 AirCirculator:送風 Other:その他

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/airConditioner/powerSaving

API Pattern

one-shot

Summary

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

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

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

Example Response

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

PUT /gotapi/airConditioner/powerSaving

API Pattern

one-shot

Summary

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

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
powersaving	string	Yes	節電動作設定。 PowerSaving：節電動作中 Normal：通常動作中 Unknown：不明

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/airConditioner/roomTemperature

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

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

Example Response

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

GET /gotapi/airConditioner/temperature

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

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

Example Response

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

PUT /gotapi/airConditioner/temperature

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
temperature	integer	Yes	温度設定値。 0〜50 (℃)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Atmospheric Pressure Profile

Ver. 2.0.0

Description

気圧の値を取得する機能を提供するAPI。

Operations

GET /gotapi/atmosphericPressure

GET /gotapi/atmosphericPressure

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
気圧	atmosphericPressure	float	Yes	気圧単位: ヘクトパスカル(hPa)
気圧のタイムスタンプ	timeStamp	long	No	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
気圧のタイムスタンプ文字列	timeStampString	dateTime	No	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "atmosphericPressure" : 1016.12,
  "timeStamp" : 1431856940275,
  "timeStampString" : "2015-05-17T10:02:20+09:00"
}

Authorization Profile

Ver. 2.0.0

Description

Local OAuthのクライアントを操作する機能を提供するAPI。

GET /gotapi/authorization/accessToken

API Pattern

one-shot

Summary

DeviceConnectManagerにLocal OAuthを行うためのアクセストークンの作成要求を行う。

Description

各プロファイルにアクセスするためには、このAPIで作成したアクセストークンが必要になる。
また、アクセストークンには有効期限が存在するので、有効期限が切れた場合には再度アクセストークンを作成し直す必要がある。

Parameters

Name	Type	Required	Description
clientId	string	Yes	クライアントID。Authorization Create Client APIで取得したclientIdを使用する。
applicationName	string	Yes	アプリケーション名。承認確認画面に表示するアプリケーション名を指定する。例:「Twitterイベントプラグイン」と指定した場合は、「TwitterイベントプラグインがdConnectにアクセスする許可をしますか？」と確認メッセージが表示される。
scope	array(string)	Yes	スコープ。使用するプロファイルの一覧をカンマ区切りで定義する。例)file,notification,vibration

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
アクセストークン		accessToken	string	Yes	各プロファイルにアクセスする場合に必要になる。
失効日時		expire	float	Yes	スコープ毎のアクセストークンの失効時刻のうち、直近の時刻(UNIX時間)。
スコープ配列		scopes	array(object)	Yes	スコープの有効期限一覧を格納する配列。
	スコープ	scope	string	Yes	スコープのプロファイル名。
	スコープの有効期限	expirePeriod	float	Yes	アクセストークンの有効期限。スコープ毎に設定されている。アクセストークンが作成されてから使用できる間の時間(秒)を返す。この時間を過ぎるとアクセストークンが使用できなくなる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "accessToken" : "0a93ac0aade4e046ed63eb24d1172f5f35c88ca60daa901547c28d5827cb418a5de1d7c5f9e62405",
  "scopes" : [ {
    "scope" : "file",
    "expirePeriod" : 15552000
  }, {
    "scope" : "creditcard",
    "expirePeriod" : 0
  } ],
  "expire" : 1431856940275
}

GET /gotapi/authorization/grant

API Pattern

one-shot

Summary

Device Connect ManagerにLocal OAuthを行うためのクライアントの作成要求を行う。

Description

同じオリジンから送信された場合には、以前のクライアントを削除して新たにクライアントを作成する。
それに伴い、クライアントに紐づいていたアクセストークンもすべて破棄される。

Parameters

Name	Type	Required	Description

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
クライアントID	clientId	string	Yes	クライアントを識別するためのID。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "clientId" : "d94da8f1-3826-4ed5-a729-2d9499e842c9"
}

Availability Profile

Ver. 2.0.0

Description

ホストデバイス上でDevice Connect Managerが起動しているかどうかを確認する機能を提供する。

Operations

GET /gotapi/availability

GET /gotapi/availability

API Pattern

one-shot

Summary

Device Connect Managerが起動しているかどうかを確認する。

Parameters

Name	Type	Required	Description

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Managerの名前	name	string	No	Managerの設定画面の「Managerの名前を表示」をONにすることで追加される。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "name" : "Manager-xxxx"
}

Battery Profile

Ver. 2.0.0

Description

スマートデバイスのバッテリー情報を提供するAPI。

Operations

GET /gotapi/battery
GET /gotapi/battery/charging
GET /gotapi/battery/chargingTime
GET /gotapi/battery/dischargingTime
GET /gotapi/battery/level
GET /gotapi/battery/onBatteryChange
PUT /gotapi/battery/onBatteryChange
DELETE /gotapi/battery/onBatteryChange
GET /gotapi/battery/onChargingChange
PUT /gotapi/battery/onChargingChange
DELETE /gotapi/battery/onChargingChange

スマートデバイスのバッテリー情報を取得する。

Description

スマートデバイスのバッテリー情報として取得できない値がある場合は適切な値を代入してレスポンスを返却する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
充電状態フラグ	charging	boolean	Yes	充電中:true 非充電中:false
完全充電までの時間 (秒)	chargingTime	long	No	満充電、または非充電中の場合は0。システムとして取得出来ない場合はNumber.MAX_VALUE。
完全放電までの時間 (秒)	dischargingTime	long	No	充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE
バッテリー残量	level	float	No	範囲: 0.0 <= level <= 1.0

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "charging" : true,
  "chargingTime" : 10,
  "dischargingTime" : 0,
  "level" : 0.8
}

GET /gotapi/battery/charging

API Pattern

one-shot

Summary

スマートデバイスの充電状態フラグを取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
充電状態フラグ	charging	boolean	Yes	充電中:true 非充電中:false

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "charging" : true
}

GET /gotapi/battery/chargingTime

API Pattern

one-shot

Summary

スマートデバイスの充電完了時間を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
完全充電までの時間 (秒)	chargingTime	long	Yes	満充電、または非充電中の場合は0。システムとして取得出来ない場合はNumber.MAX_VALUE。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "chargingTime" : 10
}

GET /gotapi/battery/dischargingTime

API Pattern

one-shot

Summary

スマートデバイスの放電完了時間を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
完全放電までの時間 (秒)	dischargingTime	long	Yes	充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE。

Example Response

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

GET /gotapi/battery/level

API Pattern

one-shot

Summary

スマートデバイスのバッテリー残量を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
バッテリー残量	level	float	Yes	範囲: 0.0 <= level <= 1.0

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "level" : 0.8
}

GET /gotapi/battery/onBatteryChange

API Pattern

one-shot

Summary

スマートデバイスのバッテリー状態変化通知イベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
バッテリー情報		battery	object	Yes
	完全充電までの時間 (秒)	chargingTime	long	Yes	満充電、または非充電中の場合は0。システムとして取得出来ない場合はNumber.MAX_VALUE。
	完全放電までの時間 (秒)	dischargingTime	long	Yes	充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE。
	バッテリー残量	level	float	Yes	範囲: 0.0 <= level <= 1.0

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "battery" : {
    "chargingTime" : 10,
    "dischargingTime" : 0,
    "level" : 0.8
  }
}

PUT /gotapi/battery/onBatteryChange

API Pattern

event

Summary

スマートデバイスのバッテリーの状態が変化したことを通知する。

Description

充電時間、放電時間、バッテリー残量の値が変わった時にイベントが発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
バッテリー情報		battery	object	Yes
	完全充電までの時間 (秒)	chargingTime	long	Yes	満充電、または非充電中の場合は0。システムとして取得出来ない場合はNumber.MAX_VALUE。
	完全放電までの時間 (秒)	dischargingTime	long	Yes	充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE。
	バッテリー残量	level	float	Yes	範囲: 0.0 <= level <= 1.0

Example Event

{
  "serviceId" : "example-service-id",
  "profile" : "battery",
  "attribute" : "onBatteryChange",
  "battery" : {
    "chargingTime" : 10,
    "dischargingTime" : 0,
    "level" : 0.8
  }
}

DELETE /gotapi/battery/onBatteryChange

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/battery/onChargingChange

API Pattern

one-shot

Summary

スマートデバイスのバッテリー充電状態変化通知イベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
バッテリー情報		battery	object	Yes
	充電状態フラグ	charging	boolean	Yes	充電中:true 非充電中:false

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "battery" : {
    "charging" : true
  }
}

PUT /gotapi/battery/onChargingChange

API Pattern

event

Summary

スマートフォンもしくは周辺機器へ他方のスマートデバイスのバッテリーの充電状態が変化したことを通知する。

Description

充電中フラグの値がtrueからfalse、もしくは、falseからtrueへ変わった時にイベントが発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
バッテリー情報		battery	object	Yes
	充電状態フラグ	charging	boolean	Yes	充電中:true 非充電中:false

Example Event

{
  "serviceId" : "example-service-id",
  "profile" : "battery",
  "attribute" : "onChargingChange",
  "battery" : {
    "charging" : true
  }
}

DELETE /gotapi/battery/onChargingChange

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Camera Profile

Ver. 2.0.0

Description

スマートデバイス(Cameraデバイスなど）のズーム操作機能を提供するAPI。

Operations

GET /gotapi/camera/zoom
PUT /gotapi/camera/zoom

GET /gotapi/camera/zoom

API Pattern

one-shot

Summary

Cameraデバイスの現在の倍率を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
カメラの倍率	zoomPosition	float	Yes	カメラの倍率(%) 例) QX-10の場合 0(%):拡大なし 50(%):倍率5倍での拡大

Example Response

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

PUT /gotapi/camera/zoom

API Pattern

one-shot

Summary

Cameraデバイスに対してレンズのズームイン・アウトリクエストを送る。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
direction	string	Yes	方向。ズームの方向 in out
movement	string	Yes	動作。ズームの動作 in-startで開始して in-stopで終了。 1shotは開始してから所定位置まで動作する。 maxはin-startと同じ動作を行う。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Canvas Profile

Ver. 2.0.0

Description

デバイスに画像を描画・削除する機能を提供するAPI。

Operations

POST /gotapi/canvas/drawImage
DELETE /gotapi/canvas/drawImage

POST /gotapi/canvas/drawImage

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mimeType	string	No	MIMEタイプ。表示する画像のMimeType。
data	file	No	ファイルのbinary。表示する画像ファイルのbinary。uriと同時に省略することはできない。両方指定した場合の挙動は未定義。
uri	string	No	ファイルのURI。表示する画像ファイルのURI。dataと同時に省略することはできない。両方指定した場合の挙動は未定義。
x	integer	No	デバイスが持つ空間の左上を原点としたx座標。0～デバイスの空間領域。等倍描画モードの場合のみ有効。
y	integer	No	デバイスが持つ空間の左上を原点としたy座標。0～デバイスの空間領域。等倍描画モードの場合のみ有効。
mode	string	No	画像描画モード。(省略時)：等倍描画モード。座標(x, y)に画像の左上隅がくるように描画する。 scales：スケールモード。アスペクト比を保持して最大限に拡大して画面中央に描画する。x, y座標は無効。 fills：フィルモード。等倍の画像を並べて画面全体に敷き詰めるように描画する。x, y座標は無効。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/canvas/drawImage

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Connection Profile

Ver. 2.0.0

Description

スマートデバイスとのネットワーク接続情報を提供するAPI。

Operations

GET /gotapi/connection/ble
PUT /gotapi/connection/ble
DELETE /gotapi/connection/ble
GET /gotapi/connection/bluetooth
PUT /gotapi/connection/bluetooth
DELETE /gotapi/connection/bluetooth
PUT /gotapi/connection/bluetooth/discoverable
DELETE /gotapi/connection/bluetooth/discoverable
GET /gotapi/connection/nfc
PUT /gotapi/connection/nfc
DELETE /gotapi/connection/nfc
GET /gotapi/connection/onBleChange
PUT /gotapi/connection/onBleChange
DELETE /gotapi/connection/onBleChange
GET /gotapi/connection/onBluetoothChange
PUT /gotapi/connection/onBluetoothChange
DELETE /gotapi/connection/onBluetoothChange
GET /gotapi/connection/onNfcChange
PUT /gotapi/connection/onNfcChange
DELETE /gotapi/connection/onNfcChange
GET /gotapi/connection/onWifiChange
PUT /gotapi/connection/onWifiChange
DELETE /gotapi/connection/onWifiChange
GET /gotapi/connection/wifi
PUT /gotapi/connection/wifi
DELETE /gotapi/connection/wifi

GET /gotapi/connection/ble

API Pattern

one-shot

Summary

スマートデバイスのBLE機能有効状態(ON/OFF)を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
BLE有効状態	enable	boolean	Yes	BLE機能有効状態。 ON : true OFF : false

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "enable" : true
}

PUT /gotapi/connection/ble

API Pattern

one-shot

Summary

スマートデバイスのBLE機能有効状態を有効に設定する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/connection/ble

API Pattern

one-shot

Summary

スマートデバイスのBLE機能有効状態を無効に設定する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/connection/bluetooth

API Pattern

one-shot

Summary

スマートデバイスのBluetooth機能有効状態(ON/OFF)を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Bluetooth機能有効状態	enable	boolean	Yes	Bluetooth機能有効状態。 ON : true OFF : false

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "enable" : true
}

PUT /gotapi/connection/bluetooth

API Pattern

one-shot

Summary

スマートデバイスのBluetooth機能有効状態を有効に設定する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/connection/bluetooth

API Pattern

one-shot

Summary

スマートデバイスのBluetooth機能有効状態を無効に設定する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/connection/bluetooth/discoverable

API Pattern

one-shot

Summary

スマートデバイスのBluetooth検索可能状態を有効に設定する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/connection/bluetooth/discoverable

API Pattern

one-shot

Summary

スマートデバイスのBluetooth検索可能状態を無効に設定する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/connection/nfc

API Pattern

one-shot

Summary

スマートデバイスのNFC機能有効状態(ON/OFF)を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
NFC機能有効状態	enable	boolean	Yes	NFC機能有効状態。 ON : true OFF : false

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "enable" : true
}

PUT /gotapi/connection/nfc

API Pattern

one-shot

Summary

スマートデバイスのNFC機能有効状態を有効に設定する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/connection/nfc

API Pattern

one-shot

Summary

スマートデバイスのNFC機能有効状態を無効に設定する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/connection/onBleChange

API Pattern

one-shot

Summary

スマートデバイスのBLE機能有効状態(ON/OFF)の変化を通知するイベントを取得する。

Description

BLE機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
接続情報		connectStatus	object	Yes
	BLE機能有効状態	enable	boolean	Yes	BLE機能有効状態 ON: true OFF: false

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connectStatus" : {
    "enable" : true
  }
}

PUT /gotapi/connection/onBleChange

API Pattern

event

Summary

スマートデバイスのBLE機能有効状態(ON/OFF)の変化を通知するイベントを開始する。

Description

BLE機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
接続情報		connectStatus	object	Yes
	BLE機能有効状態	enable	boolean	Yes	BLE機能有効状態 ON: true OFF: false

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onblechange",
  "connectStatus" : {
    "enable" : true
  }
}

DELETE /gotapi/connection/onBleChange

API Pattern

event

Summary

スマートデバイスのBLE機能有効状態(ON/OFF)の変化を通知するイベントを停止する。

Description

BLE機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/connection/onBluetoothChange

API Pattern

one-shot

Summary

スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを取得する。

Description

Bluetooth機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
接続情報		connectStatus	object	Yes
	Bluetooth機能有効状態	enable	boolean	Yes	Bluetooth機能有効状態 ON: true OFF: false

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connectStatus" : {
    "enable" : true
  }
}

PUT /gotapi/connection/onBluetoothChange

API Pattern

event

Summary

スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを開始する。

Description

Bluetooth機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
接続情報		connectStatus	object	Yes
	Bluetooth機能有効状態	enable	boolean	Yes	Bluetooth機能有効状態 ON: true OFF: false

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onbluetoothchange",
  "connectStatus" : {
    "enable" : true
  }
}

DELETE /gotapi/connection/onBluetoothChange

API Pattern

event

Summary

スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを停止する。

Description

Bluetooth機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/connection/onNfcChange

API Pattern

one-shot

Summary

スマートデバイスのNFC機能有効状態(ON/OFF)の変化を通知するイベントを取得する。

Description

NFC機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
接続情報		connectStatus	object	Yes
	NFC機能有効状態	enable	boolean	Yes	NFC機能有効状態 ON: true OFF: false

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connectStatus" : {
    "enable" : true
  }
}

PUT /gotapi/connection/onNfcChange

API Pattern

event

Summary

スマートデバイスのNFC機能有効状態(ON/OFF)の変化を通知するイベントを開始する。

Description

NFC機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
接続情報		connectStatus	object	Yes
	NFC機能有効状態	enable	boolean	Yes	NFC機能有効状態 ON: true OFF: false

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onnfcchange",
  "connectStatus" : {
    "enable" : true
  }
}

DELETE /gotapi/connection/onNfcChange

API Pattern

event

Summary

スマートデバイスのNFC機能有効状態(ON/OFF)の変化を通知するイベントを停止する。

Description

NFC機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/connection/onWifiChange

API Pattern

one-shot

Summary

スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを取得する。

Description

WIFI機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
接続情報		connectStatus	object	Yes
	WIFI機能有効状態	enable	boolean	Yes	WIFI機能有効状態 ON: true OFF: false

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connectStatus" : {
    "enable" : true
  }
}

PUT /gotapi/connection/onWifiChange

API Pattern

event

Summary

スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを開始する。

Description

WIFI機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
接続情報		connectStatus	object	Yes
	WIFI機能有効状態	enable	boolean	Yes	WIFI機能有効状態 ON: true OFF: false

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onwifichange",
  "connectStatus" : {
    "enable" : true
  }
}

DELETE /gotapi/connection/onWifiChange

API Pattern

event

Summary

スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを停止する。

Description

WIFI機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/connection/wifi

API Pattern

one-shot

Summary

スマートデバイスのWIFI機能有効状態(ON/OFF)を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
WIFI機能有効状態	enable	boolean	Yes	WIFI機能有効状態。 ON : true OFF : false

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "enable" : true
}

PUT /gotapi/connection/wifi

API Pattern

one-shot

Summary

スマートデバイスのWIFI機能有効状態を有効に設定する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/connection/wifi

API Pattern

one-shot

Summary

スマートデバイスのWIFI機能有効状態を無効に設定する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

device Profile

Ver. 2.0.0

Description

スマートデバイスへの接続関連の機能を提供するAPI。

Operations

POST /gotapi/device/pairing
DELETE /gotapi/device/pairing

POST /gotapi/device/pairing

Name	Type	Required	Description
serviceId	string	Yes	サービスID。ペアリング対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/device/pairing

Name	Type	Required	Description
serviceId	string	Yes	サービスID。ペアリング解除対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DeviceOrientation Profile

Ver. 2.0.0

Description

スマートデバイスの加速度センサー機能を提供するAPI。

Operations

GET /gotapi/deviceOrientation/onDeviceOrientation
PUT /gotapi/deviceOrientation/onDeviceOrientation
DELETE /gotapi/deviceOrientation/onDeviceOrientation

GET /gotapi/deviceOrientation/onDeviceOrientation

API Pattern

one-shot

Summary

スマートデバイスが検知した加速度や重力込みの加速度（加速度センサー）、そして角速度（ジャイロセンサー）を通知するイベントを取得する。

Description

スマートデバイスでサポートしていないパラメータがある場合には、そのパラメータを省略する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
デバイスの向き			orientation	object	Yes
	インターバル		interval	long	Yes	インターバル (単位: ミリ秒)
	加速度		acceleration	object	No	加速度のオブジェクト。
		x軸成分	x	float	Yes	x軸方向への加速度（m/s2）。
		y軸成分	y	float	Yes	y軸方向への加速度（m/s2）。
		z軸成分	z	float	Yes	z軸方向への加速度（m/s2）。
	重力込みの加速度		accelerationIncludingGravity	object	No	重力込みの加速度のオブジェクト。
		x軸成分	x	float	Yes	x軸方向への重力込みの加速度（m/s2）。
		y軸成分	y	float	Yes	y軸方向への重力込みの加速度（m/s2）。
		z軸成分	z	float	Yes	z軸方向への重力込みの加速度（m/s2）。
	角速度		rotationRate	object	No	角速度のオブジェクト。
		z軸回り成分	alpha	float	Yes	z軸回りの角速度(degree/s)。
		x軸回り成分	beta	float	Yes	x軸回りの角速度(degree/s)。
		y軸回り成分	gamma	float	Yes	y軸回りの角速度(degree/s)。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "orientation" : {
    "acceleration" : {
      "x" : 0.12345678901234566,
      "y" : 0.9876543210987654,
      "z" : 0.24680135792468014
    },
    "rotationRate" : {
      "alpha" : -0.24680135792468014,
      "beta" : 0.12345678901234566,
      "gamma" : -0.9876543210987654
    },
    "accelerationIncludingGravity" : {
      "x" : 0.24680135792468014,
      "y" : 0.12345678901234566,
      "z" : 9.87654321098
    },
    "interval" : 0
  }
}

PUT /gotapi/deviceOrientation/onDeviceOrientation

API Pattern

event

Summary

スマートデバイスが検知した加速度や重力込みの加速度（加速度センサー）、そして角速度（ジャイロセンサー）を通知するイベントを開始する。

Description

スマートデバイスでサポートしていないパラメータがある場合には、そのパラメータを省略する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
デバイスの向き			orientation	object	Yes
	インターバル		interval	long	Yes	インターバル (単位: ミリ秒)
	加速度		acceleration	object	No	加速度のオブジェクト。
		x軸成分	x	float	Yes	x軸方向への加速度（m/s2）。
		y軸成分	y	float	Yes	y軸方向への加速度（m/s2）。
		z軸成分	z	float	Yes	z軸方向への加速度（m/s2）。
	重力込みの加速度		accelerationIncludingGravity	object	No	重力込みの加速度のオブジェクト。
		x軸成分	x	float	Yes	x軸方向への重力込みの加速度（m/s2）。
		y軸成分	y	float	Yes	y軸方向への重力込みの加速度（m/s2）。
		z軸成分	z	float	Yes	z軸方向への重力込みの加速度（m/s2）。
	角速度		rotationRate	object	No	角速度のオブジェクト。
		z軸回り成分	alpha	float	Yes	z軸回りの角速度(degree/s)。
		x軸回り成分	beta	float	Yes	x軸回りの角速度(degree/s)。
		y軸回り成分	gamma	float	Yes	y軸回りの角速度(degree/s)。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "deviceorientation",
  "attribute" : "ondeviceorientation",
  "orientation" : {
    "acceleration" : {
      "x" : 0.12345678901234566,
      "y" : 0.9876543210987654,
      "z" : 0.24680135792468014
    },
    "rotationRate" : {
      "alpha" : -0.24680135792468014,
      "beta" : 0.12345678901234566,
      "gamma" : -0.9876543210987654
    },
    "accelerationIncludingGravity" : {
      "x" : 0.24680135792468014,
      "y" : 0.12345678901234566,
      "z" : 9.87654321098
    },
    "interval" : 100
  }
}

DELETE /gotapi/deviceOrientation/onDeviceOrientation

API Pattern

event

Summary

スマートデバイスが検知した加速度や重力込みの加速度（加速度センサー）、そして角速度（ジャイロセンサー）を通知するイベントを停止する。

Description

スマートデバイスでサポートしていないパラメータがある場合には、そのパラメータを省略する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DriveController Profile

Ver. 2.0.0

Description

スマートデバイスの駆動処理を提供するAPI。

Operations

POST /gotapi/driveController/move
PUT /gotapi/driveController/rotate
DELETE /gotapi/driveController/stop

POST /gotapi/driveController/move

API Pattern

one-shot

Summary

スマートデバイスを指定された方向に移動開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
angle	float	Yes	角度。デバイスの方向 (degree) 0~360
speed	float	Yes	速度。デバイスの動く速度 0.0~1.0

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/driveController/rotate

API Pattern

one-shot

Summary

スマートデバイスを指定された向きに回転を行う。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
angle	float	Yes	角度。デバイスの方向 (degree) 0~360

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/driveController/stop

API Pattern

one-shot

Summary

スマートデバイスに移動停止リクエストを送る。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

ECG Profile

Ver. 2.0.0

Description

デバイスのECGのイベントを通知するための機能。※ECG:Electrocardiogram(心電図)

Operations

GET /gotapi/ecg/onECG
PUT /gotapi/ecg/onECG
DELETE /gotapi/ecg/onECG

GET /gotapi/ecg/onECG

API Pattern

one-shot

Summary

デバイスのECG計測通知イベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ECG		ecg	object	Yes	ECGのオブジェクト。
	ECG	value	integer	Yes	ターゲットデバイスで測定した心拍数を返す。
	ECGのMDER Float値	mderFloat	string	Yes	ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
	ECGのタイプ	type	string	Yes	この値が「ecg beat」であることを表す文字列を返す。取得できない場合は、空文字を返す。
	ECGのオブジェクトのタイプのコード	typeCode	string	Yes	「663568」という「ecg beat」を意味するコードを返す。取得できない場合は、空文字を返す。
	ECGの単位	unit	string	Yes	「mVolt * miliSecond」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
	ECGの単位コード	unitCode	string	Yes	「3328」という「mVolt * miliSecond」を意味するコードを返す。取得できない場合は、空文字を返す。
	ECGのタイムスタンプ	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	ECGのタイムスタンプ文字列	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "ecg" : {
    "value" : -172.40676879882812,
    "mderFloat" : "F68ED1CC",
    "type" : "ecg beat",
    "typeCode" : 663568,
    "unit" : "mVolt * milliSecond",
    "unitCode" : 3328,
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

PUT /gotapi/ecg/onECG

API Pattern

event

Summary

デバイスのECG計測値を通知するイベントを開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
ECG		ecg	object	Yes	ECGのオブジェクト。
	ECG	value	integer	Yes	ターゲットデバイスで測定した心拍数を返す。
	ECGのMDER Float値	mderFloat	string	Yes	ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
	ECGのタイプ	type	string	Yes	この値が「ecg beat」であることを表す文字列を返す。取得できない場合は、空文字を返す。
	ECGのオブジェクトのタイプのコード	typeCode	string	Yes	「663568」という「ecg beat」を意味するコードを返す。取得できない場合は、空文字を返す。
	ECGの単位	unit	string	Yes	「mVolt * miliSecond」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
	ECGの単位コード	unitCode	string	Yes	「3328」という「mVolt * miliSecond」を意味するコードを返す。取得できない場合は、空文字を返す。
	ECGのタイムスタンプ	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	ECGのタイムスタンプ文字列	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "ecg",
  "attribute" : "onecg",
  "ecg" : {
    "value" : -172.40676879882812,
    "mderFloat" : "F68ED1CC",
    "type" : "ecg beat",
    "typeCode" : 663568,
    "unit" : "mVolt * milliSecond",
    "unitCode" : 3328,
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

DELETE /gotapi/ecg/onECG

API Pattern

event

Summary

デバイスのECG計測値を通知するイベントを停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

ECHONETLite Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/echonetLite/property
PUT /gotapi/echonetLite/property

GET /gotapi/echonetLite/property

API Pattern

one-shot

Summary

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

Description

EPC:ECHONET Property Code

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
epc	array(string)	Yes	取得プロパティのEPC。取得するプロパティのEPCをカンマ区切りで列挙。10進または16進(0xXX)の値

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		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の設定値。

Example Response

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

PUT /gotapi/echonetLite/property

API Pattern

one-shot

Summary

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

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
epc	string	Yes	EPC。 ECHONET Property Code
value	string	Yes	EPCの設定値。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

File Profile

Ver. 2.0.0

Description

スマートデバイスに対してのファイル操作機能を提供するAPI。

Operations

GET /gotapi/file
POST /gotapi/file
PUT /gotapi/file
DELETE /gotapi/file
GET /gotapi/file/directory
POST /gotapi/file/directory
PUT /gotapi/file/directory
DELETE /gotapi/file/directory
GET /gotapi/file/list

スマートデバイスへの、テキスト（歩数、消費カロリー、睡眠時間などのバイナリーの任意のデータ）や画像、音声、動画（リソースも含む）を受け取る。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
path	string	Yes	ファイルパス。ファイル名とパス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
MimeType	mimeType	string	Yes	URIデータのMimeType
URI	uri	string	Yes	ContentProviderのURI このURIからデータを読み込む

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "mimeType" : "image/png",
  "uri" : "http://localhost:4035/gotapi/files?uri=content%3A%2F%2FTest.png"
}

スマートデバイスに対して、テキストや画像、音声、動画（リソースも含む）を渡す。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
path	string	Yes	ファイルパス。ファイル名とパス
mimeType	string	No	MimeType。送信するファイルのMimeType
uri	string	No	URI。このURIに送信するデータを格納する。dataと同時に省略することはできない。両方指定した場合はdataが優先され、uriは無視される。
data	file	No	ファイルのbinary。送信するファイルのbinary。uriと同時に省略することはできない。両方指定した場合はdataが優先され、uriは無視される。
forceOverwrite	boolean	No	上書きフラグ。 true : 既にpath名と同じファイルがある場合は上書きされる。 false : 既にpath名と同じファイルがある場合は上書きされない。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

ファイルパスで指定したテキストや画像、音声、動画（リソースも含む）の名前を変更、移動をする。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
oldPath	string	Yes	移動前のファイル名を含んだファイルパス。ファイル名を含む。
newPath	string	Yes	移動先のファイル名を含んだファイルパス。ファイル名を含まなくても良い。
forceOverwrite	boolean	No	上書きフラグ。 true : 既にpath名と同じファイルがある場合は上書きされる。 false : 既にpath名と同じファイルがある場合は上書きされない。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

ファイルパスで指定したテキストや画像、音声、動画（リソースも含む）を削除する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
path	string	Yes	ファイルパス。ファイル名とパス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/file/directory

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
path	string	No	パス。検索対象のディレクトリ。省略されたらそのデバイスプラグインのアプリがもつディレクトリのルートディレクトリを指定する。例)/files/test/
mimeType	string	No	MimeType。情報を取得するファイルの種別ごとに区切りたい場合は、mimeTypeを指定する例)image/png
order	array(string)	No	取得ファイルの並び順。取得する一覧のエントリの並び順。昇順はascで、降順はdescを後ろに指定する。並び順として選択する行をカンマ区切りでレスポンスの物理名を選択する。例)updateDate,asc
offset	integer	No	取得件数の始まり。取得できるファイル数が多いときに、表示開始位置を指定できる。例)4
limit	integer	No	取得件数の制限。取得できるファイル数を制限するときに、その件数を指定できる。例)30

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
検索結果数		count	integer	Yes	検索結果のファイル数
検索にヒットしたファイルの情報リスト		file	array(object)	Yes	検索にヒットしたファイルの情報を持つオブジェクト(object)の配列。
	ファイルパス	path	string	Yes	ファイル名を含めたファイルの存在するパス。
	MimeType	mimeType	string	Yes	fileのエンコードするタイプ。
	ファイルの種別	fileType	string	Yes	0: ファイル 1: ディレクトリ
	ファイルの名前	fileName	string	Yes
	更新時間	updateDate	dateTime	Yes	RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	ファイルサイズ	fileSize	integer	Yes	単位はbyte。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "count" : 2,
  "file" : [ {
    "path" : "/test/file1.txt",
    "fileName" : "file1.txt",
    "mimeType" : "text/plain",
    "updateDate" : "2015-05-17T10:02:20+09:00",
    "fileSize" : 123,
    "fileType" : 0
  } ]
}

POST /gotapi/file/directory

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
path	string	Yes	パス。作成するディレクトリのパス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/file/directory

API Pattern

one-shot

Summary

ディレクトリの名前の変更、移動要求を渡す。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
oldPath	string	Yes	移動前のディレクトリパス。ファイル名を含まない
newPath	string	Yes	移動先のディレクトリパス。ファイル名を含まない

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/file/directory

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
path	string	Yes	パス。削除するディレクトリのパス
forceRemove	boolean	No	強制削除フラグ。trueが指定された場合には、空ではないディレクトリも削除する。falseが指定された場合には、空でないディレクトリは削除できない。省略された場合には、falseと同じ動作となる。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/file/list

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
path	string	No	パス。検索対象のディレクトリ。省略されたらそのデバイスプラグインのアプリがもつディレクトリのルートディレクトリを指定する。例)/files/test/
mimeType	string	No	MimeType。情報を取得するファイルの種別ごとに区切りたい場合は、mimeTypeを指定する例)image/png
order	array(string)	No	取得ファイルの並び順。取得する一覧のエントリの並び順。昇順はascで、降順はdescを後ろに指定する。並び順として選択する行をカンマ区切りでレスポンスの物理名を選択する。例)updateDate,asc
offset	integer	No	取得件数の始まり。取得できるファイル数が多いときに、表示開始位置を指定できる。例)4
limit	integer	No	取得件数の制限。取得できるファイル数を制限するときに、その件数を指定できる。例)30

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
検索結果数		count	integer	Yes	検索結果のファイル数
検索にヒットしたファイルの情報リスト		file	array(object)	Yes	検索にヒットしたファイルの情報を持つオブジェクト(object)の配列。
	ファイルパス	path	string	Yes	ファイル名を含めたファイルの存在するパス。
	MimeType	mimeType	string	Yes	fileのエンコードするタイプ。
	ファイルの種別	fileType	string	Yes	0: ファイル 1: ディレクトリ
	ファイルの名前	fileName	string	Yes
	更新時間	updateDate	dateTime	Yes	RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	ファイルサイズ	fileSize	integer	Yes	単位はbyte。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "count" : 2,
  "file" : [ {
    "path" : "/test/file1.txt",
    "fileName" : "file1.txt",
    "mimeType" : "text/plain",
    "updateDate" : "2015-05-17T10:02:20+09:00",
    "fileSize" : 123,
    "fileType" : 0
  } ]
}

File Descriptor Profile

Ver. 2.0.0

Description

スマートフォンまたは周辺機器から他方のスマートデバイスに対してのファイルディスクリプタ操作機能を提供するAPI。

Operations

PUT /gotapi/fileDescriptor/close
GET /gotapi/fileDescriptor/onWatchFile
PUT /gotapi/fileDescriptor/onWatchFile
DELETE /gotapi/fileDescriptor/onWatchFile
GET /gotapi/fileDescriptor/open
GET /gotapi/fileDescriptor/read
PUT /gotapi/fileDescriptor/write

PUT /gotapi/fileDescriptor/close

API Pattern

one-shot

Summary

スマートデバイスのファイルを閉じるように要求する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
path	string	Yes	ファイルパス。ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。ディレクトリを指定した場合はエラーを返す。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/fileDescriptor/onWatchFile

API Pattern

one-shot

Summary

スマートデバイスのファイルの更新時間が変化したことを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "file" : {
    "path" : "Test1.png",
    "curr" : "2017-01-01T12:34:56+0900",
    "prev" : "2017-01-01T01:23:45+0900"
  }
}

PUT /gotapi/fileDescriptor/onWatchFile

API Pattern

event

Summary

スマートデバイスのファイルの更新時間が変化したことを通知するイベントを登録する。

Description

スマートデバイスのファイルへの書き込みが発生した時にイベントが発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name	Physical Name	Type	Required	Description
サービスID	serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名	profile	string	Yes	プロファイル名。
インターフェース名	interface	string	Yes	インターフェース名。
アトリビュート名	attribute	string	Yes	アトリビュート名。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "filedescriptor",
  "attribute" : "onwatchfile",
  "file" : {
    "path" : "/dir/file1.txt",
    "curr" : "2014-05-02 T10:32:10+0900",
    "prev" : "2014-05-01 T10:32:10+0900"
  }
}

DELETE /gotapi/fileDescriptor/onWatchFile

API Pattern

event

Summary

スマートデバイスのファイルの更新時間が変化したことを通知するイベントを登録解除する。

Description

スマートデバイスのファイルへの書き込みが発生した時にイベントが発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/fileDescriptor/open

API Pattern

one-shot

Summary

スマートデバイスのファイルを開くように要求する。

Description

ここで使用するpathは、File APIで取得できる。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
path	string	Yes	ファイルパス。ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。ディレクトリを指定した場合はエラーを返す。
flag	string	Yes	フラグ。r : 読み込みのみ rw : 読み込み＆書き込み

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/fileDescriptor/read

API Pattern

one-shot

Summary

スマートデバイスのファイルを指定したサイズ分取得する。

Description

スマートデバイスのファイルが読み込み完了していない場合には、再度このAPIを呼び出して取得を行う。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
path	string	Yes	ファイルパス。ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。ディレクトリを指定した場合はエラーを返す。
length	long	Yes	読み込みサイズ。一度の読み込みで取得する最大サイズ。length > 0
position	long	No	読み込み開始位置。読み込みファイルの開始位置を指定する。省略された場合には、現在ファイルが読み込んでいる位置から読み込む。position >= 0

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
データサイズ	size	integer	Yes	読み込んだデータのサイズ
データ	fileData	string	Yes	読み込んだデータをdata URI schemeの形式で設定する

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "size" : 100,
  "fileData" : "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
}

PUT /gotapi/fileDescriptor/write

API Pattern

one-shot

Summary

スマートデバイスのファイルへの書き込みを要求する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
path	string	Yes	ファイルパス。ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。ディレクトリを指定した場合はエラーを返す。
uri	string	No	URI。dataと同時に省略することはできない。両方指定した場合はdataが優先され、uriは無視される。
data	file	No	ファイルのbinary。送信するファイルのbinary。uriと同時に省略することはできない。両方指定した場合はdataが優先され、uriは無視される。
position	long	No	ファイルオフセット。ファイルの書き込み開始位置を指定する。省略された場合には、現在ファイルが書き込んでいる位置から書き込む。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Geolocation Profile

Ver. 2.0.0

Description

スマートデバイスの位置情報機能を提供するAPI。

Operations

GET /gotapi/geolocation/currentPosition
GET /gotapi/geolocation/onWatchPosition
PUT /gotapi/geolocation/onWatchPosition
DELETE /gotapi/geolocation/onWatchPosition

GET /gotapi/geolocation/currentPosition

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
highAccuracy	boolean	No	測位精度設定。 true : 高精度 false : 通常精度省略時はfalse
maximumAge	double	No	位置情報有効時間（ミリ秒単位）省略時は0mSec ※前回呼び出し時から該当時間以上経過していた場合に最新の位置情報を返す。それ以外は前回と同じ位置情報を返す。

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
位置情報			position	object	Yes
	座標		coordinates	object	Yes	座標のオブジェクト
		緯度	latitude	float	No	-180～180 単位：degree
		経度	longitude	float	No	-90～90 単位：degree
		高度	altitude	float	No	単位：m
		緯度・経度の誤差	accuracy	float	No	単位：m
		高度の誤差	altitudeAccuracy	float	No	単位：m
		方角	heading	float	No	0～359 単位：degree 真北に対して右回りで 0 ≦ heading ＜ 360
		速度	speed	float	No	単位：m/Sec
	測位時刻		timeStamp	float	Yes	エポックからのミリ秒
	測位時刻 (文字列)		timeStampString	dateTime	Yes	測位時刻を文字列表記 RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "position" : {
    "coordinates" : {
      "latitude" : 37.52104948,
      "longitude" : 139.93875834,
      "altitude" : 285,
      "accuracy" : 31,
      "altitudeAccuracy" : 15,
      "heading" : 0,
      "speed" : 0
    },
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

GET /gotapi/geolocation/onWatchPosition

API Pattern

one-shot

Summary

該当デバイスの位置情報定期通知イベントを取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
highAccuracy	boolean	No	測位精度設定。 true : 高精度 false : 通常精度省略時はfalse
interval	double	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
位置情報			position	object	Yes
	座標		coordinates	object	Yes	座標のオブジェクト
		緯度	latitude	float	No	-180～180 単位：degree
		経度	longitude	float	No	-90～90 単位：degree
		高度	altitude	float	No	単位：m
		緯度・経度の誤差	accuracy	float	No	単位：m
		高度の誤差	altitudeAccuracy	float	No	単位：m
		方角	heading	float	No	0～359 単位：degree 真北に対して右回りで 0 ≦ heading ＜ 360
		速度	speed	float	No	単位：m/Sec
	測位時刻		timeStamp	float	Yes	エポックからのミリ秒
	測位時刻 (文字列)		timeStampString	dateTime	Yes	測位時刻を文字列表記 RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "position" : {
    "coordinates" : {
      "latitude" : 37.52104948,
      "longitude" : 139.93875834,
      "altitude" : 285,
      "accuracy" : 31,
      "altitudeAccuracy" : 15,
      "heading" : 0,
      "speed" : 0
    },
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

PUT /gotapi/geolocation/onWatchPosition

API Pattern

event

Summary

該当デバイスの位置情報定期通知イベントを開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
highAccuracy	boolean	No	測位精度設定。 true : 高精度 false : 通常精度省略時はfalse
interval	double	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
位置情報			position	object	Yes
	座標		coordinates	object	Yes	座標のオブジェクト
		緯度	latitude	float	No	-180～180 単位：degree
		経度	longitude	float	No	-90～90 単位：degree
		高度	altitude	float	No	単位：m
		緯度・経度の誤差	accuracy	float	No	単位：m
		高度の誤差	altitudeAccuracy	float	No	単位：m
		方角	heading	float	No	0～359 単位：degree 真北に対して右回りで 0 ≦ heading ＜ 360
		速度	speed	float	No	単位：m/Sec
	測位時刻		timeStamp	float	Yes	エポックからのミリ秒
	測位時刻 (文字列)		timeStampString	dateTime	Yes	測位時刻を文字列表記 RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "geolocation",
  "attribute" : "onwatchposition",
  "position" : {
    "coordinates" : {
      "latitude" : 37.52104948,
      "longitude" : 139.93875834,
      "altitude" : 285,
      "accuracy" : 31,
      "altitudeAccuracy" : 15,
      "heading" : 0,
      "speed" : 0
    },
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

DELETE /gotapi/geolocation/onWatchPosition

API Pattern

event

Summary

該当デバイスの位置情報定期通知イベントを停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GPIO Profile

Ver. 2.0.0

Description

General Purpose Input/Output（汎用入出力）にアクセスする機能を提供するProfile。

Operations

GET /gotapi/gpio/analog/A0
POST /gotapi/gpio/analog/A0
GET /gotapi/gpio/analog/A1
POST /gotapi/gpio/analog/A1
GET /gotapi/gpio/analog/A2
POST /gotapi/gpio/analog/A2
GET /gotapi/gpio/analog/A3
POST /gotapi/gpio/analog/A3
GET /gotapi/gpio/analog/A4
POST /gotapi/gpio/analog/A4
GET /gotapi/gpio/analog/A5
POST /gotapi/gpio/analog/A5
GET /gotapi/gpio/digital/D0
POST /gotapi/gpio/digital/D0
PUT /gotapi/gpio/digital/D0
DELETE /gotapi/gpio/digital/D0
GET /gotapi/gpio/digital/D1
POST /gotapi/gpio/digital/D1
PUT /gotapi/gpio/digital/D1
DELETE /gotapi/gpio/digital/D1
GET /gotapi/gpio/digital/D10
POST /gotapi/gpio/digital/D10
PUT /gotapi/gpio/digital/D10
DELETE /gotapi/gpio/digital/D10
GET /gotapi/gpio/digital/D11
POST /gotapi/gpio/digital/D11
PUT /gotapi/gpio/digital/D11
DELETE /gotapi/gpio/digital/D11
GET /gotapi/gpio/digital/D12
POST /gotapi/gpio/digital/D12
PUT /gotapi/gpio/digital/D12
DELETE /gotapi/gpio/digital/D12
GET /gotapi/gpio/digital/D13
POST /gotapi/gpio/digital/D13
PUT /gotapi/gpio/digital/D13
DELETE /gotapi/gpio/digital/D13
GET /gotapi/gpio/digital/D2
POST /gotapi/gpio/digital/D2
PUT /gotapi/gpio/digital/D2
DELETE /gotapi/gpio/digital/D2
GET /gotapi/gpio/digital/D3
POST /gotapi/gpio/digital/D3
PUT /gotapi/gpio/digital/D3
DELETE /gotapi/gpio/digital/D3
GET /gotapi/gpio/digital/D4
POST /gotapi/gpio/digital/D4
PUT /gotapi/gpio/digital/D4
DELETE /gotapi/gpio/digital/D4
GET /gotapi/gpio/digital/D5
POST /gotapi/gpio/digital/D5
PUT /gotapi/gpio/digital/D5
DELETE /gotapi/gpio/digital/D5
GET /gotapi/gpio/digital/D6
POST /gotapi/gpio/digital/D6
PUT /gotapi/gpio/digital/D6
DELETE /gotapi/gpio/digital/D6
GET /gotapi/gpio/digital/D7
POST /gotapi/gpio/digital/D7
PUT /gotapi/gpio/digital/D7
DELETE /gotapi/gpio/digital/D7
GET /gotapi/gpio/digital/D8
POST /gotapi/gpio/digital/D8
PUT /gotapi/gpio/digital/D8
DELETE /gotapi/gpio/digital/D8
GET /gotapi/gpio/digital/D9
POST /gotapi/gpio/digital/D9
PUT /gotapi/gpio/digital/D9
DELETE /gotapi/gpio/digital/D9
POST /gotapi/gpio/export/A0
POST /gotapi/gpio/export/A1
POST /gotapi/gpio/export/A2
POST /gotapi/gpio/export/A3
POST /gotapi/gpio/export/A4
POST /gotapi/gpio/export/A5
POST /gotapi/gpio/export/D0
POST /gotapi/gpio/export/D1
POST /gotapi/gpio/export/D10
POST /gotapi/gpio/export/D11
POST /gotapi/gpio/export/D12
POST /gotapi/gpio/export/D13
POST /gotapi/gpio/export/D2
POST /gotapi/gpio/export/D3
POST /gotapi/gpio/export/D4
POST /gotapi/gpio/export/D5
POST /gotapi/gpio/export/D6
POST /gotapi/gpio/export/D7
POST /gotapi/gpio/export/D8
POST /gotapi/gpio/export/D9
GET /gotapi/gpio/onChange
PUT /gotapi/gpio/onChange
DELETE /gotapi/gpio/onChange

GET /gotapi/gpio/analog/A0

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	指定したピンのアナログ値

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1024
}

POST /gotapi/gpio/analog/A0

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	float	Yes	値。出力するアナログ値

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/analog/A1

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	指定したピンのアナログ値

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1024
}

POST /gotapi/gpio/analog/A1

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	float	Yes	値。出力するアナログ値

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/analog/A2

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	指定したピンのアナログ値

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1024
}

POST /gotapi/gpio/analog/A2

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	float	Yes	値。出力するアナログ値

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/analog/A3

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	指定したピンのアナログ値

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1024
}

POST /gotapi/gpio/analog/A3

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	float	Yes	値。出力するアナログ値

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/analog/A4

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	指定したピンのアナログ値

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1024
}

POST /gotapi/gpio/analog/A4

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	float	Yes	値。出力するアナログ値

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/analog/A5

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	指定したピンのアナログ値

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1024
}

POST /gotapi/gpio/analog/A5

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	float	Yes	値。出力するアナログ値

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D0

API Pattern

one-shot

Summary

D0ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D0

API Pattern

one-shot

Summary

D0ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D0

API Pattern

one-shot

Summary

D0ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D0

API Pattern

one-shot

Summary

D0ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D1

API Pattern

one-shot

Summary

D1ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D1

API Pattern

one-shot

Summary

D1ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D1

API Pattern

one-shot

Summary

D1ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D1

API Pattern

one-shot

Summary

D1ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D10

API Pattern

one-shot

Summary

D10ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D10

API Pattern

one-shot

Summary

D10ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D10

API Pattern

one-shot

Summary

D10ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D10

API Pattern

one-shot

Summary

D10ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D11

API Pattern

one-shot

Summary

D11ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D11

API Pattern

one-shot

Summary

D11ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D11

API Pattern

one-shot

Summary

D11ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D11

API Pattern

one-shot

Summary

D11ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D12

API Pattern

one-shot

Summary

D12ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D12

API Pattern

one-shot

Summary

D12ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D12

API Pattern

one-shot

Summary

D12ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D12

API Pattern

one-shot

Summary

D12ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D13

API Pattern

one-shot

Summary

D13ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D13

API Pattern

one-shot

Summary

D13ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D13

API Pattern

one-shot

Summary

D13ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D13

API Pattern

one-shot

Summary

D13ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D2

API Pattern

one-shot

Summary

D2ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D2

API Pattern

one-shot

Summary

D2ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D2

API Pattern

one-shot

Summary

D2ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D2

API Pattern

one-shot

Summary

D2ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D3

API Pattern

one-shot

Summary

D3ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D3

API Pattern

one-shot

Summary

D3ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D3

API Pattern

one-shot

Summary

D3ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D3

API Pattern

one-shot

Summary

D3ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D4

API Pattern

one-shot

Summary

D4ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D4

API Pattern

one-shot

Summary

D4ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D4

API Pattern

one-shot

Summary

D4ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D4

API Pattern

one-shot

Summary

D4ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D5

API Pattern

one-shot

Summary

D5ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D5

API Pattern

one-shot

Summary

D5ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D5

API Pattern

one-shot

Summary

D5ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D5

API Pattern

one-shot

Summary

D5ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D6

API Pattern

one-shot

Summary

D6ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D6

API Pattern

one-shot

Summary

D6ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D6

API Pattern

one-shot

Summary

D6ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D6

API Pattern

one-shot

Summary

D6ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D7

API Pattern

one-shot

Summary

D7ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D7

API Pattern

one-shot

Summary

D7ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D7

API Pattern

one-shot

Summary

D7ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D7

API Pattern

one-shot

Summary

D7ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D8

API Pattern

one-shot

Summary

D8ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D8

API Pattern

one-shot

Summary

D8ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D8

API Pattern

one-shot

Summary

D8ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D8

API Pattern

one-shot

Summary

D8ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/digital/D9

API Pattern

one-shot

Summary

D9ピンにデジタル値 HIGH(1)またはLOW(1)を入力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピンから取得した値	value	float	Yes	ピンの値、HIGH(1) or LOW(0)が返ってくる。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}

POST /gotapi/gpio/digital/D9

API Pattern

one-shot

Summary

D9ピンにデジタル値のHIGH(1)またはLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
value	integer	Yes	値。出力する値 LOW(0), HIGH(1)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/gpio/digital/D9

API Pattern

one-shot

Summary

D9ピンにデジタル値のHIGH(1)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/gpio/digital/D9

API Pattern

one-shot

Summary

D9ピンにデジタル値のLOW(0)を出力。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/A0

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/A1

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/A2

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/A3

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/A4

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/A5

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D0

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D1

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D10

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D11

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D12

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D13

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D2

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D3

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D4

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D5

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D6

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D7

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D8

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/gpio/export/D9

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	float	Yes	モード。設定するモード 0:デジタルIN 1:デジタルOUT 2:アナログIN 3:アナログOUT

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/gpio/onChange

API Pattern

one-shot

Summary

各ピンで、入力状態のモードに設定されているピンの値を取得する

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ピン一覧		pins	object	Yes
	ピンの値	{ピン番号}	integer	No	取得したピンの値

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "pins" : {
    "14" : 1023,
    "15" : 111,
    "16" : 201,
    "17" : 0,
    "18" : 1014,
    "19" : 99
  }
}

PUT /gotapi/gpio/onChange

API Pattern

event

Summary

各ピンで、入力状態のモードに設定されているピンの値を定期的に送信するイベントを開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
ピン一覧		pins	object	Yes
	ピンの値	{ピン番号}	integer	No	取得したピンの値

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "gpio",
  "attribute" : "onchange",
  "pins" : {
    "14" : 1023,
    "15" : 111,
    "16" : 201,
    "17" : 0,
    "18" : 1014,
    "19" : 99
  }
}

DELETE /gotapi/gpio/onChange

API Pattern

event

Summary

各ピンで、入力状態のモードに設定されているピンの値を定期的に送信するイベントを停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Health Profile

Ver. 2.0.0

Description

ヘルスケア関連のデバイスから通知されるイベントを受信するAPI.

Operations

GET /gotapi/health/heart
PUT /gotapi/health/heart
DELETE /gotapi/health/heart
GET /gotapi/health/heartRate
PUT /gotapi/health/heartRate
DELETE /gotapi/health/heartRate
GET /gotapi/health/onheart
PUT /gotapi/health/onheart
DELETE /gotapi/health/onheart

GET /gotapi/health/heart

API Pattern

one-shot

Summary

デバイスの心拍数計測通知イベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
心拍数計測結果			heart	object	Yes	検出値、検出したデバイスの情報を取得する。
	心拍数オブジェクト		rate	object	Yes	心拍数の情報を持つ。
		心拍数	value	integer	Yes	ターゲットデバイスで測定した心拍数を返す。
		心拍数のMDER Float値	mderFloat	string	Yes	ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
		心拍数のタイプ	type	string	Yes	この値が「heart rate」であることを表す文字列を返す。取得できない場合は、空文字を返す。
		心拍数のオブジェクトのタイプのコード	typeCode	string	Yes	「147842」という「heart rate」を意味するコードを返す。取得できない場合は、空文字を返す。
		心拍数の単位	unit	string	Yes	「beat per min」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
		心拍数の単位コード	unitCode	string	Yes	「264864」という「beat per min」を意味するコードを返す。取得できない場合は、空文字を返す。
		心拍数のタイムスタンプ	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
		心拍数のタイムスタンプ文字列	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	RR間隔オブジェクト		rr	object	No	RR間隔値の情報を持つ。
		RR間隔値	value	integer	No	ターゲットデバイスで測定したRR間隔を返す。
		RR間隔のMDER Float値	mderFloat	string	No	RR間隔値のMDERFloat値を返す。
		RR間隔のタイプ	type	string	No	RR間隔を表す「RR interval」を返す。取得できない場合は、空文字を返す。
		RR間隔のオブジェクトのタイプのコード	typeCode	string	No	RR間隔を表す「147240」を返す。取得できない場合は、空文字を返す。
		RR間隔の単位	unit	string	No	RR間隔の単位を表す「ms」を返す。取得できない場合は、空文字を返す。
		RR間隔の単位コード	unitCode	string	No	RR間隔の単位であるmsを表す「264338」を返す。取得できない場合は、空文字を返す。
		RR間隔のタイムスタンプ	timeStamp	long	No	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
		RR間隔のタイムスタンプ文字列	timeStampString	dateTime	No	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	消費エネルギーオブジェクト		energy	object	No	消費エネルギーの情報を持つ。
		消費エネルギー	value	integer	No	ターゲットデバイスで測定した消費エネルギー値を返す。
		消費エネルギーのMDER Float値	mderFloat	string	No	消費エネルギー値のMDERFloat値を返す。
		消費エネルギーのタイプ	type	string	No	消費エネルギー値を表す「energy expended」を返す。取得できない場合は、空文字を返す。
		消費エネルギーのタイプコード	typeCode	string	No	消費エネルギー値を表す「119」を返す。取得できない場合は、空文字を返す。
		消費エネルギーの単位	unit	string	No	消費エネルギー値の単位を表す「Calories」を返す。取得できない場合は、空文字を返す。
		消費エネルギーの単位コード	unitCode	string	No	消費エネルギー値の単位であるCaloriesを表す「6784」を返す。取得できない場合は、空文字を返す。
		消費エネルギーのタイムスタンプ	timeStamp	long	No	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
		消費エネルギーのタイムスタンプ文字列	timeStampString	dateTime	No	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	デバイスオブジェクト		device	object	Yes	健康機器の情報を持つ。
		プロダクト名	productName	string	Yes	ターゲットデバイスの製品名。取得できない時は任意のアルゴリズムでデバイス名を生成。
		メーカ名	manufacturerName	string	Yes	ターゲットデバイスのメーカ名。取得できない場合は空文字を指定。
		モデルの番号	modelNumber	string	Yes	ターゲットデバイスのモデル番号。取得できない場合は空文字を指定
		ファームウェアリビジョン	firmwareRevision	string	Yes	ターゲットデバイスのファームウェアリビジョン。取得できない場合は空文字を指定。
		シリアルナンバー	serialNumber	string	Yes	ターゲットデバイスのシリアル番号。取得できない場合は空文字を指定。
		ソフトウェアリビジョン	softwareRevision	string	Yes	ターゲットデバイスのソフトウェアリビジョン。取得できない場合は空文字を指定。
		ハードウェアリビジョン	hardwareRevision	string	Yes	ターゲットデバイスのハードウェアリビジョン。取得できない場合は、空文字を指定。
		パートナンバー	partNumber	string	Yes	ターゲットデバイスのパート番号。取得できない場合は、空文字を指定。
		プロトコルリビジョン	protocolRevision	string	Yes	ターゲットデバイスのプロトコルリビジョン。取得できない場合は、空文字を指定。
		システムID	systemId	string	Yes	ターゲットデバイスのシステムID。16進数。取得できない場合は「0x0」。
		バッテリーレベル	batteryLevel	float	Yes	ターゲットデバイスのバッテリーレベル。取得できない場合は-1.0を返す。範囲: 0.0〜1.0

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "heart" : {
    "rate" : {
      "value" : 60,
      "mderFloat" : "00000042",
      "type" : "heart rate",
      "typeCode" : 147842,
      "unit" : "beat per min",
      "unitCode" : 264864,
      "timeStamp" : 1483241696789,
      "timeStampString" : "2015-05-17T10:02:20+09:00"
    },
    "rr" : {
      "value" : 909.1796875,
      "mderFloat" : "F9E9CF8B",
      "type" : "RR interval",
      "typeCode" : 147240,
      "unit" : "ms",
      "unitCode" : 264338,
      "timeStamp" : 1483241696789,
      "timeStampString" : "2015-05-17T10:02:20+09:00"
    },
    "energy" : {
      "value" : 0,
      "mderFloat" : "01000000",
      "type" : "energy expended",
      "typeCode" : 119,
      "unit" : "Calories",
      "unitCode" : 6784,
      "timeStamp" : 1483241696789,
      "timeStampString" : "2015-05-17T10:02:20+09:00"
    },
    "device" : {
      "productName" : "DUMMY DEVICE",
      "manufacturerName" : "",
      "modelNumber" : "",
      "firmwareRevision" : "",
      "serialNumber" : "",
      "softwareRevision" : "",
      "hardwareRevision" : "",
      "partNumber" : "",
      "protocolRevision" : "",
      "systemId" : "0x0",
      "batteryLevel" : -1
    }
  }
}

PUT /gotapi/health/heart

API Pattern

event

Summary

デバイスの心拍数計測通知イベントを開始する。

Description

当該イベントの通知を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
心拍数計測結果			heart	object	Yes	検出値、検出したデバイスの情報を取得する。
	心拍数オブジェクト		rate	object	Yes	心拍数の情報を持つ。
		心拍数	value	integer	Yes	ターゲットデバイスで測定した心拍数を返す。
		心拍数のMDER Float値	mderFloat	string	Yes	ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
		心拍数のタイプ	type	string	Yes	この値が「heart rate」であることを表す文字列を返す。取得できない場合は、空文字を返す。
		心拍数のオブジェクトのタイプのコード	typeCode	string	Yes	「147842」という「heart rate」を意味するコードを返す。取得できない場合は、空文字を返す。
		心拍数の単位	unit	string	Yes	「beat per min」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
		心拍数の単位コード	unitCode	string	Yes	「264864」という「beat per min」を意味するコードを返す。取得できない場合は、空文字を返す。
		心拍数のタイムスタンプ	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
		心拍数のタイムスタンプ文字列	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	RR間隔オブジェクト		rr	object	No	RR間隔値の情報を持つ。
		RR間隔値	value	integer	No	ターゲットデバイスで測定したRR間隔を返す。
		RR間隔のMDER Float値	mderFloat	string	No	RR間隔値のMDERFloat値を返す。
		RR間隔のタイプ	type	string	No	RR間隔を表す「RR interval」を返す。取得できない場合は、空文字を返す。
		RR間隔のオブジェクトのタイプのコード	typeCode	string	No	RR間隔を表す「147240」を返す。取得できない場合は、空文字を返す。
		RR間隔の単位	unit	string	No	RR間隔の単位を表す「ms」を返す。取得できない場合は、空文字を返す。
		RR間隔の単位コード	unitCode	string	No	RR間隔の単位であるmsを表す「264338」を返す。取得できない場合は、空文字を返す。
		RR間隔のタイムスタンプ	timeStamp	long	No	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
		RR間隔のタイムスタンプ文字列	timeStampString	dateTime	No	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	消費エネルギーオブジェクト		energy	object	No	消費エネルギーの情報を持つ。
		消費エネルギー	value	integer	No	ターゲットデバイスで測定した消費エネルギー値を返す。
		消費エネルギーのMDER Float値	mderFloat	string	No	消費エネルギー値のMDERFloat値を返す。
		消費エネルギーのタイプ	type	string	No	消費エネルギー値を表す「energy expended」を返す。取得できない場合は、空文字を返す。
		消費エネルギーのタイプコード	typeCode	string	No	消費エネルギー値を表す「119」を返す。取得できない場合は、空文字を返す。
		消費エネルギーの単位	unit	string	No	消費エネルギー値の単位を表す「Calories」を返す。取得できない場合は、空文字を返す。
		消費エネルギーの単位コード	unitCode	string	No	消費エネルギー値の単位であるCaloriesを表す「6784」を返す。取得できない場合は、空文字を返す。
		消費エネルギーのタイムスタンプ	timeStamp	long	No	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
		消費エネルギーのタイムスタンプ文字列	timeStampString	dateTime	No	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	デバイスオブジェクト		device	object	Yes	健康機器の情報を持つ。
		プロダクト名	productName	string	Yes	ターゲットデバイスの製品名。取得できない時は任意のアルゴリズムでデバイス名を生成。
		メーカ名	manufacturerName	string	Yes	ターゲットデバイスのメーカ名。取得できない場合は空文字を指定。
		モデルの番号	modelNumber	string	Yes	ターゲットデバイスのモデル番号。取得できない場合は空文字を指定
		ファームウェアリビジョン	firmwareRevision	string	Yes	ターゲットデバイスのファームウェアリビジョン。取得できない場合は空文字を指定。
		シリアルナンバー	serialNumber	string	Yes	ターゲットデバイスのシリアル番号。取得できない場合は空文字を指定。
		ソフトウェアリビジョン	softwareRevision	string	Yes	ターゲットデバイスのソフトウェアリビジョン。取得できない場合は空文字を指定。
		ハードウェアリビジョン	hardwareRevision	string	Yes	ターゲットデバイスのハードウェアリビジョン。取得できない場合は、空文字を指定。
		パートナンバー	partNumber	string	Yes	ターゲットデバイスのパート番号。取得できない場合は、空文字を指定。
		プロトコルリビジョン	protocolRevision	string	Yes	ターゲットデバイスのプロトコルリビジョン。取得できない場合は、空文字を指定。
		システムID	systemId	string	Yes	ターゲットデバイスのシステムID。16進数。取得できない場合は「0x0」。
		バッテリーレベル	batteryLevel	float	Yes	ターゲットデバイスのバッテリーレベル。取得できない場合は-1.0を返す。範囲: 0.0〜1.0

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "health",
  "attribute" : "heart",
  "heart" : {
    "rate" : {
      "value" : 60,
      "mderFloat" : "00000042",
      "type" : "heart rate",
      "typeCode" : 147842,
      "unit" : "beat per min",
      "unitCode" : 264864,
      "timeStamp" : 1483241696789,
      "timeStampString" : "2015-05-17T10:02:20+09:00"
    },
    "rr" : {
      "value" : 909.1796875,
      "mderFloat" : "F9E9CF8B",
      "type" : "RR interval",
      "typeCode" : 147240,
      "unit" : "ms",
      "unitCode" : 264338,
      "timeStamp" : 1483241696789,
      "timeStampString" : "2015-05-17T10:02:20+09:00"
    },
    "energy" : {
      "value" : 0,
      "mderFloat" : "01000000",
      "type" : "energy expended",
      "typeCode" : 119,
      "unit" : "Calories",
      "unitCode" : 6784,
      "timeStamp" : 1483241696789,
      "timeStampString" : "2015-05-17T10:02:20+09:00"
    },
    "device" : {
      "productName" : "DUMMY DEVICE",
      "manufacturerName" : "",
      "modelNumber" : "",
      "firmwareRevision" : "",
      "serialNumber" : "",
      "softwareRevision" : "",
      "hardwareRevision" : "",
      "partNumber" : "",
      "protocolRevision" : "",
      "systemId" : "0x0",
      "batteryLevel" : -1
    }
  }
}

DELETE /gotapi/health/heart

API Pattern

event

Summary

デバイスの心拍数計測通知イベントを停止する。

Description

当該イベントの通知を停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/health/heartRate

API Pattern

one-shot

Summary

デバイスの心拍数計測通知イベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
心拍数	heartRate	integer	Yes	ターゲットデバイスで測定した心拍数を返す。

Example Response

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

PUT /gotapi/health/heartRate

API Pattern

event

Summary

デバイスの心拍数計測通知イベントを開始する。

Description

当該イベントの通知を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name	Physical Name	Type	Required	Description
サービスID	serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名	profile	string	Yes	プロファイル名。
インターフェース名	interface	string	Yes	インターフェース名。
アトリビュート名	attribute	string	Yes	アトリビュート名。
心拍数	heartRate	integer	Yes	ターゲットデバイスで測定した心拍数を返す。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "health",
  "attribute" : "heartrate",
  "heartRate" : 80
}

DELETE /gotapi/health/heartRate

API Pattern

event

Summary

デバイスの心拍数計測通知イベントを停止する。

Description

当該イベントの通知を停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/health/onheart

API Pattern

one-shot

Summary

デバイスの心拍数計測通知イベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
心拍数計測結果			heart	object	Yes	検出値、検出したデバイスの情報を取得する。
	心拍数オブジェクト		rate	object	Yes	心拍数の情報を持つ。
		心拍数	value	integer	Yes	ターゲットデバイスで測定した心拍数を返す。
		心拍数のMDER Float値	mderFloat	string	Yes	ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
		心拍数のタイプ	type	string	Yes	この値が「heart rate」であることを表す文字列を返す。取得できない場合は、空文字を返す。
		心拍数のオブジェクトのタイプのコード	typeCode	string	Yes	「147842」という「heart rate」を意味するコードを返す。取得できない場合は、空文字を返す。
		心拍数の単位	unit	string	Yes	「beat per min」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
		心拍数の単位コード	unitCode	string	Yes	「264864」という「beat per min」を意味するコードを返す。取得できない場合は、空文字を返す。
		心拍数のタイムスタンプ	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
		心拍数のタイムスタンプ文字列	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	RR間隔オブジェクト		rr	object	No	RR間隔値の情報を持つ。
		RR間隔値	value	integer	No	ターゲットデバイスで測定したRR間隔を返す。
		RR間隔のMDER Float値	mderFloat	string	No	RR間隔値のMDERFloat値を返す。
		RR間隔のタイプ	type	string	No	RR間隔を表す「RR interval」を返す。取得できない場合は、空文字を返す。
		RR間隔のオブジェクトのタイプのコード	typeCode	string	No	RR間隔を表す「147240」を返す。取得できない場合は、空文字を返す。
		RR間隔の単位	unit	string	No	RR間隔の単位を表す「ms」を返す。取得できない場合は、空文字を返す。
		RR間隔の単位コード	unitCode	string	No	RR間隔の単位であるmsを表す「264338」を返す。取得できない場合は、空文字を返す。
		RR間隔のタイムスタンプ	timeStamp	long	No	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
		RR間隔のタイムスタンプ文字列	timeStampString	dateTime	No	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	消費エネルギーオブジェクト		energy	object	No	消費エネルギーの情報を持つ。
		消費エネルギー	value	integer	No	ターゲットデバイスで測定した消費エネルギー値を返す。
		消費エネルギーのMDER Float値	mderFloat	string	No	消費エネルギー値のMDERFloat値を返す。
		消費エネルギーのタイプ	type	string	No	消費エネルギー値を表す「energy expended」を返す。取得できない場合は、空文字を返す。
		消費エネルギーのタイプコード	typeCode	string	No	消費エネルギー値を表す「119」を返す。取得できない場合は、空文字を返す。
		消費エネルギーの単位	unit	string	No	消費エネルギー値の単位を表す「Calories」を返す。取得できない場合は、空文字を返す。
		消費エネルギーの単位コード	unitCode	string	No	消費エネルギー値の単位であるCaloriesを表す「6784」を返す。取得できない場合は、空文字を返す。
		消費エネルギーのタイムスタンプ	timeStamp	long	No	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
		消費エネルギーのタイムスタンプ文字列	timeStampString	dateTime	No	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	デバイスオブジェクト		device	object	Yes	健康機器の情報を持つ。
		プロダクト名	productName	string	Yes	ターゲットデバイスの製品名。取得できない時は任意のアルゴリズムでデバイス名を生成。
		メーカ名	manufacturerName	string	Yes	ターゲットデバイスのメーカ名。取得できない場合は空文字を指定。
		モデルの番号	modelNumber	string	Yes	ターゲットデバイスのモデル番号。取得できない場合は空文字を指定
		ファームウェアリビジョン	firmwareRevision	string	Yes	ターゲットデバイスのファームウェアリビジョン。取得できない場合は空文字を指定。
		シリアルナンバー	serialNumber	string	Yes	ターゲットデバイスのシリアル番号。取得できない場合は空文字を指定。
		ソフトウェアリビジョン	softwareRevision	string	Yes	ターゲットデバイスのソフトウェアリビジョン。取得できない場合は空文字を指定。
		ハードウェアリビジョン	hardwareRevision	string	Yes	ターゲットデバイスのハードウェアリビジョン。取得できない場合は、空文字を指定。
		パートナンバー	partNumber	string	Yes	ターゲットデバイスのパート番号。取得できない場合は、空文字を指定。
		プロトコルリビジョン	protocolRevision	string	Yes	ターゲットデバイスのプロトコルリビジョン。取得できない場合は、空文字を指定。
		システムID	systemId	string	Yes	ターゲットデバイスのシステムID。16進数。取得できない場合は「0x0」。
		バッテリーレベル	batteryLevel	float	Yes	ターゲットデバイスのバッテリーレベル。取得できない場合は-1.0を返す。範囲: 0.0〜1.0

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "heart" : {
    "rate" : {
      "value" : 60,
      "mderFloat" : "00000042",
      "type" : "heart rate",
      "typeCode" : 147842,
      "unit" : "beat per min",
      "unitCode" : 264864,
      "timeStamp" : 1483241696789,
      "timeStampString" : "2015-05-17T10:02:20+09:00"
    },
    "rr" : {
      "value" : 909.1796875,
      "mderFloat" : "F9E9CF8B",
      "type" : "RR interval",
      "typeCode" : 147240,
      "unit" : "ms",
      "unitCode" : 264338,
      "timeStamp" : 1483241696789,
      "timeStampString" : "2015-05-17T10:02:20+09:00"
    },
    "energy" : {
      "value" : 0,
      "mderFloat" : "01000000",
      "type" : "energy expended",
      "typeCode" : 119,
      "unit" : "Calories",
      "unitCode" : 6784,
      "timeStamp" : 1483241696789,
      "timeStampString" : "2015-05-17T10:02:20+09:00"
    },
    "device" : {
      "productName" : "DUMMY DEVICE",
      "manufacturerName" : "",
      "modelNumber" : "",
      "firmwareRevision" : "",
      "serialNumber" : "",
      "softwareRevision" : "",
      "hardwareRevision" : "",
      "partNumber" : "",
      "protocolRevision" : "",
      "systemId" : "0x0",
      "batteryLevel" : -1
    }
  }
}

PUT /gotapi/health/onheart

API Pattern

event

Summary

デバイスの心拍数計測通知イベントを開始する。

Description

当該イベントの通知を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
心拍数計測結果			heart	object	Yes	検出値、検出したデバイスの情報を取得する。
	心拍数オブジェクト		rate	object	Yes	心拍数の情報を持つ。
		心拍数	value	integer	Yes	ターゲットデバイスで測定した心拍数を返す。
		心拍数のMDER Float値	mderFloat	string	Yes	ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
		心拍数のタイプ	type	string	Yes	この値が「heart rate」であることを表す文字列を返す。取得できない場合は、空文字を返す。
		心拍数のオブジェクトのタイプのコード	typeCode	string	Yes	「147842」という「heart rate」を意味するコードを返す。取得できない場合は、空文字を返す。
		心拍数の単位	unit	string	Yes	「beat per min」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
		心拍数の単位コード	unitCode	string	Yes	「264864」という「beat per min」を意味するコードを返す。取得できない場合は、空文字を返す。
		心拍数のタイムスタンプ	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
		心拍数のタイムスタンプ文字列	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	RR間隔オブジェクト		rr	object	No	RR間隔値の情報を持つ。
		RR間隔値	value	integer	No	ターゲットデバイスで測定したRR間隔を返す。
		RR間隔のMDER Float値	mderFloat	string	No	RR間隔値のMDERFloat値を返す。
		RR間隔のタイプ	type	string	No	RR間隔を表す「RR interval」を返す。取得できない場合は、空文字を返す。
		RR間隔のオブジェクトのタイプのコード	typeCode	string	No	RR間隔を表す「147240」を返す。取得できない場合は、空文字を返す。
		RR間隔の単位	unit	string	No	RR間隔の単位を表す「ms」を返す。取得できない場合は、空文字を返す。
		RR間隔の単位コード	unitCode	string	No	RR間隔の単位であるmsを表す「264338」を返す。取得できない場合は、空文字を返す。
		RR間隔のタイムスタンプ	timeStamp	long	No	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
		RR間隔のタイムスタンプ文字列	timeStampString	dateTime	No	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	消費エネルギーオブジェクト		energy	object	No	消費エネルギーの情報を持つ。
		消費エネルギー	value	integer	No	ターゲットデバイスで測定した消費エネルギー値を返す。
		消費エネルギーのMDER Float値	mderFloat	string	No	消費エネルギー値のMDERFloat値を返す。
		消費エネルギーのタイプ	type	string	No	消費エネルギー値を表す「energy expended」を返す。取得できない場合は、空文字を返す。
		消費エネルギーのタイプコード	typeCode	string	No	消費エネルギー値を表す「119」を返す。取得できない場合は、空文字を返す。
		消費エネルギーの単位	unit	string	No	消費エネルギー値の単位を表す「Calories」を返す。取得できない場合は、空文字を返す。
		消費エネルギーの単位コード	unitCode	string	No	消費エネルギー値の単位であるCaloriesを表す「6784」を返す。取得できない場合は、空文字を返す。
		消費エネルギーのタイムスタンプ	timeStamp	long	No	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
		消費エネルギーのタイムスタンプ文字列	timeStampString	dateTime	No	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	デバイスオブジェクト		device	object	Yes	健康機器の情報を持つ。
		プロダクト名	productName	string	Yes	ターゲットデバイスの製品名。取得できない時は任意のアルゴリズムでデバイス名を生成。
		メーカ名	manufacturerName	string	Yes	ターゲットデバイスのメーカ名。取得できない場合は空文字を指定。
		モデルの番号	modelNumber	string	Yes	ターゲットデバイスのモデル番号。取得できない場合は空文字を指定
		ファームウェアリビジョン	firmwareRevision	string	Yes	ターゲットデバイスのファームウェアリビジョン。取得できない場合は空文字を指定。
		シリアルナンバー	serialNumber	string	Yes	ターゲットデバイスのシリアル番号。取得できない場合は空文字を指定。
		ソフトウェアリビジョン	softwareRevision	string	Yes	ターゲットデバイスのソフトウェアリビジョン。取得できない場合は空文字を指定。
		ハードウェアリビジョン	hardwareRevision	string	Yes	ターゲットデバイスのハードウェアリビジョン。取得できない場合は、空文字を指定。
		パートナンバー	partNumber	string	Yes	ターゲットデバイスのパート番号。取得できない場合は、空文字を指定。
		プロトコルリビジョン	protocolRevision	string	Yes	ターゲットデバイスのプロトコルリビジョン。取得できない場合は、空文字を指定。
		システムID	systemId	string	Yes	ターゲットデバイスのシステムID。16進数。取得できない場合は「0x0」。
		バッテリーレベル	batteryLevel	float	Yes	ターゲットデバイスのバッテリーレベル。取得できない場合は-1.0を返す。範囲: 0.0〜1.0

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "health",
  "attribute" : "heart",
  "heart" : {
    "rate" : {
      "value" : 60,
      "mderFloat" : "00000042",
      "type" : "heart rate",
      "typeCode" : 147842,
      "unit" : "beat per min",
      "unitCode" : 264864,
      "timeStamp" : 1483241696789,
      "timeStampString" : "2015-05-17T10:02:20+09:00"
    },
    "rr" : {
      "value" : 909.1796875,
      "mderFloat" : "F9E9CF8B",
      "type" : "RR interval",
      "typeCode" : 147240,
      "unit" : "ms",
      "unitCode" : 264338,
      "timeStamp" : 1483241696789,
      "timeStampString" : "2015-05-17T10:02:20+09:00"
    },
    "energy" : {
      "value" : 0,
      "mderFloat" : "01000000",
      "type" : "energy expended",
      "typeCode" : 119,
      "unit" : "Calories",
      "unitCode" : 6784,
      "timeStamp" : 1483241696789,
      "timeStampString" : "2015-05-17T10:02:20+09:00"
    },
    "device" : {
      "productName" : "DUMMY DEVICE",
      "manufacturerName" : "",
      "modelNumber" : "",
      "firmwareRevision" : "",
      "serialNumber" : "",
      "softwareRevision" : "",
      "hardwareRevision" : "",
      "partNumber" : "",
      "protocolRevision" : "",
      "systemId" : "0x0",
      "batteryLevel" : -1
    }
  }
}

DELETE /gotapi/health/onheart

API Pattern

event

Summary

デバイスの心拍数計測通知イベントを停止する。

Description

当該イベントの通知を停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Human Detection Profile

Ver. 2.0.0

Description

スマートデバイスの人体検出機能を提供するAPI。

Operations

GET /gotapi/humanDetection/onBodyDetection
PUT /gotapi/humanDetection/onBodyDetection
DELETE /gotapi/humanDetection/onBodyDetection
GET /gotapi/humanDetection/onDetection
PUT /gotapi/humanDetection/onDetection
DELETE /gotapi/humanDetection/onDetection
GET /gotapi/humanDetection/onFaceDetection
PUT /gotapi/humanDetection/onFaceDetection
DELETE /gotapi/humanDetection/onFaceDetection
GET /gotapi/humanDetection/onHandDetection
PUT /gotapi/humanDetection/onHandDetection
DELETE /gotapi/humanDetection/onHandDetection

GET /gotapi/humanDetection/onBodyDetection

API Pattern

one-shot

Summary

体を検出したときの通知イベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
threshold	float	No	検出しきい値。省略時はデバイス初期値設定できる値の範囲:0.0~1.0
minWidth	float	No	検出最小サイズ(w)。minHeight < maxHeightとすること、省略時デバイス初期値。設定できる値の範囲:0.0~1.0
minHeight	float	No	検出最小サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値設定できる値の範囲:0.0~1.0
maxWidth	float	No	検出最大サイズ(w)。minWidth < maxWidthとすること、省略時はデバイス初期値設定できる値の範囲:0.0~1.0
maxHeight	float	No	検出最大サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
options	array(string)	No	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションは無し。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
人体検出リスト		bodyDetects	array(object)	Yes	検出された数分出現する。
	検出領域の中心X座標	x	float	Yes	0.0~1.0
	検出領域の中心Y座標	y	float	Yes	0.0~1.0
	検出領域のX方向の幅	width	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
	検出領域のY方向の幅	height	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
	解析の信頼度	confidence	float	Yes	0.0~1.0

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "bodyDetects" : [ {
    "x" : 0.47291666666666665,
    "y" : 0.6712962962962963,
    "width" : 0.271875,
    "height" : 0.48333333333333334,
    "confidence" : 0.907
  }, {
    "x" : 0.034375,
    "y" : 0.8925925925925926,
    "width" : 0.036458333333333336,
    "height" : 0.06481481481481481,
    "confidence" : 0.746
  }, {
    "x" : 0.9515625,
    "y" : 0.9592592592592593,
    "width" : 0.03177083333333333,
    "height" : 0.05648148148148148,
    "confidence" : 0.619
  } ]
}

PUT /gotapi/humanDetection/onBodyDetection

API Pattern

event

Summary

体を検出したときの通知イベントを開始する。

Description

当該イベントの通知を停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
threshold	float	No	検出しきい値。省略時はデバイス初期値設定できる値の範囲:0.0~1.0
minWidth	float	No	検出最小サイズ(w)。minHeight < maxHeightとすること、省略時デバイス初期値。設定できる値の範囲:0.0~1.0
minHeight	float	No	検出最小サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値設定できる値の範囲:0.0~1.0
maxWidth	float	No	検出最大サイズ(w)。minWidth < maxWidthとすること、省略時はデバイス初期値設定できる値の範囲:0.0~1.0
maxHeight	float	No	検出最大サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
interval	long	No	デバイスプラグインがイベントを送信する間隔。
options	array(string)	No	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションは無し。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
人体検出リスト		bodyDetects	array(object)	Yes	検出された数分出現する。
	検出領域の中心X座標	x	float	Yes	0.0~1.0
	検出領域の中心Y座標	y	float	Yes	0.0~1.0
	検出領域のX方向の幅	width	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
	検出領域のY方向の幅	height	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
	解析の信頼度	confidence	float	Yes	0.0~1.0

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "humandetection",
  "attribute" : "onbodydetection",
  "bodyDetects" : [ {
    "x" : 0.47291666666666665,
    "y" : 0.6712962962962963,
    "width" : 0.271875,
    "height" : 0.48333333333333334,
    "confidence" : 0.907
  }, {
    "x" : 0.034375,
    "y" : 0.8925925925925926,
    "width" : 0.036458333333333336,
    "height" : 0.06481481481481481,
    "confidence" : 0.746
  }, {
    "x" : 0.9515625,
    "y" : 0.9592592592592593,
    "width" : 0.03177083333333333,
    "height" : 0.05648148148148148,
    "confidence" : 0.619
  } ]
}

DELETE /gotapi/humanDetection/onBodyDetection

API Pattern

event

Summary

体を検出したときの通知イベントを停止する。

Description

当該イベントの通知を停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/humanDetection/onDetection

API Pattern

one-shot

Summary

人を検出したときの通知イベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
人検出情報		humanDetect	object	Yes
	人検出フラグ	exist	boolean	Yes	検出された : true 検出されない : false

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "humanDetect" : {
    "exist" : true
  }
}

PUT /gotapi/humanDetection/onDetection

API Pattern

event

Summary

人を検出したときの通知イベントを開始する。

Description

当該イベントの通知を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
人検出情報		humanDetect	object	Yes
	人検出フラグ	exist	boolean	Yes	検出された : true 検出されない : false

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "humandetection",
  "attribute" : "ondetection",
  "humanDetect" : {
    "exist" : true
  }
}

DELETE /gotapi/humanDetection/onDetection

API Pattern

event

Summary

人を検出したときの通知イベントを停止する。

Description

当該イベントの通知を停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/humanDetection/onFaceDetection

API Pattern

one-shot

Summary

顔を検出したときの通知イベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
threshold	float	No	検出しきい値。省略時はデバイス初期値設定できる値の範囲:0.0~1.0
minWidth	float	No	検出最小サイズ(w)。minHeight < maxHeightとすること、省略時デバイス初期値。設定できる値の範囲:0.0~1.0
minHeight	float	No	検出最小サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値設定できる値の範囲:0.0~1.0
maxWidth	float	No	検出最大サイズ(w)。minWidth < maxWidthとすること、省略時はデバイス初期値設定できる値の範囲:0.0~1.0
maxHeight	float	No	検出最大サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
eyeThreshold	float	No	目の座標検出しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
noseThreshold	float	No	鼻の座標検出しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
mouthThreshold	float	No	口の座標検出しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
blinkThreshold	float	No	目つむり検出しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
ageThreshold	float	No	年齢推定しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
genderThreshold	float	No	性別推定しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
faceDirectionThreshold	float	No	顔向き推定しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
gazeThreshold	float	No	視線推定しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
expressionThreshold	float	No	表情推定しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
options	array(string)	No	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションはデバイスプラグインによって違う。例)eye, nose, mouth, blink,age,gender,faceDirection,gaze,expressionをカンマ区切りで指定することで、それぞれの検出値がある場合はレスポンスに含めることができる。ただし、デバイスによって対応していない値がある。

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
顔検出リスト			faceDetects	array(object)	Yes	検出された数分出現する。
	検出領域の中心X座標		x	float	Yes	0.0~1.0
	検出領域の中心Y座標		y	float	Yes	0.0~1.0
	検出領域のX方向の幅		width	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
	検出領域のY方向の幅		height	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
	解析の信頼度		confidence	float	Yes	0.0~1.0
	目検出情報		eyePoints	object	No
		左目の中心座標(x)	leftEyeX	float	No	0.0~1.0
		左目の中心座標(y)	leftEyeY	float	No	0.0~1.0
		左目の領域幅(w)	leftEyeWidth	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		左目の領域幅(h)	leftEyeHeight	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		右目の中心座標(x)	rightEyeX	float	No	0.0~1.0
		右目の中心座標(y)	rightEyeY	float	No	0.0~1.0
		右目の領域幅(w)	rightEyeWidth	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		右目の領域幅(h)	rightEyeHeight	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		解析の信頼度	confidence	float	No	0.0~1.0
	鼻検出情報		nosePoints	object	No
		鼻の中心座標(x)	noseX	float	No	0.0~1.0
		鼻の中心座標(y)	noseY	float	No	0.0~1.0
		鼻の領域幅(w)	noseWidth	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		鼻の領域幅(h)	noseHeight	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		解析の信頼度	confidence	float	No	0.0~1.0
	口検出情報		mouthPoints	object	No
		口の中心座標(x)	mouthX	float	No	0.0~1.0
		口の中心座標(y)	mouthY	float	No	0.0~1.0
		口の領域幅(w)	mouthWidth	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		口の領域幅(h)	mouthHeight	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		解析の信頼度	confidence	float	No	0.0~1.0
	まばたき検出情報		blinkResults	object	No
		目つむり度合(左)	leftEye	float	No	0.0~1.0
		目つむり度合(右)	rightEye	float	No	0.0~1.0
		解析の信頼度	confidence	float	No	0.0~1.0
	年齢判定結果		ageResults	object	No
		年齢	age	integer	No
		解析の信頼度	confidence	float	No	0.0~1.0
	性別判定結果		genderResults	object	No
		性別	gender	string	No	male : 男性 female : 女性
		解析の信頼度	confidence	float	No	0.0~1.0
	顔の向き判定結果		faceDirectionResults	object	No
		左右方向角度	yaw	integer	No	-180~180[degree]
		上下方向角度	pitch	integer	No	-180~180[degree]
		顔傾き角度	roll	integer	No	-180~180[degree]
		解析の信頼度	confidence	float	No	0.0~1.0
	目の向き判定結果		gazeResults	object	No
		左右角度	gazeLR	integer	No	-90~90[degree]
		上下角度	gateUD	integer	No	-90~90[degree]
		解析の信頼度	confidence	float	No	0.0~1.0
	表情判定結果		expressionResults	object	No
		左右角度	expression	string	No	unknown : 無表情 smile : 笑い/喜び surprise : 驚き mad : 怒り sad : 悲しみ
		解析の信頼度	confidence	float	No	0.0~1.0

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "faceDetects" : [ {
    "x" : 0.9515625,
    "y" : 0.9592592592592593,
    "width" : 0.03177083333333333,
    "height" : 0.05648148148148148,
    "confidence" : 0.619,
    "ageResults" : {
      "age" : "35",
      "confidence" : "0.82"
    },
    "genderResults" : {
      "gender" : "male",
      "confidence" : "0.75"
    },
    "expressionResults" : {
      "expression" : "surprise",
      "confidence" : "0.69"
    }
  } ]
}

PUT /gotapi/humanDetection/onFaceDetection

API Pattern

event

Summary

顔を検出したときの通知イベントを開始する。

Description

当該イベントの通知を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
threshold	float	No	検出しきい値。省略時はデバイス初期値設定できる値の範囲:0.0~1.0
minWidth	float	No	検出最小サイズ(w)。minHeight < maxHeightとすること、省略時デバイス初期値。設定できる値の範囲:0.0~1.0
minHeight	float	No	検出最小サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値設定できる値の範囲:0.0~1.0
maxWidth	float	No	検出最大サイズ(w)。minWidth < maxWidthとすること、省略時はデバイス初期値設定できる値の範囲:0.0~1.0
maxHeight	float	No	検出最大サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
eyeThreshold	float	No	目の座標検出しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
noseThreshold	float	No	鼻の座標検出しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
mouthThreshold	float	No	口の座標検出しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
blinkThreshold	float	No	目つむり検出しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
ageThreshold	float	No	年齢推定しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
genderThreshold	float	No	性別推定しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
faceDirectionThreshold	float	No	顔向き推定しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
gazeThreshold	float	No	視線推定しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
expressionThreshold	float	No	表情推定しきい値。省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
interval	long	No	デバイスプラグインがイベントを送信する間隔。
options	array(string)	No	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションはデバイスプラグインによって違う。例)eye, nose, mouth, blink,age,gender,faceDirection,gaze,expressionをカンマ区切りで指定することで、それぞれの検出値がある場合はレスポンスに含めることができる。ただし、デバイスによって対応していない値がある。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
顔検出リスト			faceDetects	array(object)	Yes	検出された数分出現する。
	検出領域の中心X座標		x	float	Yes	0.0~1.0
	検出領域の中心Y座標		y	float	Yes	0.0~1.0
	検出領域のX方向の幅		width	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
	検出領域のY方向の幅		height	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
	解析の信頼度		confidence	float	Yes	0.0~1.0
	目検出情報		eyePoints	object	No
		左目の中心座標(x)	leftEyeX	float	No	0.0~1.0
		左目の中心座標(y)	leftEyeY	float	No	0.0~1.0
		左目の領域幅(w)	leftEyeWidth	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		左目の領域幅(h)	leftEyeHeight	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		右目の中心座標(x)	rightEyeX	float	No	0.0~1.0
		右目の中心座標(y)	rightEyeY	float	No	0.0~1.0
		右目の領域幅(w)	rightEyeWidth	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		右目の領域幅(h)	rightEyeHeight	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		解析の信頼度	confidence	float	No	0.0~1.0
	鼻検出情報		nosePoints	object	No
		鼻の中心座標(x)	noseX	float	No	0.0~1.0
		鼻の中心座標(y)	noseY	float	No	0.0~1.0
		鼻の領域幅(w)	noseWidth	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		鼻の領域幅(h)	noseHeight	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		解析の信頼度	confidence	float	No	0.0~1.0
	口検出情報		mouthPoints	object	No
		口の中心座標(x)	mouthX	float	No	0.0~1.0
		口の中心座標(y)	mouthY	float	No	0.0~1.0
		口の領域幅(w)	mouthWidth	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		口の領域幅(h)	mouthHeight	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
		解析の信頼度	confidence	float	No	0.0~1.0
	まばたき検出情報		blinkResults	object	No
		目つむり度合(左)	leftEye	float	No	0.0~1.0
		目つむり度合(右)	rightEye	float	No	0.0~1.0
		解析の信頼度	confidence	float	No	0.0~1.0
	年齢判定結果		ageResults	object	No
		年齢	age	integer	No
		解析の信頼度	confidence	float	No	0.0~1.0
	性別判定結果		genderResults	object	No
		性別	gender	string	No	male : 男性 female : 女性
		解析の信頼度	confidence	float	No	0.0~1.0
	顔の向き判定結果		faceDirectionResults	object	No
		左右方向角度	yaw	integer	No	-180~180[degree]
		上下方向角度	pitch	integer	No	-180~180[degree]
		顔傾き角度	roll	integer	No	-180~180[degree]
		解析の信頼度	confidence	float	No	0.0~1.0
	目の向き判定結果		gazeResults	object	No
		左右角度	gazeLR	integer	No	-90~90[degree]
		上下角度	gateUD	integer	No	-90~90[degree]
		解析の信頼度	confidence	float	No	0.0~1.0
	表情判定結果		expressionResults	object	No
		左右角度	expression	string	No	unknown : 無表情 smile : 笑い/喜び surprise : 驚き mad : 怒り sad : 悲しみ
		解析の信頼度	confidence	float	No	0.0~1.0

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "humandetection",
  "attribute" : "onfacedetection",
  "faceDetects" : [ {
    "x" : 0.9515625,
    "y" : 0.9592592592592593,
    "width" : 0.03177083333333333,
    "height" : 0.05648148148148148,
    "confidence" : 0.619,
    "ageResults" : {
      "age" : "35",
      "confidence" : "0.82"
    },
    "genderResults" : {
      "gender" : "male",
      "confidence" : "0.75"
    },
    "expressionResults" : {
      "expression" : "surprise",
      "confidence" : "0.69"
    }
  } ]
}

DELETE /gotapi/humanDetection/onFaceDetection

API Pattern

event

Summary

顔を検出したときの通知イベントを停止する。

Description

当該イベントの通知を停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/humanDetection/onHandDetection

API Pattern

one-shot

Summary

手を検出したときの通知イベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
threshold	float	No	検出しきい値。省略時はデバイス初期値設定できる値の範囲:0.0~1.0
minWidth	float	No	検出最小サイズ(w)。minHeight < maxHeightとすること、省略時デバイス初期値。設定できる値の範囲:0.0~1.0
minHeight	float	No	検出最小サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値設定できる値の範囲:0.0~1.0
maxWidth	float	No	検出最大サイズ(w)。minWidth < maxWidthとすること、省略時はデバイス初期値設定できる値の範囲:0.0~1.0
maxHeight	float	No	検出最大サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
options	array(string)	No	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションは無し。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
手検出リスト		handDetects	array(object)	Yes	検出された数分出現する。
	検出領域の中心X座標	x	float	Yes	0.0~1.0
	検出領域の中心Y座標	y	float	Yes	0.0~1.0
	検出領域のX方向の幅	width	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
	検出領域のY方向の幅	height	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
	解析の信頼度	confidence	float	Yes	0.0~1.0

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "handDetects" : [ {
    "x" : 0.5114583333333333,
    "y" : 0.6018518518518519,
    "width" : 0.15833333333333333,
    "height" : 0.2814814814814815,
    "confidence" : 0.962
  } ]
}

PUT /gotapi/humanDetection/onHandDetection

API Pattern

event

Summary

手を検出したときの通知イベントを開始する。

Description

当該イベントの通知を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
threshold	float	No	検出しきい値。省略時はデバイス初期値設定できる値の範囲:0.0~1.0
minWidth	float	No	検出最小サイズ(w)。minHeight < maxHeightとすること、省略時デバイス初期値。設定できる値の範囲:0.0~1.0
minHeight	float	No	検出最小サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値設定できる値の範囲:0.0~1.0
maxWidth	float	No	検出最大サイズ(w)。minWidth < maxWidthとすること、省略時はデバイス初期値設定できる値の範囲:0.0~1.0
maxHeight	float	No	検出最大サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値。設定できる値の範囲:0.0~1.0
interval	long	No	デバイスプラグインがイベントを送信する間隔。
options	array(string)	No	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションは無し。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
手検出リスト		handDetects	array(object)	Yes	検出された数分出現する。
	検出領域の中心X座標	x	float	Yes	0.0~1.0
	検出領域の中心Y座標	y	float	Yes	0.0~1.0
	検出領域のX方向の幅	width	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
	検出領域のY方向の幅	height	float	No	※領域幅が提供できない場合は出現しない。 0.0~1.0
	解析の信頼度	confidence	float	Yes	0.0~1.0

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "humandetection",
  "attribute" : "onhanddetection",
  "handDetects" : [ {
    "x" : 0.5114583333333333,
    "y" : 0.6018518518518519,
    "width" : 0.15833333333333333,
    "height" : 0.2814814814814815,
    "confidence" : 0.962
  } ]
}

DELETE /gotapi/humanDetection/onHandDetection

API Pattern

event

Summary

手を検出したときの通知イベントを停止する。

Description

当該イベントの通知を停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Humidity Profile

Ver. 2.0.0

Description

スマートデバイスが計測した湿度を取得する機能を提供するAPI。

Operations

GET /gotapi/humidity

スマートデバイスの湿度を取得する機能を提供する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
湿度	humidity	float	Yes	湿度センサーが検知した湿度を通知する。範囲: 0.0 ~ 1.0
湿度のタイムスタンプ	timeStamp	long	No	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
湿度のタイムスタンプ文字列	timeStampString	dateTime	No	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "humidity" : 0.1,
  "timeStamp" : 1431856940275,
  "timeStampString" : "2015-05-17T10:02:20+09:00"
}

Illuminance Profile

Ver. 2.0.0

Description

スマートデバイスが計測した照度を取得する機能を提供するAPI。

Operations

GET /gotapi/illuminance

GET /gotapi/illuminance

API Pattern

one-shot

Summary

スマートデバイスの照度を取得する機能を提供する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
照度	illuminance	float	Yes	照度センサーが検知した照度。単位はルクス(lx)。
照度のタイムスタンプ	timeStamp	long	No	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
照度のタイムスタンプ文字列	timeStampString	dateTime	No	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "illuminance" : 240,
  "timeStamp" : 1431856940275,
  "timeStampString" : "2015-05-17T10:02:20+09:00"
}

Key Event Profile

Ver. 2.0.0

Description

デバイスのキーイベントが操作されたことを通知する機能。

Operations

GET /gotapi/keyEvent/onDown
PUT /gotapi/keyEvent/onDown
DELETE /gotapi/keyEvent/onDown
GET /gotapi/keyEvent/onKeyChange
PUT /gotapi/keyEvent/onKeyChange
DELETE /gotapi/keyEvent/onKeyChange
GET /gotapi/keyEvent/onUp
PUT /gotapi/keyEvent/onUp
DELETE /gotapi/keyEvent/onUp

GET /gotapi/keyEvent/onDown

API Pattern

one-shot

Summary

デバイスのキーが押されたときの情報を取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
KeyEvent		keyevent	object	Yes	KeyEventのオブジェクト。
	離されたKeyのID	id	integer	Yes
	離されたKeyのConfig	config	string	No

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "keyevent" : {
    "config" : "5",
    "id" : 149
  }
}

PUT /gotapi/keyEvent/onDown

API Pattern

event

Summary

デバイスのキーが押されたことを通知するイベントを開始する。

Description

当該イベントの通知を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
KeyEvent		keyevent	object	Yes	KeyEventのオブジェクト。
	離されたKeyのID	id	integer	Yes
	離されたKeyのConfig	config	string	No

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "keyevent",
  "attribute" : "ondown",
  "keyevent" : {
    "config" : "5",
    "id" : 149
  }
}

DELETE /gotapi/keyEvent/onDown

API Pattern

event

Summary

デバイスのキーが押されたことを通知するイベントを停止する。

Description

当該イベントの通知を停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/keyEvent/onKeyChange

API Pattern

one-shot

Summary

デバイスのキーが押された、離された時の情報を取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
KeyEvent		keyevent	object	Yes	KeyEventのオブジェクト。
	押された、もしくは離された時の状態	state	string	Yes	up:Keyが離された。 down:Keyが押された。
	押された、もしくは離された時のKeyのID	id	integer	Yes
	押された、もしくは離された時のKeyのConfig	config	string	No

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "keyevent" : {
    "state" : "up",
    "config" : "5",
    "id" : 149
  }
}

PUT /gotapi/keyEvent/onKeyChange

API Pattern

event

Summary

デバイスのキーが押された、または離されたことを通知するイベントを開始する。

Description

当該イベントの通知を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
KeyEvent		keyevent	object	Yes	KeyEventのオブジェクト。
	押された、もしくは離された時の状態	state	string	Yes	up:Keyが離された。 down:Keyが押された。
	押された、もしくは離された時のKeyのID	id	integer	Yes
	押された、もしくは離された時のKeyのConfig	config	string	No

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "keyevent",
  "attribute" : "onkeychange",
  "keyevent" : {
    "state" : "up",
    "config" : "5",
    "id" : 149
  }
}

DELETE /gotapi/keyEvent/onKeyChange

API Pattern

event

Summary

デバイスのキーが押された、または離されたことを通知するイベントを停止する。

Description

当該イベントの通知を停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/keyEvent/onUp

API Pattern

one-shot

Summary

デバイスのキーが離されたときの情報を取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
KeyEvent		keyevent	object	Yes	KeyEventのオブジェクト。
	押されたKeyのID	id	integer	Yes
	押されたKeyのConfig	config	string	No

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "keyevent" : {
    "config" : "play",
    "id" : 672
  }
}

PUT /gotapi/keyEvent/onUp

API Pattern

event

Summary

デバイスのキーが離されたことを通知するイベントを開始する。

Description

当該イベントの通知を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
KeyEvent		keyevent	object	Yes	KeyEventのオブジェクト。
	押されたKeyのID	id	integer	Yes
	押されたKeyのConfig	config	string	No

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "keyevent",
  "attribute" : "onup",
  "keyevent" : {
    "config" : "play",
    "id" : 672
  }
}

DELETE /gotapi/keyEvent/onUp

API Pattern

event

Summary

デバイスのキーが離されたことを通知するイベントを停止する。

Description

当該イベントの通知を停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Light Profile

Ver. 2.0.0

Description

スマートデバイスのライト機能を提供するAPI。

Operations

GET /gotapi/light
POST /gotapi/light
PUT /gotapi/light
DELETE /gotapi/light

ライトを識別するIDなどを取得するAPI。

Description

スマートデバイスが認識しているライトデバイスの一覧を取得する。取得できる情報には、ライトの識別子、ライトの名前と状態を持つ。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ライト一覧		lights	array(object)	Yes	ライト一覧を格納する配列。
	ライトID	lightId	string	Yes	ライトを識別するID。
	ライト名	name	string	Yes	ライト名。
	ライトの点灯状態	on	boolean	Yes	ライトの点灯状態を示す。 true: 点灯 false: 消灯
	コンフィグ	config	string	Yes	ライトに設定がある場合には、ここに文字列としてデータが格納されている。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "lights" : [ {
    "config" : "",
    "on" : false,
    "name" : "Example Light 1",
    "lightId" : "0"
  }, {
    "config" : "",
    "on" : true,
    "name" : "Example Light 2",
    "lightId" : "1"
  } ]
}

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
lightId	string	No	ライトID。操作の対象となるライト。省略された場合、デフォルトのライトが選択される。
brightness	float	No	ライトの明るさ。ライトの明るさを0.0-1.0で表す。
color	string	No	ライトの色。RGB形式の16進数で指定。
flashing	array(long)	No	ライトの点滅間隔。点滅間隔をカンマ区切りの msecで点灯、消灯を繰り返し指定できる。このパラメータを指定しなかった場合は、常時点灯。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

ライトの色、明るさ及び、名前の変更ができる。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
lightId	string	No	ライトID。操作の対象となるライト。省略された場合、デフォルトのライトが選択される。
name	string	Yes	ライト名。
brightness	float	No	ライトの明るさ。ライトの明るさを0.0-1.0で表す。
color	string	No	ライトの色。RGB形式の16進数で指定。
flashing	array(long)	No	ライトの点滅間隔。点滅間隔をカンマ区切りの msecで点灯、消灯を繰り返し指定できる。このパラメータを指定しなかった場合は、常時点灯。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
lightId	string	No	ライトID。操作の対象となるライト。省略された場合、デフォルトのライトが選択される。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

MediaPlayer Profile

Ver. 2.0.0

Description

スマートデバイス上のメディアの再生状態の変更要求を通知するAPI。

Operations

GET /gotapi/mediaPlayer/media
PUT /gotapi/mediaPlayer/media
GET /gotapi/mediaPlayer/mediaList
GET /gotapi/mediaPlayer/mute
PUT /gotapi/mediaPlayer/mute
DELETE /gotapi/mediaPlayer/mute
GET /gotapi/mediaPlayer/onStatusChange
PUT /gotapi/mediaPlayer/onStatusChange
DELETE /gotapi/mediaPlayer/onStatusChange
PUT /gotapi/mediaPlayer/pause
PUT /gotapi/mediaPlayer/play
GET /gotapi/mediaPlayer/playStatus
PUT /gotapi/mediaPlayer/resume
GET /gotapi/mediaPlayer/seek
PUT /gotapi/mediaPlayer/seek
PUT /gotapi/mediaPlayer/stop
GET /gotapi/mediaPlayer/volume
PUT /gotapi/mediaPlayer/volume

GET /gotapi/mediaPlayer/media

API Pattern

one-shot

Summary

スマートデバイスの再生コンテンツ（再生対象の音楽、映像）の情報を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mediaId	string	Yes	メディアID。メディアを識別するID。メディアIDは同プロファイルのMediaList APIで取得する。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
MimeType		mimeType	string	No	録画・録音する際のエンコードするMimeType。
タイトル名		title	string	No	楽曲名や動画名等。
タイプ名		type	string	No	タイトルの種別。「Music」（楽曲名）、「Movie」（動画名）など。
言語		language	string	No	言語。BCP47で定義されている文字列を設定する。(例)「ja」「en-us」。
説明文		description	string	No	内容についての説明。
画像URI		imageUri	string	No	アルバムカバーや動画サムネイルなどの画像へのURI。
曲の長さ		duration	float	Yes	秒単位。
制作者情報		creators	object	No
	制作者名	creator	string	Yes	制作を行った個人や法人の名称（楽曲のアーティスト名、動画の制作監督名、配給会社名など）。
	役割	role	float	Yes	制作者の役割。「Artist」アーティスト名。「Lyrics」作詞者名。「Composer」作曲者名。「Film distributer」映画配給会社名。※上記以外の文字列を自由に設定してもよい。※W3Cでは明確な定義が無い。
キーワード		keywords	array(string)	No	内容についての各種キーワードをstring配列で返す。
ジャンル		genres	array(string)	No	ジャンルをstring配列で返す。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "mediaId" : "1234",
  "mimeType" : "audio/mpeg",
  "title" : "Test Music 1",
  "type" : "Music",
  "language" : "ja",
  "description" : "",
  "imageUri" : "",
  "duration" : 100,
  "creators" : [ {
    "creator" : "Tester 1",
    "role" : "Artist"
  }, {
    "creator" : "Tester 1",
    "role" : "Composer"
  } ],
  "keywords" : [ "Test1", "Sample" ],
  "genres" : [ "J-POP", "Sample" ]
}

PUT /gotapi/mediaPlayer/media

API Pattern

one-shot

Summary

スマートデバイスの再生コンテンツ（再生対象の音楽、映像）を変更する。

Description

メディア再生中にmediaIdを再指定した場合は、新たに指定されたメディアの再生が始まる事とする。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mediaId	string	Yes	メディアID。メディアを識別するID。メディアIDは同プロファイルのMediaList APIで取得する。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/mediaPlayer/mediaList

API Pattern

one-shot

Summary

スマートデバイスの再生コンテンツ（再生対象の音楽、映像）の一覧を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mediaId	string	No	メディアID。メディアを識別するID。メディアIDは同プロファイルのMediaList APIで取得する。
query	string	No	検索する文字列。部分一致検索を行い、一致対象はレスポンスパラメータのタイトル名（title）、制作者名（creators/creator）。
mimeType	string	No	MimeType。情報を取得するファイルの種別ごとに区切りたい場合は、mimeTypeを指定する例)video%2F
order	array(string)	No	検索結果の並び順。検索結果の並び順。辞書順ソートの基準にするレスポンスパラメータの物理名と昇順・降順をカンマ区切りで指定する。物理名を最初に指定し、次に昇順はascを、降順はdescを指定する。省略時は、order=title,ascをしたのと同等となる。例)duration,asc
offset	integer	No	一覧の開始エントリ位置オフセット。全検索結果エントリの内、取得する一覧の開始エントリの位置を指定する。省略時は全検索結果の先頭エントリからの取得となり、offset=0と同義。レスポンスパラメータの count と併用して、検索結果のページングを実現する。
limit	integer	No	一覧エントリ数の上限。取得する一覧のエントリ数の上限。省略もしくは0が指定された場合、全検索結果エントリを返却する。レスポンスパラメータの count と併用して、検索結果のページングを実現する。

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
全検索結果の件数			count	integer	Yes	全検索結果の件数。リクエストパラメータの offset および limit と併用して、検索結果のページングを実現する。
検索にヒットしたメディアの情報			media	array(object)	Yes
	メディアID		mediaId	string	Yes	メディアを識別するID。
	MimeType		mimeType	string	No	録画・録音する際のエンコードするMimeType。
	タイトル名		title	string	No	楽曲名や動画名等。
	タイプ名		type	string	No	タイトルの種別。「Music」（楽曲名）、「Movie」（動画名）など。
	言語		language	string	No	言語。BCP47で定義されている文字列を設定する。(例)「ja」「en-us」。
	説明文		description	string	No	内容についての説明。
	画像URI		imageUri	string	No	アルバムカバーや動画サムネイルなどの画像へのURI。
	曲の長さ		duration	float	No	秒単位。
	制作者情報		creators	object	No
		制作者名	creator	string	Yes	制作を行った個人や法人の名称（楽曲のアーティスト名、動画の制作監督名、配給会社名など）。
		役割	role	float	Yes	制作者の役割。「Artist」アーティスト名。「Lyrics」作詞者名。「Composer」作曲者名。「Film distributer」映画配給会社名。※上記以外の文字列を自由に設定してもよい。※W3Cでは明確な定義が無い。
	キーワード		keywords	array(string)	No	内容についての各種キーワードをstring配列で返す。
	ジャンル		genres	array(string)	No	ジャンルをstring配列で返す。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "count" : 3,
  "media" : [ {
    "mediaId" : "1234",
    "mimeType" : "audio/mpeg",
    "title" : "Test Music 1",
    "type" : "Music",
    "language" : "ja",
    "description" : "",
    "imageUri" : "",
    "duration" : 100,
    "creators" : [ {
      "creator" : "Tester 1",
      "role" : "Artist"
    }, {
      "creator" : "Tester 1",
      "role" : "Composer"
    } ],
    "keywords" : [ "Test1", "Sample" ],
    "genres" : [ "J-POP", "Sample" ]
  }, {
    "mediaId" : "2345",
    "mimeType" : "audio/mpeg",
    "title" : "Test Music 2",
    "type" : "Music",
    "language" : "ja",
    "description" : "",
    "imageUri" : "",
    "duration" : 200,
    "creators" : [ {
      "creator" : "Tester 2",
      "role" : "Artist"
    }, {
      "creator" : "Tester 2",
      "role" : "Composer"
    } ],
    "keywords" : [ "Test 2", "Sample" ],
    "genres" : [ "J-POP", "Sample" ]
  }, {
    "mediaId" : "3456",
    "mimeType" : "audio/mpeg",
    "title" : "Test Music 3",
    "type" : "Music",
    "language" : "ja",
    "description" : "",
    "imageUri" : "",
    "duration" : 300,
    "creators" : [ {
      "creator" : "Tester 3",
      "role" : "Artist"
    }, {
      "creator" : "Tester 3",
      "role" : "Composer"
    } ],
    "keywords" : [ "Test 3", "Sample" ],
    "genres" : [ "J-POP", "Sample" ]
  } ]
}

GET /gotapi/mediaPlayer/mute

API Pattern

one-shot

Summary

スマートデバイスのメディアプレイヤー再生音量のミュート状態を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ミュート状態	mute	boolean	Yes	再生音量のミュート状態を表す。 true: ミュート有り false: ミュート無し

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "mute" : false
}

PUT /gotapi/mediaPlayer/mute

API Pattern

one-shot

Summary

スマートデバイスのメディアプレイヤー再生音量のミュートを有効にする。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/mediaPlayer/mute

API Pattern

one-shot

Summary

スマートデバイスのメディアプレイヤー再生音量のミュートを解除する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/mediaPlayer/onStatusChange

API Pattern

one-shot

Summary

スマートデバイスのコンテンツ再生状態の変化（音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更）通知イベントを取得する。

Description

再生位置の変化はイベント通知対象ではないが、先述のコンテンツ再生状態の変化通知の際、再生位置が併せて通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Player情報		mediaPlayer	object	Yes
	状態	status	string	Yes	メディアプレイヤーの状態。 play : 再生 stop : 再生停止 mute : ミュート unmute : ミュート解除 pause : 一時停止 resume : 一時停止解除 media : 再生コンテンツ変更 volume : 音量変更 complete : 再生完了
	メディアID	mediaId	string	Yes	メディアを識別するID。
	MimeType	mimeType	string	No	録画・録音が開始されたメディアのMimeType。このタイプで、動画、音声などを識別する。
	再生位置	pos	string	No	トラックの再生位置を秒単位で返す。
	メディア再生音量	volume	string	No	メディアの再生音量を0から1の割合で表す。範囲 (0.0 <= volume <= 1.0)

Example Response

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "mediaplayer",
  "attribute" : "onstatuschange",
  "mediaPlayer" : {
    "status" : "media",
    "mediaId" : "1234",
    "mimeType" : "application/ogg",
    "pos" : 0,
    "volume" : 1
  }
}

PUT /gotapi/mediaPlayer/onStatusChange

API Pattern

event

Summary

スマートデバイスのコンテンツ再生状態の変化（音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更）通知イベントを開始する。

Description

再生位置の変化はイベント通知対象ではないが、先述のコンテンツ再生状態の変化通知の際、再生位置が併せて通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
Player情報		mediaPlayer	object	Yes
	状態	status	string	Yes	メディアプレイヤーの状態。 play : 再生 stop : 再生停止 mute : ミュート unmute : ミュート解除 pause : 一時停止 resume : 一時停止解除 media : 再生コンテンツ変更 volume : 音量変更 complete : 再生完了
	メディアID	mediaId	string	Yes	メディアを識別するID。
	MimeType	mimeType	string	No	録画・録音が開始されたメディアのMimeType。このタイプで、動画、音声などを識別する。
	再生位置	pos	string	No	トラックの再生位置を秒単位で返す。
	メディア再生音量	volume	string	No	メディアの再生音量を0から1の割合で表す。範囲 (0.0 <= volume <= 1.0)

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "mediaplayer",
  "attribute" : "onstatuschange",
  "mediaPlayer" : {
    "status" : "media",
    "mediaId" : "1234",
    "mimeType" : "application/ogg",
    "pos" : 0,
    "volume" : 1
  }
}

DELETE /gotapi/mediaPlayer/onStatusChange

API Pattern

event

Summary

スマートデバイスのコンテンツ再生状態の変化（音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更）通知イベントを停止する。

Description

再生位置の変化はイベント通知対象ではないが、先述のコンテンツ再生状態の変化通知の際、再生位置が併せて通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/mediaPlayer/pause

API Pattern

one-shot

Summary

スマートデバイスの再生コンテンツ（再生対象の音楽、映像）の再生状態を一時停止に変更する。

Description

再生中のメディアが無い場合はエラーを返却する。再生中以外の状態で呼び出された場合はエラーを返却する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/mediaPlayer/play

API Pattern

one-shot

Summary

スマートデバイスの再生コンテンツ（再生対象の音楽、映像）の再生状態を再生中に変更する。

Description

再生中のメディアが無い場合はエラーを返却する。停止状態以外の状態で呼び出された場合はエラーを返却する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/mediaPlayer/playStatus

API Pattern

one-shot

Summary

スマートデバイスの再生コンテンツ（再生対象の音楽、映像）の再生状態（音声・映像の再生・一時停止・ミュート）を取得する。

Description

再生中のメディアが無い場合はエラーを返却する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
再生状態	status	string	Yes	・play : 再生・stop : 停止・pause : 一時停止

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "status" : "stop"
}

PUT /gotapi/mediaPlayer/resume

API Pattern

one-shot

Summary

スマートデバイスの再生コンテンツ（再生対象の音楽、映像）の再生状態を再生中に変更する。

Description

再生中のメディアが無い場合はエラーを返却する。一時停止以外の状態で呼び出された場合はエラーを返却する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/mediaPlayer/seek

API Pattern

one-shot

Summary

スマートデバイスの再生コンテンツ（再生対象の音楽、映像）の再生位置を取得する。

Description

再生中のメディアが無い場合はエラーを返却する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
再生位置	pos	integer	Yes	秒単位。最大値はMedia API（GET）やMediaList APIで取得できるパラメータ duration に相当する。範囲(0 ≤ pos ≤ duration)

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "pos" : 60
}

PUT /gotapi/mediaPlayer/seek

API Pattern

one-shot

Summary

スマートデバイスの再生コンテンツ（再生対象の音楽、映像）の再生位置を変更する。

Description

再生中のメディアが無い場合はエラーを返却する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
pos	long	Yes	再生位置。秒単位。最大値はMedia API（GET）やMediaList APIで取得できるパラメータ duration に相当する。範囲(0 ≤ pos ≤ duration)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/mediaPlayer/stop

API Pattern

one-shot

Summary

スマートデバイスの再生コンテンツ（再生対象の音楽、映像）の再生状態を停止に変更する。

Description

再生中のメディアが無い場合はエラーを返却する。再生中以外の状態で呼び出された場合はエラーを返却する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/mediaPlayer/volume

API Pattern

one-shot

Summary

スマートデバイスのメディアプレイヤーの再生音量を取得する。

Description

システム全体の音量を取得したい場合はSettingプロファイルのVolume Setting APIを用いる事。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
設定したいメディア再生音量	volume	float	Yes	メディアの再生音量を0から1の割合で表す。範囲 (0.0 <= voleme <= 1.0)

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "volume" : 0.25
}

PUT /gotapi/mediaPlayer/volume

API Pattern

one-shot

Summary

スマートデバイスのメディアプレイヤーの再生音量を変更する。

Description

システム全体の音量を変更したい場合はSettingプロファイルのVolume Setting APIを用いる事。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
volume	float	Yes	設定したいメディア再生音量。メディアの再生音量を0から1の割合で表す。範囲 (0.0 <= voleme <= 1.0)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Media Stream Recording Profile

Ver. 2.0.0

Description

スマートデバイスによる写真撮影、動画録画または音声録音などの操作を行うAPI。

Operations

GET /gotapi/mediaStreamRecording/mediaRecorder
PUT /gotapi/mediaStreamRecording/muteTrack
GET /gotapi/mediaStreamRecording/onPhoto
PUT /gotapi/mediaStreamRecording/onPhoto
DELETE /gotapi/mediaStreamRecording/onPhoto
GET /gotapi/mediaStreamRecording/onRecordingChange
PUT /gotapi/mediaStreamRecording/onRecordingChange
DELETE /gotapi/mediaStreamRecording/onRecordingChange
GET /gotapi/mediaStreamRecording/options
PUT /gotapi/mediaStreamRecording/options
PUT /gotapi/mediaStreamRecording/pause
GET /gotapi/mediaStreamRecording/preview
PUT /gotapi/mediaStreamRecording/preview
DELETE /gotapi/mediaStreamRecording/preview
POST /gotapi/mediaStreamRecording/record
PUT /gotapi/mediaStreamRecording/resume
PUT /gotapi/mediaStreamRecording/stop
POST /gotapi/mediaStreamRecording/takePhoto
PUT /gotapi/mediaStreamRecording/unmuteTrack

GET /gotapi/mediaStreamRecording/mediaRecorder

API Pattern

one-shot

Summary

スマートデバイスから使用可能なレコーダーの一覧を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
レコーダーリスト			recorders	array(object)	Yes	レコーダー情報の配列。
	レコーダーID		id	string	Yes	レコーダーを識別するID。
	レコーダー名		name	string	Yes	レコーダー名。
	レコーダーの状態		state	string	Yes	レコーダーの状態。
	MIME Type		mimeType	string	Yes	レコーダーのエンコードするタイプ。
	コンフィグ		config	string	Yes	カメラに設定がある場合には、ここに文字列としてデータが格納されている。
	画像の横幅		imageWidth	integer	No	レコーダーの現在の横幅。単位はピクセル。録音の場合は省略可。
	画像の縦幅		imageHeight	integer	No	レコーダーの現在の縦幅。単位はピクセル。録音の場合は省略可。
	プレビューの横幅		previewWidth	integer	No	プレビューの現在の横幅。単位はピクセル。録音の場合は省略可。
	プレビューの縦幅		previewHeight	integer	No	プレビューの現在の縦幅。単位はピクセル。録音の場合は省略可。
	プレビューの最大フレームレート		previewMaxFrameRate	float	No	現在のプレビューのフレームレートの最大値。単位はfps。録音の場合は省略可。
	音声情報		audio	object	No	録音する音声に関する情報。
		チャンネル数	channels	integer	Yes	音声のチャンネル数。
		サンプルレート	sampleRate	float	Yes	音声のサンプルレート。単位はHz。
		サンプルサイズ	sampleSize	integer	Yes	音声のサンプルサイズ。単位はビット。
		ブロックサイズ	blockSize	integer	Yes	音声のブロックサイズ。単位はバイト。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "recorders" : [ {
    "id" : "photo_0",
    "name" : "Dummy Camera Recorder - back",
    "state" : "inactive",
    "imageWidth" : 3264,
    "imageHeight" : 2448,
    "previewWidth" : 640,
    "previewHeight" : 480,
    "previewMaxFrameRate" : 10,
    "mimeType" : "image/png",
    "config" : ""
  }, {
    "id" : "photo_1",
    "name" : "Dummy Camera Recorder - front",
    "state" : "inactive",
    "imageWidth" : 1280,
    "imageHeight" : 960,
    "previewWidth" : 640,
    "previewHeight" : 480,
    "previewMaxFrameRate" : 10,
    "mimeType" : "image/png",
    "config" : ""
  }, {
    "id" : "video_0",
    "name" : "Dummy Video Recorder - back",
    "state" : "inactive",
    "imageWidth" : 640,
    "imageHeight" : 480,
    "mimeType" : "video/3gp",
    "config" : ""
  }, {
    "id" : "video_1",
    "name" : "Dummy Video Recorder - front",
    "state" : "inactive",
    "imageWidth" : 640,
    "imageHeight" : 480,
    "mimeType" : "video/3gp",
    "config" : ""
  }, {
    "id" : "audio",
    "name" : "Dummy Audio Recorder",
    "state" : "inactive",
    "mimeType" : "audio/3gp",
    "config" : ""
  }, {
    "id" : "screen",
    "name" : "Dummy Screen",
    "state" : "inactive",
    "imageWidth" : 1080,
    "imageHeight" : 1776,
    "previewWidth" : 270,
    "previewHeight" : 444,
    "previewMaxFrameRate" : 10,
    "mimeType" : "video/x-mjpeg",
    "config" : ""
  } ]
}

PUT /gotapi/mediaStreamRecording/muteTrack

API Pattern

one-shot

Summary

スマートデバイスに対して動画撮影や音声録音のミュート依頼を送る。

Description

ビデオとオーディオなどの複数トラックが含まれる撮影中メディアにおいては、オーディオトラックがミュートされる。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
target	string	No	ターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/mediaStreamRecording/onPhoto

API Pattern

one-shot

Summary

スマートデバイスの写真撮影通知イベントを取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
写真データ		photo	object	Yes	撮影された写真データ。
	URI	uri	string	No	撮影された写真のURI。
	ファイルパス	path	string	Yes	ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。File APIで使用可能。
	MIME Type	mimeType	string	Yes	撮影された写真のMIME Type。動画・音声を識別するために使用する。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy URI",
  "path" : "Dummy Path"
}

PUT /gotapi/mediaStreamRecording/onPhoto

API Pattern

event

Summary

スマートデバイスの写真撮影通知イベントを開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
写真データ		photo	object	Yes	撮影された写真データ。
	URI	uri	string	No	撮影された写真のURI。
	ファイルパス	path	string	Yes	ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。File APIで使用可能。
	MIME Type	mimeType	string	Yes	撮影された写真のMIME Type。動画・音声を識別するために使用する。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "mediastreamrecording",
  "attribute" : "onphoto",
  "photo" : {
    "uri" : "Dummy URI",
    "path" : "Dummy Path",
    "mimeType" : "image/png"
  }
}

DELETE /gotapi/mediaStreamRecording/onPhoto

API Pattern

event

Summary

スマートデバイスの写真撮影通知イベントを停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/mediaStreamRecording/onRecordingChange

API Pattern

one-shot

Summary

スマートデバイスでの写真撮影、動画撮影または音声録音の状態変化通知イベントを取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
レコーディング情報		media	object	Yes	レコーディング情報
	レコーディングの状態	status	string	Yes	レコーディングの状態を識別する文字列。
	URI	uri	string	No	動画または音声のURI。
	ファイルパス	path	string	No	ファイルが存在するパス。ルートはデバイスプラグインごとに違う。
	MIME Type	mimeType	string	Yes	録画・録音が開始されたメディアのMIME Type。このタイプで、動画、音声などを識別する。
	エラーメッセージ	errorMessasge	string	No	エラー、警告内容を伝える文字列。状態が error、warning の時のみ付加される。省略可能。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "media" : {
    "status" : "stop",
    "path" : "Dummy Path",
    "mimeType" : "video/3gp"
  }
}

PUT /gotapi/mediaStreamRecording/onRecordingChange

API Pattern

event

Summary

スマートデバイスでの写真撮影、動画撮影または音声録音の状態変化通知イベントを開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
レコーディング情報		media	object	Yes	レコーディング情報
	レコーディングの状態	status	string	Yes	レコーディングの状態を識別する文字列。
	URI	uri	string	No	動画または音声のURI。
	ファイルパス	path	string	No	ファイルが存在するパス。ルートはデバイスプラグインごとに違う。
	MIME Type	mimeType	string	Yes	録画・録音が開始されたメディアのMIME Type。このタイプで、動画、音声などを識別する。
	エラーメッセージ	errorMessasge	string	No	エラー、警告内容を伝える文字列。状態が error、warning の時のみ付加される。省略可能。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "mediastreamrecording",
  "attribute" : "onrecordingchange",
  "media" : {
    "status" : "stop",
    "path" : "Dummy Path",
    "mimeType" : "image/png"
  }
}

DELETE /gotapi/mediaStreamRecording/onRecordingChange

API Pattern

event

Summary

スマートデバイスでの写真撮影、動画撮影または音声録音の状態変化通知イベントを停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/mediaStreamRecording/options

API Pattern

one-shot

Summary

スマートデバイスからサポートしている写真撮影、動画撮影や音声録音のオプションを取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
target	string	No	ターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
MIME Type		mimeType	array(string)	Yes	録画・録音する際のエンコードするタイプの一覧
撮影時の解像度の一覧		imageSizes	array(object)	No	レコーダーのサポートする画像の解像度の一覧。録音の場合は省略可。プラグイン側でリサイズすることでサポートするサイズも含めてよい。
	横幅	width	integer	Yes	画像の横幅。単位はピクセル。
	縦幅	height	integer	Yes	画像の縦幅。単位はピクセル。
プレビュー時の解像度の一覧		previewSizes	array(object)	No	プレビューで利用可能な解像度の一覧。録音の場合、またはプレビューを提供しない場合は省略可。プラグイン側でリサイズすることでサポートするサイズも含めてよい。
	横幅	width	integer	Yes	画像の横幅。単位はピクセル。
	縦幅	height	integer	Yes	画像の縦幅。単位はピクセル。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "imageSize" : [ {
    "width" : 3264,
    "height" : 2448
  }, {
    "width" : 3200,
    "height" : 2400
  }, {
    "width" : 2592,
    "height" : 1944
  }, {
    "width" : 2048,
    "height" : 1536
  }, {
    "width" : 1920,
    "height" : 1080
  }, {
    "width" : 1600,
    "height" : 1200
  }, {
    "width" : 1280,
    "height" : 960
  }, {
    "width" : 1280,
    "height" : 768
  }, {
    "width" : 1280,
    "height" : 720
  }, {
    "width" : 1024,
    "height" : 768
  }, {
    "width" : 800,
    "height" : 600
  }, {
    "width" : 800,
    "height" : 480
  }, {
    "width" : 720,
    "height" : 480
  }, {
    "width" : 640,
    "height" : 480
  }, {
    "width" : 352,
    "height" : 288
  }, {
    "width" : 320,
    "height" : 240
  }, {
    "width" : 176,
    "height" : 144
  } ],
  "previewSize" : [ {
    "width" : 1920,
    "height" : 1080
  }, {
    "width" : 1600,
    "height" : 1200
  }, {
    "width" : 1280,
    "height" : 960
  }, {
    "width" : 1280,
    "height" : 768
  }, {
    "width" : 1280,
    "height" : 720
  }, {
    "width" : 1024,
    "height" : 768
  }, {
    "width" : 800,
    "height" : 600
  }, {
    "width" : 800,
    "height" : 480
  }, {
    "width" : 720,
    "height" : 480
  }, {
    "width" : 640,
    "height" : 480
  }, {
    "width" : 352,
    "height" : 288
  }, {
    "width" : 320,
    "height" : 240
  }, {
    "width" : 176,
    "height" : 144
  } ],
  "mimeType" : [ "image/png" ]
}

PUT /gotapi/mediaStreamRecording/options

API Pattern

one-shot

Summary

スマートデバイスからサポートしている写真撮影、動画撮影や音声録音のオプションを設定する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
target	string	No	ターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
imageWidth	integer	No	撮影時の横幅。単位はピクセル。previewHeightを指定するときは省略不可。Options API GETで返された値以外を指定した場合はパラメータエラー。
imageHeight	integer	No	撮影時の縦幅。単位はピクセル。previewWidthを指定するときは省略不可。Options API GETで返された値以外を指定した場合はパラメータエラー。
previewWidth	integer	No	プレビュー時の横幅。単位はピクセル。previewHeightを指定するときは省略不可。Options API GETで返された値以外を指定した場合はパラメータエラー。
previewHeight	integer	No	プレビュー時の縦幅。単位はピクセル。previewWidthを指定するときは省略不可。Options API GETで返された値以外を指定した場合はパラメータエラー。
previewMaxFrameRate	float	No	プレビュー時の最大フレームレート。単位はfps。範囲は0.0より大きい小数値。
mimeType	string	Yes	MimeType。動画録画・音声録音するときのエンコードするタイプ。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/mediaStreamRecording/pause

API Pattern

one-shot

Summary

スマートデバイスに対して動画撮影または音声録音の一時停止依頼を送る。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
target	string	No	ターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/mediaStreamRecording/preview

API Pattern

one-shot

Summary

スマートデバイスでの動画撮影中に、動画のプレビュー画像を取得する。

Description

このイベント通知を行うタイミングに規定は無く、デバイスプラグインの実装依存とする。JPEGでデータを受信する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
target	string	No	ターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
プレビュー画像URI	uri	string	Yes	プレビュー画像URI。形式はJPEGとする。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy Preview URI"
}

PUT /gotapi/mediaStreamRecording/preview

API Pattern

streaming

Summary

スマートデバイスでの動画撮影中に、動画のプレビュー画像を受信を開始する。

Description

このイベント通知を行うタイミングに規定は無く、デバイスプラグインの実装依存とする。MotionJPEGでデータを受信する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
target	string	No	ターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
プレビュー配信URI		uri	string	Yes	開始したプレビューの配信用URI。形式はMotionJPEGとする。
ストリームのリスト		streams	array(object)	No	ストリーム情報の配列。
	ストリームのMIMEType	mimeType	string	Yes	ストリームのMIMEType。
	ストリームのURI	uri	string	Yes	ストリームのURI。
音声配信情報		audio	object	No	音声配信に関する情報。音声のみの配信をサポートしない場合は省略可。
	音声配信URI	uri	string	Yes	音声配信URI。

Example Response

{
  "streams" : [ {
    "mimeType" : "video/x-mjpeg",
    "uri" : "http://localhost:9000/xxxxxx"
  }, {
    "mimeType" : "video/x-rtp",
    "uri" : "rtsp://localhost:8086"
  } ],
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy Preview URI"
}

DELETE /gotapi/mediaStreamRecording/preview

API Pattern

streaming

Summary

スマートデバイスでの動画撮影中に、動画のプレビュー画像を受信を停止する。

Description

このイベント通知を行うタイミングに規定は無く、デバイスプラグインの実装依存とする。MotionJPEGでデータを受信する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
target	string	No	ターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

POST /gotapi/mediaStreamRecording/record

API Pattern

one-shot

Summary

スマートデバイスに対して、動画撮影や音声録音の開始リクエストを送る。

Description

MediaStreamRecording Stopされない場合は各デバイスが撮影できる最大時間まで撮影を行い、その後撮影を停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
target	string	No	ターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
timeslice	long	No	タイムスライス。動画・音声入力などから得られた1フレームを新たに出力先メディアに書き出すまでの待ち時間。単位はミリ秒。1000/timesliceが出力メディアの固定フレームレート（フレーム/秒）に相当する。省略された場合には、デバイス毎の挙動でフレーム書き出しを行う。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
URI	uri	string	No	動画または音声のURI。
ファイルパス	path	string	No	動画または音声へのファイルパス。ルートはデバイスプラグインごとに異なる。File APIのパラメータとして使用可能。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy URI",
  "path" : "Dummy Path"
}

PUT /gotapi/mediaStreamRecording/resume

API Pattern

one-shot

Summary

スマートデバイスに対して一時停止状態にある動画撮影または音声録音の再開リクエストを送る。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
target	string	No	ターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/mediaStreamRecording/stop

API Pattern

one-shot

Summary

スマートデバイスに対して動画撮影または音声録音の終了リクエストを送る。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
target	string	No	ターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
URI	uri	string	No	動画または音声のURI。
ファイルパス	path	string	No	動画または音声へのファイルパス。ルートはデバイスプラグインごとに異なる。File APIのパラメータとして使用可能。

Example Response

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

POST /gotapi/mediaStreamRecording/takePhoto

API Pattern

one-shot

Summary

スマートデバイスに対して写真撮影リクエストを送る。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
target	string	No	ターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
URI	uri	string	Yes	撮影された写真のURI。
ファイルパス	path	string	Yes	撮影された写真へのファイルパス。ルートはデバイスプラグインごとに異なる。File APIのパラメータとして使用可能。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy URI",
  "path" : "Dummy Path"
}

PUT /gotapi/mediaStreamRecording/unmuteTrack

API Pattern

one-shot

Summary

スマートデバイスに対して動画撮影や音声録音のミュート解除依頼を送る。

Description

ビデオとオーディオなどの複数トラックが含まれる撮影中メディアにおいては、オーディオトラックがミュート解除される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
target	string	No	ターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

MessageHook Profile

Ver. 2.0.0

Description

メッセージ送受信の機能を提供するAPI。

Operations

GET /gotapi/messageHook/channel
GET /gotapi/messageHook/message
POST /gotapi/messageHook/message
GET /gotapi/messageHook/onMessage
PUT /gotapi/messageHook/onMessage
DELETE /gotapi/messageHook/onMessage

GET /gotapi/messageHook/channel

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
チャンネル		channels	array(object)	Yes	チャンネルを格納する配列。
	チャンネル識別子	id	string	Yes	チャンネルを識別するID。
	チャンネル名	name	string	Yes	チャンネルの名前。
	チャンネルタイプ	type	string	Yes	チャンネルのタイプ・facebook ・line ・slack など

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "channels" : [ {
    "id" : "xxxxxxxx",
    "name" : "名前",
    "type" : "slack"
  }, {
    "id" : "xxxxxxxx",
    "name" : "名前",
    "type" : "slack"
  } ]
}

GET /gotapi/messageHook/message

API Pattern

one-shot

Summary

直近に受信したメッセージの一覧を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
メッセージ		messages	array(object)	Yes	メッセージ情報。
	メッセンジャータイプ	messagerType	string	Yes	メッセンジャーのタイプ・facebook ・line ・slack など。
	送信元ID	from	long	Yes
	チャンネルID	channelId	string	Yes	チャンネルを識別するID。
	投稿した時間	timeStamp	long	Yes
	投稿した時間の文字列	timeStampString	dateTime	Yes	投稿した時間をRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	チャンネル名	text	string	No	チャンネルの名前。
	リソースURI	resource	string	No	送られてきたメッセージのリソースへのURI。メッセージが指定されていない時は省略されない。
	MimeType	mimeType	string	No	リソースのタイプ。メッセージが指定されていない時は省略されない。
	メッセージタイプ	messageType	string	No	normal, direct, mention の文字列（複数になる場合がある「direct, mention」など）・normal: 通常メッセージ・direct: ダイレクトメッセージ・mention: メンション付きメッセージ＃メンション付きのメッセージのtextはメンション部分が削除されます。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "messages" : [ {
    "messengerType" : "facebook",
    "from" : "abcdef",
    "timeStamp" : 1234567890,
    "timeStampString" : "2015-05-17T10:02:20+09:00",
    "channelId" : "1",
    "text" : "ライトをつけて",
    "resource" : "http://www.gclue.io/a.png",
    "mimeType" : "image/png",
    "messageType" : "direct"
  } ]
}

POST /gotapi/messageHook/message

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
channelId	string	Yes	チャンネルID。メッセージの投稿先チャンネルID。
text	string	No	テキスト。送信する文言。リソースURIが指定されていない時は省略できない。
resource	string	No	リソースURI。画像、音声、映像などのリソースへのURI。テキストが指定されていない時は省略できない。
mimeType	string	No	MimeType。送信するリソースのタイプ。リソースURIが指定されている時は省略できない。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/messageHook/onMessage

API Pattern

one-shot

Summary

直近に受信したメッセージの一覧を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
メッセージ		message	object	Yes
	メッセンジャータイプ	messagerType	string	Yes	メッセンジャーのタイプ・facebook ・line ・slack など。
	送信元ID	from	long	Yes
	チャンネルID	channelId	string	Yes	チャンネルを識別するID。
	投稿した時間	timeStamp	long	Yes
	投稿した時間の文字列	timeStampString	dateTime	Yes	投稿した時間をRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	チャンネル名	text	string	No	チャンネルの名前。
	リソースURI	resource	string	No	送られてきたメッセージのリソースへのURI。メッセージが指定されていない時は省略されない。
	MimeType	mimeType	string	No	リソースのタイプ。メッセージが指定されていない時は省略されない。
	メッセージタイプ	messageType	string	No	normal, direct, mention の文字列（複数になる場合がある「direct, mention」など）・normal: 通常メッセージ・direct: ダイレクトメッセージ・mention: メンション付きメッセージ＃メンション付きのメッセージのtextはメンション部分が削除されます。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "message" : {
    "messengerType" : "xxxx",
    "from" : "abcdef",
    "timeStamp" : 1234567890,
    "timeStampString" : "2015-05-17T10:02:20+09:00",
    "channelId" : "1",
    "text" : "ライトをつけて",
    "resource" : "http://org.deviceconnect/test.png",
    "mimeType" : "image/png",
    "messageType" : "direct"
  }
}

PUT /gotapi/messageHook/onMessage

API Pattern

event

Summary

直近に受信したメッセージ取得イベントを開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
メッセージ		message	object	Yes
	メッセンジャータイプ	messagerType	string	Yes	メッセンジャーのタイプ・facebook ・line ・slack など。
	送信元ID	from	long	Yes
	チャンネルID	channelId	string	Yes	チャンネルを識別するID。
	投稿した時間	timeStamp	long	Yes
	投稿した時間の文字列	timeStampString	dateTime	Yes	投稿した時間をRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
	チャンネル名	text	string	No	チャンネルの名前。
	リソースURI	resource	string	No	送られてきたメッセージのリソースへのURI。メッセージが指定されていない時は省略されない。
	MimeType	mimeType	string	No	リソースのタイプ。メッセージが指定されていない時は省略されない。
	メッセージタイプ	messageType	string	No	normal, direct, mention の文字列（複数になる場合がある「direct, mention」など）・normal: 通常メッセージ・direct: ダイレクトメッセージ・mention: メンション付きメッセージ＃メンション付きのメッセージのtextはメンション部分が削除されます。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "messageHook",
  "attribute" : "onMessage",
  "message" : {
    "messengerType" : "xxxx",
    "from" : "abcdef",
    "timeStamp" : 1234567890,
    "timeStampString" : "2015-05-17T10:02:20+09:00",
    "channelId" : "1",
    "text" : "ライトをつけて",
    "resource" : "http://org.deviceconnect/test.png",
    "mimeType" : "image/png",
    "messageType" : "direct"
  }
}

DELETE /gotapi/messageHook/onMessage

API Pattern

event

Summary

直近に受信したメッセージ取得イベントを停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Notification Profile

Ver. 2.0.0

Description

スマートデバイスのノーティフィケーションを操作する機能。

Operations

POST /gotapi/notification/notify
DELETE /gotapi/notification/notify
GET /gotapi/notification/onClick
PUT /gotapi/notification/onClick
DELETE /gotapi/notification/onClick
GET /gotapi/notification/onClose
PUT /gotapi/notification/onClose
DELETE /gotapi/notification/onClose
GET /gotapi/notification/onError
PUT /gotapi/notification/onError
DELETE /gotapi/notification/onError
GET /gotapi/notification/onShow
PUT /gotapi/notification/onShow
DELETE /gotapi/notification/onShow

POST /gotapi/notification/notify

API Pattern

one-shot

Summary

スマートデバイスにノーティフィケーションの表示要求をする。

Description

ノーティフィケーションの表示要求の到達成否を応答として返却し、ノーティフィケーションの表示完了を待って応答をするわけではない。ノーティフィケーションの表示方法は表示要求を受けたスマートデバイスに依存する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
type	integer	Yes	通知タイプ。通知のタイプを識別する。 0: 音声通話着信 1: メール着信 2: SMS着信 3: イベント
dir	string	No	向き。メッセージの文字の向き。 auto: 自動 rtl: 右から左 ltr: 左から右
lang	string	No	言語。メッセージの言語。 ref. BCP47
body	string	No	表示させる文字列。
tag	string	No	タグ。任意タグ文字列カンマ(,)区切りで任意個数指定。
uri	string	No	アイコン。アイコンファイルのURI。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ノーティフィケーションID	notificationId	string	Yes	ユニークな文字列。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}

DELETE /gotapi/notification/notify

API Pattern

one-shot

Summary

スマートデバイスにノーティフィケーションの消去要求をする。

Description

ノーティフィケーションの消去要求の到達成否を応答として返却し、ノーティフィケーションの消去完了を待って応答をするわけではない。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
notificationId	string	Yes	通知ID。ユニークな文字列。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/notification/onClick

API Pattern

one-shot

Summary

スマートデバイスのノーティフィケーションがクリックされたことを通知するイベントを取得する。

Description

スマートデバイスでノーティフィケーションがクリック(タップ)された時にイベントが発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}

PUT /gotapi/notification/onClick

API Pattern

event

Summary

スマートデバイスのノーティフィケーションがクリックされたことを通知するイベントを開始する。

Description

スマートデバイスでノーティフィケーションがクリック(タップ)された時にイベントが発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name	Physical Name	Type	Required	Description
サービスID	serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名	profile	string	Yes	プロファイル名。
インターフェース名	interface	string	Yes	インターフェース名。
アトリビュート名	attribute	string	Yes	アトリビュート名。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "notification",
  "attribute" : "onclick",
  "notificationId" : 123456
}

DELETE /gotapi/notification/onClick

API Pattern

event

Summary

スマートデバイスのノーティフィケーションがクリックされたことを通知するイベントを停止する。

Description

スマートデバイスでノーティフィケーションがクリック(タップ)された時にイベントが発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/notification/onClose

API Pattern

one-shot

Summary

スマートデバイスのノーティフィケーションが消去されたことを通知するイベントを取得する。

Description

ユーザ操作による消去、プログラムからの消去要求による消去のいずれのイベントでもイベントは発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}

PUT /gotapi/notification/onClose

API Pattern

event

Summary

スマートデバイスのノーティフィケーションが消去されたことを通知するイベントを開始する。

Description

ユーザ操作による消去、プログラムからの消去要求による消去のいずれのイベントでもイベントは発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name	Physical Name	Type	Required	Description
サービスID	serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名	profile	string	Yes	プロファイル名。
インターフェース名	interface	string	Yes	インターフェース名。
アトリビュート名	attribute	string	Yes	アトリビュート名。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "notification",
  "attribute" : "onclose",
  "notificationId" : 123456
}

DELETE /gotapi/notification/onClose

API Pattern

event

Summary

スマートデバイスのノーティフィケーションが消去されたことを通知するイベントを停止する。

Description

ユーザ操作による消去、プログラムからの消去要求による消去のいずれのイベントでもイベントは発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/notification/onError

API Pattern

one-shot

Summary

スマートデバイスのノーティフィケーション操作でエラーが発生したことを通知するイベントを取得する。

Description

スマートデバイスでノーティフィケーション操作でエラーが発生した時にイベントが発行される。表示要求に対する表示失敗のエラー、非表示要求に対する消去失敗のエラーなどが通知される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}

PUT /gotapi/notification/onError

API Pattern

event

Summary

スマートデバイスのノーティフィケーション操作でエラーが発生したことを通知するイベントを開始する。

Description

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name	Physical Name	Type	Required	Description
サービスID	serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名	profile	string	Yes	プロファイル名。
インターフェース名	interface	string	Yes	インターフェース名。
アトリビュート名	attribute	string	Yes	アトリビュート名。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "notification",
  "attribute" : "onerror",
  "notificationId" : 123456
}

DELETE /gotapi/notification/onError

API Pattern

event

Summary

スマートデバイスのノーティフィケーション操作でエラーが発生したことを通知するイベントを停止する。

Description

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/notification/onShow

API Pattern

one-shot

Summary

スマートデバイスのノーティフィケーションが表示されたことを通知するイベントを取得する。

Description

スマートデバイスでノーティフィケーションが表示された時にイベントが発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}

PUT /gotapi/notification/onShow

API Pattern

event

Summary

スマートデバイスのノーティフィケーションが表示されたことを通知するイベントを開始する。

Description

スマートデバイスでノーティフィケーションが表示された時にイベントが発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name	Physical Name	Type	Required	Description
サービスID	serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名	profile	string	Yes	プロファイル名。
インターフェース名	interface	string	Yes	インターフェース名。
アトリビュート名	attribute	string	Yes	アトリビュート名。
ノーティフィケーションID	notificationId	string	Yes	ノーティフィケーションを識別するID。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "notification",
  "attribute" : "onshow",
  "notificationId" : 123456
}

DELETE /gotapi/notification/onShow

API Pattern

event

Summary

スマートデバイスのノーティフィケーションが表示されたことを通知するイベントを停止する。

Description

スマートデバイスでノーティフィケーションが表示された時にイベントが発行される。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Omnidirectional Image Profile

Ver. 2.0.0

Description

全方位パノラマ画像をROI画像へ変換する機能を提供する。
※ROI:Region of Imageのこと。

Operations

PUT /gotapi/omnidirectionalImage/roi
DELETE /gotapi/omnidirectionalImage/roi
PUT /gotapi/omnidirectionalImage/roi/settings

PUT /gotapi/omnidirectionalImage/roi

本APIのレスポンスで返されるURIでROI画像を参照できる。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
source	string	Yes	全方位パノラマ画像URI。ROI画像に変換する全方位パノラマ画像のURI。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ROI画像配信サーバURI	uri	string	Yes	ROI画像を配信するサーバのURIを示す。配信される画像の形式はMotionJPEGとする。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy Preview URI"
}

DELETE /gotapi/omnidirectionalImage/roi

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
uri	string	Yes	ROI画像URI。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/omnidirectionalImage/roi/settings

注1: OpenGLで実装する場合、ワールド座標上の長さ1は実世界上の1メートルに換算する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
uri	string	Yes	ROI画像URI。
x	float	No	視点の絶対座標 (x)。ワールド座標上の視点の絶対座標(前後方向)。単位はメートル。（注1）指定なしの場合は 0.0。
y	float	No	視点の絶対座標 (y)。ワールド座標上の視点の絶対座標(左右方向)。以下、同上。
z	float	No	視点の絶対座標 (z)。ワールド座標上の視点の絶対座標(上下方向)。以下、同上。
roll	float	No	視点の回転 (ロール)。ワールド座標系に対する視点の回転(前後方向の軸中心)。単位はdegree。角度の範囲は0.0〜360.0。0.0, 360.0は撮影時の角度とする。指定なしの場合は0.0。配信開始時の視点の向きは全方位パノラマ画像の中央点。回転の順番はroll, pitch, yawの順。
pitch	float	No	視点の回転 (ピッチ)。ワールド座標系に対する視点の回転(左右方向の軸中心)。以下、同上。
yaw	float	No	視点の回転 (ヨー)。ワールド座標系に対する視点の回転(上下方向の軸中心)。以下、同上。
fov	float	No	視点の画角。視点の画角。角度の範囲は0.0〜180.0。単位はdegree。指定なしの場合は90度。
sphereSize	float	No	天球の大きさ。天球の大きさを半径で指定。単位はメートル。（注1）指定なしの場合は 1。
width	integer	No	ROI画像のサイズ (横)。配信されるROI画像の横サイズ。単位はピクセル。指定なしの場合は600。ステレオ画像生成フラグがtrueの場合、左右それぞれに対しての画像のサイズとして適用される。(よって、ステレオ画像全体としての横幅は 2 * width となる)
height	integer	No	ROI画像のサイズ (縦)。配信されるROI画像の縦サイズ。単位はピクセル。指定なしの場合は400。
stereo	boolean	No	ステレオ画像生成フラグ。trueの場合、ROI画像がステレオ画像形式で配信されるようになる。(ステレオ画像左右の視点が) 指定なしの場合はfalse。
vr	boolean	No	仮想現実モードフラグ。trueの場合、仮想現実モード(ホストデバイスの向きとROIの向きを連動させるモード)をONにする。指定なしの場合はfalse。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Phone Profile

Ver. 2.0.0

Description

周辺機器からスマートフォンの通話機能もしくは通話操作機能を提供するAPI。

Operations

POST /gotapi/phone/call
GET /gotapi/phone/onConnect
PUT /gotapi/phone/onConnect
DELETE /gotapi/phone/onConnect
PUT /gotapi/phone/set

POST /gotapi/phone/call

API Pattern

one-shot

Summary

スマートフォンに対して電話発信要求をリクエストする。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
phoneNumber	string	Yes	電話番号。電話番号を示す文字列。文字には数字の0〜9のみを使用可能。長さは11桁または13桁のいずれかとする。11桁は国内電話、13桁は国際電話として扱う。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/phone/onConnect

API Pattern

one-shot

Summary

スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
電話機能の状態		phoneStatus	object	Yes	電話機能の状態を保持するオブジェクト。特定の相手先との通話状態の変化を通知する。
	電話番号	phoneNumber	string	Yes	相手先の電話番号を示す文字列。文字には数字の0〜9のみを使用可能。長さは11桁または13桁のいずれかとする。11桁は国内電話、13桁は国際電話として扱う。
	通話状態	state	float	Yes	通話状態を示す定数。 0: 通話開始 1: 通話失敗 2: 通話終了

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "phoneStatus" : {
    "phoneNumber" : "01234567890",
    "state" : 2
  }
}

PUT /gotapi/phone/onConnect

API Pattern

event

Summary

スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
電話機能の状態		phoneStatus	object	Yes	電話機能の状態を保持するオブジェクト。特定の相手先との通話状態の変化を通知する。
	電話番号	phoneNumber	string	Yes	相手先の電話番号を示す文字列。文字には数字の0〜9のみを使用可能。長さは11桁または13桁のいずれかとする。11桁は国内電話、13桁は国際電話として扱う。
	通話状態	state	float	Yes	通話状態を示す定数。 0: 通話開始 1: 通話失敗 2: 通話終了

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "phone",
  "attribute" : "onconnect",
  "phoneStatus" : {
    "phoneNumber" : "01234567890",
    "state" : 2
  }
}

DELETE /gotapi/phone/onConnect

API Pattern

event

Summary

スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/phone/set

API Pattern

one-shot

Summary

スマートフォンに対して電話に関する設定項目(サイレント・マナー・音あり)の設定をリクエストする。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
mode	integer	Yes	電話のモード。電話のモードを指定 0:サイレント 1:マナー 2:音あり

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PoseEstimation Profile

Ver. 2.0.0

Description

デバイスの姿勢推定のイベントを通知するための機能。

Operations

GET /gotapi/poseEstimation/onPoseEstimation
PUT /gotapi/poseEstimation/onPoseEstimation
DELETE /gotapi/poseEstimation/onPoseEstimation

GET /gotapi/poseEstimation/onPoseEstimation

API Pattern

one-shot

Summary

デバイスの姿勢推定計測イベントを取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
姿勢情報		pose	object	Yes
	姿勢状態	state	string	Yes	ターゲットデバイスによって測定された姿勢状態を返す。 Forward:前屈 Backward:後屈 Rightside:右傾き Leftside:左傾き FaceUp:仰向け FaceLeft:左向き FaceDown:うつ伏せ FaceRight:右向き Standing:直立
	姿勢推定のタイムスタンプ	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	姿勢推定のタイムスタンプ文字列	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "pose" : {
    "state" : "FaceUp",
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

PUT /gotapi/poseEstimation/onPoseEstimation

API Pattern

event

Summary

デバイスの姿勢推定計測イベントを開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
姿勢情報		pose	object	Yes
	姿勢状態	state	string	Yes	ターゲットデバイスによって測定された姿勢状態を返す。 Forward:前屈 Backward:後屈 Rightside:右傾き Leftside:左傾き FaceUp:仰向け FaceLeft:左向き FaceDown:うつ伏せ FaceRight:右向き Standing:直立
	姿勢推定のタイムスタンプ	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	姿勢推定のタイムスタンプ文字列	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "poseestimation",
  "attribute" : "onposeestimation",
  "pose" : {
    "state" : "FaceUp",
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

DELETE /gotapi/poseEstimation/onPoseEstimation

API Pattern

event

Summary

デバイスの姿勢推定計測イベントを停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Power Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/power
PUT /gotapi/power
DELETE /gotapi/power

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

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

Example Response

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

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Power Meter Profile

Ver. 2.0.0

Description

スマートデバイスが計測した電力を取得する機能を提供するAPI。

Operations

GET /gotapi/powerMeter
PUT /gotapi/powerMeter
DELETE /gotapi/powerMeter
GET /gotapi/powerMeter/instantaneousCurrent
GET /gotapi/powerMeter/instantaneousPower
GET /gotapi/powerMeter/integratedPower

GET /gotapi/powerMeter

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
電源状態	powerstatus	string	Yes	電源状態を示す文字列。

Example Response

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

PUT /gotapi/powerMeter

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/powerMeter

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/powerMeter/instantaneousCurrent

API Pattern

one-shot

Summary

スマートデバイスが計測した瞬時電流量を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
unit	string	No	瞬時電流量単位。瞬時電流量の単位を指定。例： 'mA' 'A' 省略時は'A'

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
瞬時電流量		instantaneouscurrent	object	Yes	瞬時電流量を表す実数。単位はパラメータによる。
	R相瞬時電流量	rphase	double	Yes	R相の瞬時電流量を表す実数。
	T相瞬時電流量	tphase	double	No	T相の瞬時電流量を表す実数。単相の場合は省略。
	瞬時電流量単位	unit	string	Yes	瞬時電流量の単位を表す。例：'mA' 'A'

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "instantaneouscurrent" : {
    "rphase" : 1234.5,
    "tphase" : -2345.6,
    "unit" : "mA"
  }
}

GET /gotapi/powerMeter/instantaneousPower

API Pattern

one-shot

Summary

スマートデバイスが計測した瞬時電力量を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
unit	string	No	瞬時電力量単位。瞬時電力量の単位を指定。例： 'W' 'kW' 省略時は'W'

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
瞬時電力量	instantaneouspower	double	Yes	瞬時電力量を表す実数。単位はパラメータ設定による。
瞬時電力量単位	unit	string	Yes	瞬時電力量の単位を表す。例：'W' 'kW'

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "instantaneouspower" : 38.4,
  "unit" : "W"
}

GET /gotapi/powerMeter/integratedPower

API Pattern

one-shot

Summary

スマートデバイスが計測した積算電力量を取得する。

Description

指定した日時から過去24時間分の計測値を24または48分割して返す。（1時間または30分ごとの値を返す。）

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
date	dateTime	No	取得日付。 RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」形式省略時はAPI実行日時が指定される
unit	string	No	積算電力量単位。積算電力量の単位を指定。省略時は'Wh'
count	integer	No	積算電力量コマ数。24時間分の積算電力量を指定数で返す。 24: 24分割＝１時間単位（デフォルト） 48: 48分割＝30分単位
powerFlow	string	No	積算電力量方向指定。取得する積算電力量の方向を指定。 normal : 正方向 reverse : 逆方向省略時はnormal (正方向)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
積算電力量	integratedpower	array(double)	Yes	24時間分の計測値を返す。サイズが24または48のnumberの配列。各値は積算電力量を表す実数。単位はパラメーター設定による。時間順に格納されているため、最初の要素は24時間前のもの。例: リクエストで date=2015-08-24T15:14:00+0900, count=24 を指定した場合、0から23までの各インデックスに対応する時間帯は下記のとおり。 0 : 2015-08-23T15:00 ~ 15:59 : 23 :2015-08-24T14:00 ~ 14:59
積算電力量単位	unit	string	Yes	積算電力量の単位を表す。例：'Wh' 'kWh'
積算電力量コマ数	count	integer	Yes	積算電力量コマ数（24または48）
積算電力量方向	powerFlow	string	Yes	積算電力量方向を表す。'normal' 'reverse'

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "integratedpower" : [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 ],
  "unit" : "Wh",
  "count" : 24,
  "powerFlow" : "normal"
}

Proximity Profile

Ver. 2.0.0

Description

スマートデバイスの近接センサーの物/人の検知を通知するAPI。

Operations

GET /gotapi/proximity/onDeviceProximity
PUT /gotapi/proximity/onDeviceProximity
DELETE /gotapi/proximity/onDeviceProximity
GET /gotapi/proximity/onUserProximity
PUT /gotapi/proximity/onUserProximity
DELETE /gotapi/proximity/onUserProximity

GET /gotapi/proximity/onDeviceProximity

API Pattern

one-shot

Summary

スマートデバイスの近接センサーの物の検知を通知するイベントを取得する。

Description

スマートデバイスの近接センサーの情報を近接距離最小/最大値の範囲で連続的にイベント発行する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
近接イベント		proximity	object	Yes
	近接距離	value	integer	No	cm単位の距離。
	近接距離最小値	min	integer	No	cm単位の距離。
	近接距離最大値	max	integer	No	cm単位の距離。
	閾値	threshold	integer	No	cm単位の距離の閾値。
	距離識別子	range	string	No	距離を示す文字列。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "proximity" : {
    "value" : 12.3456,
    "min" : 1.23456,
    "max" : 123.456,
    "threshold" : 12.3456,
    "range" : "NEAR"
  }
}

PUT /gotapi/proximity/onDeviceProximity

API Pattern

event

Summary

スマートデバイスの近接センサーの物の検知を通知するイベントを開始する。

Description

スマートデバイスの近接センサーの情報を近接距離最小/最大値の範囲で連続的にイベント発行する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
近接イベント		proximity	object	Yes
	近接距離	value	integer	No	cm単位の距離。
	近接距離最小値	min	integer	No	cm単位の距離。
	近接距離最大値	max	integer	No	cm単位の距離。
	閾値	threshold	integer	No	cm単位の距離の閾値。
	距離識別子	range	string	No	距離を示す文字列。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "proximity",
  "attribute" : "ondeviceproximity",
  "proximity" : {
    "value" : 12.3456,
    "min" : 1.23456,
    "max" : 123.456,
    "threshold" : 12.3456,
    "range" : "NEAR"
  }
}

DELETE /gotapi/proximity/onDeviceProximity

API Pattern

event

Summary

スマートデバイスの近接センサーの物の検知を通知するイベントを停止する。

Description

スマートデバイスの近接センサーの情報を近接距離最小/最大値の範囲で連続的にイベント発行する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
近接イベント		proximity	object	Yes
	近接距離	value	integer	No	cm単位の距離。
	近接距離最小値	min	integer	No	cm単位の距離。
	近接距離最大値	max	integer	No	cm単位の距離。
	閾値	threshold	integer	No	cm単位の距離の閾値。
	距離識別子	range	string	No	距離を示す文字列。

GET /gotapi/proximity/onUserProximity

API Pattern

one-shot

Summary

スマートデバイスの近接センサーのユーザ検知を通知するイベントを取得する。

Description

ユーザ検知とは、例えば通話時にスマートフォンの画面を耳元に近接させた場合等に発生する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
近接イベント		proximity	object	Yes
	近接の有無	near	boolean	Yes	ユーザがデバイスに近接しているかどうか。 true: 近接している false: 近接していない

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "proximity" : {
    "near" : true
  }
}

PUT /gotapi/proximity/onUserProximity

API Pattern

event

Summary

スマートデバイスの近接センサーのユーザ検知を通知するイベントを開始する。

Description

ユーザ検知とは、例えば通話時にスマートフォンの画面を耳元に近接させた場合等に発生する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
近接イベント		proximity	object	Yes
	近接の有無	near	boolean	Yes	ユーザがデバイスに近接しているかどうか。 true: 近接している false: 近接していない

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "proximity",
  "attribute" : "onuserproximity",
  "proximity" : {
    "near" : true
  }
}

DELETE /gotapi/proximity/onUserProximity

API Pattern

event

Summary

スマートデバイスの近接センサーのユーザ検知を通知するイベントを停止する。

Description

ユーザ検知とは、例えば通話時にスマートフォンの画面を耳元に近接させた場合等に発生する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
近接イベント		proximity	object	Yes
	近接の有無	near	boolean	Yes	ユーザがデバイスに近接しているかどうか。 true: 近接している false: 近接していない

Remote Controller Profile

Ver. 2.0.0

Description

スマートデバイスが保持する赤外線などの信号の送受信機能を提供するAPI。

Operations

GET /gotapi/remoteController
POST /gotapi/remoteController

GET /gotapi/remoteController

API Pattern

one-shot

Summary

スマートデバイスが保持する赤外線などの信号を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
メッセージ(赤外線など）	message	string	Yes	赤外線などの信号。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "message" : "{data[18031,8755,1190,1190,1190,3341,1190,3341,1190,3341,1190,1190,1190,3341,1190,3341,1190,334 1,1190,3341,1190,3341,1190,3341,1190,1190,1190,1190,1190,1190,1190,1190,1190,3341,1190,3341,1190,1190,1190,3 341,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,1190,3341,1190,3341,1190 ,3341,1190,3341,1190,3341,1190,65535,0,9379,18031,4400,1190]}"
}

POST /gotapi/remoteController

API Pattern

one-shot

Summary

スマートデバイスに対して赤外線などの信号送信依頼を送る。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
message	string	Yes	メッセージ(赤外線など)。赤外線などの信号。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

ServiceDiscovery Profile

Ver. 2.0.0

Description

DeviceConnectシステム上のサービス検索機能を提供するAPI。

Operations

GET /gotapi/serviceDiscovery
PUT /gotapi/serviceDiscovery/onServiceChange
DELETE /gotapi/serviceDiscovery/onServiceChange

GET /gotapi/serviceDiscovery

API Pattern

one-shot

Summary

DeviceConnectサービスの検索を行う。

Description

DeviceConnectサービス検索機能を提供するAPI。取得できる情報としては、サービスID、サービス名、ネットワーク種別、利用可能状態やデバイス固有のコンフィグ情報がある。

Parameters

Name	Type	Required	Description

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
サービス一覧		services	array(object)	Yes	DeviceConnectサービスの配列。
	サービスID	id	string	Yes	サービスを識別するためのID。
	サービス名	name	string	Yes	サービスの名前。
	ネットワーク種別	type	string	No	ホストデバイスと接続するためのネットワークの種別。
	利用可能状態	online	boolean	Yes	サービスが利用可能であるかどうかを示すフラグ。
	コンフィグ	config	string	No	サービス固有の設定がある場合には、ここに文字列として格納される。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "services" : [ {
    "id" : "example-service-id",
    "name" : "Example Service",
    "online" : true
  } ]
}

PUT /gotapi/serviceDiscovery/onServiceChange

API Pattern

event

Summary

DeviceConnectサービス一覧の変更通知を受領する。

Description

DeviceConnectサービスの追加・削除・利用可能状態変更を通知するためのイベント。

Parameters

Name	Type	Required	Description

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
オブジェクト			networkService	object	Yes	イベントの内容を保持するオブジェクト。
	サービス一覧		services	array(object)	Yes	DeviceConnectサービスの配列。
		サービスID	id	string	Yes	サービスを識別するためのID。
		サービス名	name	string	Yes	サービスの名前。
		ネットワーク種別	type	string	No	ホストデバイスと接続するためのネットワークの種別。
		利用可能状態	online	boolean	Yes	サービスが利用可能であるかどうかを示すフラグ。
		コンフィグ	config	string	No	サービス固有の設定がある場合には、ここに文字列として格納される。

Example Event

{
  "profile" : "serviceDiscovery",
  "attribute" : "onServiceChange",
  "networkService" : {
    "services" : [ {
      "id" : "example-service-id",
      "name" : "Example Service",
      "online" : true
    } ]
  }
}

DELETE /gotapi/serviceDiscovery/onServiceChange

API Pattern

event

Summary

DeviceConnectサービス一覧の変更通知の受領を停止する。

Parameters

Name	Type	Required	Description

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

ServiceInformation Profile

Ver. 2.0.0

Description

DeviceConnectシステム上の特定のサービスに関する情報を提供するAPI。

Operations

GET /gotapi/serviceInformation

GET /gotapi/serviceInformation

API Pattern

one-shot

Summary

DeviceConnectシステム上の特定のサービスに関する情報を提供するAPI。

Description

サポートするプロファイル一覧、ネットワークへの接続状態を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
オブジェクト		connect	object	Yes	ネットワークの接続状態
	Wi-Fi接続フラグ	wifi	boolean	No	Wi-Fiの接続を提供しない場合は省略。
	Bluetooth接続フラグ	bluetooth	boolean	No	Bluetoothの接続を提供しない場合は省略。
	BLE接続フラグ	ble	boolean	No	BLEの接続を提供しない場合は省略。
	NFC接続フラグ	NFC	boolean	No	NFCの接続を提供しない場合は省略。
プロファイル一覧		supports	array(string)	Yes	サポートしているプロファイル名の配列。
各プロファイルのDeviceConnectAPI仕様定義		supportApis	object	No	指定されたサービスのサポートするプロファイル名をキーとして、そのプロファイルのAPIを定義するSwagger 2.0ドキュメントを提供する。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connect" : {
    "ble" : true
  },
  "supports" : [ "example" ],
  "supportApis" : {
    "example" : {
      "swagger" : "2.0",
      "basePath" : "/gotapi/example",
      "info" : {
        "title" : "Example Profile",
        "version" : "1.0",
        "description" : ""
      },
      "paths" : {
        "/message" : {
          "post" : {
            "x-type" : "one-shot",
            "summary" : "Post a message.",
            "parameters" : [ {
              "name" : "serviceId",
              "in" : "query",
              "required" : true,
              "type" : "string"
            }, {
              "name" : "message",
              "in" : "query",
              "required" : true,
              "type" : "string"
            } ],
            "responses" : {
              "200" : {
                "description" : ""
              }
            }
          }
        }
      }
    }
  }
}

Setting Profile

Ver. 2.0.0

Description

スマートデバイスの各種設定状態の取得および設定機能を提供するプロファイル。

Operations

GET /gotapi/setting/date
PUT /gotapi/setting/date
GET /gotapi/setting/display/brightness
PUT /gotapi/setting/display/brightness
GET /gotapi/setting/display/sleep
PUT /gotapi/setting/display/sleep
GET /gotapi/setting/sound/volume
PUT /gotapi/setting/sound/volume

GET /gotapi/setting/date

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
日付	date	dateTime	Yes	RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式の日付。例: 2015-05-17T10:02:20+09:00

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "date" : "2015-05-17T10:02:20+09:00"
}

PUT /gotapi/setting/date

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
date	dateTime	Yes	RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式の日付。例: 2015-05-17T10:02:20+09:00

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/setting/display/brightness

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
輝度	level	float	Yes	ディスプレイの輝度を割合で示す範囲 (0.0 <= level <= 1.0)

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "level" : 0.5
}

PUT /gotapi/setting/display/brightness

API Pattern

one-shot

Summary

スマートデバイスのライト明度の設定依頼を送る。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
level	float	Yes	ディスプレイの輝度を割合で示す範囲 (0.0 <= level <= 1.0)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/setting/display/sleep

API Pattern

one-shot

Summary

スマートデバイスの画面消灯設定を取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
消灯するまでの時間	time	long	Yes	ディスプレイが消灯するまでの時間 (ミリ秒)

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "time" : 120000
}

PUT /gotapi/setting/display/sleep

API Pattern

one-shot

Summary

スマートデバイスの画面消灯設定依頼を送る。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
time	long	Yes	ディスプレイが消灯するまでの時間 (ミリ秒)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/setting/sound/volume

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
kind	integer	Yes	\|Value\|Description\| \|:-----\|:-----\| \|1\|Alarm\| \|2\|Voice Volume\| \|3\|Ring Alert\| \|4\|Incoming Mail Alert\| \|5\|Media Player\| \|6\|Other\|

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
音量	level	float	Yes	音量を割合で示す。(0.0 <= level <= 1.0)

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "level" : 1
}

PUT /gotapi/setting/sound/volume

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
kind	integer	Yes	\|Value\|Description\| \|:-----\|:-----\| \|1\|Alarm\| \|2\|Voice Volume\| \|3\|Ring Alert\| \|4\|Incoming Mail Alert\| \|5\|Media Player\| \|6\|Other\|
level	float	Yes	音量を割合で示す。(0.0 <= level <= 1.0)

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Sphero Profile

Ver. 2.0.0

Description

Spheroに搭載されているセンサーの値を通知するプロファイル。

Operations

GET /gotapi/sphero/collision/onCollision
PUT /gotapi/sphero/collision/onCollision
DELETE /gotapi/sphero/collision/onCollision
GET /gotapi/sphero/locator/onLocator
PUT /gotapi/sphero/locator/onLocator
DELETE /gotapi/sphero/locator/onLocator
GET /gotapi/sphero/quaternion/onQuaternion
PUT /gotapi/sphero/quaternion/onQuaternion
DELETE /gotapi/sphero/quaternion/onQuaternion

GET /gotapi/sphero/collision/onCollision

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
衝突イベント			collision	object	Yes	衝突イベントオブジェクト。
	衝突加速度		impactAcceleration	object	No	衝突加速度。
		x成分	x	float	Yes	x軸方向への加速度(cm/s2)
		y成分	y	float	Yes	y軸方向への加速度(cm/s2)
		z成分	z	float	Yes	z軸方向への加速度(cm/s2)
	衝突軸		impactAxis	object	No	衝突軸。
		x成分	x	boolean	Yes	x成分。
		y成分	y	boolean	Yes	y成分。
	衝突力		impactPower	object	No	衝突力。
		x成分	x	float	Yes	x成分。
		y成分	y	float	Yes	y成分。
	衝突速度		impactSpeed	float	No	衝突速度(単位: cm/s)
	衝突時刻		impactTimeStamp	long	No	衝突した時間のタイムスタンプ(単位: ミリ秒)
	衝突時刻の文字列		impactTimeStampString	dateTime	No	衝突した時間のタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "collision" : {
    "impactAxis" : {
      "x" : true,
      "y" : false
    },
    "impactPower" : {
      "x" : 152,
      "y" : 75
    },
    "impactSpeed" : 0,
    "impactTimestamp" : 1483241696789,
    "impactTimeStampString" : "2015-05-17T10:02:20+09:00",
    "impactAcceleration" : {
      "x" : -1.57421875,
      "y" : -1.53076171875,
      "z" : 0
    }
  }
}

PUT /gotapi/sphero/collision/onCollision

API Pattern

event

Summary

Spheroの衝突イベントの受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
衝突イベント			collision	object	Yes	衝突イベントオブジェクト。
	衝突加速度		impactAcceleration	object	No	衝突加速度。
		x成分	x	float	Yes	x軸方向への加速度(cm/s2)
		y成分	y	float	Yes	y軸方向への加速度(cm/s2)
		z成分	z	float	Yes	z軸方向への加速度(cm/s2)
	衝突軸		impactAxis	object	No	衝突軸。
		x成分	x	boolean	Yes	x成分。
		y成分	y	boolean	Yes	y成分。
	衝突力		impactPower	object	No	衝突力。
		x成分	x	float	Yes	x成分。
		y成分	y	float	Yes	y成分。
	衝突速度		impactSpeed	float	No	衝突速度(単位: cm/s)
	衝突時刻		impactTimeStamp	long	No	衝突した時間のタイムスタンプ(単位: ミリ秒)
	衝突時刻の文字列		impactTimeStampString	dateTime	No	衝突した時間のタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "sphero",
  "interface" : "collision",
  "attribute" : "oncollision",
  "collision" : {
    "impactAxis" : {
      "x" : true,
      "y" : false
    },
    "impactPower" : {
      "x" : 152,
      "y" : 75
    },
    "impactSpeed" : 0,
    "impactTimeStamp" : 1483241696789,
    "impactTimeStampString" : "2015-05-17T10:02:20+09:00",
    "impactAcceleration" : {
      "x" : -1.57421875,
      "y" : -1.53076171875,
      "z" : 0
    }
  }
}

DELETE /gotapi/sphero/collision/onCollision

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/sphero/locator/onLocator

API Pattern

one-shot

Summary

Spheroの位置と速度を通知するイベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
位置		locator	object	Yes	Spheroの位置座標オブジェクト。
	x座標	positionX	float	Yes	位置のx座標 (単位: cm)
	y座標	positionY	float	Yes	位置のy座標 (単位: cm)
	x成分	velocityX	float	Yes	速度のx成分 (単位:cm/s)
	y成分	velocityY	float	Yes	速度のy成分 (単位:cm/s)

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "locator" : {
    "positionX" : -3,
    "positionY" : 5,
    "velocityX" : -10,
    "velocityY" : -1.5
  }
}

PUT /gotapi/sphero/locator/onLocator

API Pattern

event

Summary

Spheroの位置と速度を通知するイベントの受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
位置		locator	object	Yes	Spheroの位置座標オブジェクト。
	x座標	positionX	float	Yes	位置のx座標 (単位: cm)
	y座標	positionY	float	Yes	位置のy座標 (単位: cm)
	x成分	velocityX	float	Yes	速度のx成分 (単位:cm/s)
	y成分	velocityY	float	Yes	速度のy成分 (単位:cm/s)

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "sphero",
  "interface" : "locator",
  "attribute" : "onlocator",
  "locator" : {
    "positionX" : -3,
    "positionY" : 5,
    "velocityX" : -10,
    "velocityY" : -1.5
  }
}

DELETE /gotapi/sphero/locator/onLocator

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/sphero/quaternion/onQuaternion

API Pattern

one-shot

Summary

Spheroの四元数を通知するイベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
四元数		quaternion	object	Yes	四元数オブジェクト。
	i軸	q0	float	Yes	i軸
	j軸	q1	float	Yes	j軸
	k軸	q2	float	Yes	k軸
	s軸	q3	float	Yes	s軸
	インターバル	interval	long	Yes	計測のインターバル。(単位: ミリ秒)

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "quaternion" : {
    "q0" : 0.9998000264167786,
    "q1" : -0.0027000000700354576,
    "q2" : -0.010099999606609344,
    "q3" : 0.010900000110268593,
    "interval" : 220
  }
}

PUT /gotapi/sphero/quaternion/onQuaternion

API Pattern

event

Summary

Spheroの四元数を通知するイベントの受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
四元数		quaternion	object	Yes	四元数オブジェクト。
	i軸	q0	float	Yes	i軸
	j軸	q1	float	Yes	j軸
	k軸	q2	float	Yes	k軸
	s軸	q3	float	Yes	s軸
	インターバル	interval	long	Yes	計測のインターバル。(単位: ミリ秒)

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "sphero",
  "interface" : "quaternion",
  "attribute" : "onquaternion",
  "quaternion" : {
    "q0" : 0.9998000264167786,
    "q1" : -0.0027000000700354576,
    "q2" : -0.010099999606609344,
    "q3" : 0.010900000110268593,
    "interval" : 220
  }
}

DELETE /gotapi/sphero/quaternion/onQuaternion

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

StressEstimation Profile

Ver. 2.0.0

Description

ストレス推定のイベントを通知するプロファイル。

Operations

GET /gotapi/stressEstimation/onStressEstimation
PUT /gotapi/stressEstimation/onStressEstimation
DELETE /gotapi/stressEstimation/onStressEstimation

GET /gotapi/stressEstimation/onStressEstimation

API Pattern

one-shot

Summary

デバイスのストレス推定計測イベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ストレス情報		stress	object	Yes
	LFHF値	lfhf	float	Yes	ターゲットデバイスによって測定されたLFHF値。
	タイムスタンプ (Unix時刻)	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	タイムスタンプ (日付)	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "stress" : {
    "lfhf" : 0.5,
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

PUT /gotapi/stressEstimation/onStressEstimation

API Pattern

event

Summary

デバイスのストレス推定計測イベントの受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
ストレス情報		stress	object	Yes
	LFHF値	lfhf	float	Yes	ターゲットデバイスによって測定されたLFHF値。
	タイムスタンプ (Unix時刻)	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	タイムスタンプ (日付)	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "stressestimation",
  "attribute" : "onstressestimation",
  "stress" : {
    "lfhf" : 0.5,
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

DELETE /gotapi/stressEstimation/onStressEstimation

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

System Profile

Ver. 2.0.0

Description

DeviceConnectシステム情報を提供するAPI。

Operations

GET /gotapi/system
PUT /gotapi/system/device/wakeup
DELETE /gotapi/system/events
PUT /gotapi/system/keyword

DeviceConnectシステム情報を提供するAPI。

Description

DeviceConnectシステムのバージョンやサポートするAPI一覧、インストールされているプラグイン一覧などのアプリケーション情報を取得する。

Parameters

Name	Type	Required	Description

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
プロファイル一覧		supports	array(string)	Yes	Device Connect Managerのサポートするプロファイル名の配列。
プラグイン一覧		plugins	array(object)	Yes	DeviceConnectシステムにインストールされているプラグインについての情報の配列。
	ID	id	string	Yes	DeviceConnectシステム上でプラグインを識別するためのID。
	名前	name	string	Yes	プラグインの名前。
	バージョン	version	string	Yes	プラグインのバージョン名。
	プロファイル一覧	supports	array(string)	Yes	プラグインのサポートするプロファイル名の配列。
	パッケージ名	packageName	string	No	DeviceConnectシステムの実行環境(例:Android)でプラグインを識別するための名前。

PUT /gotapi/system/device/wakeup

プラグインによっては、設定画面が起動してデバイスとの接続を行う。

Parameters

Name	Type	Required	Description
pluginId	string	Yes

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

DELETE /gotapi/system/events

API Pattern

one-shot

Summary

リクエスト送信元のオリジンに紐づくイベントを一挙に解除する。

Parameters

Name	Type	Required	Description

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

PUT /gotapi/system/keyword

API Pattern

one-shot

Summary

DeviceConnectシステムに対し、ユーザーが登録したキーワードの表示要求をする。

Parameters

Name	Type	Required	Description

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Temperature Profile

Ver. 2.0.0

Description

スマートデバイスの計測または管理している温度を提供するプロファイル。

Operations

GET /gotapi/temperature
PUT /gotapi/temperature

GET /gotapi/temperature

typeはそれぞれ、1:摂氏、2:華氏を表している。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
type	integer	No	1:摂氏、2:華氏

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
温度	tempareture	float	Yes	温度の値。
単位	type	integer	Yes	1:摂氏、2:華氏
温度のタイムスタンプ	timeStamp	long	No	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
温度のタイムスタンプ文字列	timeStampString	dateTime	No	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0,
  "temperature" : 25,
  "type" : 1,
  "timeStamp" : 1431856940275,
  "timeStampString" : "2015-05-17T10:02:20+09:00"
}

PUT /gotapi/temperature

typeはそれぞれ、1:摂氏、2:華氏を表している。
temperatureに設定できる値は、摂氏の場合は0以上50以下, 華氏の場合は32以上122以下。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
temperature	integer	Yes	温度の値。
type	integer	No	1:摂氏、2:華氏

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0
}

Touch Profile

Ver. 2.0.0

Description

スマートデバイス上でのタッチイベントを通知するプロファイル。

Operations

GET /gotapi/touch/onDoubleTap
PUT /gotapi/touch/onDoubleTap
DELETE /gotapi/touch/onDoubleTap
GET /gotapi/touch/onTouch
PUT /gotapi/touch/onTouch
DELETE /gotapi/touch/onTouch
GET /gotapi/touch/onTouchCancel
PUT /gotapi/touch/onTouchCancel
DELETE /gotapi/touch/onTouchCancel
GET /gotapi/touch/onTouchChange
PUT /gotapi/touch/onTouchChange
DELETE /gotapi/touch/onTouchChange
GET /gotapi/touch/onTouchEnd
PUT /gotapi/touch/onTouchEnd
DELETE /gotapi/touch/onTouchEnd
GET /gotapi/touch/onTouchMove
PUT /gotapi/touch/onTouchMove
DELETE /gotapi/touch/onTouchMove
GET /gotapi/touch/onTouchStart
PUT /gotapi/touch/onTouchStart
DELETE /gotapi/touch/onTouchStart

GET /gotapi/touch/onDoubleTap

API Pattern

one-shot

Summary

デバイスでダブルタップされたイベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
タッチイベント			touch	object	Yes	イベントの内容を保持するオブジェクト。
	タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
		ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 192,
      "y" : 168,
      "id" : 0
    }, {
      "x" : 54,
      "y" : 200,
      "id" : 1
    } ]
  }
}

PUT /gotapi/touch/onDoubleTap

API Pattern

event

Summary

デバイスでダブルタップされたイベントの受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
タッチイベント			touch	object	Yes	イベントの内容を保持するオブジェクト。
	タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
		ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ondoubletap",
  "touch" : {
    "touches" : [ {
      "x" : 192,
      "y" : 168,
      "id" : 0
    }, {
      "x" : 54,
      "y" : 200,
      "id" : 1
    } ]
  }
}

DELETE /gotapi/touch/onDoubleTap

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/touch/onTouch

API Pattern

one-shot

Summary

デバイスでタッチ(touchstart,touchendされた後)されたイベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
タッチイベント			touch	object	Yes	イベントの内容を保持するオブジェクト。
	タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
		ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 256,
      "y" : 128,
      "id" : 0
    }, {
      "x" : 64,
      "y" : 32,
      "id" : 1
    } ]
  }
}

PUT /gotapi/touch/onTouch

API Pattern

event

Summary

デバイスでタッチ(touchstart,touchendされた後)されたイベントの受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
タッチイベント			touch	object	Yes	イベントの内容を保持するオブジェクト。
	タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
		ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ontouch",
  "touch" : {
    "touches" : [ {
      "x" : 256,
      "y" : 128,
      "id" : 0
    }, {
      "x" : 64,
      "y" : 32,
      "id" : 1
    } ]
  }
}

DELETE /gotapi/touch/onTouch

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/touch/onTouchCancel

API Pattern

one-shot

Summary

デバイスでタッチがキャンセルされたイベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
タッチイベント			touch	object	Yes	イベントの内容を保持するオブジェクト。
	タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
		ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 384,
      "y" : 192,
      "id" : 0
    }, {
      "x" : 512,
      "y" : 256,
      "id" : 1
    } ]
  }
}

PUT /gotapi/touch/onTouchCancel

API Pattern

event

Summary

デバイスでタッチがキャンセルされたイベントの受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
タッチイベント			touch	object	Yes	イベントの内容を保持するオブジェクト。
	タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
		ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ontouchcancel",
  "touch" : {
    "touches" : [ {
      "x" : 384,
      "y" : 192,
      "id" : 0
    }, {
      "x" : 512,
      "y" : 256,
      "id" : 1
    } ]
  }
}

DELETE /gotapi/touch/onTouchCancel

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/touch/onTouchChange

API Pattern

one-shot

Summary

デバイスでタッチされた座標と状態をイベントとして取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
タッチの状態		state	string	No	start:タッチを開始した。 end:タッチが終了した。 doubletap:ダブルタップが行われた。 move:タッチされ続けている。 cancel:タッチが中断された。
タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
	ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
	x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
	y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 192,
      "y" : 168,
      "id" : 0
    }, {
      "x" : 54,
      "y" : 200,
      "id" : 1
    } ]
  }
}

PUT /gotapi/touch/onTouchChange

API Pattern

event

Summary

デバイスでタッチされた座標と状態をイベントとしての受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
タッチの状態		state	string	No	start:タッチを開始した。 end:タッチが終了した。 doubletap:ダブルタップが行われた。 move:タッチされ続けている。 cancel:タッチが中断された。
タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
	ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
	x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
	y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ondoubletap",
  "touch" : {
    "touches" : [ {
      "x" : 192,
      "y" : 168,
      "id" : 0
    }, {
      "x" : 54,
      "y" : 200,
      "id" : 1
    } ]
  }
}

DELETE /gotapi/touch/onTouchChange

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/touch/onTouchEnd

API Pattern

one-shot

Summary

デバイスでタッチが終了したイベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
タッチイベント			touch	object	Yes	イベントの内容を保持するオブジェクト。
	タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
		ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 384,
      "y" : 512,
      "id" : 0
    }, {
      "x" : 512,
      "y" : 768,
      "id" : 1
    } ]
  }
}

PUT /gotapi/touch/onTouchEnd

API Pattern

event

Summary

デバイスでタッチが終了したイベントの受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
タッチイベント			touch	object	Yes	イベントの内容を保持するオブジェクト。
	タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
		ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ontouchend",
  "touch" : {
    "touches" : [ {
      "x" : 384,
      "y" : 512,
      "id" : 0
    }, {
      "x" : 512,
      "y" : 768,
      "id" : 1
    } ]
  }
}

DELETE /gotapi/touch/onTouchEnd

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/touch/onTouchMove

API Pattern

one-shot

Summary

デバイスでタッチされ続けているイベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
タッチイベント			touch	object	Yes	イベントの内容を保持するオブジェクト。
	タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
		ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 16,
      "y" : 32,
      "id" : 0
    }, {
      "x" : 32,
      "y" : 64,
      "id" : 1
    } ]
  }
}

PUT /gotapi/touch/onTouchMove

API Pattern

event

Summary

デバイスでタッチされ続けているイベントの受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
タッチイベント			touch	object	Yes	イベントの内容を保持するオブジェクト。
	タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
		ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ontouchmove",
  "touch" : {
    "touches" : [ {
      "x" : 16,
      "y" : 32,
      "id" : 0
    }, {
      "x" : 32,
      "y" : 64,
      "id" : 1
    } ]
  }
}

DELETE /gotapi/touch/onTouchMove

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/touch/onTouchStart

API Pattern

one-shot

Summary

デバイスでタッチが開始されたイベントを取得する。

Description

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name			Physical Name	Type	Required	Description
処理結果			result	integer	Yes	0:正常応答 0以外:異常応答
システム名			product	string	Yes	DeviceConnectシステムの名前。
システムバージョン			version	string	Yes	DeviceConnectシステムのバージョン名。
署名			hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
タッチイベント			touch	object	Yes	イベントの内容を保持するオブジェクト。
	タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
		ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "touch" : {
    "touches" : [ {
      "x" : 64,
      "y" : 32,
      "id" : 0
    }, {
      "x" : 128,
      "y" : 256,
      "id" : 1
    } ]
  }
}

PUT /gotapi/touch/onTouchStart

API Pattern

event

Summary

デバイスでタッチが開始されたイベントの受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name			Physical Name	Type	Required	Description
サービスID			serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名			profile	string	Yes	プロファイル名。
インターフェース名			interface	string	Yes	インターフェース名。
アトリビュート名			attribute	string	Yes	アトリビュート名。
タッチイベント			touch	object	Yes	イベントの内容を保持するオブジェクト。
	タッチ情報の配列		touches	array(object)	Yes	各タッチに関する情報の配列。
		ID	id	integer	Yes	タッチを開始すると割り振られる、ユニーク（唯一）な識別番号。
		x座標	x	integer	Yes	デバイスが持つ空間の左上を原点としたx座標。
		y座標	y	integer	Yes	デバイスが持つ空間の左上を原点としたy座標。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ontouchstart",
  "touch" : {
    "touches" : [ {
      "x" : 64,
      "y" : 32,
      "id" : 0
    }, {
      "x" : 128,
      "y" : 256,
      "id" : 1
    } ]
  }
}

DELETE /gotapi/touch/onTouchStart

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

TV Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/tv
PUT /gotapi/tv
DELETE /gotapi/tv
PUT /gotapi/tv/broadcastWave
PUT /gotapi/tv/channel
GET /gotapi/tv/enlProperty
PUT /gotapi/tv/enlProperty
PUT /gotapi/tv/mute
DELETE /gotapi/tv/mute
PUT /gotapi/tv/volume

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

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

Example Response

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

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/tv/broadcastWave

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
select	string	Yes	放送波選択。 DTV : 地上波デジタル放送 BS : BS放送波 CS : CS放送波

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/tv/channel

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
tuning	string	No	選局。1〜12：チャンネル番号
control	string	No	操作。 next : 次局選局 previous : 前局選局

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

GET /gotapi/tv/enlProperty

API Pattern

one-shot

Summary

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

Description

※enlproperty:ECHONET Lite Propertyのこと。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
epc	array(string)	No	取得プロパティのEPC。取得するプロパティのEPCをカンマ区切りで列挙。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		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の設定値。

Example Response

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

PUT /gotapi/tv/enlProperty

API Pattern

one-shot

Summary

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

Description

※enlproperty:ECHONET Lite Propertyのこと。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
epc	string	Yes	EPC。 ECHONET Property Code
value	string	Yes	EPCの設定値。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/tv/mute

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

PUT /gotapi/tv/volume

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
control	string	Yes	操作。 up : ボリュームを上げる down : ボリュームを下げる

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Vibration Profile

Ver. 2.0.0

Description

バイブレーション操作機能を提供するプロファイル。

Operations

PUT /gotapi/vibration/vibrate
DELETE /gotapi/vibration/vibrate

PUT /gotapi/vibration/vibrate

API Pattern

one-shot

Summary

スマートデバイスに対してバイブレーション依頼を送る。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象デバイス
pattern	array(long)	No	バイブレーションのパターン。カンマ区切りで、震える、止まるを繰り返しバイブレーションする。カンマ区切りされていない場合は、そのms分バイブレーションする。省略された場合は、デバイス毎のMax値分バイブレーションする。デバイス毎にMax値が設定されていない場合は、500ms分バイブレーションする。例) 100, 100, 100, 100

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

DELETE /gotapi/vibration/vibrate

API Pattern

one-shot

Summary

スマートデバイスに対してバイブレーション停止依頼を送る。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象デバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0: 正常応答 0以外: 異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Video Chat Profile

Ver. 2.0.0

Description

スマートデバイスが持つビデオチャットを操作する機能を提供するプロファイル。

Operations

GET /gotapi/videoChat/address
POST /gotapi/videoChat/call
DELETE /gotapi/videoChat/call
GET /gotapi/videoChat/onCall
PUT /gotapi/videoChat/onCall
DELETE /gotapi/videoChat/onCall
GET /gotapi/videoChat/onHangup
PUT /gotapi/videoChat/onHangup
DELETE /gotapi/videoChat/onHangup
GET /gotapi/videoChat/onIncoming
PUT /gotapi/videoChat/onIncoming
DELETE /gotapi/videoChat/onIncoming
GET /gotapi/videoChat/profile
PUT /gotapi/videoChat/profile

GET /gotapi/videoChat/address

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
addressId	string	No	アドレスID。指定しない場合は、接続できるすべてのアドレスを返却する。指定した場合は、接続先アドレスに対応する情報のみ取得できる。
config	string	No	コンフィグ。必要に応じてAPIキーなどを格納する任意の文字列。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
アドレス一覧		addresses	array(object)	Yes
	デバイス名	name	string	Yes	接続先のデバイス名。
	アドレスID	addressId	string	Yes	接続先のアドレスID。
	状態	status	string	Yes	デバイスの状態 idle: 待機状態 calling: 発信状態 talking: 通話中

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0,
  "addresses" : [ {
    "name" : "Sample 1",
    "addressId" : "xxxxxx",
    "status" : "idle"
  }, {
    "name" : "Sample 2",
    "addressId" : "xxxxx",
    "status" : "calling"
  }, {
    "name" : "Sample 3",
    "addressId" : "xxxxx",
    "status" : "talking"
  } ]
}

POST /gotapi/videoChat/call

Name	Type	Required	Description
serviceId	string	Yes	サービスID
addressId	string	Yes	接続先のアドレス。
video	string	No	映像リソースURI。 true: デバイス標準のカメラから取得できる映像を利用する。 false: 映像リソースを利用しない。 URI: 指定されたURIの映像リソースを利用する。省略された場合は、trueと同じ扱い。
audio	string	No	音声リソースURI。 true: デバイス標準のマイクから取得できる映像を利用する。 false: 音声リソースを利用しない。 URL: 指定されたURIの音声リソースを利用する。省略された場合は、trueと同じ扱い。
config	string	No	コンフィグ。必要に応じてAPIキーなどを格納する任意の文字列。必要に応じてAPIキーなどを格納する任意の文字列。
outputs	string	No	出力設定。 host: HOST表示 app: アプリケーション表示ホストデバイスの画面上に表示する場合はhostを指定する。省略された場合はhost指定として動作する。アプリケーション等でURIを参照して表示する場合は、appを指定する。
audioSampleRate	integer	No	サンプリング周波数。 48000 44100 32000 22050 サンプリング周波数を設定する。省略された場合は48000。
audioBitDepth	string	No	量子化ビット数。 PCM_8BIT PCM_16BIT PCM_FLOAT 量子化ビット数を設定する。省略された場合はPCM_FLOAT。
audioChannel	string	No	チャンネル数。 Monaural Stereo チャンネル数を設定する。省略され場合は、Monaural。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0
}

DELETE /gotapi/videoChat/call

API Pattern

one-shot

Summary

接続中の VideoChat の切断を行う。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
addressId	string	Yes	接続先のアドレス。
config	string	No	コンフィグ。必要に応じてAPIキーなどを格納する任意の文字列。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0
}

GET /gotapi/videoChat/onCall

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
config	string	No	コンフィグ。必要に応じてAPIキーなどを格納する任意の文字列。

Response

Logical Name				Physical Name	Type	Required	Description
処理結果				result	integer	Yes	0:正常応答 0以外:異常応答
システム名				product	string	Yes	DeviceConnectシステムの名前。
システムバージョン				version	string	Yes	DeviceConnectシステムのバージョン名。
署名				hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
発信元情報				oncall	object	Yes
	デバイス名			name	string	Yes	発信元のデバイス名。
	アドレスID			addressId	string	Yes	発信元のアドレスID。
	相手局リソース情報			remote	object	No	相手局リソース情報
		映像関連情報		video	object	No	映像関連情報
			映像リソースURI	uri	string	No	映像のリソースURI。省略された場合は映像無し。但し、videoとaudioの両方が省略されることは無い
			MIMEタイプ	mimeType	string	No	映像リソースのMIMEタイプ。
			フレームレート	frameRate	float	No	映像リソースのフレームレート。
			幅	width	integer	No	通知時点での幅（可変）
			高さ	height	integer	No	通知時点での高さ（可変）
		音声関連情報		audio	object	No	音声関連情報
			音声リソースURI	uri	string	No	音声のリソースURI。省略された場合は音声無し。但し、videoとaudioの両方が省略されることは無い。
			MIMEタイプ	mimeType	string	No	音声リソースのMIMEタイプ。
			サンプルレート	sampleRate	integer	No	音声リソースのサンプルレート。
			チャンネル数	channels	integer	No	音声リソースのチャンネル数。
			サンプルサイズ	sampleSize	integer	No	音声リソースのサンプルサイズ。
			ブロックサイズ	blockSize	integer	No	音声リソースのブロックサイズ。
	自局リソース情報			local	object	No	自局リソース情報
		映像関連情報		video	object	No	映像関連情報
			映像リソースURI	uri	string	No	映像のリソースURI。省略された場合は映像無し。但し、videoとaudioの両方が省略されることは無い
			MIMEタイプ	mimeType	string	No	映像リソースのMIMEタイプ。
			フレームレート	frameRate	float	No	映像リソースのフレームレート。
			幅	width	integer	No	通知時点での幅（可変）
			高さ	height	integer	No	通知時点での高さ（可変）
		音声関連情報		audio	object	No	音声関連情報
			音声リソースURI	uri	string	No	音声のリソースURI。省略された場合は音声無し。但し、videoとaudioの両方が省略されることは無い。
			MIMEタイプ	mimeType	string	No	音声リソースのMIMEタイプ。
			サンプルレート	sampleRate	integer	No	音声リソースのサンプルレート。
			チャンネル数	channels	integer	No	音声リソースのチャンネル数。
			サンプルサイズ	sampleSize	integer	No	音声リソースのサンプルサイズ。
			ブロックサイズ	blockSize	integer	No	音声リソースのブロックサイズ。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0,
  "oncall" : [ {
    "name" : "xxxx",
    "addressId" : "xxxx"
  } ]
}

PUT /gotapi/videoChat/onCall

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
config	string	No	コンフィグ。必要に応じてAPIキーなどを格納する任意の文字列。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0
}

Event

Logical Name				Physical Name	Type	Required	Description
サービスID				serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名				profile	string	Yes	プロファイル名。
インターフェース名				interface	string	Yes	インターフェース名。
アトリビュート名				attribute	string	Yes	アトリビュート名。
発信元情報				oncall	object	Yes
	デバイス名			name	string	Yes	発信元のデバイス名。
	アドレスID			addressId	string	Yes	発信元のアドレスID。
	相手局リソース情報			remote	object	No	相手局リソース情報
		映像関連情報		video	object	No	映像関連情報
			映像リソースURI	uri	string	No	映像のリソースURI。省略された場合は映像無し。但し、videoとaudioの両方が省略されることは無い
			MIMEタイプ	mimeType	string	No	映像リソースのMIMEタイプ。
			フレームレート	frameRate	float	No	映像リソースのフレームレート。
			幅	width	integer	No	通知時点での幅（可変）
			高さ	height	integer	No	通知時点での高さ（可変）
		音声関連情報		audio	object	No	音声関連情報
			音声リソースURI	uri	string	No	音声のリソースURI。省略された場合は音声無し。但し、videoとaudioの両方が省略されることは無い。
			MIMEタイプ	mimeType	string	No	音声リソースのMIMEタイプ。
			サンプルレート	sampleRate	integer	No	音声リソースのサンプルレート。
			チャンネル数	channels	integer	No	音声リソースのチャンネル数。
			サンプルサイズ	sampleSize	integer	No	音声リソースのサンプルサイズ。
			ブロックサイズ	blockSize	integer	No	音声リソースのブロックサイズ。
	自局リソース情報			local	object	No	自局リソース情報
		映像関連情報		video	object	No	映像関連情報
			映像リソースURI	uri	string	No	映像のリソースURI。省略された場合は映像無し。但し、videoとaudioの両方が省略されることは無い
			MIMEタイプ	mimeType	string	No	映像リソースのMIMEタイプ。
			フレームレート	frameRate	float	No	映像リソースのフレームレート。
			幅	width	integer	No	通知時点での幅（可変）
			高さ	height	integer	No	通知時点での高さ（可変）
		音声関連情報		audio	object	No	音声関連情報
			音声リソースURI	uri	string	No	音声のリソースURI。省略された場合は音声無し。但し、videoとaudioの両方が省略されることは無い。
			MIMEタイプ	mimeType	string	No	音声リソースのMIMEタイプ。
			サンプルレート	sampleRate	integer	No	音声リソースのサンプルレート。
			チャンネル数	channels	integer	No	音声リソースのチャンネル数。
			サンプルサイズ	sampleSize	integer	No	音声リソースのサンプルサイズ。
			ブロックサイズ	blockSize	integer	No	音声リソースのブロックサイズ。

Example Event

{
  "servieId" : "xxxxx",
  "profile" : "videochat",
  "attribute" : "oncall",
  "oncall" : [ {
    "name" : "xxxx",
    "addressId" : "xxxx"
  } ]
}

DELETE /gotapi/videoChat/onCall

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0
}

GET /gotapi/videoChat/onHangup

API Pattern

one-shot

Summary

VideoChatの切断イベントを取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID
config	string	No	コンフィグ。必要に応じてAPIキーなどを格納する任意の文字列。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
接続先情報		hangup	object	Yes	接続先のデバイスの情報を格納したオブジェクト。
	アドレス	addressId	string	Yes	接続先のアドレスID。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0,
  "hangup" : {
    "addressId" : "xxxx"
  }
}

PUT /gotapi/videoChat/onHangup

API Pattern

event

Summary

VideoChatの切断イベントの受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
config	string	No	コンフィグ。必要に応じてAPIキーなどを格納する任意の文字列。
interval	long	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0
}

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
接続先情報		hangup	object	Yes	接続先のデバイスの情報を格納したオブジェクト。
	アドレス	addressId	string	Yes	接続先のアドレスID。

Example Event

{
  "servieId" : "xxxxx",
  "profile" : "videochat",
  "attribute" : "hangup",
  "hangup" : {
    "addressId" : "xxxx"
  }
}

DELETE /gotapi/videoChat/onHangup

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0
}

GET /gotapi/videoChat/onIncoming

プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
config	string	No	コンフィグ。必要に応じてAPIキーなどを格納する任意の文字列。

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
発信元情報		incoming	object	Yes	発信元デバイスの情報を格納したオブジェクト。
	デバイス名	name	string	Yes	発信元のデバイス名。
	アドレスID	addressId	string	Yes	発信元のアドレスID。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0,
  "incoming" : {
    "name" : "xxxx",
    "addressId" : "xxxx"
  }
}

PUT /gotapi/videoChat/onIncoming

API Pattern

event

Summary

他デバイスからの着信イベントの受信を開始する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
config	string	No	イベント受信間隔。単位：mSec

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0
}

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
発信元情報		incoming	object	Yes	発信元デバイスの情報を格納したオブジェクト。
	デバイス名	name	string	Yes	発信元のデバイス名。
	アドレスID	addressId	string	Yes	発信元のアドレスID。

Example Event

{
  "servieId" : "xxxxx",
  "profile" : "videochat",
  "attribute" : "incoming",
  "incoming" : {
    "name" : "xxxx",
    "addressId" : "xxxx"
  }
}

DELETE /gotapi/videoChat/onIncoming

Name	Type	Required	Description
serviceId	string	Yes	サービスID。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0
}

GET /gotapi/videoChat/profile

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
config	string	No	コンフィグ。必要に応じてAPIキーなどを格納する任意の文字列。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
名前	name	string	Yes	デバイス自身の名前。
アドレスID	addressId	string	Yes	デバイス自身のアドレスID。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0,
  "name" : "WebRTC Service",
  "addressId" : "xxxxx"
}

PUT /gotapi/videoChat/profile

Name	Type	Required	Description
serviceId	string	Yes	サービスID。
name	string	Yes	デバイスに付ける新規の名前
config	string	No	コンフィグ。必要に応じてAPIキーなどを格納する任意の文字列

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0
}

WalkState Profile

Ver. 2.0.0

Description

歩行状態を通知する機能を提供するプロファイル。

Operations

GET /gotapi/walkState/onWalkState
PUT /gotapi/walkState/onWalkState
DELETE /gotapi/walkState/onWalkState

GET /gotapi/walkState/onWalkState

API Pattern

one-shot

Summary

該当デバイスの歩行状態計測イベントを取得する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name		Physical Name	Type	Required	Description
処理結果		result	integer	Yes	0:正常応答 0以外:異常応答
システム名		product	string	Yes	DeviceConnectシステムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
歩行情報		walk	object	Yes
	歩数	step	double	Yes	歩数。単位は歩。
	歩行状態	state	string	Yes	Stop:停止 Walking:歩行 Running:走行
	速度	speed	double	Yes	速度。単位はkm/h。
	距離	distance	double	No	距離。単位はkm。
	左右バランス	balance	double	Yes	左右のバランス。1に近いほど左右のバランスが良い。 -1.0〜1.0
	タイムスタンプ (Unix時刻)	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	タイムスタンプ (日付)	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Response

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "walk" : {
    "step" : 123456,
    "state" : "Walking",
    "speed" : 5.799,
    "distance" : 12.3456,
    "balance" : 0.16,
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

PUT /gotapi/walkState/onWalkState

API Pattern

event

Summary

該当デバイスの歩行状態計測イベントを通知する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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

Event

Logical Name		Physical Name	Type	Required	Description
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
歩行情報		walk	object	Yes
	歩数	step	double	Yes	歩数。単位は歩。
	歩行状態	state	string	Yes	Stop:停止 Walking:歩行 Running:走行
	速度	speed	double	Yes	速度。単位はkm/h。
	距離	distance	double	No	距離。単位はkm。
	左右バランス	balance	double	Yes	左右のバランス。1に近いほど左右のバランスが良い。 -1.0〜1.0
	タイムスタンプ (Unix時刻)	timeStamp	long	Yes	測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
	タイムスタンプ (日付)	timeStampString	dateTime	Yes	タイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。

Example Event

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "walkstate",
  "attribute" : "onwalkstate",
  "walk" : {
    "step" : 123456,
    "state" : "Walking",
    "speed" : 5.799,
    "distance" : 12.3456,
    "balance" : 0.16,
    "timeStamp" : 1483241696789,
    "timeStampString" : "2015-05-17T10:02:20+09:00"
  }
}

DELETE /gotapi/walkState/onWalkState

API Pattern

event

Summary

該当デバイスの歩行状態計測イベントを停止する。

Parameters

Name	Type	Required	Description
serviceId	string	Yes	サービスID。取得対象スマートデバイス

Response

Logical Name	Physical Name	Type	Required	Description
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

Example Response

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