HumanDetection - masaru-takano/DeviceConnect-Spec GitHub Wiki

概要

スマートデバイスの人体検出機能を提供するAPI。

API	概要
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

種別

one-shot

概要

体を検出したときの通知イベントを取得する。

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

リクエスト

物理名	データ型	必須	説明
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	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションは無し。

レスポンス

物理名		データ型	必須	説明
result		integer	Yes	0:正常応答 0以外:異常応答
product		string	Yes	DeviceConnectシステムの名前。
version		string	Yes	DeviceConnectシステムのバージョン名。
hmac		string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
bodyDetects		array(object)	Yes	人体検出リスト検出された数分出現する。
	x	float	Yes	検出領域の中心X座標 0.0~1.0
	y	float	Yes	検出領域の中心Y座標 0.0~1.0
	width	float	No	検出領域のX方向の幅 ※領域幅が提供できない場合は出現しない。 0.0~1.0
	height	float	No	検出領域のY方向の幅 ※領域幅が提供できない場合は出現しない。 0.0~1.0
	confidence	float	Yes	解析の信頼度 0.0~1.0

レスポンスサンプル

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

種別

event

概要

体を検出したときの通知イベントを開始する。

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

リクエスト

物理名	データ型	必須	説明
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	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションは無し。

レスポンス

物理名	データ型	必須	説明
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	0:正常応答 0以外:異常応答
interface		string	Yes	インターフェース名。
profile		string	Yes	プロファイル名。
bodyDetects		array(object)	Yes	人体検出リスト検出された数分出現する。
	x	float	Yes	検出領域の中心X座標 0.0~1.0
	y	float	Yes	検出領域の中心Y座標 0.0~1.0
	width	float	No	検出領域のX方向の幅 ※領域幅が提供できない場合は出現しない。 0.0~1.0
	height	float	No	検出領域のY方向の幅 ※領域幅が提供できない場合は出現しない。 0.0~1.0
	confidence	float	Yes	解析の信頼度 0.0~1.0

イベントサンプル

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

種別

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

GET /gotapi/humanDetection/onDetection

種別

one-shot

概要

人を検出したときの通知イベントを取得する。

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

リクエスト

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

レスポンス

物理名		データ型	必須	説明
result		integer	Yes	0:正常応答 0以外:異常応答
product		string	Yes	DeviceConnectシステムの名前。
humanDetect		object	Yes
	exist	boolean	Yes	人が検出されたかどうかのフラグ。検出された : true 検出されない : false
version		string	Yes	DeviceConnectシステムのバージョン名。
hmac		string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

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

PUT /gotapi/humanDetection/onDetection

種別

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	アトリビュート名。
humanDetect		object	Yes
	exist	boolean	Yes	人が検出されたかどうかのフラグ。検出された : true 検出されない : false
serviceId		string	Yes	0:正常応答 0以外:異常応答
interface		string	Yes	インターフェース名。
profile		string	Yes	プロファイル名。

イベントサンプル

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "humandetection",
  "attribute" : "ondetection",
  "humanDetect" : {
    "exist" : true
  }
}

DELETE /gotapi/humanDetection/onDetection

種別

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

GET /gotapi/humanDetection/onFaceDetection

種別

one-shot

概要

顔を検出したときの通知イベントを取得する。

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

リクエスト

物理名	データ型	必須	説明
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	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションは無し。

レスポンス

物理名			データ型	必須	説明
result			integer	Yes	0:正常応答 0以外:異常応答
faceDetects			array(object)	Yes	顔検出リスト検出された数分出現する。
	eyePoints		object	No
		leftEyeX	float	No	左目の中心座標(x) 0.0~1.0
		leftEyeY	float	No	左目の中心座標(y) 0.0~1.0
		leftEyeWidth	float	No	左目の領域幅(w) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		leftEyeHeight	float	No	左目の領域幅(h) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		rightEyeX	float	No	右目の中心座標(x) 0.0~1.0
		rightEyeY	float	No	右目の中心座標(y) 0.0~1.0
		rightEyeWidth	float	No	右目の領域幅(w) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		rightEyeHeight	float	No	右目の領域幅(h) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		confidence	float	No	解析の信頼度 0.0~1.0
	nosePoints		object	No
		noseX	float	No	鼻の中心座標(x) 0.0~1.0
		noseY	float	No	鼻の中心座標(y) 0.0~1.0
		noseWidth	float	No	鼻の領域幅(w) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		noseHeight	float	No	鼻の領域幅(h) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		confidence	float	No	解析の信頼度 0.0~1.0
	mouthPoints		object	No
		mouthX	float	No	口の中心座標(x) 0.0~1.0
		mouthY	float	No	口の中心座標(y) 0.0~1.0
		mouthWidth	float	No	口の領域幅(w) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		mouthHeight	float	No	口の領域幅(h) ※領域幅が提供できない場合は出現しない。 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
product			string	Yes	DeviceConnectシステムの名前。
version			string	Yes	DeviceConnectシステムのバージョン名。
hmac			string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "faceDetects" : [ {
    "ageResults" : {
      "age" : "35",
      "confidence" : "0.82"
    },
    "genderResults" : {
      "gender" : "male",
      "confidence" : "0.75"
    },
    "expressionResults" : {
      "expression" : "surprise",
      "confidence" : "0.69"
    }
  } ]
}

PUT /gotapi/humanDetection/onFaceDetection

種別

event

概要

顔を検出したときの通知イベントを開始する。

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

リクエスト

物理名	データ型	必須	説明
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	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションは無し。

レスポンス

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

イベント

物理名			データ型	必須	説明
faceDetects			array(object)	Yes	顔検出リスト検出された数分出現する。
	eyePoints		object	No
		leftEyeX	float	No	左目の中心座標(x) 0.0~1.0
		leftEyeY	float	No	左目の中心座標(y) 0.0~1.0
		leftEyeWidth	float	No	左目の領域幅(w) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		leftEyeHeight	float	No	左目の領域幅(h) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		rightEyeX	float	No	右目の中心座標(x) 0.0~1.0
		rightEyeY	float	No	右目の中心座標(y) 0.0~1.0
		rightEyeWidth	float	No	右目の領域幅(w) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		rightEyeHeight	float	No	右目の領域幅(h) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		confidence	float	No	解析の信頼度 0.0~1.0
	nosePoints		object	No
		noseX	float	No	鼻の中心座標(x) 0.0~1.0
		noseY	float	No	鼻の中心座標(y) 0.0~1.0
		noseWidth	float	No	鼻の領域幅(w) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		noseHeight	float	No	鼻の領域幅(h) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		confidence	float	No	解析の信頼度 0.0~1.0
	mouthPoints		object	No
		mouthX	float	No	口の中心座標(x) 0.0~1.0
		mouthY	float	No	口の中心座標(y) 0.0~1.0
		mouthWidth	float	No	口の領域幅(w) ※領域幅が提供できない場合は出現しない。 0.0~1.0
		mouthHeight	float	No	口の領域幅(h) ※領域幅が提供できない場合は出現しない。 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
attribute			string	Yes	アトリビュート名。
serviceId			string	Yes	0:正常応答 0以外:異常応答
interface			string	Yes	インターフェース名。
profile			string	Yes	プロファイル名。

イベントサンプル

{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "humandetection",
  "attribute" : "onfacedetection",
  "faceDetects" : [ {
    "ageResults" : {
      "age" : "35",
      "confidence" : "0.82"
    },
    "genderResults" : {
      "gender" : "male",
      "confidence" : "0.75"
    },
    "expressionResults" : {
      "expression" : "surprise",
      "confidence" : "0.69"
    }
  } ]
}

DELETE /gotapi/humanDetection/onFaceDetection

種別

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

GET /gotapi/humanDetection/onHandDetection

種別

one-shot

概要

手を検出したときの通知イベントを取得する。

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

リクエスト

物理名	データ型	必須	説明
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	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションは無し。

レスポンス

物理名		データ型	必須	説明
result		integer	Yes	0:正常応答 0以外:異常応答
product		string	Yes	DeviceConnectシステムの名前。
version		string	Yes	DeviceConnectシステムのバージョン名。
handDetects		array(object)	Yes	手検出リスト検出された数分出現する。
	x	float	Yes	検出領域の中心X座標 0.0~1.0
	y	float	Yes	検出領域の中心Y座標 0.0~1.0
	width	float	No	検出領域のX方向の幅 ※領域幅が提供できない場合は出現しない。 0.0~1.0
	height	float	No	検出領域のY方向の幅 ※領域幅が提供できない場合は出現しない。 0.0~1.0
	confidence	float	Yes	解析の信頼度 0.0~1.0
hmac		string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

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

種別

event

概要

手を検出したときの通知イベントを開始する。

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

リクエスト

物理名	データ型	必須	説明
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	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションは無し。

レスポンス

物理名	データ型	必須	説明
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	0:正常応答 0以外:異常応答
interface		string	Yes	インターフェース名。
handDetects		array(object)	Yes	手検出リスト検出された数分出現する。
	x	float	Yes	検出領域の中心X座標 0.0~1.0
	y	float	Yes	検出領域の中心Y座標 0.0~1.0
	width	float	No	検出領域のX方向の幅 ※領域幅が提供できない場合は出現しない。 0.0~1.0
	height	float	No	検出領域のY方向の幅 ※領域幅が提供できない場合は出現しない。 0.0~1.0
	confidence	float	Yes	解析の信頼度 0.0~1.0
profile		string	Yes	プロファイル名。

イベントサンプル

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

種別

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

HumanDetection - masaru-takano/DeviceConnect-Spec GitHub Wiki

概要

目次

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️