HumanDetection - TakayukiHoshi1984/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座標	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

レスポンスサンプル

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

イベント

論理名		物理名	データ型	必須	説明
サービス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

イベントサンプル

{
  "serviceId" : "Host.exampleId.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システムの名前。
システムバージョン		version	string	Yes	DeviceConnectシステムのバージョン名。
署名		hmac	string	No	レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
人検出情報		humanDetect	object	Yes
	人検出フラグ	exist	boolean	Yes	検出された : true 検出されない : false'

レスポンスサンプル

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

イベント

論理名		物理名	データ型	必須	説明
サービスID		serviceId	string	Yes	イベントを送信したサービスのID
プロファイル名		profile	string	Yes	プロファイル名。
インターフェース名		interface	string	Yes	インターフェース名。
アトリビュート名		attribute	string	Yes	アトリビュート名。
人検出情報		humanDetect	object	Yes
	人検出フラグ	exist	boolean	Yes	検出された : true 検出されない : false'

イベントサンプル

{
  "serviceId" : "Host.exampleId.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	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションはデバイスプラグインによって違う。例) eye,nose, mouth,blink,age,gender,faceDirection,gaze,expression をカンマ区切りで指定することで、それぞれの検出値がある場合はレスポンスに含めることができる。ただし、デバイスによって対応していない値がある。

レスポンス

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

レスポンスサンプル

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

種別

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	利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。 ※使用できるオプションはデバイスプラグインによって違う。例) eye,nose, mouth,blink,age,gender,faceDirection,gaze,expression をカンマ区切りで指定することで、それぞれの検出値がある場合はレスポンスに含めることができる。ただし、デバイスによって対応していない値がある。

レスポンス

論理名	物理名	データ型	必須	説明
処理結果	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	アトリビュート名。
顔検出リスト			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

イベントサンプル

{
  "serviceId" : "Host.exampleId.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

種別

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システムのバージョン名。
署名		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

レスポンスサンプル

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

イベント

論理名		物理名	データ型	必須	説明
サービス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

イベントサンプル

{
  "serviceId" : "Host.exampleId.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 - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

概要

目次

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

イベント

イベントサンプル

種別

概要

リクエスト

レスポンス

レスポンスサンプル

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

⚠️ GitHub.com Fallback ⚠️