KeyEvent - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

デバイスのキーイベントが操作されたことを通知する機能。

API	概要
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	デバイスのキーが離されたことを通知するイベントを停止する。

one-shot

デバイスのキーが押されたときの情報を取得する。

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

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

論理名		物理名	データ型	必須	説明
処理結果		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のIDがある場合は、そちらを利用すること。
	離されたKeyのConfig	config	string	No	特にConfigがない場合は空文字を返すこと。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "keyevent" : {
    "config" : "5",
    "id" : 149
  }
}

event

デバイスのキーが押されたことを通知するイベントを開始する。

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

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

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

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

論理名		物理名	データ型	必須	説明
サービス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のIDがある場合は、そちらを利用すること。
	離されたKeyのConfig	config	string	No	特にConfigがない場合は空文字を返すこと。

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "keyevent",
  "attribute" : "ondown",
  "keyevent" : {
    "config" : "5",
    "id" : 149
  }
}

event

デバイスのキーが押されたことを通知するイベントを停止する。

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

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

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

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

one-shot

デバイスのキーが押された時あるいは離された時の情報を取得する。

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

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

論理名		物理名	データ型	必須	説明
処理結果		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のIDがある場合は、そちらを利用すること。
	押された、もしくは離された時のKeyのConfig	config	string	No	特にConfigがない場合は空文字を返すこと。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "keyevent" : {
    "state" : "up",
    "config" : "5",
    "id" : 149
  }
}

event

デバイスのキーが押された、または離されたことを通知するイベントを開始する。

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

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

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

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

論理名		物理名	データ型	必須	説明
サービス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のIDがある場合は、そちらを利用すること。
	押された、もしくは離された時のKeyのConfig	config	string	No	特にConfigがない場合は空文字を返すこと。

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "keyevent",
  "attribute" : "onkeychange",
  "keyevent" : {
    "state" : "up",
    "config" : "5",
    "id" : 149
  }
}

event

デバイスのキーが押された、または離されたことを通知するイベントを停止する。

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

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

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

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

one-shot

デバイスのキーが離されたときの情報を取得する。

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

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

論理名		物理名	データ型	必須	説明
処理結果		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のIDがある場合は、そちらを利用すること。
	押されたKeyのConfig	config	string	No	特にConfigがない場合は空文字を返すこと。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "keyevent" : {
    "config" : "play",
    "id" : 672
  }
}

event

デバイスのキーが離されたことを通知するイベントを開始する。

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

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。取得対象スマートデバイス
interval	long	No	デバイスプラグインがイベントを送信する間隔。

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

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

論理名		物理名	データ型	必須	説明
サービス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のIDがある場合は、そちらを利用すること。
	押されたKeyのConfig	config	string	No	特にConfigがない場合は空文字を返すこと。

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "keyevent",
  "attribute" : "onup",
  "keyevent" : {
    "config" : "play",
    "id" : 672
  }
}

event

デバイスのキーが離されたことを通知するイベントを停止する。

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

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

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

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