Air Conditioner Profile

Ver. 2.0.0

Description

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

Operations

DELETE /gotapi/airConditioner
API Pattern
one-shot
Summary
スマートデバイスの電源を消す。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/airConditioner
API Pattern
one-shot
Summary
スマートデバイスの電源を点ける。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/airConditioner
API Pattern
one-shot
Summary
スマートデバイスの電源状態を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
powerstatusstringYes電源状態
ON:電源オン
OFF:電源オフ
UNKNOWN:不明
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "powerstatus" : "OFF"
}
PUT /gotapi/airConditioner/airFlow
API Pattern
one-shot
Summary
スマートデバイスの風量設定値を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
airflowfloatNo風量設定値。
0.0〜1.0
airflowautobooleanNo風量自動モード設定。true : 自動モード有効
false : 自動モード無効
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/airConditioner/airFlow
API Pattern
one-shot
Summary
スマートデバイスの風量設定値を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
airflowautobooleanNo風量自動モード設定
true:自動モード有効
false:自動モード無効
※(注1) 風量自動モード設定をtrue設定した時のみ省略可。
※(注2) 省略時及びfalse設定時は、「風量設定値」が反映される。
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
airflowfloatYes風量設定値
0.0〜1.0
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "airflowauto" : "true",
  "airflow" : "0.0"
}
PUT /gotapi/airConditioner/enlProperty
API Pattern
one-shot
Summary
スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティに設定を行う(必須プロパティのみ)。
Description
※enlproperty:ECHONET Lite Propertyのこと。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
epcstringYesEPC。
ECHONET Property Code
valuestringYesEPCの設定値。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "epc" : "OperationStatus",
  "value" : "49"
}
GET /gotapi/airConditioner/enlProperty
API Pattern
one-shot
Summary
スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティの設定内容を取得する(必須プロパティのみ)。
Description
※enlproperty:ECHONET Lite Propertyのこと。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
epcarray(string)Yes取得プロパティのEPC。取得するプロパティのEPCをカンマ区切りで列挙。10進または16進(0xXX)の値
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
propertiesarray(object)YesEPCのリスト
指定されたEPCの配列。
epcstringYesECHONET Property Code
ECHONET Property Code
valuestringYesECHONET Property Codeの設定値。
ECHONET Property Codeの設定値。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "properties" : [ {
    "epc" : "OperationStatus",
    "value" : "49"
  }, {
    "epc" : "InstallationLocation",
    "value" : "0"
  } ]
}
PUT /gotapi/airConditioner/modeSetting
API Pattern
one-shot
Summary
スマートデバイスの運転モード設定を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modesettingstringYes運転モード設定。
Automatic:自動
Cooling:冷房
Heating:暖房
Dehumidification:除湿
AirCirculator:送風
Other:その他
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/airConditioner/modeSetting
API Pattern
one-shot
Summary
スマートデバイスの運転モード設定を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
modesettingstringYes運転モード設定
Automatic:自動
Cooling:冷房
Heating:暖房
Dehumidification:除湿
AirCirculator:送風
Other:その他
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "modesetting" : "Automatic"
}
PUT /gotapi/airConditioner/powerSaving
API Pattern
one-shot
Summary
スマートデバイスの節電動作設定を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
powersavingstringYes節電動作設定。
PowerSaving:節電動作中
Normal:通常動作中
Unknown:不明
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/airConditioner/powerSaving
API Pattern
one-shot
Summary
スマートデバイスの節電動作設定を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
powersavingstringYes節電動作設定
PowerSaving:節電動作中
Normal:通常動作中
Unknown:不明
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "powersaving" : "Normal"
}
GET /gotapi/airConditioner/roomTemperature
API Pattern
one-shot
Summary
スマートデバイスの室温計測値を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
roomtemperatureintegerYes室内温度計測値
-127〜125 (℃)
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "roomtemperature" : "25"
}
PUT /gotapi/airConditioner/temperature
API Pattern
one-shot
Summary
スマートデバイスの温度設定値を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
temperatureintegerYes温度設定値。
0〜50 (℃)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/airConditioner/temperature
API Pattern
one-shot
Summary
スマートデバイスの温度設定値を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
temperatureintegerYes温度設定値
0〜50 (℃)
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "temperature" : "20"
}

Atmospheric Pressure Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/atmosphericPressure
API Pattern
one-shot
Summary
スマートデバイスの気圧情報を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
timeStamplongYes気圧のタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
productstringYesDeviceConnectシステムの名前
timeStampStringstringYes気圧のタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
versionstringYesDeviceConnectシステムのバージョン名
atmosphericPressurefloatYes気圧
気圧
単位: ヘクトパスカル(hPa)
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "atmosphericPressure" : 1016.12,
  "timeStamp" : 1431856940275,
  "timeStampString" : "20150517100220.000-0000"
}

Authorization Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/authorization/accessToken
API Pattern
one-shot
Summary
DeviceConnectManagerにLocal OAuthを行うためのアクセストークンの作成要求を行う。
Description
各プロファイルにアクセスするためには、このAPIで作成したアクセストークンが必要になる。
また、アクセストークンには有効期限が存在するので、有効期限が切れた場合には再度アクセストークンを作成し直す必要がある。
Parameters
NameTypeRequiredDescription
clientIdstringYesクライアントID。Authorization Create Client APIで取得したclientIdを使用する。
applicationNamestringYesアプリケーション名。承認確認画面に表示するアプリケーション名を指定する。
例:「Twitterイベントプラグイン」と指定した場合は、「TwitterイベントプラグインがdConnectにアクセスする許可をしますか?」と確認メッセージが表示される。
scopearray(string)Yesスコープ。使用するプロファイルの一覧をカンマ区切りで定義する。
例)file,notification,vibration
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
expirefloatYes失効日時
スコープ毎のアクセストークンの失効時刻のうち、直近の時刻(UNIX時間)。
scopesarray(object)Yesスコープ配列
スコープの有効期限一覧を格納する配列。
scopestringYesスコープ
スコープのプロファイル名。
expirePeriodfloatYesスコープの有効期限
アクセストークンの有効期限。スコープ毎に設定されている。
アクセストークンが作成されてから使用できる間の時間(秒)を返す。
この時間を過ぎるとアクセストークンが使用できなくなる。
accessTokenstringYesアクセストークン
各プロファイルにアクセスする場合に必要になる。
versionstringYesDeviceConnectシステムのバージョン名
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
NameTypeRequiredDescription
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
clientIdstringYesクライアントID
クライアントを識別するためのID。
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
API Pattern
one-shot
Summary
Device Connect Managerが起動しているかどうかを確認する。
Parameters
NameTypeRequiredDescription
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
namestringNoManagerの名前
Managerの設定画面の「Managerの名前を表示」をONにすることで追加される。
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
API Pattern
one-shot
Summary
スマートデバイスのバッテリー情報を取得する。
Description
スマートデバイスのバッテリー情報として取得できない値がある場合は適切な値を代入してレスポンスを返却する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
levelfloatNoバッテリー残量。
範囲: 0.0 <= level <= 1.0
chargingTimelongNo完全充電までの時間(秒)。
満充電、または非充電中の場合は0。
システムとして取得出来ない場合はNumber.MAX_VALUE。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
chargingbooleanYes充電状態フラグ。
充電中:true
非充電中:false
versionstringYesDeviceConnectシステムのバージョン名。
dischargingTimelongNo完全放電までの時間(秒)。
充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE
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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
chargingbooleanYes充電状態フラグ
充電中:true
非充電中:false
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "charging" : true
}
GET /gotapi/battery/chargingTime
API Pattern
one-shot
Summary
スマートデバイスの充電完了時間を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
chargingTimelongYes完全充電までの時間(秒)。
満充電、または非充電中の場合は0。システムとして取得出来ない場合はNumber.MAX_VALUE。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "chargingTime" : 10
}
GET /gotapi/battery/dischargingTime
API Pattern
one-shot
Summary
スマートデバイスの放電完了時間を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
dischargingTimelongYes完全放電までの時間(秒)。
充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "dischargingTime" : 0
}
GET /gotapi/battery/level
API Pattern
one-shot
Summary
スマートデバイスのバッテリー残量を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
levelfloatYesバッテリー残量。
範囲: 0.0 <= level <= 1.0
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "level" : 0.8
}
DELETE /gotapi/battery/onBatteryChange
API Pattern
event
Summary
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/battery/onBatteryChange
API Pattern
event
Summary
スマートデバイスのバッテリーの状態が変化したことを通知する。
Description
充電時間、放電時間、バッテリー残量の値が変わった時にイベントが発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoイベント受信間隔。単位:mSec
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
batteryobjectYes
chargingTimelongYes完全充電までの時間(秒)。
満充電、または非充電中の場合は0。
システムとして取得出来ない場合はNumber.MAX_VALUE。
dischargingTimelongYes完全放電までの時間(秒)。
充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE。
levelfloatYesバッテリー残量。
範囲: 0.0 <= level <= 1.0
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "example-service-id",
  "profile" : "battery",
  "attribute" : "onBatteryChange",
  "battery" : {
    "chargingTime" : 10,
    "dischargingTime" : 0,
    "level" : 0.8
  }
}
GET /gotapi/battery/onBatteryChange
API Pattern
one-shot
Summary
スマートデバイスのバッテリー状態変化通知イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
batteryobjectYes
chargingTimelongYes完全充電までの時間(秒)。
満充電、または非充電中の場合は0。
システムとして取得出来ない場合はNumber.MAX_VALUE。
dischargingTimelongYes完全放電までの時間(秒)。
充電中、またはシステムとして取得出来ない場合はNumber.MAX_VALUE。
levelfloatYesバッテリー残量。
範囲: 0.0 <= level <= 1.0
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "battery" : {
    "chargingTime" : 10,
    "dischargingTime" : 0,
    "level" : 0.8
  }
}
DELETE /gotapi/battery/onChargingChange
API Pattern
event
Summary
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/battery/onChargingChange
API Pattern
event
Summary
スマートフォンもしくは周辺機器へ他方のスマートデバイスのバッテリーの充電状態が変化したことを通知する。
Description
充電中フラグの値がtrueからfalse、もしくは、falseからtrueへ変わった時にイベントが発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoイベント受信間隔。単位:mSec
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
batteryobjectYes
chargingbooleanYes充電状態フラグ
充電中:true
非充電中:false
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "example-service-id",
  "profile" : "battery",
  "attribute" : "onChargingChange",
  "battery" : {
    "charging" : true
  }
}
GET /gotapi/battery/onChargingChange
API Pattern
one-shot
Summary
スマートデバイスのバッテリー充電状態変化通知イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
batteryobjectYes
chargingbooleanYes充電状態フラグ
充電中:true
非充電中:false
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "battery" : {
    "charging" : true
  }
}

Camera Profile

Ver. 2.0.0

Description

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

Operations

PUT /gotapi/camera/zoom
API Pattern
one-shot
Summary
Cameraデバイスに対してレンズのズームイン・アウトリクエストを送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
directionstringYes方向。ズームの方向
in
out
movementstringYes動作。ズームの動作
in-startで開始して in-stopで終了。
1shotは開始してから所定位置まで動作する。
maxはin-startと同じ動作を行う。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/camera/zoom
API Pattern
one-shot
Summary
Cameraデバイスの現在の倍率を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
zoomPositionfloatYesカメラの倍率
カメラの倍率(%)
例)
QX-10の場合
0(%):拡大なし
50(%):倍率5倍での拡大
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "zoomPosition" : 0
}

Canvas Profile

Ver. 2.0.0

Description

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

Operations

DELETE /gotapi/canvas/drawImage
API Pattern
one-shot
Summary
デバイスに描画した画像を削除する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/canvas/drawImage
API Pattern
one-shot
Summary
デバイスに画像を描画する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
mimeTypestringNoMIMEタイプ。表示する画像のMimeType。
datafileNoファイルのbinary。表示する画像ファイルのbinary。uriと同時に省略することはできない。両方指定した場合の挙動は未定義。
uristringNoファイルのURI。表示する画像ファイルのURI。dataと同時に省略することはできない。両方指定した場合の挙動は未定義。
xintegerNoデバイスが持つ空間の左上を原点としたx座標。0~デバイスの空間領域。等倍描画モードの場合のみ有効。
yintegerNoデバイスが持つ空間の左上を原点としたy座標。0~デバイスの空間領域。等倍描画モードの場合のみ有効。
modestringNo画像描画モード。(省略時):等倍描画モード。座標(x, y)に画像の左上隅がくるように描画する。
scales:スケールモード。アスペクト比を保持して最大限に拡大して画面中央に描画する。x, y座標は無効。
fills:フィルモード。等倍の画像を並べて画面全体に敷き詰めるように描画する。x, y座標は無効。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

Connection Profile

Ver. 2.0.0

Description

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

Operations

DELETE /gotapi/connection/ble
API Pattern
one-shot
Summary
スマートデバイスのBLE機能有効状態を無効に設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/connection/ble
API Pattern
one-shot
Summary
スマートデバイスのBLE機能有効状態を有効に設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/connection/ble
API Pattern
one-shot
Summary
スマートデバイスのBLE機能有効状態(ON/OFF)を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
enablebooleanYesBLE有効状態
BLE機能有効状態。
ON : true
OFF : false
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "enable" : true
}
DELETE /gotapi/connection/bluetooth
API Pattern
one-shot
Summary
スマートデバイスのBluetooth機能有効状態を無効に設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/connection/bluetooth
API Pattern
one-shot
Summary
スマートデバイスのBluetooth機能有効状態を有効に設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
enablebooleanYesBluetooth機能有効状態
Bluetooth機能有効状態。
ON : true
OFF : false
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "enable" : true
}
DELETE /gotapi/connection/bluetooth/discoverable
API Pattern
one-shot
Summary
スマートデバイスのBluetooth検索可能状態を無効に設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/connection/bluetooth/discoverable
API Pattern
one-shot
Summary
スマートデバイスのBluetooth検索可能状態を有効に設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/connection/nfc
API Pattern
one-shot
Summary
スマートデバイスのNFC機能有効状態を無効に設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/connection/nfc
API Pattern
one-shot
Summary
スマートデバイスのNFC機能有効状態を有効に設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
enablebooleanYesNFC機能有効状態
NFC機能有効状態。
ON : true
OFF : false
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "enable" : true
}
DELETE /gotapi/connection/onBleChange
API Pattern
event
Summary
スマートデバイスのBLE機能有効状態(ON/OFF)の変化を通知するイベントを停止する。
Description
BLE機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/connection/onBleChange
API Pattern
event
Summary
スマートデバイスのBLE機能有効状態(ON/OFF)の変化を通知するイベントを開始する。
Description
BLE機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
connectStatusobjectYes
enablebooleanYesBLE機能有効状態
BLE機能有効状態
ON: true
OFF: false
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onblechange",
  "connectStatus" : {
    "enable" : true
  }
}
GET /gotapi/connection/onBleChange
API Pattern
one-shot
Summary
スマートデバイスのBLE機能有効状態(ON/OFF)の変化を通知するイベントを取得する。
Description
BLE機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
connectStatusobjectYes
enablebooleanYesBLE機能有効状態
BLE機能有効状態
ON: true
OFF: false
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connectStatus" : {
    "enable" : true
  }
}
DELETE /gotapi/connection/onBluetoothChange
API Pattern
event
Summary
スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを停止する。
Description
Bluetooth機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/connection/onBluetoothChange
API Pattern
event
Summary
スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを開始する。
Description
Bluetooth機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
connectStatusobjectYes
enablebooleanYesBluetooth機能有効状態
Bluetooth機能有効状態
ON: true
OFF: false
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onbluetoothchange",
  "connectStatus" : {
    "enable" : true
  }
}
GET /gotapi/connection/onBluetoothChange
API Pattern
one-shot
Summary
スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを取得する。
Description
Bluetooth機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
connectStatusobjectYes
enablebooleanYesBluetooth機能有効状態
Bluetooth機能有効状態
ON: true
OFF: false
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connectStatus" : {
    "enable" : true
  }
}
DELETE /gotapi/connection/onNfcChange
API Pattern
event
Summary
スマートデバイスのNFC機能有効状態(ON/OFF)の変化を通知するイベントを停止する。
Description
NFC機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/connection/onNfcChange
API Pattern
event
Summary
スマートデバイスのNFC機能有効状態(ON/OFF)の変化を通知するイベントを開始する。
Description
NFC機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
connectStatusobjectYes
enablebooleanYesNFC機能有効状態
NFC機能有効状態
ON: true
OFF: false
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onnfcchange",
  "connectStatus" : {
    "enable" : true
  }
}
GET /gotapi/connection/onNfcChange
API Pattern
one-shot
Summary
スマートデバイスのNFC機能有効状態(ON/OFF)の変化を通知するイベントを取得する。
Description
NFC機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
connectStatusobjectYes
enablebooleanYesNFC機能有効状態
NFC機能有効状態
ON: true
OFF: false
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connectStatus" : {
    "enable" : true
  }
}
DELETE /gotapi/connection/onWifiChange
API Pattern
event
Summary
スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを停止する。
Description
WIFI機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/connection/onWifiChange
API Pattern
event
Summary
スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを開始する。
Description
WIFI機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
connectStatusobjectYes
enablebooleanYesWIFI機能有効状態
WIFI機能有効状態
ON: true
OFF: false
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onwifichange",
  "connectStatus" : {
    "enable" : true
  }
}
GET /gotapi/connection/onWifiChange
API Pattern
one-shot
Summary
スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを取得する。
Description
WIFI機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
connectStatusobjectYes
enablebooleanYesWIFI機能有効状態
WIFI機能有効状態
ON: true
OFF: false
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connectStatus" : {
    "enable" : true
  }
}
DELETE /gotapi/connection/wifi
API Pattern
one-shot
Summary
スマートデバイスのWIFI機能有効状態を無効に設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/connection/wifi
API Pattern
one-shot
Summary
スマートデバイスのWIFI機能有効状態を有効に設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
enablebooleanYesWIFI機能有効状態
WIFI機能有効状態。
ON : true
OFF : false
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "enable" : true
}

DeviceOrientation Profile

Ver. 2.0.0

Description

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

Operations

DELETE /gotapi/deviceOrientation/onDeviceOrientation
API Pattern
event
Summary
スマートデバイスが検知した加速度や重力込みの加速度(加速度センサー)、そして角速度(ジャイロセンサー)を通知するイベントを停止する。
Description
スマートデバイスでサポートしていないパラメータがある場合には、そのパラメータを省略する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/deviceOrientation/onDeviceOrientation
API Pattern
event
Summary
スマートデバイスが検知した加速度や重力込みの加速度(加速度センサー)、そして角速度(ジャイロセンサー)を通知するイベントを開始する。
Description
スマートデバイスでサポートしていないパラメータがある場合には、そのパラメータを省略する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
orientationobjectYes
intervallongYesインターバル
インターバル (単位: ミリ秒)
accelerationobjectNo加速度
加速度のオブジェクト。
xfloatYesx軸成分
x軸方向への加速度(m/s2)。
yfloatYesy軸成分
y軸方向への加速度(m/s2)。
zfloatYesz軸成分
z軸方向への加速度(m/s2)。
accelerationIncludingGravityobjectNo重力込みの加速度
重力込みの加速度のオブジェクト。
xfloatYesx軸成分
x軸方向への重力込みの加速度(m/s2)。
yfloatYesy軸成分
y軸方向への重力込みの加速度(m/s2)。
zfloatYesz軸成分
z軸方向への重力込みの加速度(m/s2)。
rotationRateobjectNo角速度
角速度のオブジェクト。
alphafloatYesz軸回り成分
z軸回りの角速度(degree/s)。
betafloatYesx軸回り成分
x軸回りの角速度(degree/s)。
gammafloatYesy軸回り成分
y軸回りの角速度(degree/s)。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
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
  }
}
GET /gotapi/deviceOrientation/onDeviceOrientation
API Pattern
one-shot
Summary
スマートデバイスが検知した加速度や重力込みの加速度(加速度センサー)、そして角速度(ジャイロセンサー)を通知するイベントを取得する。
Description
スマートデバイスでサポートしていないパラメータがある場合には、そのパラメータを省略する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
orientationobjectYes
intervallongYesインターバル
インターバル (単位: ミリ秒)
accelerationobjectNo加速度
加速度のオブジェクト。
xfloatYesx軸成分
x軸方向への加速度(m/s2)。
yfloatYesy軸成分
y軸方向への加速度(m/s2)。
zfloatYesz軸成分
z軸方向への加速度(m/s2)。
accelerationIncludingGravityobjectNo重力込みの加速度
重力込みの加速度のオブジェクト。
xfloatYesx軸成分
x軸方向への重力込みの加速度(m/s2)。
yfloatYesy軸成分
y軸方向への重力込みの加速度(m/s2)。
zfloatYesz軸成分
z軸方向への重力込みの加速度(m/s2)。
rotationRateobjectNo角速度
角速度のオブジェクト。
alphafloatYesz軸回り成分
z軸回りの角速度(degree/s)。
betafloatYesx軸回り成分
x軸回りの角速度(degree/s)。
gammafloatYesy軸回り成分
y軸回りの角速度(degree/s)。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
  }
}

DriveController Profile

Ver. 2.0.0

Description

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

Operations

DELETE /gotapi/driveController/move
API Pattern
one-shot
Summary
スマートデバイスに移動停止リクエストを送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/driveController/move
API Pattern
one-shot
Summary
スマートデバイスを指定された方向に移動開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
anglefloatYes角度。デバイスの方向 (degree)
0~360
speedfloatYes速度。デバイスの動く速度
0.0~1.0
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/driveController/rotate
API Pattern
one-shot
Summary
スマートデバイスを指定された向きに回転を行う。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
anglefloatYes角度。デバイスの方向 (degree)
0~360
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

ECG Profile

Ver. 2.0.0

Description

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

Operations

DELETE /gotapi/ecg/onECG
API Pattern
event
Summary
デバイスのECG計測値を通知するイベントを停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/ecg/onECG
API Pattern
event
Summary
デバイスのECG計測値を通知するイベントを開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
ecgobjectYesECG
ECGのオブジェクト。
valueintegerYesECG
ターゲットデバイスで測定した心拍数を返す。
mderFloatstringYesECGのMDER Float値
ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
typestringYesECGのタイプ
この値が「ecg beat」であることを表す文字列を返す。取得できない場合は、空文字を返す。
typeCodestringYesECGのオブジェクトのタイプのコード
「663568」という「ecg beat」を意味するコードを返す。取得できない場合は、空文字を返す。
unitstringYesECGの単位
「mVolt * miliSecond」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
unitCodestringYesECGの単位コード
「3328」という「mVolt * miliSecond」を意味するコードを返す。取得できない場合は、空文字を返す。
timeStamplongYesECGのタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringYesECGのタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
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" : "20170101123456.789+0900"
  }
}
GET /gotapi/ecg/onECG
API Pattern
one-shot
Summary
デバイスのECG計測通知イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
ecgobjectYesECG
ECGのオブジェクト。
valueintegerYesECG
ターゲットデバイスで測定した心拍数を返す。
mderFloatstringYesECGのMDER Float値
ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
typestringYesECGのタイプ
この値が「ecg beat」であることを表す文字列を返す。取得できない場合は、空文字を返す。
typeCodestringYesECGのオブジェクトのタイプのコード
「663568」という「ecg beat」を意味するコードを返す。取得できない場合は、空文字を返す。
unitstringYesECGの単位
「mVolt * miliSecond」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
unitCodestringYesECGの単位コード
「3328」という「mVolt * miliSecond」を意味するコードを返す。取得できない場合は、空文字を返す。
timeStamplongYesECGのタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringYesECGのタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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" : "20170101123456.789+0900"
  }
}

ECHONETLite Profile

Ver. 2.0.0

Description

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

Operations

PUT /gotapi/echonetLite/property
API Pattern
one-shot
Summary
スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティに設定を行う。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
epcstringYesEPC。
ECHONET Property Code
valuestringYesEPCの設定値。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "epc" : "OperationStatus",
  "value" : "49"
}
GET /gotapi/echonetLite/property
API Pattern
one-shot
Summary
スマートデバイスがサポートしているECHONET Lite 機器オブジェクトプロパティの設定内容を取得する。
Description
EPC:ECHONET Property Code
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
epcarray(string)Yes取得プロパティのEPC。取得するプロパティのEPCをカンマ区切りで列挙。10進または16進(0xXX)の値
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
propertiesarray(object)YesEPCのリスト
指定されたEPCの配列。
epcstringYesECHONET Property Code
ECHONET Property Code
valuestringYesECHONET Property Codeの設定値。
ECHONET Property Codeの設定値。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "properties" : [ {
    "epc" : "OperationStatus",
    "value" : "49"
  }, {
    "epc" : "InstallationLocation",
    "value" : "0"
  } ]
}

File Profile

Ver. 2.0.0

Description

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

Operations

DELETE /gotapi/file
API Pattern
one-shot
Summary
ファイルパスで指定したテキストや画像、音声、動画(リソースも含む)を削除する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesファイルパス。ファイル名とパス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/file
API Pattern
one-shot
Summary
ファイルパスで指定したテキストや画像、音声、動画(リソースも含む)の名前を変更、移動をする。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
oldPathstringYes移動前のファイル名を含んだファイルパス。ファイル名を含む。
newPathstringYes移動先のファイル名を含んだファイルパス。ファイル名を含まなくても良い。
forceOverwritebooleanNo上書きフラグ。
true : 既にpath名と同じファイルがある場合は上書きされる。
false : 既にpath名と同じファイルがある場合は上書きされない。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/file
API Pattern
one-shot
Summary
スマートデバイスに対して、テキストや画像、音声、動画(リソースも含む)を渡す。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesファイルパス。ファイル名とパス
mimeTypestringNoMimeType。送信するファイルのMimeType
uristringNoURI。このURIに送信するデータを格納する。dataと同時に省略することはできない。両方指定した場合はdataが優先され、uriは無視される。
datafileNoファイルのbinary。送信するファイルのbinary。uriと同時に省略することはできない。両方指定した場合はdataが優先され、uriは無視される。
forceOverwritebooleanNo上書きフラグ。
true : 既にpath名と同じファイルがある場合は上書きされる。
false : 既にpath名と同じファイルがある場合は上書きされない。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/file
API Pattern
one-shot
Summary
スマートデバイスへの、テキスト(歩数、消費カロリー、睡眠時間などのバイナリーの任意のデータ)や画像、音声、動画(リソースも含む)を受け取る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesファイルパス。ファイル名とパス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
mimeTypestringYesMimeType
URIデータのMimeType
versionstringYesDeviceConnectシステムのバージョン名
uristringYesURI
ContentProviderのURI
このURIからデータを読み込む
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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"
}
DELETE /gotapi/file/directory
API Pattern
one-shot
Summary
ディレクトリの削除要求を渡す。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesパス。削除するディレクトリのパス
forceRemovebooleanNo強制削除フラグ。trueが指定された場合には、空ではないディレクトリも削除する。falseが指定された場合には、空でないディレクトリは削除できない。省略された場合には、falseと同じ動作となる。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/file/directory
API Pattern
one-shot
Summary
ディレクトリの名前の変更、移動要求を渡す。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
oldPathstringYes移動前のディレクトリパス。ファイル名を含まない
newPathstringYes移動先のディレクトリパス。ファイル名を含まない
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/file/directory
API Pattern
one-shot
Summary
ディレクトリの作成要求を渡す。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesパス。作成するディレクトリのパス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/file/directory
API Pattern
one-shot
Summary
保存されているファイルの一覧を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringNoパス。検索対象のディレクトリ。省略されたらそのデバイスプラグインのアプリがもつディレクトリのルートディレクトリを指定する。 例)/files/test/
mimeTypestringNoMimeType。情報を取得するファイルの種別ごとに区切りたい場合は、mimeTypeを指定する 例)image/png
orderarray(string)No取得ファイルの並び順。取得する一覧のエントリの並び順。昇順はascで、降順はdescを後ろに指定する。並び順として選択する行をカンマ区切りでレスポンスの物理名を選択する。例)updateDate,asc
offsetintegerNo取得件数の始まり。取得できるファイル数が多いときに、表示開始位置を指定できる。例)4
limitintegerNo取得件数の制限。取得できるファイル数を制限するときに、その件数を指定できる。例)30
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
countintegerYes検索結果数
検索結果のファイル数
productstringYesDeviceConnectシステムの名前
filearray(object)Yes検索にヒットしたファイルの情報リスト
検索にヒットしたファイルの情報を持つオブジェクト(object)の配列。
pathstringYesファイル名を含めたファイルの存在するパス。
mimeTypestringYesMimeType
fileのエンコードするタイプ。
fileTypestringYesファイルの種別
0: ファイル
1: ディレクトリ
fileNamestringYesファイルの名前
updateDatestringYes更新時間
RFC 3339
fileSizeintegerYesファイルのサイズ。
単位はbyte。
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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" : "2014-05-02 T10:32:10+0900",
    "fileSize" : 123,
    "fileType" : 0
  } ]
}
GET /gotapi/file/list
API Pattern
one-shot
Summary
保存されているファイルの一覧を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringNoパス。検索対象のディレクトリ。省略されたらそのデバイスプラグインのアプリがもつディレクトリのルートディレクトリを指定する。 例)/files/test/
mimeTypestringNoMimeType。情報を取得するファイルの種別ごとに区切りたい場合は、mimeTypeを指定する 例)image/png
orderarray(string)No取得ファイルの並び順。取得する一覧のエントリの並び順。昇順はascで、降順はdescを後ろに指定する。並び順として選択する行をカンマ区切りでレスポンスの物理名を選択する。例)updateDate,asc
offsetintegerNo取得件数の始まり。取得できるファイル数が多いときに、表示開始位置を指定できる。例)4
limitintegerNo取得件数の制限。取得できるファイル数を制限するときに、その件数を指定できる。例)30
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
countintegerYes検索結果数
検索結果のファイル数
productstringYesDeviceConnectシステムの名前
filearray(object)Yes検索にヒットしたファイルの情報リスト
検索にヒットしたファイルの情報を持つオブジェクト(object)の配列。
pathstringYesファイル名を含めたファイルの存在するパス。
mimeTypestringYesMimeType
fileのエンコードするタイプ。
fileTypestringYesファイルの種別
0: ファイル
1: ディレクトリ
fileNamestringYesファイルの名前
updateDatestringYes更新時間
RFC 3339
fileSizeintegerYesファイルのサイズ。
単位はbyte。
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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" : "2014-05-02 T10:32:10+0900",
    "fileSize" : 123,
    "fileType" : 0
  } ]
}

File Descriptor Profile

Ver. 2.0.0

Description

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

Operations

PUT /gotapi/fileDescriptor/close
API Pattern
one-shot
Summary
スマートデバイスのファイルを閉じるように要求する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesファイルパス。ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。ディレクトリを指定した場合はエラーを返す。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/fileDescriptor/onWatchFile
API Pattern
event
Summary
スマートデバイスのファイルの更新時間が変化したことを通知するイベントを登録解除する。
Description
スマートデバイスのファイルへの書き込みが発生した時にイベントが発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/fileDescriptor/onWatchFile
API Pattern
event
Summary
スマートデバイスのファイルの更新時間が変化したことを通知するイベントを登録する。
Description
スマートデバイスのファイルへの書き込みが発生した時にイベントが発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
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"
  }
}
GET /gotapi/fileDescriptor/onWatchFile
API Pattern
one-shot
Summary
スマートデバイスのファイルの更新時間が変化したことを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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"
  }
}
GET /gotapi/fileDescriptor/open
API Pattern
one-shot
Summary
スマートデバイスのファイルを開くように要求する。
Description
ここで使用するpathは、File APIで取得できる。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesファイルパス。ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。ディレクトリを指定した場合はエラーを返す。
flagstringYesフラグ。r : 読み込みのみ
rw : 読み込み&書き込み
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/fileDescriptor/read
API Pattern
one-shot
Summary
スマートデバイスのファイルを指定したサイズ分取得する。
Description
スマートデバイスのファイルが読み込み完了していない場合には、再度このAPIを呼び出して取得を行う。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesファイルパス。ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。ディレクトリを指定した場合はエラーを返す。
lengthlongYes読み込みサイズ。一度の読み込みで取得する最大サイズ。length > 0
positionlongNo読み込み開始位置。読み込みファイルの開始位置を指定する。省略された場合には、現在ファイルが読み込んでいる位置から読み込む。position >= 0
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
sizeintegerYesデータサイズ
読み込んだデータのサイズ
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
fileDatastringYesデータ
読み込んだデータを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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesファイルパス。ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。ディレクトリを指定した場合はエラーを返す。
uristringNoURI。dataと同時に省略することはできない。両方指定した場合はdataが優先され、uriは無視される。
datafileNoファイルのbinary。送信するファイルのbinary。uriと同時に省略することはできない。両方指定した場合はdataが優先され、uriは無視される。
positionlongNoファイルオフセット。ファイルの書き込み開始位置を指定する。省略された場合には、現在ファイルが書き込んでいる位置から書き込む。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

Files Profile

Ver. 2.0.0

Description

各デバイスプラグインが持っているファイルにアクセスするためのAPI。
Javascriptからは、バイナリを直接操作することができない。その為にURIという形にして返却することになる。
その為にFile Receive APIでファイルを取得する際には、Filesプロファイルを経由して取得できるURIにしている。
例えば、Javascriptでは、取得したURIが画像の場合には、imgタグのsrcに設定して画像を表示する。
テキストの場合には、XMLHttpRequestでテキストを取得する。

Operations

GET /files
API Pattern
one-shot
Summary
各デバイスプラグインが持っているファイルにアクセスする。
Parameters
NameTypeRequiredDescription
uristringYesリソースのURL。デバイスプラグインが持つファイルのURI。

Geolocation Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/geolocation/currentPosition
API Pattern
one-shot
Summary
該当デバイスの現在の位置情報を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
highAccuracybooleanNo測位精度設定。
true : 高精度
false : 通常精度
省略時はfalse
maximumAgedoubleNo位置情報有効時間(ミリ秒単位)省略時は0mSec
※前回呼び出し時から該当時間以上経過していた場合に最新の位置情報を返す。それ以外は前回と同じ位置情報を返す。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
positionobjectYes
coordinatesobjectYes座標
座標のオブジェクト
latitudefloatNo緯度
-180~180
単位:degree
longitudefloatNo経度
-90~90
単位:degree
altitudefloatNo高度
単位:m
accuracyfloatNo緯度・経度の誤差
単位:m
altitudeAccuracyfloatNo高度の誤差
単位:m
headingfloatNo方角
0~359
単位:degree
真北に対して右回りで 0 ≦ heading < 360
speedfloatNo速度
単位:m/Sec
timeStampfloatYes測位時刻
エポックからのミリ秒
timeStampStringstringYes測位時刻 (文字列)
測位時刻を文字列表記
[YYYYMMDDHHMMSS.sss+/-HHMM]形式
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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" : "20170101123456.789+0900"
  }
}
DELETE /gotapi/geolocation/onWatchPosition
API Pattern
event
Summary
該当デバイスの位置情報定期通知イベントを停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/geolocation/onWatchPosition
API Pattern
event
Summary
該当デバイスの位置情報定期通知イベントを開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
highAccuracybooleanNo測位精度設定。
true : 高精度
false : 通常精度
省略時はfalse
intervaldoubleNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
positionobjectYes
coordinatesobjectYes座標
座標のオブジェクト
latitudefloatNo緯度
-180~180
単位:degree
longitudefloatNo経度
-90~90
単位:degree
altitudefloatNo高度
単位:m
accuracyfloatNo緯度・経度の誤差
単位:m
altitudeAccuracyfloatNo高度の誤差
単位:m
headingfloatNo方角
0~359
単位:degree
真北に対して右回りで 0 ≦ heading < 360
speedfloatNo速度
単位:m/Sec
timeStampfloatYes測位時刻
エポックからのミリ秒
timeStampStringstringYes測位時刻 (文字列)
測位時刻を文字列表記
[YYYYMMDDHHMMSS.sss+/-HHMM]形式
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
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" : "20170101123456.789+0900"
  }
}
GET /gotapi/geolocation/onWatchPosition
API Pattern
one-shot
Summary
該当デバイスの位置情報定期通知イベントを取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
highAccuracybooleanNo測位精度設定。
true : 高精度
false : 通常精度
省略時はfalse
intervaldoubleNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
positionobjectYes
coordinatesobjectYes座標
座標のオブジェクト
latitudefloatNo緯度
-180~180
単位:degree
longitudefloatNo経度
-90~90
単位:degree
altitudefloatNo高度
単位:m
accuracyfloatNo緯度・経度の誤差
単位:m
altitudeAccuracyfloatNo高度の誤差
単位:m
headingfloatNo方角
0~359
単位:degree
真北に対して右回りで 0 ≦ heading < 360
speedfloatNo速度
単位:m/Sec
timeStampfloatYes測位時刻
エポックからのミリ秒
timeStampStringstringYes測位時刻 (文字列)
測位時刻を文字列表記
[YYYYMMDDHHMMSS.sss+/-HHMM]形式
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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" : "20170101123456.789+0900"
  }
}

GPIO Profile

Ver. 2.0.0

Description

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

Operations

POST /gotapi/gpio/analog/A0
API Pattern
one-shot
Summary
A0ピンのアナログ値を出力
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valuefloatYes値。出力するアナログ値
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/gpio/analog/A0
API Pattern
one-shot
Summary
A0ピンのアナログ値を入力
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
指定したピンのアナログ値
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1024
}
POST /gotapi/gpio/analog/A1
API Pattern
one-shot
Summary
A1ピンのアナログ値を出力
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valuefloatYes値。出力するアナログ値
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/gpio/analog/A1
API Pattern
one-shot
Summary
A1ピンのアナログ値を入力
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
指定したピンのアナログ値
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1024
}
POST /gotapi/gpio/analog/A2
API Pattern
one-shot
Summary
A2ピンのアナログ値を出力
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valuefloatYes値。出力するアナログ値
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/gpio/analog/A2
API Pattern
one-shot
Summary
A2ピンのアナログ値を入力
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
指定したピンのアナログ値
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1024
}
POST /gotapi/gpio/analog/A3
API Pattern
one-shot
Summary
A3ピンのアナログ値を出力
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valuefloatYes値。出力するアナログ値
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/gpio/analog/A3
API Pattern
one-shot
Summary
A3ピンのアナログ値を入力
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
指定したピンのアナログ値
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1024
}
POST /gotapi/gpio/analog/A4
API Pattern
one-shot
Summary
A4ピンのアナログ値を出力
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valuefloatYes値。出力するアナログ値
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/gpio/analog/A4
API Pattern
one-shot
Summary
A4ピンのアナログ値を入力
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
指定したピンのアナログ値
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1024
}
POST /gotapi/gpio/analog/A5
API Pattern
one-shot
Summary
A5ピンのアナログ値を出力
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valuefloatYes値。出力するアナログ値
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/gpio/analog/A5
API Pattern
one-shot
Summary
A5ピンのアナログ値を入力
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
指定したピンのアナログ値
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1024
}
DELETE /gotapi/gpio/digital/D0
API Pattern
one-shot
Summary
D0ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D0
API Pattern
one-shot
Summary
D0ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D1
API Pattern
one-shot
Summary
D1ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D1
API Pattern
one-shot
Summary
D1ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D10
API Pattern
one-shot
Summary
D10ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D10
API Pattern
one-shot
Summary
D10ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D11
API Pattern
one-shot
Summary
D11ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D11
API Pattern
one-shot
Summary
D11ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D12
API Pattern
one-shot
Summary
D12ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D12
API Pattern
one-shot
Summary
D12ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D13
API Pattern
one-shot
Summary
D13ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D13
API Pattern
one-shot
Summary
D13ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D2
API Pattern
one-shot
Summary
D2ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D2
API Pattern
one-shot
Summary
D2ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D3
API Pattern
one-shot
Summary
D3ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D3
API Pattern
one-shot
Summary
D3ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D4
API Pattern
one-shot
Summary
D4ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D4
API Pattern
one-shot
Summary
D4ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D5
API Pattern
one-shot
Summary
D5ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D5
API Pattern
one-shot
Summary
D5ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D6
API Pattern
one-shot
Summary
D6ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D6
API Pattern
one-shot
Summary
D6ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D7
API Pattern
one-shot
Summary
D7ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D7
API Pattern
one-shot
Summary
D7ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D8
API Pattern
one-shot
Summary
D8ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D8
API Pattern
one-shot
Summary
D8ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
DELETE /gotapi/gpio/digital/D9
API Pattern
one-shot
Summary
D9ピンにデジタル値のLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/digital/D9
API Pattern
one-shot
Summary
D9ピンにデジタル値のHIGH(1)またはLOW(0)を出力。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
valueintegerYes値。出力する値
LOW(0), HIGH(1)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
valuefloatYesピンから取得した値
ピンの値、HIGH(1) or LOW(0)が返ってくる。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "value" : 1
}
POST /gotapi/gpio/export/A0
API Pattern
one-shot
Summary
A0ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/A1
API Pattern
one-shot
Summary
A1ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/A2
API Pattern
one-shot
Summary
A2ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/A3
API Pattern
one-shot
Summary
A3ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/A4
API Pattern
one-shot
Summary
A4ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/A5
API Pattern
one-shot
Summary
A5ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D0
API Pattern
one-shot
Summary
D0ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D1
API Pattern
one-shot
Summary
D1ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D10
API Pattern
one-shot
Summary
D10ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D11
API Pattern
one-shot
Summary
D11ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D12
API Pattern
one-shot
Summary
D12ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D13
API Pattern
one-shot
Summary
D13ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D2
API Pattern
one-shot
Summary
D2ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D3
API Pattern
one-shot
Summary
D3ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D4
API Pattern
one-shot
Summary
D4ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D5
API Pattern
one-shot
Summary
D5ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D6
API Pattern
one-shot
Summary
D6ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D7
API Pattern
one-shot
Summary
D7ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D8
API Pattern
one-shot
Summary
D8ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/gpio/export/D9
API Pattern
one-shot
Summary
D9ピンの出力/入力の種類を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modefloatYesモード。設定するモード
0:デジタルIN
1:デジタルOUT
2:アナログIN
3:アナログOUT
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/gpio/onChange
API Pattern
event
Summary
各ピンで、入力状態のモードに設定されているピンの値を定期的に送信するイベントを停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/gpio/onChange
API Pattern
event
Summary
各ピンで、入力状態のモードに設定されているピンの値を定期的に送信するイベントを開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
pinsobjectYes
{ピン番号}integerNoピンの値
取得したピンの値
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onbluetoothchange",
  "pins" : {
    "14" : 1023,
    "15" : 111,
    "16" : 201,
    "17" : 0,
    "18" : 1014,
    "19" : 99
  }
}
GET /gotapi/gpio/onChange
API Pattern
one-shot
Summary
各ピンで、入力状態のモードに設定されているピンの値を取得する
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
pinsobjectYes
{ピン番号}integerNoピンの値
取得したピンの値
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

Health Profile

Ver. 2.0.0

Description

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

Operations

DELETE /gotapi/health/heart
API Pattern
event
Summary
デバイスの心拍数計測通知イベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/health/heart
API Pattern
event
Summary
デバイスの心拍数計測通知イベントを開始する。
Description
当該イベントの通知を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
heartobjectYes心拍数計測結果
検出値、検出したデバイスの情報を取得する。
rateobjectYes心拍数オブジェクト
心拍数の情報を持つ。
valueintegerYes心拍数
ターゲットデバイスで測定した心拍数を返す。
mderFloatstringYes心拍数のMDER Float値
ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
typestringYes心拍数のタイプ
この値が「heart rate」であることを表す文字列を返す。取得できない場合は、空文字を返す。
typeCodestringYes心拍数のオブジェクトのタイプのコード
「147842」という「heart rate」を意味するコードを返す。取得できない場合は、空文字を返す。
unitstringYes心拍数の単位
「beat per min」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
unitCodestringYes心拍数の単位コード
「264864」という「beat per min」を意味するコードを返す。取得できない場合は、空文字を返す。
timeStamplongYes心拍数のタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringYes心拍数のタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
rrobjectNoRR間隔オブジェクト
RR間隔値の情報を持つ。
valueintegerNoRR間隔値
ターゲットデバイスで測定したRR間隔を返す。
mderFloatstringNoRR間隔のMDER Float値
RR間隔値のMDERFloat値を返す。
typestringNoRR間隔のタイプ
RR間隔を表す「RR interval」を返す。取得できない場合は、空文字を返す。
typeCodestringNoRR間隔のオブジェクトのタイプのコード
RR間隔を表す「147240」を返す。取得できない場合は、空文字を返す。
unitstringNoRR間隔の単位
RR間隔の単位を表す「ms」を返す。取得できない場合は、空文字を返す。
unitCodestringNoRR間隔の単位コード
RR間隔の単位であるmsを表す「264338」を返す。取得できない場合は、空文字を返す。
timeStamplongNoRR間隔のタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringNoRR間隔のタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
energyobjectNo消費エネルギーオブジェクト
消費エネルギーの情報を持つ。
valueintegerNo消費エネルギー
ターゲットデバイスで測定した消費エネルギー値を返す。
mderFloatstringNo消費エネルギーのMDER Float値
消費エネルギー値のMDERFloat値を返す。
typestringNo消費エネルギーのタイプ
消費エネルギー値を表す「energy expended」を返す。取得できない場合は、空文字を返す。
typeCodestringNo消費エネルギーのタイプコード
消費エネルギー値を表す「119」を返す。取得できない場合は、空文字を返す。
unitstringNo消費エネルギーの単位
消費エネルギー値の単位を表す「Calories」を返す。取得できない場合は、空文字を返す。
unitCodestringNo消費エネルギーの単位コード
消費エネルギー値の単位であるCaloriesを表す「6784」を返す。取得できない場合は、空文字を返す。
timeStamplongNo消費エネルギーのタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringNo消費エネルギーのタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
deviceobjectYesデバイスオブジェクト
健康機器の情報を持つ。
productNamestringYesプロダクト名
ターゲットデバイスの製品名。取得できない時は任意のアルゴリズムでデバイス名を生成。
manufacturerNamestringYesメーカ名
ターゲットデバイスのメーカ名。取得できない場合は空文字を指定。
modelNumberstringYesモデルの番号
ターゲットデバイスのモデル番号。取得できない場合は空文字を指定
firmwareRevisionstringYesファームウェアリビジョン
ターゲットデバイスのファームウェアリビジョン。取得できない場合は空文字を指定。
serialNumberstringYesシリアルナンバー
ターゲットデバイスのシリアル番号。取得できない場合は空文字を指定。
softwareRevisionstringYesソフトウェアリビジョン
ターゲットデバイスのソフトウェアリビジョン。取得できない場合は空文字を指定。
hardwareRevisionstringYesハードウェアリビジョン
ターゲットデバイスのハードウェアリビジョン。取得できない場合は、空文字を指定。
partNumberstringYesパートナンバー
ターゲットデバイスのパート番号。取得できない場合は、空文字を指定。
protocolRevisionstringYesプロトコルリビジョン
ターゲットデバイスのプロトコルリビジョン。取得できない場合は、空文字を指定。
systemIdstringYesシステムID
ターゲットデバイスのシステムID。16進数。取得できない場合は「0x0」。
batteryLevelfloatYesバッテリーレベル
ターゲットデバイスのバッテリーレベル。取得できない場合は-1.0を返す。
範囲: 0.0〜1.0
profilestringYesプロファイル名。
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" : "20170101123456.789+0900"
    },
    "rr" : {
      "value" : 909.1796875,
      "mderFloat" : "F9E9CF8B",
      "type" : "RR interval",
      "typeCode" : 147240,
      "unit" : "ms",
      "unitCode" : 264338,
      "timeStamp" : 1483241696789,
      "timeStampString" : "20170101123456.789+0900"
    },
    "energy" : {
      "value" : 0,
      "mderFloat" : "01000000",
      "type" : "energy expended",
      "typeCode" : 119,
      "unit" : "Calories",
      "unitCode" : 6784,
      "timeStamp" : 1483241696789,
      "timeStampString" : "20170101123456.789+0900"
    },
    "device" : {
      "productName" : "DUMMY DEVICE",
      "manufacturerName" : "",
      "modelNumber" : "",
      "firmwareRevision" : "",
      "serialNumber" : "",
      "softwareRevision" : "",
      "hardwareRevision" : "",
      "partNumber" : "",
      "protocolRevision" : "",
      "systemId" : "0x0",
      "batteryLevel" : -1
    }
  }
}
GET /gotapi/health/heart
API Pattern
one-shot
Summary
デバイスの心拍数計測通知イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
heartobjectYes心拍数計測結果
検出値、検出したデバイスの情報を取得する。
rateobjectYes心拍数オブジェクト
心拍数の情報を持つ。
valueintegerYes心拍数
ターゲットデバイスで測定した心拍数を返す。
mderFloatstringYes心拍数のMDER Float値
ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
typestringYes心拍数のタイプ
この値が「heart rate」であることを表す文字列を返す。取得できない場合は、空文字を返す。
typeCodestringYes心拍数のオブジェクトのタイプのコード
「147842」という「heart rate」を意味するコードを返す。取得できない場合は、空文字を返す。
unitstringYes心拍数の単位
「beat per min」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
unitCodestringYes心拍数の単位コード
「264864」という「beat per min」を意味するコードを返す。取得できない場合は、空文字を返す。
timeStamplongYes心拍数のタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringYes心拍数のタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
rrobjectNoRR間隔オブジェクト
RR間隔値の情報を持つ。
valueintegerNoRR間隔値
ターゲットデバイスで測定したRR間隔を返す。
mderFloatstringNoRR間隔のMDER Float値
RR間隔値のMDERFloat値を返す。
typestringNoRR間隔のタイプ
RR間隔を表す「RR interval」を返す。取得できない場合は、空文字を返す。
typeCodestringNoRR間隔のオブジェクトのタイプのコード
RR間隔を表す「147240」を返す。取得できない場合は、空文字を返す。
unitstringNoRR間隔の単位
RR間隔の単位を表す「ms」を返す。取得できない場合は、空文字を返す。
unitCodestringNoRR間隔の単位コード
RR間隔の単位であるmsを表す「264338」を返す。取得できない場合は、空文字を返す。
timeStamplongNoRR間隔のタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringNoRR間隔のタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
energyobjectNo消費エネルギーオブジェクト
消費エネルギーの情報を持つ。
valueintegerNo消費エネルギー
ターゲットデバイスで測定した消費エネルギー値を返す。
mderFloatstringNo消費エネルギーのMDER Float値
消費エネルギー値のMDERFloat値を返す。
typestringNo消費エネルギーのタイプ
消費エネルギー値を表す「energy expended」を返す。取得できない場合は、空文字を返す。
typeCodestringNo消費エネルギーのタイプコード
消費エネルギー値を表す「119」を返す。取得できない場合は、空文字を返す。
unitstringNo消費エネルギーの単位
消費エネルギー値の単位を表す「Calories」を返す。取得できない場合は、空文字を返す。
unitCodestringNo消費エネルギーの単位コード
消費エネルギー値の単位であるCaloriesを表す「6784」を返す。取得できない場合は、空文字を返す。
timeStamplongNo消費エネルギーのタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringNo消費エネルギーのタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
deviceobjectYesデバイスオブジェクト
健康機器の情報を持つ。
productNamestringYesプロダクト名
ターゲットデバイスの製品名。取得できない時は任意のアルゴリズムでデバイス名を生成。
manufacturerNamestringYesメーカ名
ターゲットデバイスのメーカ名。取得できない場合は空文字を指定。
modelNumberstringYesモデルの番号
ターゲットデバイスのモデル番号。取得できない場合は空文字を指定
firmwareRevisionstringYesファームウェアリビジョン
ターゲットデバイスのファームウェアリビジョン。取得できない場合は空文字を指定。
serialNumberstringYesシリアルナンバー
ターゲットデバイスのシリアル番号。取得できない場合は空文字を指定。
softwareRevisionstringYesソフトウェアリビジョン
ターゲットデバイスのソフトウェアリビジョン。取得できない場合は空文字を指定。
hardwareRevisionstringYesハードウェアリビジョン
ターゲットデバイスのハードウェアリビジョン。取得できない場合は、空文字を指定。
partNumberstringYesパートナンバー
ターゲットデバイスのパート番号。取得できない場合は、空文字を指定。
protocolRevisionstringYesプロトコルリビジョン
ターゲットデバイスのプロトコルリビジョン。取得できない場合は、空文字を指定。
systemIdstringYesシステムID
ターゲットデバイスのシステムID。16進数。取得できない場合は「0x0」。
batteryLevelfloatYesバッテリーレベル
ターゲットデバイスのバッテリーレベル。取得できない場合は-1.0を返す。
範囲: 0.0〜1.0
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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" : "20170101123456.789+0900"
    },
    "rr" : {
      "value" : 909.1796875,
      "mderFloat" : "F9E9CF8B",
      "type" : "RR interval",
      "typeCode" : 147240,
      "unit" : "ms",
      "unitCode" : 264338,
      "timeStamp" : 1483241696789,
      "timeStampString" : "20170101123456.789+0900"
    },
    "energy" : {
      "value" : 0,
      "mderFloat" : "01000000",
      "type" : "energy expended",
      "typeCode" : 119,
      "unit" : "Calories",
      "unitCode" : 6784,
      "timeStamp" : 1483241696789,
      "timeStampString" : "20170101123456.789+0900"
    },
    "device" : {
      "productName" : "DUMMY DEVICE",
      "manufacturerName" : "",
      "modelNumber" : "",
      "firmwareRevision" : "",
      "serialNumber" : "",
      "softwareRevision" : "",
      "hardwareRevision" : "",
      "partNumber" : "",
      "protocolRevision" : "",
      "systemId" : "0x0",
      "batteryLevel" : -1
    }
  }
}
DELETE /gotapi/health/heartRate
API Pattern
event
Summary
デバイスの心拍数計測通知イベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/health/heartRate
API Pattern
event
Summary
デバイスの心拍数計測通知イベントを開始する。
Description
当該イベントの通知を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
heartRateintegerYes心拍数
ターゲットデバイスで測定した心拍数を返す。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "health",
  "attribute" : "heartrate",
  "heartRate" : 80
}
GET /gotapi/health/heartRate
API Pattern
one-shot
Summary
デバイスの心拍数計測通知イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
heartRateintegerYes心拍数
ターゲットデバイスで測定した心拍数を返す。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/health/onheart
API Pattern
event
Summary
デバイスの心拍数計測通知イベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/health/onheart
API Pattern
event
Summary
デバイスの心拍数計測通知イベントを開始する。
Description
当該イベントの通知を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
heartobjectYes心拍数計測結果
検出値、検出したデバイスの情報を取得する。
rateobjectYes心拍数オブジェクト
心拍数の情報を持つ。
valueintegerYes心拍数
ターゲットデバイスで測定した心拍数を返す。
mderFloatstringYes心拍数のMDER Float値
ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
typestringYes心拍数のタイプ
この値が「heart rate」であることを表す文字列を返す。取得できない場合は、空文字を返す。
typeCodestringYes心拍数のオブジェクトのタイプのコード
「147842」という「heart rate」を意味するコードを返す。取得できない場合は、空文字を返す。
unitstringYes心拍数の単位
「beat per min」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
unitCodestringYes心拍数の単位コード
「264864」という「beat per min」を意味するコードを返す。取得できない場合は、空文字を返す。
timeStamplongYes心拍数のタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringYes心拍数のタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
rrobjectNoRR間隔オブジェクト
RR間隔値の情報を持つ。
valueintegerNoRR間隔値
ターゲットデバイスで測定したRR間隔を返す。
mderFloatstringNoRR間隔のMDER Float値
RR間隔値のMDERFloat値を返す。
typestringNoRR間隔のタイプ
RR間隔を表す「RR interval」を返す。取得できない場合は、空文字を返す。
typeCodestringNoRR間隔のオブジェクトのタイプのコード
RR間隔を表す「147240」を返す。取得できない場合は、空文字を返す。
unitstringNoRR間隔の単位
RR間隔の単位を表す「ms」を返す。取得できない場合は、空文字を返す。
unitCodestringNoRR間隔の単位コード
RR間隔の単位であるmsを表す「264338」を返す。取得できない場合は、空文字を返す。
timeStamplongNoRR間隔のタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringNoRR間隔のタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
energyobjectNo消費エネルギーオブジェクト
消費エネルギーの情報を持つ。
valueintegerNo消費エネルギー
ターゲットデバイスで測定した消費エネルギー値を返す。
mderFloatstringNo消費エネルギーのMDER Float値
消費エネルギー値のMDERFloat値を返す。
typestringNo消費エネルギーのタイプ
消費エネルギー値を表す「energy expended」を返す。取得できない場合は、空文字を返す。
typeCodestringNo消費エネルギーのタイプコード
消費エネルギー値を表す「119」を返す。取得できない場合は、空文字を返す。
unitstringNo消費エネルギーの単位
消費エネルギー値の単位を表す「Calories」を返す。取得できない場合は、空文字を返す。
unitCodestringNo消費エネルギーの単位コード
消費エネルギー値の単位であるCaloriesを表す「6784」を返す。取得できない場合は、空文字を返す。
timeStamplongNo消費エネルギーのタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringNo消費エネルギーのタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
deviceobjectYesデバイスオブジェクト
健康機器の情報を持つ。
productNamestringYesプロダクト名
ターゲットデバイスの製品名。取得できない時は任意のアルゴリズムでデバイス名を生成。
manufacturerNamestringYesメーカ名
ターゲットデバイスのメーカ名。取得できない場合は空文字を指定。
modelNumberstringYesモデルの番号
ターゲットデバイスのモデル番号。取得できない場合は空文字を指定
firmwareRevisionstringYesファームウェアリビジョン
ターゲットデバイスのファームウェアリビジョン。取得できない場合は空文字を指定。
serialNumberstringYesシリアルナンバー
ターゲットデバイスのシリアル番号。取得できない場合は空文字を指定。
softwareRevisionstringYesソフトウェアリビジョン
ターゲットデバイスのソフトウェアリビジョン。取得できない場合は空文字を指定。
hardwareRevisionstringYesハードウェアリビジョン
ターゲットデバイスのハードウェアリビジョン。取得できない場合は、空文字を指定。
partNumberstringYesパートナンバー
ターゲットデバイスのパート番号。取得できない場合は、空文字を指定。
protocolRevisionstringYesプロトコルリビジョン
ターゲットデバイスのプロトコルリビジョン。取得できない場合は、空文字を指定。
systemIdstringYesシステムID
ターゲットデバイスのシステムID。16進数。取得できない場合は「0x0」。
batteryLevelfloatYesバッテリーレベル
ターゲットデバイスのバッテリーレベル。取得できない場合は-1.0を返す。
範囲: 0.0〜1.0
profilestringYesプロファイル名。
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" : "20170101123456.789+0900"
    },
    "rr" : {
      "value" : 909.1796875,
      "mderFloat" : "F9E9CF8B",
      "type" : "RR interval",
      "typeCode" : 147240,
      "unit" : "ms",
      "unitCode" : 264338,
      "timeStamp" : 1483241696789,
      "timeStampString" : "20170101123456.789+0900"
    },
    "energy" : {
      "value" : 0,
      "mderFloat" : "01000000",
      "type" : "energy expended",
      "typeCode" : 119,
      "unit" : "Calories",
      "unitCode" : 6784,
      "timeStamp" : 1483241696789,
      "timeStampString" : "20170101123456.789+0900"
    },
    "device" : {
      "productName" : "DUMMY DEVICE",
      "manufacturerName" : "",
      "modelNumber" : "",
      "firmwareRevision" : "",
      "serialNumber" : "",
      "softwareRevision" : "",
      "hardwareRevision" : "",
      "partNumber" : "",
      "protocolRevision" : "",
      "systemId" : "0x0",
      "batteryLevel" : -1
    }
  }
}
GET /gotapi/health/onheart
API Pattern
one-shot
Summary
デバイスの心拍数計測通知イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
heartobjectYes心拍数計測結果
検出値、検出したデバイスの情報を取得する。
rateobjectYes心拍数オブジェクト
心拍数の情報を持つ。
valueintegerYes心拍数
ターゲットデバイスで測定した心拍数を返す。
mderFloatstringYes心拍数のMDER Float値
ターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
typestringYes心拍数のタイプ
この値が「heart rate」であることを表す文字列を返す。取得できない場合は、空文字を返す。
typeCodestringYes心拍数のオブジェクトのタイプのコード
「147842」という「heart rate」を意味するコードを返す。取得できない場合は、空文字を返す。
unitstringYes心拍数の単位
「beat per min」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
unitCodestringYes心拍数の単位コード
「264864」という「beat per min」を意味するコードを返す。取得できない場合は、空文字を返す。
timeStamplongYes心拍数のタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringYes心拍数のタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
rrobjectNoRR間隔オブジェクト
RR間隔値の情報を持つ。
valueintegerNoRR間隔値
ターゲットデバイスで測定したRR間隔を返す。
mderFloatstringNoRR間隔のMDER Float値
RR間隔値のMDERFloat値を返す。
typestringNoRR間隔のタイプ
RR間隔を表す「RR interval」を返す。取得できない場合は、空文字を返す。
typeCodestringNoRR間隔のオブジェクトのタイプのコード
RR間隔を表す「147240」を返す。取得できない場合は、空文字を返す。
unitstringNoRR間隔の単位
RR間隔の単位を表す「ms」を返す。取得できない場合は、空文字を返す。
unitCodestringNoRR間隔の単位コード
RR間隔の単位であるmsを表す「264338」を返す。取得できない場合は、空文字を返す。
timeStamplongNoRR間隔のタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringNoRR間隔のタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
energyobjectNo消費エネルギーオブジェクト
消費エネルギーの情報を持つ。
valueintegerNo消費エネルギー
ターゲットデバイスで測定した消費エネルギー値を返す。
mderFloatstringNo消費エネルギーのMDER Float値
消費エネルギー値のMDERFloat値を返す。
typestringNo消費エネルギーのタイプ
消費エネルギー値を表す「energy expended」を返す。取得できない場合は、空文字を返す。
typeCodestringNo消費エネルギーのタイプコード
消費エネルギー値を表す「119」を返す。取得できない場合は、空文字を返す。
unitstringNo消費エネルギーの単位
消費エネルギー値の単位を表す「Calories」を返す。取得できない場合は、空文字を返す。
unitCodestringNo消費エネルギーの単位コード
消費エネルギー値の単位であるCaloriesを表す「6784」を返す。取得できない場合は、空文字を返す。
timeStamplongNo消費エネルギーのタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringNo消費エネルギーのタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
deviceobjectYesデバイスオブジェクト
健康機器の情報を持つ。
productNamestringYesプロダクト名
ターゲットデバイスの製品名。取得できない時は任意のアルゴリズムでデバイス名を生成。
manufacturerNamestringYesメーカ名
ターゲットデバイスのメーカ名。取得できない場合は空文字を指定。
modelNumberstringYesモデルの番号
ターゲットデバイスのモデル番号。取得できない場合は空文字を指定
firmwareRevisionstringYesファームウェアリビジョン
ターゲットデバイスのファームウェアリビジョン。取得できない場合は空文字を指定。
serialNumberstringYesシリアルナンバー
ターゲットデバイスのシリアル番号。取得できない場合は空文字を指定。
softwareRevisionstringYesソフトウェアリビジョン
ターゲットデバイスのソフトウェアリビジョン。取得できない場合は空文字を指定。
hardwareRevisionstringYesハードウェアリビジョン
ターゲットデバイスのハードウェアリビジョン。取得できない場合は、空文字を指定。
partNumberstringYesパートナンバー
ターゲットデバイスのパート番号。取得できない場合は、空文字を指定。
protocolRevisionstringYesプロトコルリビジョン
ターゲットデバイスのプロトコルリビジョン。取得できない場合は、空文字を指定。
systemIdstringYesシステムID
ターゲットデバイスのシステムID。16進数。取得できない場合は「0x0」。
batteryLevelfloatYesバッテリーレベル
ターゲットデバイスのバッテリーレベル。取得できない場合は-1.0を返す。
範囲: 0.0〜1.0
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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" : "20170101123456.789+0900"
    },
    "rr" : {
      "value" : 909.1796875,
      "mderFloat" : "F9E9CF8B",
      "type" : "RR interval",
      "typeCode" : 147240,
      "unit" : "ms",
      "unitCode" : 264338,
      "timeStamp" : 1483241696789,
      "timeStampString" : "20170101123456.789+0900"
    },
    "energy" : {
      "value" : 0,
      "mderFloat" : "01000000",
      "type" : "energy expended",
      "typeCode" : 119,
      "unit" : "Calories",
      "unitCode" : 6784,
      "timeStamp" : 1483241696789,
      "timeStampString" : "20170101123456.789+0900"
    },
    "device" : {
      "productName" : "DUMMY DEVICE",
      "manufacturerName" : "",
      "modelNumber" : "",
      "firmwareRevision" : "",
      "serialNumber" : "",
      "softwareRevision" : "",
      "hardwareRevision" : "",
      "partNumber" : "",
      "protocolRevision" : "",
      "systemId" : "0x0",
      "batteryLevel" : -1
    }
  }
}

Human Detection Profile

Ver. 2.0.0

Description

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

Operations

DELETE /gotapi/humanDetection/onBodyDetection
API Pattern
event
Summary
体を検出したときの通知イベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/humanDetection/onBodyDetection
API Pattern
event
Summary
体を検出したときの通知イベントを開始する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
thresholdfloatNo検出しきい値。省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
minWidthfloatNo検出最小サイズ(w)。minHeight < maxHeightとすること、省略時デバイス初期値。
設定できる値の範囲:0.0~1.0
minHeightfloatNo検出最小サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
maxWidthfloatNo検出最大サイズ(w)。minWidth < maxWidthとすること、省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
maxHeightfloatNo検出最大サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
intervallongNoデバイスプラグインがイベントを送信する間隔。
optionsarray(string)No利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。
※使用できるオプションは無し。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
bodyDetectsarray(object)Yes人体検出リスト
検出された数分出現する。
xfloatYes検出領域の中心X座標
0.0~1.0
yfloatYes検出領域の中心Y座標
0.0~1.0
widthfloatNo検出領域のX方向の幅
※領域幅が提供できない場合は出現しない。
0.0~1.0
heightfloatNo検出領域のY方向の幅
※領域幅が提供できない場合は出現しない。
0.0~1.0
confidencefloatYes解析の信頼度
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
  } ]
}
GET /gotapi/humanDetection/onBodyDetection
API Pattern
one-shot
Summary
体を検出したときの通知イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
thresholdfloatNo検出しきい値。省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
minWidthfloatNo検出最小サイズ(w)。minHeight < maxHeightとすること、省略時デバイス初期値。
設定できる値の範囲:0.0~1.0
minHeightfloatNo検出最小サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
maxWidthfloatNo検出最大サイズ(w)。minWidth < maxWidthとすること、省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
maxHeightfloatNo検出最大サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
optionsarray(string)No利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。
※使用できるオプションは無し。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
bodyDetectsarray(object)Yes人体検出リスト
検出された数分出現する。
xfloatYes検出領域の中心X座標
0.0~1.0
yfloatYes検出領域の中心Y座標
0.0~1.0
widthfloatNo検出領域のX方向の幅
※領域幅が提供できない場合は出現しない。
0.0~1.0
heightfloatNo検出領域のY方向の幅
※領域幅が提供できない場合は出現しない。
0.0~1.0
confidencefloatYes解析の信頼度
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
  } ]
}
DELETE /gotapi/humanDetection/onDetection
API Pattern
event
Summary
人を検出したときの通知イベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/humanDetection/onDetection
API Pattern
event
Summary
人を検出したときの通知イベントを開始する。
Description
当該イベントの通知を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
humanDetectobjectYes
existbooleanYes人が検出されたかどうかのフラグ。
検出された : true
検出されない : false
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "humandetection",
  "attribute" : "ondetection",
  "humanDetect" : {
    "exist" : true
  }
}
GET /gotapi/humanDetection/onDetection
API Pattern
one-shot
Summary
人を検出したときの通知イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
humanDetectobjectYes
existbooleanYes人が検出されたかどうかのフラグ。
検出された : true
検出されない : false
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "humanDetect" : {
    "exist" : true
  }
}
DELETE /gotapi/humanDetection/onFaceDetection
API Pattern
event
Summary
顔を検出したときの通知イベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/humanDetection/onFaceDetection
API Pattern
event
Summary
顔を検出したときの通知イベントを開始する。
Description
当該イベントの通知を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
thresholdfloatNo検出しきい値。省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
minWidthfloatNo検出最小サイズ(w)。minHeight < maxHeightとすること、省略時デバイス初期値。
設定できる値の範囲:0.0~1.0
minHeightfloatNo検出最小サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
maxWidthfloatNo検出最大サイズ(w)。minWidth < maxWidthとすること、省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
maxHeightfloatNo検出最大サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
eyeThresholdfloatNo目の座標検出しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
noseThresholdfloatNo鼻の座標検出しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
mouthThresholdfloatNo口の座標検出しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
blinkThresholdfloatNo目つむり検出しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
ageThresholdfloatNo年齢推定しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
genderThresholdfloatNo性別推定しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
faceDirectionThresholdfloatNo顔向き推定しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
gazeThresholdfloatNo視線推定しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
expressionThresholdfloatNo表情推定しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
intervallongNoデバイスプラグインがイベントを送信する間隔。
optionsarray(string)No利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。
※使用できるオプションは無し。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
faceDetectsarray(object)Yes顔検出リスト
検出された数分出現する。
eyePointsobjectNo
leftEyeXfloatNo左目の中心座標(x)
0.0~1.0
leftEyeYfloatNo左目の中心座標(y)
0.0~1.0
leftEyeWidthfloatNo左目の領域幅(w)
※領域幅が提供できない場合は出現しない。
0.0~1.0
leftEyeHeightfloatNo左目の領域幅(h)
※領域幅が提供できない場合は出現しない。
0.0~1.0
rightEyeXfloatNo右目の中心座標(x)
0.0~1.0
rightEyeYfloatNo右目の中心座標(y)
0.0~1.0
rightEyeWidthfloatNo右目の領域幅(w)
※領域幅が提供できない場合は出現しない。
0.0~1.0
rightEyeHeightfloatNo右目の領域幅(h)
※領域幅が提供できない場合は出現しない。
0.0~1.0
confidencefloatNo解析の信頼度
0.0~1.0
nosePointsobjectNo
noseXfloatNo鼻の中心座標(x)
0.0~1.0
noseYfloatNo鼻の中心座標(y)
0.0~1.0
noseWidthfloatNo鼻の領域幅(w)
※領域幅が提供できない場合は出現しない。
0.0~1.0
noseHeightfloatNo鼻の領域幅(h)
※領域幅が提供できない場合は出現しない。
0.0~1.0
confidencefloatNo解析の信頼度
0.0~1.0
mouthPointsobjectNo
mouthXfloatNo口の中心座標(x)
0.0~1.0
mouthYfloatNo口の中心座標(y)
0.0~1.0
mouthWidthfloatNo口の領域幅(w)
※領域幅が提供できない場合は出現しない。
0.0~1.0
mouthHeightfloatNo口の領域幅(h)
※領域幅が提供できない場合は出現しない。
0.0~1.0
confidencefloatNo解析の信頼度
0.0~1.0
blinkResultsobjectNo
leftEyefloatNo目つむり度合(左)
0.0~1.0
rightEyefloatNo目つむり度合(右)
0.0~1.0
confidencefloatNo解析の信頼度
0.0~1.0
ageResultsobjectNo
ageintegerNo年齢
confidencefloatNo解析の信頼度
0.0~1.0
genderResultsobjectNo
genderstringNo性別
male : 男性
female : 女性
confidencefloatNo解析の信頼度
0.0~1.0
faceDirectionResultsobjectNo
yawintegerNo左右方向角度
-180~180[degree]
pitchintegerNo上下方向角度
-180~180[degree]
rollintegerNo顔傾き角度
-180~180[degree]
confidencefloatNo解析の信頼度
0.0~1.0
gazeResultsobjectNo
gazeLRintegerNo左右角度
-90~90[degree]
gateUDintegerNo上下角度
-90~90[degree]
confidencefloatNo解析の信頼度
0.0~1.0
expressionResultsobjectNo
expressionstringNo左右角度
unknown : 無表情
smile : 笑 い/喜び
surprise : 驚き
mad : 怒り
sad : 悲しみ
confidencefloatNo解析の信頼度
0.0~1.0
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "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"
    }
  } ]
}
GET /gotapi/humanDetection/onFaceDetection
API Pattern
one-shot
Summary
顔を検出したときの通知イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
thresholdfloatNo検出しきい値。省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
minWidthfloatNo検出最小サイズ(w)。minHeight < maxHeightとすること、省略時デバイス初期値。
設定できる値の範囲:0.0~1.0
minHeightfloatNo検出最小サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
maxWidthfloatNo検出最大サイズ(w)。minWidth < maxWidthとすること、省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
maxHeightfloatNo検出最大サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
eyeThresholdfloatNo目の座標検出しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
noseThresholdfloatNo鼻の座標検出しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
mouthThresholdfloatNo口の座標検出しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
blinkThresholdfloatNo目つむり検出しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
ageThresholdfloatNo年齢推定しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
genderThresholdfloatNo性別推定しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
faceDirectionThresholdfloatNo顔向き推定しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
gazeThresholdfloatNo視線推定しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
expressionThresholdfloatNo表情推定しきい値。省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
optionsarray(string)No利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。
※使用できるオプションは無し。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
faceDetectsarray(object)Yes顔検出リスト
検出された数分出現する。
eyePointsobjectNo
leftEyeXfloatNo左目の中心座標(x)
0.0~1.0
leftEyeYfloatNo左目の中心座標(y)
0.0~1.0
leftEyeWidthfloatNo左目の領域幅(w)
※領域幅が提供できない場合は出現しない。
0.0~1.0
leftEyeHeightfloatNo左目の領域幅(h)
※領域幅が提供できない場合は出現しない。
0.0~1.0
rightEyeXfloatNo右目の中心座標(x)
0.0~1.0
rightEyeYfloatNo右目の中心座標(y)
0.0~1.0
rightEyeWidthfloatNo右目の領域幅(w)
※領域幅が提供できない場合は出現しない。
0.0~1.0
rightEyeHeightfloatNo右目の領域幅(h)
※領域幅が提供できない場合は出現しない。
0.0~1.0
confidencefloatNo解析の信頼度
0.0~1.0
nosePointsobjectNo
noseXfloatNo鼻の中心座標(x)
0.0~1.0
noseYfloatNo鼻の中心座標(y)
0.0~1.0
noseWidthfloatNo鼻の領域幅(w)
※領域幅が提供できない場合は出現しない。
0.0~1.0
noseHeightfloatNo鼻の領域幅(h)
※領域幅が提供できない場合は出現しない。
0.0~1.0
confidencefloatNo解析の信頼度
0.0~1.0
mouthPointsobjectNo
mouthXfloatNo口の中心座標(x)
0.0~1.0
mouthYfloatNo口の中心座標(y)
0.0~1.0
mouthWidthfloatNo口の領域幅(w)
※領域幅が提供できない場合は出現しない。
0.0~1.0
mouthHeightfloatNo口の領域幅(h)
※領域幅が提供できない場合は出現しない。
0.0~1.0
confidencefloatNo解析の信頼度
0.0~1.0
blinkResultsobjectNo
leftEyefloatNo目つむり度合(左)
0.0~1.0
rightEyefloatNo目つむり度合(右)
0.0~1.0
confidencefloatNo解析の信頼度
0.0~1.0
ageResultsobjectNo
ageintegerNo年齢
confidencefloatNo解析の信頼度
0.0~1.0
genderResultsobjectNo
genderstringNo性別
male : 男性
female : 女性
confidencefloatNo解析の信頼度
0.0~1.0
faceDirectionResultsobjectNo
yawintegerNo左右方向角度
-180~180[degree]
pitchintegerNo上下方向角度
-180~180[degree]
rollintegerNo顔傾き角度
-180~180[degree]
confidencefloatNo解析の信頼度
0.0~1.0
gazeResultsobjectNo
gazeLRintegerNo左右角度
-90~90[degree]
gateUDintegerNo上下角度
-90~90[degree]
confidencefloatNo解析の信頼度
0.0~1.0
expressionResultsobjectNo
expressionstringNo左右角度
unknown : 無表情
smile : 笑 い/喜び
surprise : 驚き
mad : 怒り
sad : 悲しみ
confidencefloatNo解析の信頼度
0.0~1.0
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "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"
    }
  } ]
}
DELETE /gotapi/humanDetection/onHandDetection
API Pattern
event
Summary
手を検出したときの通知イベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/humanDetection/onHandDetection
API Pattern
event
Summary
手を検出したときの通知イベントを開始する。
Description
当該イベントの通知を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
thresholdfloatNo検出しきい値。省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
minWidthfloatNo検出最小サイズ(w)。minHeight < maxHeightとすること、省略時デバイス初期値。
設定できる値の範囲:0.0~1.0
minHeightfloatNo検出最小サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
maxWidthfloatNo検出最大サイズ(w)。minWidth < maxWidthとすること、省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
maxHeightfloatNo検出最大サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
intervallongNoデバイスプラグインがイベントを送信する間隔。
optionsarray(string)No利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。
※使用できるオプションは無し。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
handDetectsarray(object)Yes手検出リスト
検出された数分出現する。
xfloatYes検出領域の中心X座標
0.0~1.0
yfloatYes検出領域の中心Y座標
0.0~1.0
widthfloatNo検出領域のX方向の幅
※領域幅が提供できない場合は出現しない。
0.0~1.0
heightfloatNo検出領域のY方向の幅
※領域幅が提供できない場合は出現しない。
0.0~1.0
confidencefloatYes解析の信頼度
0.0~1.0
profilestringYesプロファイル名。
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
  } ]
}
GET /gotapi/humanDetection/onHandDetection
API Pattern
one-shot
Summary
手を検出したときの通知イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
thresholdfloatNo検出しきい値。省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
minWidthfloatNo検出最小サイズ(w)。minHeight < maxHeightとすること、省略時デバイス初期値。
設定できる値の範囲:0.0~1.0
minHeightfloatNo検出最小サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
maxWidthfloatNo検出最大サイズ(w)。minWidth < maxWidthとすること、省略時はデバイス初期値
設定できる値の範囲:0.0~1.0
maxHeightfloatNo検出最大サイズ(h)。minHeight < maxHeightとすること、省略時はデバイス初期値。
設定できる値の範囲:0.0~1.0
optionsarray(string)No利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。
※使用できるオプションは無し。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
handDetectsarray(object)Yes手検出リスト
検出された数分出現する。
xfloatYes検出領域の中心X座標
0.0~1.0
yfloatYes検出領域の中心Y座標
0.0~1.0
widthfloatNo検出領域のX方向の幅
※領域幅が提供できない場合は出現しない。
0.0~1.0
heightfloatNo検出領域のY方向の幅
※領域幅が提供できない場合は出現しない。
0.0~1.0
confidencefloatYes解析の信頼度
0.0~1.0
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
  } ]
}

Humidity Profile

Ver. 2.0.0

Description

スマートデバイスが計測した湿度を取得する機能を提供するAPI。

Operations

GET /gotapi/humidity
API Pattern
one-shot
Summary
スマートデバイスの湿度を取得する機能を提供する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
humidityfloatYes湿度
湿度センサーが検知した湿度を通知する。
範囲: 0.0 ~ 1.0
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "humidity" : 0.1
}

Illuminance Profile

Ver. 2.0.0

Description

スマートデバイスが計測した照度を取得する機能を提供するAPI。

Operations

GET /gotapi/illuminance
API Pattern
one-shot
Summary
スマートデバイスの照度を取得する機能を提供する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
illuminancefloatYes照度
照度センサーが検知した照度。単位はルクス(lx)。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "illuminance" : 240
}

Key Event Profile

Ver. 2.0.0

Description

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

Operations

DELETE /gotapi/keyevent/onDown
API Pattern
event
Summary
デバイスのキーが押されたことを通知するイベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/keyevent/onDown
API Pattern
event
Summary
デバイスのキーが押されたことを通知するイベントを開始する。
Description
当該イベントの通知を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
keyeventobjectYesKeyEvent
KeyEventのオブジェクト。
idintegerYes離されたKeyのID
configstringNo離されたKeyのConfig
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "keyevent",
  "attribute" : "ondown",
  "keyevent" : {
    "config" : "5",
    "id" : 149
  }
}
GET /gotapi/keyevent/onDown
API Pattern
one-shot
Summary
デバイスのキーが押されたときの情報を取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
keyeventobjectYesKeyEvent
KeyEventのオブジェクト。
idintegerYes離されたKeyのID
configstringNo離されたKeyのConfig
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "keyevent" : {
    "config" : "5",
    "id" : 149
  }
}
DELETE /gotapi/keyevent/onKeyChange
API Pattern
event
Summary
デバイスのキーが押された、または離されたことを通知するイベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/keyevent/onKeyChange
API Pattern
event
Summary
デバイスのキーが押された、または離されたことを通知するイベントを開始する。
Description
当該イベントの通知を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
keyeventobjectYesKeyEvent
KeyEventのオブジェクト。
statestringYes押されたKeyのID
idintegerYes押された、もしくは離された時のKeyのID
configstringNo押された、もしくは離された時のKeyのConfig
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "keyevent",
  "attribute" : "onkeychange",
  "keyevent" : {
    "state" : "up",
    "config" : "5",
    "id" : 149
  }
}
GET /gotapi/keyevent/onKeyChange
API Pattern
one-shot
Summary
デバイスのキーが押された、離された時の情報を取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
keyeventobjectYesKeyEvent
KeyEventのオブジェクト。
statestringYes押されたKeyのID
idintegerYes押された、もしくは離された時のKeyのID
configstringNo押された、もしくは離された時のKeyのConfig
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "keyevent" : {
    "state" : "up",
    "config" : "5",
    "id" : 149
  }
}
DELETE /gotapi/keyevent/onUp
API Pattern
event
Summary
デバイスのキーが離されたことを通知するイベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/keyevent/onUp
API Pattern
event
Summary
デバイスのキーが離されたことを通知するイベントを開始する。
Description
当該イベントの通知を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
keyeventobjectYesKeyEvent
KeyEventのオブジェクト。
idintegerYes押されたKeyのID
configstringNo押されたKeyのConfig
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "keyevent",
  "attribute" : "onup",
  "keyevent" : {
    "config" : "play",
    "id" : 672
  }
}
GET /gotapi/keyevent/onUp
API Pattern
one-shot
Summary
デバイスのキーが離されたときの情報を取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
keyeventobjectYesKeyEvent
KeyEventのオブジェクト。
idintegerYes押されたKeyのID
configstringNo押されたKeyのConfig
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "keyevent" : {
    "config" : "play",
    "id" : 672
  }
}

Light Profile

Ver. 2.0.0

Description

スマートデバイスのライト機能を提供するAPI。

Operations

DELETE /gotapi/light
API Pattern
one-shot
Summary
ライトを消灯するAPI。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
lightIdstringNoライトID。操作の対象となるライト。省略された場合、デフォルトのライトが選択される。
Response
NameTypeRequiredDescription
resultintegerYes0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/light
API Pattern
one-shot
Summary
ライトのステータスを変更するAPI。
Description
ライトの色、明るさ及び、名前の変更ができる。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
lightIdstringNoライトID。操作の対象となるライト。省略された場合、デフォルトのライトが選択される。
namestringYesライト名。
brightnessfloatNoライトの明るさ。ライトの明るさを0.0-1.0で表す。
colorstringNoライトの色。RGB形式の16進数で指定。
flashingarray(long)Noライトの点滅間隔。点滅間隔をカンマ区切りの msecで点灯、消灯を繰り返し指定できる。このパラメータを指定しなかった場合は、 常時点灯。
Response
NameTypeRequiredDescription
resultintegerYes0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/light
API Pattern
one-shot
Summary
ライトを点灯するAPI。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
lightIdstringNoライトID。操作の対象となるライト。省略された場合、デフォルトのライトが選択される。
brightnessfloatNoライトの明るさ。ライトの明るさを0.0-1.0で表す。
colorstringNoライトの色。RGB形式の16進数で指定。
flashingarray(long)Noライトの点滅間隔。点滅間隔をカンマ区切りの msecで点灯、消灯を繰り返し指定できる。このパラメータを指定しなかった場合は、 常時点灯。
Response
NameTypeRequiredDescription
resultintegerYes0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/light
API Pattern
one-shot
Summary
ライトを識別するIDなどを取得するAPI。
Description
スマートデバイスが認識しているライトデバイスの一覧を取得する。取得できる情報には、ライトの識別子、ライトの名前と状態を持つ。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
lightsarray(object)Yesライト一覧
ライト一覧を格納する配列。
lightIdstringYesライトID
ライトを識別するID。
namestringYesライト名
ライト名。
onbooleanYesライトの点灯状態
ライトの点灯状態を示す。
true: 点灯
false: 消灯
configstringYesコンフィグ
ライトに設定がある場合には、ここに文字列としてデータが格納されている。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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"
  } ]
}

Media Stream Recording Profile

Ver. 2.0.0

Description

スマートデバイスによる写真撮影、動画録画または音声録音などの操作を行うAPI。

Operations

GET /gotapi/mediaStreamRecording/mediaRecorder
API Pattern
one-shot
Summary
スマートデバイスから使用可能なレコーダーの一覧を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
recordersarray(object)Yesレコーダーリスト
レコーダー情報の配列。
idstringYesレコーダーID
レコーダーを識別するID。
namestringYesレコーダー名
レコーダー名。
statestringYesレコーダーの状態
レコーダーの状態。
mimeTypestringYesMIME Type
レコーダーのエンコードするタイプ。
configstringYesコンフィグ
カメラに設定がある場合には、ここに文字列としてデータが格納されている。
imageWidthintegerNo画像の横幅
レコーダーの現在の横幅。単位はピクセル。録音の場合は省略可。
imageHeightintegerNo画像の縦幅
レコーダーの現在の縦幅。単位はピクセル。録音の場合は省略可。
previewWidthintegerNoプレビューの横幅
プレビューの現在の横幅。単位はピクセル。録音の場合は省略可。
previewHeightintegerNoプレビューの縦幅
プレビューの現在の縦幅。単位はピクセル。録音の場合は省略可。
previewMaxFrameRatefloatNoプレビューの最大フレームレート
現在のプレビューのフレームレートの最大値。単位はfps。録音の場合は省略可。
audioobjectNo音声情報
録音する音声に関する情報。
channelsintegerYesチャンネル数
音声のチャンネル数。
sampleRatefloatYesサンプルレート
音声のサンプルレート。単位はHz。
sampleSizeintegerYesサンプルサイズ
音声のサンプルサイズ。単位はビット。
blockSizeintegerYesブロックサイズ
音声のブロックサイズ。単位はバイト。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
targetstringNoターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/mediaStreamRecording/onPhoto
API Pattern
event
Summary
スマートデバイスの写真撮影通知イベントを停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/mediaStreamRecording/onPhoto
API Pattern
event
Summary
スマートデバイスの写真撮影通知イベントを開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
photoobjectYes写真データ
撮影された写真データ。
uristringNoURI
撮影された写真のURI。
pathstringYesファイルパス
ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。File APIで使用可能。
mimeTypestringYesMIME Type
撮影された写真のMIME Type。動画・音声を識別するために使用する。
attributestringYesアトリビュート名
serviceIdstringYesサービスID
interfacestringYesインターフェース名
profilestringYesプロファイル名
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "mediastreamrecording",
  "attribute" : "onphoto",
  "photo" : {
    "uri" : "Dummy URI",
    "path" : "Dummy Path",
    "mimeType" : "image/png"
  }
}
GET /gotapi/mediaStreamRecording/onPhoto
API Pattern
one-shot
Summary
スマートデバイスの写真撮影通知イベントを取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
photoobjectYes写真データ
撮影された写真データ。
uristringNoURI
撮影された写真のURI。
pathstringYesファイルパス
ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。File APIで使用可能。
mimeTypestringYesMIME Type
撮影された写真のMIME Type。動画・音声を識別するために使用する。
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy URI",
  "path" : "Dummy Path"
}
DELETE /gotapi/mediaStreamRecording/onRecordingChange
API Pattern
event
Summary
スマートデバイスでの写真撮影、動画撮影または音声録音の状態変化通知イベントを停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/mediaStreamRecording/onRecordingChange
API Pattern
event
Summary
スマートデバイスでの写真撮影、動画撮影または音声録音の状態変化通知イベントを開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名
mediaobjectYesレコーディング情報
レコーディング情報
statusstringYesレコーディングの状態
レコーディングの状態を識別する文字列。
pathstringYesファイルパス
ファイルが存在するパス。ルートはデバイスプラグインごとに違う。File APIで使用可能。
mimeTypestringYesMIME Type
録画・録音が開始されたメディアのMIME Type。このタイプで、動画、音声などを識別する。
errorMessasgestringNoエラーメッセージ
エラー、警告内容を伝える文字列。状態が error、warning の時のみ付加される。省略可能。
serviceIdstringYesサービスID
interfacestringYesインターフェース名
profilestringYesプロファイル名
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "mediastreamrecording",
  "attribute" : "onrecordingchange",
  "media" : {
    "status" : "stop",
    "path" : "Dummy Path",
    "mimeType" : "image/png"
  }
}
GET /gotapi/mediaStreamRecording/onRecordingChange
API Pattern
one-shot
Summary
スマートデバイスでの写真撮影、動画撮影または音声録音の状態変化通知イベントを取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
mediaobjectYesレコーディング情報
レコーディング情報
statusstringYesレコーディングの状態
レコーディングの状態を識別する文字列。
pathstringYesファイルパス
ファイルが存在するパス。ルートはデバイスプラグインごとに違う。File APIで使用可能。
mimeTypestringYesMIME Type
録画・録音が開始されたメディアのMIME Type。このタイプで、動画、音声などを識別する。
errorMessasgestringNoエラーメッセージ
エラー、警告内容を伝える文字列。状態が error、warning の時のみ付加される。省略可能。
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "media" : {
    "status" : "stop",
    "path" : "Dummy Path",
    "mimeType" : "video/3gp"
  }
}
PUT /gotapi/mediaStreamRecording/options
API Pattern
one-shot
Summary
スマートデバイスからサポートしている写真撮影、動画撮影や音声録音のオプションを設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
targetstringNoターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
imageWidthintegerNo撮影時の横幅。単位はピクセル。previewHeightを指定するときは省略不可。Options API GETで返された値以外を指定した場合はパラメータエラー。
imageHeightintegerNo撮影時の縦幅。単位はピクセル。previewWidthを指定するときは省略不可。Options API GETで返された値以外を指定した場合はパラメータエラー。
previewWidthintegerNoプレビュー時の横幅。単位はピクセル。previewHeightを指定するときは省略不可。Options API GETで返された値以外を指定した場合はパラメータエラー。
previewHeightintegerNoプレビュー時の縦幅。単位はピクセル。previewWidthを指定するときは省略不可。Options API GETで返された値以外を指定した場合はパラメータエラー。
previewMaxFrameRatefloatNoプレビュー時の最大フレームレート。単位はfps。範囲は0.0より大きい小数値。
mimeTypestringYesMimeType。動画録画・音声録音するときのエンコードするタイプ。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/mediaStreamRecording/options
API Pattern
one-shot
Summary
スマートデバイスからサポートしている写真撮影、動画撮影や音声録音のオプションを取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
targetstringNoターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
previewSizesarray(object)Noプレビュー時の解像度の一覧
プレビューで利用可能な解像度の一覧。録音の場合、またはプレビューを 提供しない場合は省略可。プラグイン側でリサイズすることでサポートするサイズも含めてよい。
widthintegerYes横幅
画像の横幅。単位はピクセル。
heightintegerYes縦幅
画像の縦幅。単位はピクセル。
imageSizesarray(object)No撮影時の解像度の一覧
レコーダーのサポートする画像の解像度の一覧。録音の場合は省略可。プラグイン側でリサイズすることでサポートするサイズも含めてよい。
widthintegerYes横幅
画像の横幅。単位はピクセル。
heightintegerYes縦幅
画像の縦幅。単位はピクセル。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
mimeTypearray(string)YesMIME Type
録画・録音する際のエンコードするタイプの一覧
versionstringYesDeviceConnectシステムのバージョン名
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/pause
API Pattern
one-shot
Summary
スマートデバイスに対して動画撮影または音声録音の一時停止依頼を送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
targetstringNoターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/mediaStreamRecording/preview
API Pattern
streaming
Summary
スマートデバイスでの動画撮影中に、動画のプレビュー画像を受信を停止する。
Description
このイベント通知を行うタイミングに規定は無く、デバイスプラグインの実装依存とする。MotionJPEGでデータを受信する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
targetstringNoターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/mediaStreamRecording/preview
API Pattern
streaming
Summary
スマートデバイスでの動画撮影中に、動画のプレビュー画像を受信を開始する。
Description
このイベント通知を行うタイミングに規定は無く、デバイスプラグインの実装依存とする。MotionJPEGでデータを受信する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
targetstringNoターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
audioobjectNo音声配信情報
音声配信に関する情報。音声のみの配信をサポートしない場合は省略可。
uristringYes音声配信URI
音声配信URI。
versionstringYesDeviceConnectシステムのバージョン名
uristringYesプレビュー配信URI
開始したプレビューの配信用URI。形式はMotionJPEGとする。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy Preview URI"
}
GET /gotapi/mediaStreamRecording/preview
API Pattern
one-shot
Summary
スマートデバイスでの動画撮影中に、動画のプレビュー画像を取得する。
Description
このイベント通知を行うタイミングに規定は無く、デバイスプラグインの実装依存とする。JPEGでデータを受信する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
targetstringNoターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
uristringYesプレビュー画像URI
プレビュー画像URI。形式はJPEGとする。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy Preview URI"
}
POST /gotapi/mediaStreamRecording/record
API Pattern
one-shot
Summary
スマートデバイスに対して、動画撮影や音声録音の開始リクエストを送る。
Description
MediaStreamRecording Stopされない場合は各デバイスが撮影できる最大時間まで撮影を行い、その後撮影を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
targetstringNoターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
timeslicelongNoタイムスライス。動画・音声入力などから得られた1フレームを新たに出力先メディアに書き出すまでの待ち時間。単位はミリ秒。1000/timesliceが出力メディアの固定フレームレート(フレーム/秒)に相当する。省略された場合には、デバイス毎の挙動でフレーム書き出しを行う。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
pathstringYesファイルパス
動画または音声へのファイルパス。ルートはデバイスプラグインごとに異なる。File APIのパラメータとして使用可能。
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
uristringYesURI
動画または音声のURI。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
targetstringNoターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/mediaStreamRecording/stop
API Pattern
one-shot
Summary
スマートデバイスに対して動画撮影または音声録音の終了リクエストを送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
targetstringNoターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/mediaStreamRecording/takePhoto
API Pattern
one-shot
Summary
スマートデバイスに対して写真撮影リクエストを送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
targetstringNoターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
pathstringYesファイルパス
撮影された写真へのファイルパス。ルートはデバイスプラグインごとに異なる。File APIのパラメータとして使用可能。
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
uristringYesURI
撮影された写真のURI。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
targetstringNoターゲット。レコーダーを識別するID。省略された場合にはデフォルトのレコーダーを使用する。デバイスが音声・動画の両方のレコーダーをサポートする場合、どちらのレコーダーが使用されるかどうかはデバイスプラグイン依存とする。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

MediaPlayer Profile

Ver. 2.0.0

Description

スマートデバイス上のメディアの再生状態の変更要求を通知するAPI。

Operations

PUT /gotapi/mediaPlayer/media
API Pattern
one-shot
Summary
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)を変更する。
Description
メディア再生中にmediaIdを再指定した場合は、新たに指定されたメディアの再生が始まる事とする。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
mediaIdstringYesメディアID。メディアを識別するID。メディアIDは同プロファイルのMediaList APIで取得する。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/mediaPlayer/media
API Pattern
one-shot
Summary
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の情報を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
mediaIdstringYesメディアID。メディアを識別するID。メディアIDは同プロファイルのMediaList APIで取得する。
Response
NameTypeRequiredDescription
productstringYesDeviceConnectシステムの名前
keywordsarray(string)Noキーワード
内容についての各種キーワードをstring配列で返す。
creatorsobjectNo制作者情報
creatorstringYes制作者名
制作を行った個人や法人の名称(楽曲のアーティスト名、動画の制作監督名、配給会社名など)。
rolefloatYes役割
制作者の役割。「Artist」アーティスト名。「Lyrics」作詞者名。「Composer」作曲者名。「Film distributer」映画配給会社名。※上記以外の文字列を自由に設定してもよい。※W3Cでは明確な定義が無い。
descriptionstringNo説明文
内容についての説明。
languagestringNo言語
言語。BCP47で定義されている文字列を設定する。(例)「ja」「en-us」。
mimeTypestringNoMimeType
録画・録音する際のエンコードするMimeType。
titlestringNoタイトル名
楽曲名や動画名等。
typestringNoタイプ名
タイトルの種別。「Music」(楽曲名)、「Movie」(動画名)など。
versionstringYesDeviceConnectシステムのバージョン名
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
durationfloatYes曲の長さ
秒単位。
imageUristringNo画像URI
アルバムカバーや動画サムネイルなどの画像へのURI。
genresarray(string)Noジャンル
ジャンルをstring配列で返す。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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" ]
}
GET /gotapi/mediaPlayer/mediaList
API Pattern
one-shot
Summary
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の一覧を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
mediaIdstringNoメディアID。メディアを識別するID。メディアIDは同プロファイルのMediaList APIで取得する。
querystringNo検索する文字列。部分一致検索を行い、一致対象はレスポンスパラメータのタイトル名(title)、制作者名(creators/creator)。
mimeTypestringNoMimeType。情報を取得するファイルの種別ごとに区切りたい場合は、mimeTypeを指定する 例)video%2F
orderarray(string)No検索結果の並び順。検索結果の並び順。辞書順ソートの基準にするレスポンスパラメータの物理名と昇順・降順をカンマ区切りで指定する。物理名を最初に指定し、次に昇順はascを、降順はdescを指定する。省略時は、order=title,ascをしたのと同等となる。例)duration,asc
offsetintegerNo一覧の開始エントリ位置オフセット。全検索結果エントリの内、取得する一覧の開始エントリの位置を指定する。省略時は全検索結果の先頭エントリからの取得となり、offset=0と同義。レスポンスパラメータの count と併用して、検索結果のページングを実現する。
limitintegerNo一覧エントリ数の上限。取得する一覧のエントリ数の上限。省略もしくは0が指定された場合、全検索結果エントリを返却する。レスポンスパラメータの count と併用して、検索結果のページングを実現する。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
countintegerYes全検索結果の件数
全検索結果の件数。リクエストパラメータの offset および limit と併用して、検索結果のページングを実現する。
productstringYesDeviceConnectシステムの名前
mediaarray(object)Yes検索にヒットしたメディアの情報
mediaIdstringYesメディアID
メディアを識別するID。
mimeTypestringNoMimeType
録画・録音する際のエンコードするMimeType。
titlestringNoタイトル名
楽曲名や動画名等。
typestringNoタイプ名
タイトルの種別。「Music」(楽曲名)、「Movie」(動画名)など。
languagestringNo言語
言語。BCP47で定義されている文字列を設定する。(例)「ja」「en-us」。
descriptionstringNo説明文
内容についての説明。
imageUristringNo画像URI
アルバムカバーや動画サムネイルなどの画像へのURI。
durationfloatNo曲の長さ
秒単位。
creatorsobjectNo制作者情報
creatorstringYes制作者名
制作を行った個人や法人の名称(楽曲のアーティスト名、動画の制作監督名、配給会社名など)。
rolefloatYes役割
制作者の役割。「Artist」アーティスト名。「Lyrics」作詞者名。「Composer」作曲者名。「Film distributer」映画配給会社名。※上記以外の文字列を自由に設定してもよい。※W3Cでは明確な定義が無い。
keywordsarray(string)Noキーワード
内容についての各種キーワードをstring配列で返す。
genresarray(string)Noジャンル
ジャンルをstring配列で返す。
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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" ]
  } ]
}
DELETE /gotapi/mediaPlayer/mute
API Pattern
one-shot
Summary
スマートデバイスのメディアプレイヤー再生音量のミュートを解除する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/mediaPlayer/mute
API Pattern
one-shot
Summary
スマートデバイスのメディアプレイヤー再生音量のミュートを有効にする。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/mediaPlayer/mute
API Pattern
one-shot
Summary
スマートデバイスのメディアプレイヤー再生音量のミュート状態を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
mutebooleanYesミュート状態
再生音量のミュート状態を表す。
true: ミュート有り
false: ミュート無し
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "mute" : false
}
DELETE /gotapi/mediaPlayer/onStatusChange
API Pattern
event
Summary
スマートデバイスのコンテンツ再生状態の変化(音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更)通知イベントを停止する。
Description
再生位置の変化はイベント通知対象ではないが、先述のコンテンツ再生状態の変化通知の際、再生位置が併せて通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/mediaPlayer/onStatusChange
API Pattern
event
Summary
スマートデバイスのコンテンツ再生状態の変化(音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更)通知イベントを開始する。
Description
再生位置の変化はイベント通知対象ではないが、先述のコンテンツ再生状態の変化通知の際、再生位置が併せて通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名
serviceIdstringYesサービスID
interfacestringYesインターフェース名
mediaPlayerobjectYesPlayer情報
statusstringYes状態
メディアプレイヤーの状態。
play : 再生
stop : 再生停止
mute : ミュート
unmute : ミュート解除
pause : 一時停止
resume : 一時停止解除
media : 再生コンテンツ変更
volume : 音量変更
complete : 再生完了
mediaIdstringYesメディアID
メディアを識別するID。
mimeTypestringNoMimeType
録画・録音が開始されたメディアのMimeType。このタイプで、動画、音声などを識別する。
posstringNo再生位置
トラックの再生位置を秒単位で返す。
volumestringNoメディア再生音量
メディアの再生音量を0から1の割合で表す。
範囲 (0.0 <= volume <= 1.0)
profilestringYesプロファイル名
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "mediaplayer",
  "attribute" : "onstatuschange",
  "mediaPlayer" : {
    "status" : "media",
    "mediaId" : "1234",
    "mimeType" : "application/ogg",
    "pos" : 0,
    "volume" : 1
  }
}
GET /gotapi/mediaPlayer/onStatusChange
API Pattern
one-shot
Summary
スマートデバイスのコンテンツ再生状態の変化(音声または映像の再生・一時停止・ミュート、再生コンテンツ変更、音量変更)通知イベントを取得する。
Description
再生位置の変化はイベント通知対象ではないが、先述のコンテンツ再生状態の変化通知の際、再生位置が併せて通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
mediaPlayerobjectYesPlayer情報
statusstringYes状態
メディアプレイヤーの状態。
play : 再生
stop : 再生停止
mute : ミュート
unmute : ミュート解除
pause : 一時停止
resume : 一時停止解除
media : 再生コンテンツ変更
volume : 音量変更
complete : 再生完了
mediaIdstringYesメディアID
メディアを識別するID。
mimeTypestringNoMimeType
録画・録音が開始されたメディアのMimeType。このタイプで、動画、音声などを識別する。
posstringNo再生位置
トラックの再生位置を秒単位で返す。
volumestringNoメディア再生音量
メディアの再生音量を0から1の割合で表す。
範囲 (0.0 <= volume <= 1.0)
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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/pause
API Pattern
one-shot
Summary
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を一時停止に変更する。
Description
再生中のメディアが無い場合はエラーを返却する。再生中以外の状態で呼び出された場合はエラーを返却する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/mediaPlayer/play
API Pattern
one-shot
Summary
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を再生中に変更する。
Description
再生中のメディアが無い場合はエラーを返却する。停止状態以外の状態で呼び出された場合はエラーを返却する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/mediaPlayer/playStatus
API Pattern
one-shot
Summary
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態(音声・映像の再生・一時停止・ミュート)を取得する。
Description
再生中のメディアが無い場合はエラーを返却する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
statusstringYes再生状態
・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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/mediaPlayer/seek
API Pattern
one-shot
Summary
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生位置を変更する。
Description
再生中のメディアが無い場合はエラーを返却する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
poslongYes再生位置。秒単位。最大値はMedia API(GET)やMediaList APIで取得できるパラメータ duration に相当する。
範囲(0 ≤ pos ≤ duration)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/mediaPlayer/seek
API Pattern
one-shot
Summary
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生位置を取得する。
Description
再生中のメディアが無い場合はエラーを返却する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
posintegerYes再生位置
秒単位。最大値はMedia API(GET)やMediaList APIで取得できるパラメータ duration に相当する。
範囲(0 ≤ pos ≤ duration)
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "pos" : 60
}
PUT /gotapi/mediaPlayer/stop
API Pattern
one-shot
Summary
スマートデバイスの再生コンテンツ(再生対象の音楽、映像)の再生状態を停止に変更する。
Description
再生中のメディアが無い場合はエラーを返却する。再生中以外の状態で呼び出された場合はエラーを返却する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/mediaPlayer/volume
API Pattern
one-shot
Summary
スマートデバイスのメディアプレイヤーの再生音量を変更する。
Description
システム全体の音量を変更したい場合はSettingプロファイルのVolume Setting APIを用いる事。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
volumefloatYes設定したいメディア再生音量。メディアの再生音量を0から1の割合で表す。
範囲 (0.0 <= voleme <= 1.0)
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前に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
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
volumefloatYes設定したいメディア再生音量
メディアの再生音量を0から1の割合で表す。
範囲 (0.0 <= voleme <= 1.0)
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "volume" : 0.25
}

MessageHook Profile

Ver. 2.0.0

Description

メッセージ送受信の機能を提供するAPI。

Operations

GET /gotapi/messageHook/channel
API Pattern
one-shot
Summary
チャンネル一覧を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
channelsarray(object)Yesチャンネル
チャンネルを格納する配列。
idstringYesチャンネル識別子
チャンネルを識別するID。
namestringYesチャンネル名
チャンネルの名前。
typestringYesチャンネルタイプ
チャンネルのタイプ
・facebook
・line
・slack
など
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "channels" : [ {
    "id" : "xxxxxxxx",
    "name" : "名前",
    "type" : "slack"
  }, {
    "id" : "xxxxxxxx",
    "name" : "名前",
    "type" : "slack"
  } ]
}
POST /gotapi/messageHook/message
API Pattern
one-shot
Summary
メッセージを投稿する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
channelIdstringYesチャンネルID。メッセージの投稿先チャンネルID。
textstringNoテキスト。送信する文言。
リソースURIが指定されていない時は省略できない。
resourcestringNoリソースURI。画像、音声、映像などのリソースへのURI。
テキストが指定されていない時は省略できない。
mimeTypestringNoMimeType。送信するリソースのタイプ。
リソースURIが指定されている時は省略できない。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/messageHook/message
API Pattern
one-shot
Summary
直近に受信したメッセージの一覧を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
messagesarray(object)Yesメッセージ
メッセージ情報。
messagerTypestringYesメッセンジャータイプ
メッセンジャーのタイプ
・facebook
・line
・slack
など。
fromlongYes送信元ID
channelIdstringYesチャンネルID
チャンネルを識別するID。
timeStamplongYes投稿した時間
textstringNoチャンネル名
チャンネルの名前。
resourcestringNoリソースURI
送られてきたメッセージのリソースへのURI。
メッセージが指定されていない時は省略されない。
mimeTypestringNoMimeType
リソースのタイプ。
メッセージが指定されていない時は省略されない。
messageTypestringNoメッセージタイプ
normal, direct, mention の文字列(複数になる場合がある「direct, mention」など)
・normal: 通常メッセージ
・direct: ダイレクトメッセージ
・mention: メンション付きメッセージ
#メンション付きのメッセージのtextはメンション部分が削除されます。
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "messages" : [ {
    "messengerType" : "facebook",
    "from" : "abcdef",
    "timeStamp" : 1234567890,
    "channelId" : "1",
    "text" : "ライトをつけて",
    "resource" : "http://www.gclue.io/a.png",
    "mimeType" : "image/png",
    "messageType" : "direct"
  } ]
}
DELETE /gotapi/messageHook/onMessage
API Pattern
event
Summary
直近に受信したメッセージ取得イベントを停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/messageHook/onMessage
API Pattern
event
Summary
直近に受信したメッセージ取得イベントを開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
messageobjectYes
messagerTypestringYesメッセンジャータイプ
メッセンジャーのタイプ
・facebook
・line
・slack
など。
fromlongYes送信元ID
channelIdstringYesチャンネルID
チャンネルを識別するID。
timeStamplongYes投稿した時間
textstringNoチャンネル名
チャンネルの名前。
resourcestringNoリソースURI
送られてきたメッセージのリソースへのURI。
メッセージが指定されていない時は省略されない。
mimeTypestringNoMimeType
リソースのタイプ。
メッセージが指定されていない時は省略されない。
messageTypestringNoメッセージタイプ
normal, direct, mention の文字列(複数になる場合がある「direct, mention」など)
・normal: 通常メッセージ
・direct: ダイレクトメッセージ
・mention: メンション付きメッセージ
#メンション付きのメッセージのtextはメンション部分が削除されます。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "messageHook",
  "attribute" : "onMessage",
  "message" : {
    "messengerType" : "xxxx",
    "from" : "abcdef",
    "timeStamp" : 1234567890,
    "channelId" : "1",
    "text" : "ライトをつけて",
    "resource" : "http://org.deviceconnect/test.png",
    "mimeType" : "image/png",
    "messageType" : "direct"
  }
}
GET /gotapi/messageHook/onMessage
API Pattern
one-shot
Summary
直近に受信したメッセージの一覧を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
messageobjectYes
messagerTypestringYesメッセンジャータイプ
メッセンジャーのタイプ
・facebook
・line
・slack
など。
fromlongYes送信元ID
channelIdstringYesチャンネルID
チャンネルを識別するID。
timeStamplongYes投稿した時間
textstringNoチャンネル名
チャンネルの名前。
resourcestringNoリソースURI
送られてきたメッセージのリソースへのURI。
メッセージが指定されていない時は省略されない。
mimeTypestringNoMimeType
リソースのタイプ。
メッセージが指定されていない時は省略されない。
messageTypestringNoメッセージタイプ
normal, direct, mention の文字列(複数になる場合がある「direct, mention」など)
・normal: 通常メッセージ
・direct: ダイレクトメッセージ
・mention: メンション付きメッセージ
#メンション付きのメッセージのtextはメンション部分が削除されます。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "message" : {
    "messengerType" : "xxxx",
    "from" : "abcdef",
    "timeStamp" : 1234567890,
    "channelId" : "1",
    "text" : "ライトをつけて",
    "resource" : "http://org.deviceconnect/test.png",
    "mimeType" : "image/png",
    "messageType" : "direct"
  }
}

Notification Profile

Ver. 2.0.0

Description

スマートデバイスのノーティフィケーションを操作する機能。

Operations

DELETE /gotapi/notification/notify
API Pattern
one-shot
Summary
スマートデバイスにノーティフィケーションの消去要求をする。
Description
ノーティフィケーションの消去要求の到達成否を応答として返却し、ノーティフィケーションの消去完了を待って応答をするわけではない。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
notificationIdstringYes通知ID。ユニークな文字列。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
POST /gotapi/notification/notify
API Pattern
one-shot
Summary
スマートデバイスにノーティフィケーションの表示要求をする。
Description
ノーティフィケーションの表示要求の到達成否を応答として返却し、ノーティフィケーションの表示完了を待って応答をするわけではない。ノーティフィケーションの表示方法は表示要求を受けたスマートデバイスに依存する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
typeintegerYes通知タイプ。通知のタイプを識別する。
0: 音声通話着信
1: メール着信
2: SMS着信
3: イベント
dirstringNo向き。メッセージの文字の向き。
auto: 自動
rtl: 右から左
ltr: 左から右
langstringNo言語。メッセージの言語。 ref. BCP47
bodystringNoサービスID。取得対象スマートデバイス
tagstringNoタグ。任意タグ文字列 カンマ(,)区切りで任意個数指定。
uristringNoアイコン。アイコンファイルのURI。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
notificationIdstringYesノーティフィケーションID
ユニークな文字列。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}
DELETE /gotapi/notification/onClick
API Pattern
event
Summary
スマートデバイスのノーティフィケーションがクリックされたことを通知するイベントを停止する。
Description
スマートデバイスでノーティフィケーションがクリック(タップ)された時にイベントが発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/notification/onClick
API Pattern
event
Summary
スマートデバイスのノーティフィケーションがクリックされたことを通知するイベントを開始する。
Description
スマートデバイスでノーティフィケーションがクリック(タップ)された時にイベントが発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
notificationIdstringYesノーティフィケーションID
ノーティフィケーションを識別するID。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "notification",
  "attribute" : "onclick",
  "notificationId" : 123456
}
GET /gotapi/notification/onClick
API Pattern
one-shot
Summary
スマートデバイスのノーティフィケーションがクリックされたことを通知するイベントを取得する。
Description
スマートデバイスでノーティフィケーションがクリック(タップ)された時にイベントが発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
notificationIdstringYesノーティフィケーションID
ノーティフィケーションを識別するID。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}
DELETE /gotapi/notification/onClose
API Pattern
event
Summary
スマートデバイスのノーティフィケーションが消去されたことを通知するイベントを停止する。
Description
ユーザ操作による消去、プログラムからの消去要求による消去のいずれのイベントでもイベントは発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/notification/onClose
API Pattern
event
Summary
スマートデバイスのノーティフィケーションが消去されたことを通知するイベントを開始する。
Description
ユーザ操作による消去、プログラムからの消去要求による消去のいずれのイベントでもイベントは発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
notificationIdstringYesノーティフィケーションID
ノーティフィケーションを識別するID。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "notification",
  "attribute" : "onclose",
  "notificationId" : 123456
}
GET /gotapi/notification/onClose
API Pattern
one-shot
Summary
スマートデバイスのノーティフィケーションが消去されたことを通知するイベントを取得する。
Description
ユーザ操作による消去、プログラムからの消去要求による消去のいずれのイベントでもイベントは発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
notificationIdstringYesノーティフィケーションID
ノーティフィケーションを識別するID。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}
DELETE /gotapi/notification/onError
API Pattern
event
Summary
スマートデバイスのノーティフィケーション操作でエラーが発生したことを通知するイベントを停止する。
Description
スマートデバイスでノーティフィケーション操作でエラーが発生した時にイベントが発行される。表示要求に対する表示失敗のエラー、非表示要求に対する消去失敗のエラーなどが通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/notification/onError
API Pattern
event
Summary
スマートデバイスのノーティフィケーション操作でエラーが発生したことを通知するイベントを開始する。
Description
スマートデバイスでノーティフィケーション操作でエラーが発生した時にイベントが発行される。表示要求に対する表示失敗のエラー、非表示要求に対する消去失敗のエラーなどが通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
notificationIdstringYesノーティフィケーションID
ノーティフィケーションを識別するID。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "notification",
  "attribute" : "onerror",
  "notificationId" : 123456
}
GET /gotapi/notification/onError
API Pattern
one-shot
Summary
スマートデバイスのノーティフィケーション操作でエラーが発生したことを通知するイベントを取得する。
Description
スマートデバイスでノーティフィケーション操作でエラーが発生した時にイベントが発行される。表示要求に対する表示失敗のエラー、非表示要求に対する消去失敗のエラーなどが通知される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
notificationIdstringYesノーティフィケーションID
ノーティフィケーションを識別するID。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}
DELETE /gotapi/notification/onShow
API Pattern
event
Summary
スマートデバイスのノーティフィケーションが表示されたことを通知するイベントを停止する。
Description
スマートデバイスでノーティフィケーションが表示された時にイベントが発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/notification/onShow
API Pattern
event
Summary
スマートデバイスのノーティフィケーションが表示されたことを通知するイベントを開始する。
Description
スマートデバイスでノーティフィケーションが表示された時にイベントが発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
notificationIdstringYesノーティフィケーションID
ノーティフィケーションを識別するID。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "notification",
  "attribute" : "onshow",
  "notificationId" : 123456
}
GET /gotapi/notification/onShow
API Pattern
one-shot
Summary
スマートデバイスのノーティフィケーションが表示されたことを通知するイベントを取得する。
Description
スマートデバイスでノーティフィケーションが表示された時にイベントが発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
notificationIdstringYesノーティフィケーションID
ノーティフィケーションを識別するID。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "notificationId" : 123456
}

Omnidirectional Image Profile

Ver. 2.0.0

Description

全方位パノラマ画像をROI画像へ変換する機能を提供する。
※ROI:Region of Imageのこと。

Operations

DELETE /gotapi/omnidirectionalImage/roi
API Pattern
streaming
Summary
ROI画像の受信を終了する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
uristringYesROI画像URI。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/omnidirectionalImage/roi
API Pattern
streaming
Summary
ROI画像の受信を開始するAPI。
Description
本APIのレスポンスで返されるURIでROI画像を参照できる。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
sourcestringYes全方位パノラマ画像URI。ROI画像に変換する全方位パノラマ画像のURI。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
uristringYesROI画像配信サーバURI
ROI画像を配信するサーバのURIを示す。配信される画像の形式はMotionJPEGとする。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy Preview URI"
}
PUT /gotapi/omnidirectionalImage/roi/settings
API Pattern
one-shot
Summary
ROI画像の設定を変更する。
Description
注1: OpenGLで実装する場合、ワールド座標上の長さ1は実世界上の1メートルに換算する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
uristringYesROI画像URI。
xfloatNo視点の絶対座標 (x)。ワールド座標上の視点の絶対座標(前後方向)。単位はメートル。(注1)指定なしの場合は 0.0。
yfloatNo視点の絶対座標 (y)。ワールド座標上の視点の絶対座標(左右方向)。以下、同上。
zfloatNo視点の絶対座標 (z)。ワールド座標上の視点の絶対座標(上下方向)。以下、同上。
rollfloatNo視点の回転 (ロール)。ワールド座標系に対する視点の回転(前後方向の軸中心)。単位はdegree。角度の範囲は0.0〜360.0。0.0, 360.0は撮影時の角度とする。指定なしの場合は0.0。配信開始時の視点の向きは全方位パノラマ画像の中央点。回転の順番はroll, pitch, yawの順。
pitchfloatNo視点の回転 (ピッチ)。ワールド座標系に対する視点の回転(左右方向の軸中心)。以下、同上。
yawfloatNo視点の回転 (ヨー)。ワールド座標系に対する視点の回転(上下方向の軸中心)。以下、同上。
fovfloatNo視点の画角。視点の画角。角度の範囲は0.0〜180.0。単位はdegree。指定なしの場合は90度。
sphereSizefloatNo天球の大きさ。天球の大きさを半径で指定。単位はメートル。(注1)指定なしの場合は 1。
widthintegerNoROI画像のサイズ (横)。配信されるROI画像の横サイズ。単位はピクセル。指定なしの場合は600。ステレオ画像生成フラグがtrueの場合、左右それぞれに対しての画像のサイズとして適用される。(よって、ステレオ画像全体としての横幅は 2 * width となる)
heightintegerNoROI画像のサイズ (縦)。配信されるROI画像の縦サイズ。単位はピクセル。指定なしの場合は400。
stereobooleanNoステレオ画像生成フラグ。trueの場合、ROI画像がステレオ画像形式で配信されるようになる。(ステレオ画像左右の視点が) 指定なしの場合はfalse。
vrbooleanNo仮想現実モードフラグ。trueの場合、仮想現実モード(ホストデバイスの向きとROIの向きを連動させるモード)をONにする。指定なしの場合はfalse。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前に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
API Pattern
one-shot
Summary
スマートフォンに対して電話発信要求をリクエストする。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
phoneNumberstringYes電話番号。電話番号を示す文字列。文字には数字の0〜9のみを使用可能。長さは11桁または13桁のいずれかとする。11桁は国内電話、13桁は国際電話として扱う。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/phone/onConnect
API Pattern
event
Summary
スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/phone/onConnect
API Pattern
event
Summary
スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
phoneStatusobjectYes電話機能の状態
電話機能の状態を保持するオブジェクト。特定の相手先との通話状態の変化を通知する。
phoneNumberstringYes電話番号
相手先の電話番号を示す文字列。文字には数字の0〜9のみを使用可能。長さは11桁または13桁のいずれかとする。11桁は国内電話、13桁は国際電話として扱う。
statefloatYes通話状態
通話状態を示す定数。
0: 通話開始
1: 通話失敗
2: 通話終了
attributestringYesアトリビュート名
serviceIdstringYesサービスID
interfacestringYesインターフェース名
profilestringYesプロファイル名
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "phone",
  "attribute" : "onconnect",
  "phoneStatus" : {
    "phoneNumber" : "01234567890",
    "state" : 2
  }
}
GET /gotapi/phone/onConnect
API Pattern
one-shot
Summary
スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
phoneStatusobjectYes電話機能の状態
電話機能の状態を保持するオブジェクト。特定の相手先との通話状態の変化を通知する。
phoneNumberstringYes電話番号
相手先の電話番号を示す文字列。文字には数字の0〜9のみを使用可能。長さは11桁または13桁のいずれかとする。11桁は国内電話、13桁は国際電話として扱う。
statefloatYes通話状態
通話状態を示す定数。
0: 通話開始
1: 通話失敗
2: 通話終了
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "phoneStatus" : {
    "phoneNumber" : "01234567890",
    "state" : 2
  }
}
PUT /gotapi/phone/set
API Pattern
one-shot
Summary
スマートフォンに対して電話に関する設定項目(サイレント・マナー・音あり)の設定をリクエストする。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modeintegerYes電話のモード。電話のモードを指定
0:サイレント
1:マナー
2:音あり
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

PoseEstimation Profile

Ver. 2.0.0

Description

デバイスの姿勢推定のイベントを通知するための機能。

Operations

DELETE /gotapi/poseEstimation/onPoseEstimation
API Pattern
event
Summary
デバイスの姿勢推定計測イベントを停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/poseEstimation/onPoseEstimation
API Pattern
event
Summary
デバイスの姿勢推定計測イベントを開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
poseobjectYes
statestringYes姿勢状態
ターゲットデバイスによって測定された姿勢状態を返す。
  • Forward:前屈
  • Backward:後屈
  • Rightside:右傾き
  • Leftside:左傾き
  • FaceUp:仰向け
  • FaceLeft:左向き
  • FaceDown:うつ伏せ
  • FaceRight:右向き
  • Standing:直立
timeStamplongYes姿勢推定のタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringlongYes姿勢推定のタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "poseestimation",
  "attribute" : "onposeestimation",
  "pose" : {
    "state" : "FaceUp",
    "timeStamp" : 1483241696789,
    "timeStampString" : "20170101123456.789+0900"
  }
}
GET /gotapi/poseEstimation/onPoseEstimation
API Pattern
one-shot
Summary
デバイスの姿勢推定計測イベントを取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
poseobjectYes
statestringYes姿勢状態
ターゲットデバイスによって測定された姿勢状態を返す。
  • Forward:前屈
  • Backward:後屈
  • Rightside:右傾き
  • Leftside:左傾き
  • FaceUp:仰向け
  • FaceLeft:左向き
  • FaceDown:うつ伏せ
  • FaceRight:右向き
  • Standing:直立
timeStamplongYes姿勢推定のタイムスタンプ
測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringlongYes姿勢推定のタイムスタンプ文字列
タイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "pose" : {
    "state" : "FaceUp",
    "timeStamp" : 1483241696789,
    "timeStampString" : "20170101123456.789+0900"
  }
}

Power Profile

Ver. 2.0.0

Description

スマートデバイスの電源状態を操作する。

Operations

DELETE /gotapi/power
API Pattern
one-shot
Summary
機器の電源をOFFにする。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/power
API Pattern
one-shot
Summary
機器の電源をONにする。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/power
API Pattern
one-shot
Summary
機器の電源の状態を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス

Power Meter Profile

Ver. 2.0.0

Description

スマートデバイスが計測した電力を取得する機能を提供するAPI。

Operations

DELETE /gotapi/powerMeter
API Pattern
one-shot
Summary
スマートデバイスの電源を消す。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/powerMeter
API Pattern
one-shot
Summary
スマートデバイスの電源を付ける。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/powerMeter
API Pattern
one-shot
Summary
スマートデバイスの電源状態を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
powerstatestringYes電源状態
電源状態を示す文字列。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "powerstate" : "OFF"
}
GET /gotapi/powerMeter/instantaneousPower
API Pattern
one-shot
Summary
スマートデバイスが計測した瞬間電力量を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
instantaneouspowervaluefloatYes瞬間電力量
瞬間電力量を表す実数。単位はW。
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "instantaneouspowervalue" : 38.4
}
GET /gotapi/powerMeter/integratedPower
API Pattern
one-shot
Summary
スマートデバイスが計測した積算電力量を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
datedateTimeNo取得日付。RFC 3339 例: 2014-01-01T00:00:00+0900
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
integratedpowervaluearray(float)Yes積算電力量
サイズが24のnumberの配列。各値は積算電力量を表す実数。単位はWh。時間順に格納されているため、最初の要素は24時間前のもの。

例: リクエストで date=2015-08-24T15:14:00+0900 を指定した場合、0から23までの各インデックスに対応する時間帯は下記のとおり。
0 : 2015-08-23T15:00 ~ 15:59
:
23 :2015-08-24T14:00 ~ 14:59
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "integratedpowervalue" : [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304 ]
}

Proximity Profile

Ver. 2.0.0

Description

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

Operations

DELETE /gotapi/proximity/onDeviceProximity
API Pattern
event
Summary
スマートデバイスの近接センサーの物の検知を通知するイベントを停止する。
Description
スマートデバイスの近接センサーの情報を近接距離最小/最大値の範囲で連続的にイベント発行する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名
serviceIdstringYesサービスID
interfacestringYesインターフェース名
proximityobjectYes
valueintegerNo近接距離
cm単位の距離。
minintegerNo近接距離最小値
cm単位の距離。
maxintegerNo近接距離最大値
cm単位の距離。
thresholdintegerNo閾値
cm単位の距離の閾値。
rangestringNo距離識別子
距離を示す文字列。
profilestringYesプロファイル名
PUT /gotapi/proximity/onDeviceProximity
API Pattern
event
Summary
スマートデバイスの近接センサーの物の検知を通知するイベントを開始する。
Description
スマートデバイスの近接センサーの情報を近接距離最小/最大値の範囲で連続的にイベント発行する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名
serviceIdstringYesサービスID
interfacestringYesインターフェース名
proximityobjectYes
valueintegerNo近接距離
cm単位の距離。
minintegerNo近接距離最小値
cm単位の距離。
maxintegerNo近接距離最大値
cm単位の距離。
thresholdintegerNo閾値
cm単位の距離の閾値。
rangestringNo距離識別子
距離を示す文字列。
profilestringYesプロファイル名
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"
  }
}
GET /gotapi/proximity/onDeviceProximity
API Pattern
one-shot
Summary
スマートデバイスの近接センサーの物の検知を通知するイベントを取得する。
Description
スマートデバイスの近接センサーの情報を近接距離最小/最大値の範囲で連続的にイベント発行する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
proximityobjectYes
valueintegerNo近接距離
cm単位の距離。
minintegerNo近接距離最小値
cm単位の距離。
maxintegerNo近接距離最大値
cm単位の距離。
thresholdintegerNo閾値
cm単位の距離の閾値。
rangestringNo距離識別子
距離を示す文字列。
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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"
  }
}
DELETE /gotapi/proximity/onUserProximity
API Pattern
event
Summary
スマートデバイスの近接センサーのユーザ検知を通知するイベントを停止する。
Description
ユーザ検知とは、例えば通話時にスマートフォンの画面を耳元に近接させた場合等に発生する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名
serviceIdstringYesサービスID
interfacestringYesインターフェース名
proximityobjectYes
nearbooleanYes近接の有無
ユーザがデバイスに近接しているかどうか。
true: 近接している
false: 近接していない
profilestringYesプロファイル名
PUT /gotapi/proximity/onUserProximity
API Pattern
event
Summary
スマートデバイスの近接センサーのユーザ検知を通知するイベントを開始する。
Description
ユーザ検知とは、例えば通話時にスマートフォンの画面を耳元に近接させた場合等に発生する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名
serviceIdstringYesサービスID
interfacestringYesインターフェース名
proximityobjectYes
nearbooleanYes近接の有無
ユーザがデバイスに近接しているかどうか。
true: 近接している
false: 近接していない
profilestringYesプロファイル名
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "proximity",
  "attribute" : "onuserproximity",
  "proximity" : {
    "near" : true
  }
}
GET /gotapi/proximity/onUserProximity
API Pattern
one-shot
Summary
スマートデバイスの近接センサーのユーザ検知を通知するイベントを取得する。
Description
ユーザ検知とは、例えば通話時にスマートフォンの画面を耳元に近接させた場合等に発生する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes処理結果
0: 正常応答
0以外: 異常応答
productstringYesDeviceConnectシステムの名前
versionstringYesDeviceConnectシステムのバージョン名
proximityobjectYes
nearbooleanYes近接の有無
ユーザがデバイスに近接しているかどうか。
true: 近接している
false: 近接していない
hmacstringNoレスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "proximity" : {
    "near" : true
  }
}

Remote Controller Profile

Ver. 2.0.0

Description

スマートデバイスが保持する赤外線などの信号の送受信機能を提供するAPI。

Operations

POST /gotapi/remoteController
API Pattern
one-shot
Summary
スマートデバイスに対して赤外線などの信号送信依頼を送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
messagestringYesメッセージ(赤外線など)。赤外線などの信号。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/remoteController
API Pattern
one-shot
Summary
スマートデバイスが保持する赤外線などの信号を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
messagestringYesメッセージ(赤外線など)
赤外線などの信号。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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]}"
}

ServiceInformation Profile

Ver. 2.0.0

Description

Operations

GET /gotapi/serviceInformation
API Pattern
one-shot
Summary
Parameters
NameTypeRequiredDescription
serviceIdstringYes

ServiceDiscovery Profile

Ver. 2.0.0

Description

Operations

GET /gotapi/servicediscovery
API Pattern
one-shot
Summary
Parameters
NameTypeRequiredDescription
DELETE /gotapi/servicediscovery/onServiceChange
API Pattern
event
Summary
Parameters
NameTypeRequiredDescription
PUT /gotapi/servicediscovery/onServiceChange
API Pattern
event
Summary
Parameters
NameTypeRequiredDescription
GET /gotapi/servicediscovery/onServiceChange
API Pattern
one-shot
Summary
Parameters
NameTypeRequiredDescription

Setting Profile

Ver. 2.0.0

Description

スマートデバイスの各種設定状態の取得および設定機能を提供するプロファイル。

Operations

PUT /gotapi/setting/date
API Pattern
one-shot
Summary
スマートデバイスの日時の設定依頼を送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
datedateTimeYesRFC3339形式の日付。 例: 2014-01-01T00:00:00+0900
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/setting/date
API Pattern
one-shot
Summary
スマートデバイスの日時を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
datedateTimeYesRFC3339形式の日付。 例: 2014-01-01T00:00:00+0900
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "date" : "2017-01-01 12:34:56+0900"
}
PUT /gotapi/setting/display/brightness
API Pattern
one-shot
Summary
スマートデバイスのライト明度の設定依頼を送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
levelfloatYesディスプレイの輝度を割合で示す 範囲 (0.0 <= level <= 1.0)
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/setting/display/brightness
API Pattern
one-shot
Summary
スマートデバイスのライト明度を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
levelfloatYesディスプレイの輝度を割合で示す 範囲 (0.0 <= level <= 1.0)
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "level" : 0.5
}
PUT /gotapi/setting/display/sleep
API Pattern
one-shot
Summary
スマートデバイスの画面消灯設定依頼を送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
timelongYesディスプレイが消灯するまでの時間 (ミリ秒)
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/setting/display/sleep
API Pattern
one-shot
Summary
スマートデバイスの画面消灯設定を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
timelongYesディスプレイが消灯するまでの時間 (ミリ秒)
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "time" : 120000
}
PUT /gotapi/setting/sound/volume
API Pattern
one-shot
Summary
スマートデバイスの音量の設定依頼を送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
kindintegerYes|Value|Description| |:-----|:-----| |1|Alarm| |2|Voice Volume| |3|Ring Alert| |4|Incoming Mail Alert| |5|Media Player| |6|Other|
levelfloatYes音量を割合で示す。(0.0 <= level <= 1.0)
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/setting/sound/volume
API Pattern
one-shot
Summary
スマートデバイスの音量を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
kindintegerYes|Value|Description| |:-----|:-----| |1|Alarm| |2|Voice Volume| |3|Ring Alert| |4|Incoming Mail Alert| |5|Media Player| |6|Other|
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
levelfloatYes音量を割合で示す。(0.0 <= level <= 1.0)
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "level" : 1
}

Sphero Profile

Ver. 2.0.0

Description

Spheroに搭載されているセンサーの値を通知するプロファイル。

Operations

DELETE /gotapi/sphero/collision/onCollision
API Pattern
event
Summary
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/sphero/collision/onCollision
API Pattern
event
Summary
Spheroの衝突イベントの受信を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
intervallongNoイベント受信間隔。単位:mSec
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
collisionobjectYes衝突イベントオブジェクト。
impactAccelerationobjectNo衝突加速度。
xfloatYesx軸方向への加速度(cm/s2)
yfloatYesy軸方向への加速度(cm/s2)
zfloatYesz軸方向への加速度(cm/s2)
impactAxisobjectNo衝突軸。
xbooleanYesx軸成分。
ybooleanYesy軸成分。
impactPowerobjectNo衝突力。
xfloatYesx軸成分。
yfloatYesy軸成分。
impactSpeedfloatNo衝突速度(単位: cm/s)
impactTimestamplongNo衝突した時間のタイムスタンプ(単位: ミリ秒)
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
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,
    "impactAcceleration" : {
      "x" : -1.57421875,
      "y" : -1.53076171875,
      "z" : 0
    }
  }
}
GET /gotapi/sphero/collision/onCollision
API Pattern
one-shot
Summary
Spheroの衝突イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
collisionobjectYes衝突イベントオブジェクト。
impactAccelerationobjectNo衝突加速度。
xfloatYesx軸方向への加速度(cm/s2)
yfloatYesy軸方向への加速度(cm/s2)
zfloatYesz軸方向への加速度(cm/s2)
impactAxisobjectNo衝突軸。
xbooleanYesx軸成分。
ybooleanYesy軸成分。
impactPowerobjectNo衝突力。
xfloatYesx軸成分。
yfloatYesy軸成分。
impactSpeedfloatNo衝突速度(単位: cm/s)
impactTimestamplongNo衝突した時間のタイムスタンプ(単位: ミリ秒)
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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,
    "impactAcceleration" : {
      "x" : -1.57421875,
      "y" : -1.53076171875,
      "z" : 0
    }
  }
}
DELETE /gotapi/sphero/locator/onLocator
API Pattern
event
Summary
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/sphero/locator/onLocator
API Pattern
event
Summary
Spheroの位置と速度を通知するイベントの受信を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
intervallongNoイベント受信間隔。単位:mSec
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
locatorobjectYesSpheroの位置座標オブジェクト。
positionXfloatYes位置のx座標 (単位: cm)
positionYfloatYes位置のy座標 (単位: cm)
velocityXfloatYes速度のx成分 (単位:cm/s)
velocityYfloatYes速度のy成分 (単位:cm/s)
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "sphero",
  "interface" : "locator",
  "attribute" : "onlocator",
  "locator" : {
    "positionX" : -3,
    "positionY" : 5,
    "velocityX" : -10,
    "velocityY" : -1.5
  }
}
GET /gotapi/sphero/locator/onLocator
API Pattern
one-shot
Summary
Spheroの位置と速度を通知するイベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
locatorobjectYesSpheroの位置座標オブジェクト。
positionXfloatYes位置のx座標 (単位: cm)
positionYfloatYes位置のy座標 (単位: cm)
velocityXfloatYes速度のx成分 (単位:cm/s)
velocityYfloatYes速度のy成分 (単位:cm/s)
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "locator" : {
    "positionX" : -3,
    "positionY" : 5,
    "velocityX" : -10,
    "velocityY" : -1.5
  }
}
DELETE /gotapi/sphero/quaternion/onQuaternion
API Pattern
event
Summary
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/sphero/quaternion/onQuaternion
API Pattern
event
Summary
Spheroの四元数を通知するイベントの受信を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
intervallongNoイベント受信間隔。単位:mSec
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
quaternionobjectYes四元数オブジェクト。
q0floatYesi軸
q1floatYesj軸
q2floatYesk軸
q3floatYess軸
intervallongYes計測のインターバル。(単位: ミリ秒)
profilestringYesプロファイル名。
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
  }
}
GET /gotapi/sphero/quaternion/onQuaternion
API Pattern
one-shot
Summary
Spheroの四元数を通知するイベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
quaternionobjectYes四元数オブジェクト。
q0floatYesi軸
q1floatYesj軸
q2floatYesk軸
q3floatYess軸
intervallongYes計測のインターバル。(単位: ミリ秒)
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
  }
}

StressEstimation Profile

Ver. 2.0.0

Description

ストレス推定のイベントを通知するプロファイル。

Operations

DELETE /gotapi/stressEstimation/onStressEstimation
API Pattern
event
Summary
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/stressEstimation/onStressEstimation
API Pattern
event
Summary
デバイスのストレス推定計測イベントの受信を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
intervallongNoイベント受信間隔。単位:mSec
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
stressobjectYes
lfhffloatYesターゲットデバイスによって測定されたLFHF値。
timeStamplongYes測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringYesタイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "stressestimation",
  "attribute" : "onstressestimation",
  "stress" : {
    "lfhf" : 0.5,
    "timeStamp" : 1483241696789,
    "timeStampString" : "20170101123456.789+0900"
  }
}
GET /gotapi/stressEstimation/onStressEstimation
API Pattern
one-shot
Summary
デバイスのストレス推定計測イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
stressobjectYes
lfhffloatYesターゲットデバイスによって測定されたLFHF値。
timeStamplongYes測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
timeStampStringstringYesタイムスタンプと同じタイムスタンプを「YYYYMMDDHHMMSS.sss+/-HHMM」の形式で返す。
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "stress" : {
    "lfhf" : 0.5,
    "timeStamp" : 1483241696789,
    "timeStampString" : "20170101123456.789+0900"
  }
}

System Profile

Ver. 2.0.0

Description

Operations

GET /gotapi/system
API Pattern
one-shot
Summary
Parameters
NameTypeRequiredDescription
PUT /gotapi/system/device/wakeup
API Pattern
one-shot
Summary
Parameters
NameTypeRequiredDescription
pluginIdstringYes
DELETE /gotapi/system/events
API Pattern
one-shot
Summary
Parameters
NameTypeRequiredDescription
PUT /gotapi/system/keyword
API Pattern
one-shot
Summary
Parameters
NameTypeRequiredDescription

Temperature Profile

Ver. 2.0.0

Description

スマートデバイスの計測または管理している温度を提供するプロファイル。

Operations

PUT /gotapi/temperature
API Pattern
one-shot
Summary
スマートデバイスの温度設定値を設定する。
Description
typeはそれぞれ、1:摂氏、2:華氏を表している。
temperatureに設定できる値は、摂氏の場合は0以上50以下, 華氏の場合は32以上122以下。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
temperatureintegerYes温度の値。
typeintegerNo1:摂氏、2:華氏
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0
}
GET /gotapi/temperature
API Pattern
one-shot
Summary
スマートデバイスの温度設定値を取得する。
Description
typeはそれぞれ、1:摂氏、2:華氏を表している。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
typeintegerNo1:摂氏、2:華氏
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
tempareturefloatYes温度の値。
productstringYesDeviceConnectシステムの名前。
typeintegerYes1:摂氏、2:華氏
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "product" : "Example System",
  "version" : "1.0",
  "result" : 0,
  "temperature" : 25,
  "type" : 1
}

Touch Profile

Ver. 2.0.0

Description

スマートデバイス上でのタッチイベントを通知するプロファイル。

Operations

DELETE /gotapi/touch/onDoubleTap
API Pattern
event
Summary
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/touch/onDoubleTap
API Pattern
event
Summary
デバイスでダブルタップされたイベントの受信を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
intervallongNoイベント受信間隔。単位:mSec
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
touchobjectYesイベントの内容を保持するオブジェクト。
touchesarray(object)Yes各タッチに関する情報の配列。
idintegerYesタッチを開始すると割り振られる、ユニーク(唯一)な識別番号。
xintegerYesデバイスが持つ空間の左上を原点としたx座標。
yintegerYesデバイスが持つ空間の左上を原点としたy座標。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
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
    } ]
  }
}
GET /gotapi/touch/onDoubleTap
API Pattern
one-shot
Summary
デバイスでダブルタップされたイベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
touchobjectYesイベントの内容を保持するオブジェクト。
touchesarray(object)Yes各タッチに関する情報の配列。
idintegerYesタッチを開始すると割り振られる、ユニーク(唯一)な識別番号。
xintegerYesデバイスが持つ空間の左上を原点としたx座標。
yintegerYesデバイスが持つ空間の左上を原点としたy座標。
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
    } ]
  }
}
DELETE /gotapi/touch/onTouch
API Pattern
event
Summary
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/touch/onTouch
API Pattern
event
Summary
デバイスでタッチ(touchstart,touchendされた後)されたイベントの受信を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
intervallongNoイベント受信間隔。単位:mSec
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
touchobjectYesイベントの内容を保持するオブジェクト。
touchesarray(object)Yes各タッチに関する情報の配列。
idintegerYesタッチを開始すると割り振られる、ユニーク(唯一)な識別番号。
xintegerYesデバイスが持つ空間の左上を原点としたx座標。
yintegerYesデバイスが持つ空間の左上を原点としたy座標。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
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
    } ]
  }
}
GET /gotapi/touch/onTouch
API Pattern
one-shot
Summary
デバイスでタッチ(touchstart,touchendされた後)されたイベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
touchobjectYesイベントの内容を保持するオブジェクト。
touchesarray(object)Yes各タッチに関する情報の配列。
idintegerYesタッチを開始すると割り振られる、ユニーク(唯一)な識別番号。
xintegerYesデバイスが持つ空間の左上を原点としたx座標。
yintegerYesデバイスが持つ空間の左上を原点としたy座標。
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
    } ]
  }
}
DELETE /gotapi/touch/onTouchCancel
API Pattern
event
Summary
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/touch/onTouchCancel
API Pattern
event
Summary
デバイスでタッチがキャンセルされたイベントの受信を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
intervallongNoイベント受信間隔。単位:mSec
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
touchobjectYesイベントの内容を保持するオブジェクト。
touchesarray(object)Yes各タッチに関する情報の配列。
idintegerYesタッチを開始すると割り振られる、ユニーク(唯一)な識別番号。
xintegerYesデバイスが持つ空間の左上を原点としたx座標。
yintegerYesデバイスが持つ空間の左上を原点としたy座標。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
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
    } ]
  }
}
GET /gotapi/touch/onTouchCancel
API Pattern
one-shot
Summary
デバイスでタッチがキャンセルされたイベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
touchobjectYesイベントの内容を保持するオブジェクト。
touchesarray(object)Yes各タッチに関する情報の配列。
idintegerYesタッチを開始すると割り振られる、ユニーク(唯一)な識別番号。
xintegerYesデバイスが持つ空間の左上を原点としたx座標。
yintegerYesデバイスが持つ空間の左上を原点としたy座標。
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
    } ]
  }
}
DELETE /gotapi/touch/onTouchEnd
API Pattern
event
Summary
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/touch/onTouchEnd
API Pattern
event
Summary
デバイスでタッチが終了したイベントの受信を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
intervallongNoイベント受信間隔。単位:mSec
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
touchobjectYesイベントの内容を保持するオブジェクト。
touchesarray(object)Yes各タッチに関する情報の配列。
idintegerYesタッチを開始すると割り振られる、ユニーク(唯一)な識別番号。
xintegerYesデバイスが持つ空間の左上を原点としたx座標。
yintegerYesデバイスが持つ空間の左上を原点としたy座標。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
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
    } ]
  }
}
GET /gotapi/touch/onTouchEnd
API Pattern
one-shot
Summary
デバイスでタッチが終了したイベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
touchobjectYesイベントの内容を保持するオブジェクト。
touchesarray(object)Yes各タッチに関する情報の配列。
idintegerYesタッチを開始すると割り振られる、ユニーク(唯一)な識別番号。
xintegerYesデバイスが持つ空間の左上を原点としたx座標。
yintegerYesデバイスが持つ空間の左上を原点としたy座標。
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
    } ]
  }
}
DELETE /gotapi/touch/onTouchMove
API Pattern
event
Summary
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/touch/onTouchMove
API Pattern
event
Summary
デバイスでタッチされ続けているイベントの受信を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
intervallongNoイベント受信間隔。単位:mSec
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
touchobjectYesイベントの内容を保持するオブジェクト。
touchesarray(object)Yes各タッチに関する情報の配列。
idintegerYesタッチを開始すると割り振られる、ユニーク(唯一)な識別番号。
xintegerYesデバイスが持つ空間の左上を原点としたx座標。
yintegerYesデバイスが持つ空間の左上を原点としたy座標。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
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
    } ]
  }
}
GET /gotapi/touch/onTouchMove
API Pattern
one-shot
Summary
デバイスでタッチされ続けているイベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
touchobjectYesイベントの内容を保持するオブジェクト。
touchesarray(object)Yes各タッチに関する情報の配列。
idintegerYesタッチを開始すると割り振られる、ユニーク(唯一)な識別番号。
xintegerYesデバイスが持つ空間の左上を原点としたx座標。
yintegerYesデバイスが持つ空間の左上を原点としたy座標。
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
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
    } ]
  }
}
DELETE /gotapi/touch/onTouchStart
API Pattern
event
Summary
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/touch/onTouchStart
API Pattern
event
Summary
デバイスでタッチが開始されたイベントの受信を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
intervallongNoイベント受信間隔。単位:mSec
Response
NameTypeRequiredDescription
resultintegerYes0:正常応答
0以外:異常応答
productstringYesDeviceConnectシステムの名前。
versionstringYesDeviceConnectシステムのバージョン名。
hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
NameTypeRequiredDescription
touchobjectYesイベントの内容を保持するオブジェクト。
touchesarray(object)Yes各タッチに関する情報の配列。
idintegerYesタッチを開始すると割り振られる、ユニーク(唯一)な識別番号。
xintegerYesデバイスが持つ空間の左上を原点としたx座標。
yintegerYesデバイスが持つ空間の左上を原点としたy座標。
attributestringYesアトリビュート名。
serviceIdstringYes0:正常応答
0以外:異常応答
interfacestringYesインターフェース名。
profilestringYesプロファイル名。
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "touch",
  "attribute" : "ontouchstart",
  "touch" : {
    "touches" : [ {
      "x" : 64,
      "y" : 32