Proximity - masaru-takano/DeviceConnect-Spec GitHub Wiki

スマートデバイスの近接センサーの物/人の検知を通知するAPI。

API	概要
GET /gotapi/proximity/onDeviceProximity	スマートデバイスの近接センサーの物の検知を通知するイベントを取得する。
PUT /gotapi/proximity/onDeviceProximity	スマートデバイスの近接センサーの物の検知を通知するイベントを開始する。
DELETE /gotapi/proximity/onDeviceProximity	スマートデバイスの近接センサーの物の検知を通知するイベントを停止する。
GET /gotapi/proximity/onUserProximity	スマートデバイスの近接センサーのユーザ検知を通知するイベントを取得する。
PUT /gotapi/proximity/onUserProximity	スマートデバイスの近接センサーのユーザ検知を通知するイベントを開始する。
DELETE /gotapi/proximity/onUserProximity	スマートデバイスの近接センサーのユーザ検知を通知するイベントを停止する。

one-shot

スマートデバイスの近接センサーの物の検知を通知するイベントを取得する。

スマートデバイスの近接センサーの情報を近接距離最小/最大値の範囲で連続的にイベント発行する。

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

物理名		データ型	必須	説明
result		integer	Yes	処理結果 0: 正常応答 0以外: 異常応答
product		string	Yes	DeviceConnectシステムの名前
version		string	Yes	DeviceConnectシステムのバージョン名
proximity		object	Yes
	value	integer	No	近接距離 cm単位の距離。
	min	integer	No	近接距離最小値 cm単位の距離。
	max	integer	No	近接距離最大値 cm単位の距離。
	threshold	integer	No	閾値 cm単位の距離の閾値。
	range	string	No	距離識別子 距離を示す文字列。
hmac		string	No	レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "proximity" : {
    "value" : 12.3456,
    "min" : 1.23456,
    "max" : 123.456,
    "threshold" : 12.3456,
    "range" : "NEAR"
  }
}

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

物理名		データ型	必須	説明
attribute		string	Yes	アトリビュート名
serviceId		string	Yes	サービスID
interface		string	Yes	インターフェース名
proximity		object	Yes
	value	integer	No	近接距離 cm単位の距離。
	min	integer	No	近接距離最小値 cm単位の距離。
	max	integer	No	近接距離最大値 cm単位の距離。
	threshold	integer	No	閾値 cm単位の距離の閾値。
	range	string	No	距離識別子 距離を示す文字列。
profile		string	Yes	プロファイル名

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

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

物理名		データ型	必須	説明
attribute		string	Yes	アトリビュート名
serviceId		string	Yes	サービスID
interface		string	Yes	インターフェース名
proximity		object	Yes
	value	integer	No	近接距離 cm単位の距離。
	min	integer	No	近接距離最小値 cm単位の距離。
	max	integer	No	近接距離最大値 cm単位の距離。
	threshold	integer	No	閾値 cm単位の距離の閾値。
	range	string	No	距離識別子 距離を示す文字列。
profile		string	Yes	プロファイル名

one-shot

スマートデバイスの近接センサーのユーザ検知を通知するイベントを取得する。

ユーザ検知とは、例えば通話時にスマートフォンの画面を耳元に近接させた場合等に発生する。

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

物理名		データ型	必須	説明
result		integer	Yes	処理結果 0: 正常応答 0以外: 異常応答
product		string	Yes	DeviceConnectシステムの名前
version		string	Yes	DeviceConnectシステムのバージョン名
proximity		object	Yes
	near	boolean	Yes	近接の有無 ユーザがデバイスに近接しているかどうか。 true: 近接している false: 近接していない
hmac		string	No	レスポンスに対する署名 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

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

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

物理名		データ型	必須	説明
attribute		string	Yes	アトリビュート名
serviceId		string	Yes	サービスID
interface		string	Yes	インターフェース名
proximity		object	Yes
	near	boolean	Yes	近接の有無 ユーザがデバイスに近接しているかどうか。 true: 近接している false: 近接していない
profile		string	Yes	プロファイル名

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "proximity",
  "attribute" : "onuserproximity",
  "proximity" : {
    "near" : true
  }
}

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

物理名		データ型	必須	説明
attribute		string	Yes	アトリビュート名
serviceId		string	Yes	サービスID
interface		string	Yes	インターフェース名
proximity		object	Yes
	near	boolean	Yes	近接の有無 ユーザがデバイスに近接しているかどうか。 true: 近接している false: 近接していない
profile		string	Yes	プロファイル名