Air Conditioner Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/airConditioner
API Pattern
one-shot
Summary
スマートデバイスの電源状態を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
電源状態powerstatusstringYesON:電源オン
OFF:電源オフ
UNKNOWN:不明
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "powerstatus" : "OFF"
}
PUT /gotapi/airConditioner
API Pattern
one-shot
Summary
スマートデバイスの電源を点ける。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/airConditioner
API Pattern
one-shot
Summary
スマートデバイスの電源を消す。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
風量設定値airflowfloatYes0.0〜1.0
風量自動モード設定airflowautobooleanNotrue:自動モード有効
false:自動モード無効
※(注1) 風量自動モード設定をtrue設定した時のみ省略可。
※(注2) 省略時及びfalse設定時は、「風量設定値」が反映される。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "airflowauto" : "true",
  "airflow" : "0.0"
}
PUT /gotapi/airConditioner/airFlow
API Pattern
one-shot
Summary
スマートデバイスの風量設定値を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
airflowfloatNo風量設定値。
0.0〜1.0
airflowautobooleanNo風量自動モード設定。true : 自動モード有効
false : 自動モード無効
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
EPCのリストpropertiesarray(object)Yes指定されたEPCの配列。
EPCepcstringYesECHONET Property Code
設定値valuestringYesECHONET Property Codeの設定値。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "properties" : [ {
    "epc" : "OperationStatus",
    "value" : "49"
  }, {
    "epc" : "InstallationLocation",
    "value" : "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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "epc" : "OperationStatus",
  "value" : "49"
}
GET /gotapi/airConditioner/modeSetting
API Pattern
one-shot
Summary
スマートデバイスの運転モード設定を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
運転モード設定modesettingstringYesAutomatic:自動
Cooling:冷房
Heating:暖房
Dehumidification:除湿
AirCirculator:送風
Other:その他
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "modesetting" : "Automatic"
}
PUT /gotapi/airConditioner/modeSetting
API Pattern
one-shot
Summary
スマートデバイスの運転モード設定を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modesettingstringYes運転モード設定。
Automatic:自動
Cooling:冷房
Heating:暖房
Dehumidification:除湿
AirCirculator:送風
Other:その他
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
節電動作設定powersavingstringYesPowerSaving:節電動作中
Normal:通常動作中
Unknown:不明
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "powersaving" : "Normal"
}
PUT /gotapi/airConditioner/powerSaving
API Pattern
one-shot
Summary
スマートデバイスの節電動作設定を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
powersavingstringYes節電動作設定。
PowerSaving:節電動作中
Normal:通常動作中
Unknown:不明
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/airConditioner/roomTemperature
API Pattern
one-shot
Summary
スマートデバイスの室温計測値を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
室内温度計測値roomtemperatureintegerYes-127〜125 (℃)
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "roomtemperature" : "25"
}
GET /gotapi/airConditioner/temperature
API Pattern
one-shot
Summary
スマートデバイスの温度設定値を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
温度設定値temperatureintegerYes0〜50 (℃)
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "temperature" : "20"
}
PUT /gotapi/airConditioner/temperature
API Pattern
one-shot
Summary
スマートデバイスの温度設定値を設定する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
temperatureintegerYes温度設定値。
0〜50 (℃)
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

Atmospheric Pressure Profile

Ver. 2.0.0

Description

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

Operations

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

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

Camera Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/camera/zoom
API Pattern
one-shot
Summary
Cameraデバイスの現在の倍率を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
カメラの倍率zoomPositionfloatYesカメラの倍率(%)
例)
QX-10の場合
0(%):拡大なし
50(%):倍率5倍での拡大
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "zoomPosition" : 0
}
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

Canvas Profile

Ver. 2.0.0

Description

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

Operations

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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/canvas/drawImage
API Pattern
one-shot
Summary
デバイスに描画した画像を削除する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical 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

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

device Profile

Ver. 2.0.0

Description

スマートデバイスへの接続関連の機能を提供するAPI。

Operations

POST /gotapi/device/pairing
API Pattern
one-shot
Summary
スマートデバイスとペアリングする。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
ペアリング対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/device/pairing
API Pattern
one-shot
Summary
スマートデバイスとペアリングを解除する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
ペアリング解除対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

DeviceOrientation Profile

Ver. 2.0.0

Description

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

Operations

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

DriveController Profile

Ver. 2.0.0

Description

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

Operations

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

GET /gotapi/ecg/onECG
API Pattern
one-shot
Summary
デバイスのECG計測通知イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ECGecgobjectYesECGのオブジェクト。
ECGvalueintegerYesターゲットデバイスで測定した心拍数を返す。
ECGのMDER Float値mderFloatstringYesターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
ECGのタイプtypestringYesこの値が「ecg beat」であることを表す文字列を返す。取得できない場合は、空文字を返す。
ECGのオブジェクトのタイプのコードtypeCodestringYes「663568」という「ecg beat」を意味するコードを返す。取得できない場合は、空文字を返す。
ECGの単位unitstringYes「mVolt * miliSecond」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
ECGの単位コードunitCodestringYes「3328」という「mVolt * miliSecond」を意味するコードを返す。取得できない場合は、空文字を返す。
ECGのタイムスタンプtimeStamplongYes測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
ECGのタイムスタンプ文字列timeStampStringdateTimeYesタイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
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" : "2015-05-17T10:02:20+09:00"
  }
}
PUT /gotapi/ecg/onECG
API Pattern
event
Summary
デバイスのECG計測値を通知するイベントを開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
Logical NamePhysical NameTypeRequiredDescription
サービスIDserviceIdstringYesイベントを送信したサービスのID
プロファイル名profilestringYesプロファイル名。
インターフェース名interfacestringYesインターフェース名。
アトリビュート名attributestringYesアトリビュート名。
ECGecgobjectYesECGのオブジェクト。
ECGvalueintegerYesターゲットデバイスで測定した心拍数を返す。
ECGのMDER Float値mderFloatstringYesターゲットデバイスによって測定された心拍数を、16進数のMDER Float値で表している。取得できない場合は-1の16進数文字列を返す。
ECGのタイプtypestringYesこの値が「ecg beat」であることを表す文字列を返す。取得できない場合は、空文字を返す。
ECGのオブジェクトのタイプのコードtypeCodestringYes「663568」という「ecg beat」を意味するコードを返す。取得できない場合は、空文字を返す。
ECGの単位unitstringYes「mVolt * miliSecond」のように人間がわかるように単位を返す。取得できない場合は、空文字を返す。
ECGの単位コードunitCodestringYes「3328」という「mVolt * miliSecond」を意味するコードを返す。取得できない場合は、空文字を返す。
ECGのタイムスタンプtimeStamplongYes測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
ECGのタイムスタンプ文字列timeStampStringdateTimeYesタイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
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" : "2015-05-17T10:02:20+09:00"
  }
}
DELETE /gotapi/ecg/onECG
API Pattern
event
Summary
デバイスのECG計測値を通知するイベントを停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

ECHONETLite Profile

Ver. 2.0.0

Description

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

Operations

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

File Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/file
API Pattern
one-shot
Summary
スマートデバイスへの、テキスト(歩数、消費カロリー、睡眠時間などのバイナリーの任意のデータ)や画像、音声、動画(リソースも含む)を受け取る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesファイルパス。ファイル名とパス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
MimeTypemimeTypestringYesURIデータのMimeType
URIuristringYesContentProviderのURI
このURIからデータを読み込む
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"
}
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/file
API Pattern
one-shot
Summary
ファイルパスで指定したテキストや画像、音声、動画(リソースも含む)を削除する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesファイルパス。ファイル名とパス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
検索結果数countintegerYes検索結果のファイル数
検索にヒットしたファイルの情報リストfilearray(object)Yes検索にヒットしたファイルの情報を持つオブジェクト(object)の配列。
ファイルパスpathstringYesファイル名を含めたファイルの存在するパス。
MimeTypemimeTypestringYesfileのエンコードするタイプ。
ファイルの種別fileTypestringYes0: ファイル
1: ディレクトリ
ファイルの名前fileNamestringYes
更新時間updateDatedateTimeYesRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
ファイルサイズfileSizeintegerYes単位はbyte。
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" : "2015-05-17T10:02:20+09:00",
    "fileSize" : 123,
    "fileType" : 0
  } ]
}
POST /gotapi/file/directory
API Pattern
one-shot
Summary
ディレクトリの作成要求を渡す。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesパス。作成するディレクトリのパス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/file/directory
API Pattern
one-shot
Summary
ディレクトリの削除要求を渡す。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesパス。削除するディレクトリのパス
forceRemovebooleanNo強制削除フラグ。trueが指定された場合には、空ではないディレクトリも削除する。falseが指定された場合には、空でないディレクトリは削除できない。省略された場合には、falseと同じ動作となる。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
検索結果数countintegerYes検索結果のファイル数
検索にヒットしたファイルの情報リストfilearray(object)Yes検索にヒットしたファイルの情報を持つオブジェクト(object)の配列。
ファイルパスpathstringYesファイル名を含めたファイルの存在するパス。
MimeTypemimeTypestringYesfileのエンコードするタイプ。
ファイルの種別fileTypestringYes0: ファイル
1: ディレクトリ
ファイルの名前fileNamestringYes
更新時間updateDatedateTimeYesRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
ファイルサイズfileSizeintegerYes単位はbyte。
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" : "2015-05-17T10:02:20+09:00",
    "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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/fileDescriptor/onWatchFile
API Pattern
one-shot
Summary
スマートデバイスのファイルの更新時間が変化したことを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
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"
  }
}
PUT /gotapi/fileDescriptor/onWatchFile
API Pattern
event
Summary
スマートデバイスのファイルの更新時間が変化したことを通知するイベントを登録する。
Description
スマートデバイスのファイルへの書き込みが発生した時にイベントが発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
Logical NamePhysical NameTypeRequiredDescription
サービスIDserviceIdstringYesイベントを送信したサービスのID
プロファイル名profilestringYesプロファイル名。
インターフェース名interfacestringYesインターフェース名。
アトリビュート名attributestringYesアトリビュート名。
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"
  }
}
DELETE /gotapi/fileDescriptor/onWatchFile
API Pattern
event
Summary
スマートデバイスのファイルの更新時間が変化したことを通知するイベントを登録解除する。
Description
スマートデバイスのファイルへの書き込みが発生した時にイベントが発行される。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/fileDescriptor/open
API Pattern
one-shot
Summary
スマートデバイスのファイルを開くように要求する。
Description
ここで使用するpathは、File APIで取得できる。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
pathstringYesファイルパス。ファイルが存在するパス。ルートはデバイスプラグインごとに異なる。ディレクトリを指定した場合はエラーを返す。
flagstringYesフラグ。r : 読み込みのみ
rw : 読み込み&書き込み
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
データサイズsizeintegerYes読み込んだデータのサイズ
データ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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
位置情報positionobjectYes
座標coordinatesobjectYes座標のオブジェクト
緯度latitudefloatNo-180~180
単位:degree
経度longitudefloatNo-90~90
単位:degree
高度altitudefloatNo単位:m
緯度・経度の誤差accuracyfloatNo単位:m
高度の誤差altitudeAccuracyfloatNo単位:m
方角headingfloatNo0~359
単位:degree
真北に対して右回りで 0 ≦ heading < 360
速度speedfloatNo単位:m/Sec
測位時刻timeStampfloatYesエポックからのミリ秒
測位時刻 (文字列)timeStampStringdateTimeYes測位時刻を文字列表記
RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式
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" : "2015-05-17T10:02:20+09:00"
  }
}
GET /gotapi/geolocation/onWatchPosition
API Pattern
one-shot
Summary
該当デバイスの位置情報定期通知イベントを取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
highAccuracybooleanNo測位精度設定。
true : 高精度
false : 通常精度
省略時はfalse
intervaldoubleNoデバイスプラグインがイベントを送信する間隔。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
位置情報positionobjectYes
座標coordinatesobjectYes座標のオブジェクト
緯度latitudefloatNo-180~180
単位:degree
経度longitudefloatNo-90~90
単位:degree
高度altitudefloatNo単位:m
緯度・経度の誤差accuracyfloatNo単位:m
高度の誤差altitudeAccuracyfloatNo単位:m
方角headingfloatNo0~359
単位:degree
真北に対して右回りで 0 ≦ heading < 360
速度speedfloatNo単位:m/Sec
測位時刻timeStampfloatYesエポックからのミリ秒
測位時刻 (文字列)timeStampStringdateTimeYes測位時刻を文字列表記
RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式
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" : "2015-05-17T10:02:20+09:00"
  }
}
PUT /gotapi/geolocation/onWatchPosition
API Pattern
event
Summary
該当デバイスの位置情報定期通知イベントを開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
highAccuracybooleanNo測位精度設定。
true : 高精度
false : 通常精度
省略時はfalse
intervaldoubleNoデバイスプラグインがイベントを送信する間隔。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
Logical NamePhysical NameTypeRequiredDescription
サービスIDserviceIdstringYesイベントを送信したサービスのID
プロファイル名profilestringYesプロファイル名。
インターフェース名interfacestringYesインターフェース名。
アトリビュート名attributestringYesアトリビュート名。
位置情報positionobjectYes
座標coordinatesobjectYes座標のオブジェクト
緯度latitudefloatNo-180~180
単位:degree
経度longitudefloatNo-90~90
単位:degree
高度altitudefloatNo単位:m
緯度・経度の誤差accuracyfloatNo単位:m
高度の誤差altitudeAccuracyfloatNo単位:m
方角headingfloatNo0~359
単位:degree
真北に対して右回りで 0 ≦ heading < 360
速度speedfloatNo単位:m/Sec
測位時刻timeStampfloatYesエポックからのミリ秒
測位時刻 (文字列)timeStampStringdateTimeYes測位時刻を文字列表記
RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式
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" : "2015-05-17T10:02:20+09:00"
  }
}
DELETE /gotapi/geolocation/onWatchPosition
API Pattern
event
Summary
該当デバイスの位置情報定期通知イベントを停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

GPIO Profile

Ver. 2.0.0

Description

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

Operations

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

Health Profile

Ver. 2.0.0

Description

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

Operations

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

Human Detection Profile

Ver. 2.0.0

Description

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

Operations

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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
人体検出リストbodyDetectsarray(object)Yes検出された数分出現する。
検出領域の中心X座標xfloatYes0.0~1.0
検出領域の中心Y座標yfloatYes0.0~1.0
検出領域のX方向の幅widthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
検出領域のY方向の幅heightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
解析の信頼度confidencefloatYes0.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
  } ]
}
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
Logical NamePhysical NameTypeRequiredDescription
サービスIDserviceIdstringYesイベントを送信したサービスのID
プロファイル名profilestringYesプロファイル名。
インターフェース名interfacestringYesインターフェース名。
アトリビュート名attributestringYesアトリビュート名。
人体検出リストbodyDetectsarray(object)Yes検出された数分出現する。
検出領域の中心X座標xfloatYes0.0~1.0
検出領域の中心Y座標yfloatYes0.0~1.0
検出領域のX方向の幅widthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
検出領域のY方向の幅heightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
解析の信頼度confidencefloatYes0.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
  } ]
}
DELETE /gotapi/humanDetection/onBodyDetection
API Pattern
event
Summary
体を検出したときの通知イベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/humanDetection/onDetection
API Pattern
one-shot
Summary
人を検出したときの通知イベントを取得する。
Description
プラグイン側でキャッシュしている最新のイベントメッセージを1つ取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
人検出情報humanDetectobjectYes
人検出フラグexistbooleanYes検出された : true
検出されない : false
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "humanDetect" : {
    "exist" : true
  }
}
PUT /gotapi/humanDetection/onDetection
API Pattern
event
Summary
人を検出したときの通知イベントを開始する。
Description
当該イベントの通知を開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
Logical NamePhysical NameTypeRequiredDescription
サービスIDserviceIdstringYesイベントを送信したサービスのID
プロファイル名profilestringYesプロファイル名。
インターフェース名interfacestringYesインターフェース名。
アトリビュート名attributestringYesアトリビュート名。
人検出情報humanDetectobjectYes
人検出フラグexistbooleanYes検出された : true
検出されない : false
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "humandetection",
  "attribute" : "ondetection",
  "humanDetect" : {
    "exist" : true
  }
}
DELETE /gotapi/humanDetection/onDetection
API Pattern
event
Summary
人を検出したときの通知イベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
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利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。
※使用できるオプションはデバイスプラグインによって違う。
例)eye, nose, mouth, blink,age,gender,faceDirection,gaze,expressionをカンマ区切りで指定することで、それぞれの検出値がある場合はレスポンスに含めることができる。ただし、デバイスによって対応していない値がある。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
顔検出リストfaceDetectsarray(object)Yes検出された数分出現する。
検出領域の中心X座標xfloatYes0.0~1.0
検出領域の中心Y座標yfloatYes0.0~1.0
検出領域のX方向の幅widthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
検出領域のY方向の幅heightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
解析の信頼度confidencefloatYes0.0~1.0
目検出情報eyePointsobjectNo
左目の中心座標(x)leftEyeXfloatNo0.0~1.0
左目の中心座標(y)leftEyeYfloatNo0.0~1.0
左目の領域幅(w)leftEyeWidthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
左目の領域幅(h)leftEyeHeightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
右目の中心座標(x)rightEyeXfloatNo0.0~1.0
右目の中心座標(y)rightEyeYfloatNo0.0~1.0
右目の領域幅(w)rightEyeWidthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
右目の領域幅(h)rightEyeHeightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
解析の信頼度confidencefloatNo0.0~1.0
鼻検出情報nosePointsobjectNo
鼻の中心座標(x)noseXfloatNo0.0~1.0
鼻の中心座標(y)noseYfloatNo0.0~1.0
鼻の領域幅(w)noseWidthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
鼻の領域幅(h)noseHeightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
解析の信頼度confidencefloatNo0.0~1.0
口検出情報mouthPointsobjectNo
口の中心座標(x)mouthXfloatNo0.0~1.0
口の中心座標(y)mouthYfloatNo0.0~1.0
口の領域幅(w)mouthWidthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
口の領域幅(h)mouthHeightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
解析の信頼度confidencefloatNo0.0~1.0
まばたき検出情報blinkResultsobjectNo
目つむり度合(左)leftEyefloatNo0.0~1.0
目つむり度合(右)rightEyefloatNo0.0~1.0
解析の信頼度confidencefloatNo0.0~1.0
年齢判定結果ageResultsobjectNo
年齢ageintegerNo
解析の信頼度confidencefloatNo0.0~1.0
性別判定結果genderResultsobjectNo
性別genderstringNomale : 男性
female : 女性
解析の信頼度confidencefloatNo0.0~1.0
顔の向き判定結果faceDirectionResultsobjectNo
左右方向角度yawintegerNo-180~180[degree]
上下方向角度pitchintegerNo-180~180[degree]
顔傾き角度rollintegerNo-180~180[degree]
解析の信頼度confidencefloatNo0.0~1.0
目の向き判定結果gazeResultsobjectNo
左右角度gazeLRintegerNo-90~90[degree]
上下角度gateUDintegerNo-90~90[degree]
解析の信頼度confidencefloatNo0.0~1.0
表情判定結果expressionResultsobjectNo
左右角度expressionstringNounknown : 無表情
smile : 笑 い/喜び
surprise : 驚き
mad : 怒り
sad : 悲しみ
解析の信頼度confidencefloatNo0.0~1.0
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "faceDetects" : [ {
    "x" : 0.9515625,
    "y" : 0.9592592592592593,
    "width" : 0.03177083333333333,
    "height" : 0.05648148148148148,
    "confidence" : 0.619,
    "ageResults" : {
      "age" : "35",
      "confidence" : "0.82"
    },
    "genderResults" : {
      "gender" : "male",
      "confidence" : "0.75"
    },
    "expressionResults" : {
      "expression" : "surprise",
      "confidence" : "0.69"
    }
  } ]
}
PUT /gotapi/humanDetection/onFaceDetection
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利用するオプション機能。利用するオプション機能を指定する。複数指定可能。省略時は指定なし。
※使用できるオプションはデバイスプラグインによって違う。
例)eye, nose, mouth, blink,age,gender,faceDirection,gaze,expressionをカンマ区切りで指定することで、それぞれの検出値がある場合はレスポンスに含めることができる。ただし、デバイスによって対応していない値がある。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
Logical NamePhysical NameTypeRequiredDescription
サービスIDserviceIdstringYesイベントを送信したサービスのID
プロファイル名profilestringYesプロファイル名。
インターフェース名interfacestringYesインターフェース名。
アトリビュート名attributestringYesアトリビュート名。
顔検出リストfaceDetectsarray(object)Yes検出された数分出現する。
検出領域の中心X座標xfloatYes0.0~1.0
検出領域の中心Y座標yfloatYes0.0~1.0
検出領域のX方向の幅widthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
検出領域のY方向の幅heightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
解析の信頼度confidencefloatYes0.0~1.0
目検出情報eyePointsobjectNo
左目の中心座標(x)leftEyeXfloatNo0.0~1.0
左目の中心座標(y)leftEyeYfloatNo0.0~1.0
左目の領域幅(w)leftEyeWidthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
左目の領域幅(h)leftEyeHeightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
右目の中心座標(x)rightEyeXfloatNo0.0~1.0
右目の中心座標(y)rightEyeYfloatNo0.0~1.0
右目の領域幅(w)rightEyeWidthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
右目の領域幅(h)rightEyeHeightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
解析の信頼度confidencefloatNo0.0~1.0
鼻検出情報nosePointsobjectNo
鼻の中心座標(x)noseXfloatNo0.0~1.0
鼻の中心座標(y)noseYfloatNo0.0~1.0
鼻の領域幅(w)noseWidthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
鼻の領域幅(h)noseHeightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
解析の信頼度confidencefloatNo0.0~1.0
口検出情報mouthPointsobjectNo
口の中心座標(x)mouthXfloatNo0.0~1.0
口の中心座標(y)mouthYfloatNo0.0~1.0
口の領域幅(w)mouthWidthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
口の領域幅(h)mouthHeightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
解析の信頼度confidencefloatNo0.0~1.0
まばたき検出情報blinkResultsobjectNo
目つむり度合(左)leftEyefloatNo0.0~1.0
目つむり度合(右)rightEyefloatNo0.0~1.0
解析の信頼度confidencefloatNo0.0~1.0
年齢判定結果ageResultsobjectNo
年齢ageintegerNo
解析の信頼度confidencefloatNo0.0~1.0
性別判定結果genderResultsobjectNo
性別genderstringNomale : 男性
female : 女性
解析の信頼度confidencefloatNo0.0~1.0
顔の向き判定結果faceDirectionResultsobjectNo
左右方向角度yawintegerNo-180~180[degree]
上下方向角度pitchintegerNo-180~180[degree]
顔傾き角度rollintegerNo-180~180[degree]
解析の信頼度confidencefloatNo0.0~1.0
目の向き判定結果gazeResultsobjectNo
左右角度gazeLRintegerNo-90~90[degree]
上下角度gateUDintegerNo-90~90[degree]
解析の信頼度confidencefloatNo0.0~1.0
表情判定結果expressionResultsobjectNo
左右角度expressionstringNounknown : 無表情
smile : 笑 い/喜び
surprise : 驚き
mad : 怒り
sad : 悲しみ
解析の信頼度confidencefloatNo0.0~1.0
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "humandetection",
  "attribute" : "onfacedetection",
  "faceDetects" : [ {
    "x" : 0.9515625,
    "y" : 0.9592592592592593,
    "width" : 0.03177083333333333,
    "height" : 0.05648148148148148,
    "confidence" : 0.619,
    "ageResults" : {
      "age" : "35",
      "confidence" : "0.82"
    },
    "genderResults" : {
      "gender" : "male",
      "confidence" : "0.75"
    },
    "expressionResults" : {
      "expression" : "surprise",
      "confidence" : "0.69"
    }
  } ]
}
DELETE /gotapi/humanDetection/onFaceDetection
API Pattern
event
Summary
顔を検出したときの通知イベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
手検出リストhandDetectsarray(object)Yes検出された数分出現する。
検出領域の中心X座標xfloatYes0.0~1.0
検出領域の中心Y座標yfloatYes0.0~1.0
検出領域のX方向の幅widthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
検出領域のY方向の幅heightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
解析の信頼度confidencefloatYes0.0~1.0
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
  } ]
}
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
Logical NamePhysical NameTypeRequiredDescription
サービスIDserviceIdstringYesイベントを送信したサービスのID
プロファイル名profilestringYesプロファイル名。
インターフェース名interfacestringYesインターフェース名。
アトリビュート名attributestringYesアトリビュート名。
手検出リストhandDetectsarray(object)Yes検出された数分出現する。
検出領域の中心X座標xfloatYes0.0~1.0
検出領域の中心Y座標yfloatYes0.0~1.0
検出領域のX方向の幅widthfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
検出領域のY方向の幅heightfloatNo※領域幅が提供できない場合は出現しない。
0.0~1.0
解析の信頼度confidencefloatYes0.0~1.0
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
  } ]
}
DELETE /gotapi/humanDetection/onHandDetection
API Pattern
event
Summary
手を検出したときの通知イベントを停止する。
Description
当該イベントの通知を停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

Humidity Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/humidity
API Pattern
one-shot
Summary
スマートデバイスの湿度を取得する機能を提供する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
湿度humidityfloatYes湿度センサーが検知した湿度を通知する。
範囲: 0.0 ~ 1.0
湿度のタイムスタンプtimeStamplongNo測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
湿度のタイムスタンプ文字列timeStampStringdateTimeNoタイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "humidity" : 0.1,
  "timeStamp" : 1431856940275,
  "timeStampString" : "2015-05-17T10:02:20+09:00"
}

Illuminance Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/illuminance
API Pattern
one-shot
Summary
スマートデバイスの照度を取得する機能を提供する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
照度illuminancefloatYes照度センサーが検知した照度。単位はルクス(lx)。
照度のタイムスタンプtimeStamplongNo測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
照度のタイムスタンプ文字列timeStampStringdateTimeNoタイムスタンプと同じタイムスタンプをRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式で返す。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "illuminance" : 240,
  "timeStamp" : 1431856940275,
  "timeStampString" : "2015-05-17T10:02:20+09:00"
}

Key Event Profile

Ver. 2.0.0

Description

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

Operations

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

Light Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/light
API Pattern
one-shot
Summary
ライトを識別するIDなどを取得するAPI。
Description
スマートデバイスが認識しているライトデバイスの一覧を取得する。取得できる情報には、ライトの識別子、ライトの名前と状態を持つ。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ライト一覧lightsarray(object)Yesライト一覧を格納する配列。
ライトIDlightIdstringYesライトを識別するID。
ライト名namestringYesライト名。
ライトの点灯状態onbooleanYesライトの点灯状態を示す。
true: 点灯
false: 消灯
コンフィグconfigstringYesライトに設定がある場合には、ここに文字列としてデータが格納されている。
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"
  } ]
}
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
Logical NamePhysical 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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/light
API Pattern
one-shot
Summary
ライトを消灯するAPI。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
lightIdstringNoライトID。操作の対象となるライト。省略された場合、デフォルトのライトが選択される。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
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

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

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

MessageHook Profile

Ver. 2.0.0

Description

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

Operations

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

Notification Profile

Ver. 2.0.0

Description

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

Operations

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

Omnidirectional Image Profile

Ver. 2.0.0

Description

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

Operations

PUT /gotapi/omnidirectionalImage/roi
API Pattern
streaming
Summary
ROI画像の受信を開始するAPI。
Description
本APIのレスポンスで返されるURIでROI画像を参照できる。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
sourcestringYes全方位パノラマ画像URI。ROI画像に変換する全方位パノラマ画像のURI。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
ROI画像配信サーバURIuristringYesROI画像を配信するサーバのURIを示す。配信される画像の形式はMotionJPEGとする。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "uri" : "Dummy Preview URI"
}
DELETE /gotapi/omnidirectionalImage/roi
API Pattern
streaming
Summary
ROI画像の受信を終了する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
uristringYesROI画像URI。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
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
Logical NamePhysical 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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/phone/onConnect
API Pattern
one-shot
Summary
スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
電話機能の状態phoneStatusobjectYes電話機能の状態を保持するオブジェクト。特定の相手先との通話状態の変化を通知する。
電話番号phoneNumberstringYes相手先の電話番号を示す文字列。文字には数字の0〜9のみを使用可能。長さは11桁または13桁のいずれかとする。11桁は国内電話、13桁は国際電話として扱う。
通話状態statefloatYes通話状態を示す定数。
0: 通話開始
1: 通話失敗
2: 通話終了
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "phoneStatus" : {
    "phoneNumber" : "01234567890",
    "state" : 2
  }
}
PUT /gotapi/phone/onConnect
API Pattern
event
Summary
スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを開始する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
intervallongNoデバイスプラグインがイベントを送信する間隔。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
Logical NamePhysical NameTypeRequiredDescription
サービスIDserviceIdstringYesイベントを送信したサービスのID
プロファイル名profilestringYesプロファイル名。
インターフェース名interfacestringYesインターフェース名。
アトリビュート名attributestringYesアトリビュート名。
電話機能の状態phoneStatusobjectYes電話機能の状態を保持するオブジェクト。特定の相手先との通話状態の変化を通知する。
電話番号phoneNumberstringYes相手先の電話番号を示す文字列。文字には数字の0〜9のみを使用可能。長さは11桁または13桁のいずれかとする。11桁は国内電話、13桁は国際電話として扱う。
通話状態statefloatYes通話状態を示す定数。
0: 通話開始
1: 通話失敗
2: 通話終了
Example Event
{
  "serviceId" : "Host.dummyId.localhost.deviceconnect.org",
  "profile" : "phone",
  "attribute" : "onconnect",
  "phoneStatus" : {
    "phoneNumber" : "01234567890",
    "state" : 2
  }
}
DELETE /gotapi/phone/onConnect
API Pattern
event
Summary
スマートフォンに対して行った電話発信要求によるスマートフォン上での通話の開始、通話の失敗、通話の終了状態を、周辺機器に通知するイベントを停止する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
PUT /gotapi/phone/set
API Pattern
one-shot
Summary
スマートフォンに対して電話に関する設定項目(サイレント・マナー・音あり)の設定をリクエストする。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
modeintegerYes電話のモード。電話のモードを指定
0:サイレント
1:マナー
2:音あり
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

PoseEstimation Profile

Ver. 2.0.0

Description

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

Operations

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

Power Profile

Ver. 2.0.0

Description

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

Operations

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

Power Meter Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/powerMeter
API Pattern
one-shot
Summary
スマートデバイスの電源状態を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
電源状態powerstatusstringYes電源状態を示す文字列。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "powerstatus" : "OFF"
}
PUT /gotapi/powerMeter
API Pattern
one-shot
Summary
スマートデバイスの電源を付ける。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
DELETE /gotapi/powerMeter
API Pattern
one-shot
Summary
スマートデバイスの電源を消す。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。取得対象スマートデバイス
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
GET /gotapi/powerMeter/instantaneousCurrent
API Pattern
one-shot
Summary
スマートデバイスが計測した瞬時電流量を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
取得対象スマートデバイス
unitstringNo瞬時電流量単位。瞬時電流量の単位を指定。
例:
'mA'
'A'
省略時は'A'
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
瞬時電流量instantaneouscurrentobjectYes瞬時電流量を表す実数。単位はパラメータによる。
R相瞬時電流量rphasedoubleYesR相の瞬時電流量を表す実数。
T相瞬時電流量tphasedoubleNoT相の瞬時電流量を表す実数。単相の場合は省略。
瞬時電流量単位unitstringYes瞬時電流量の単位を表す。例:'mA' 'A'
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "instantaneouscurrent" : {
    "rphase" : 1234.5,
    "tphase" : -2345.6,
    "unit" : "mA"
  }
}
GET /gotapi/powerMeter/instantaneousPower
API Pattern
one-shot
Summary
スマートデバイスが計測した瞬時電力量を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
取得対象スマートデバイス
unitstringNo瞬時電力量単位。瞬時電力量の単位を指定。
例:
'W'
'kW'
省略時は'W'
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
瞬時電力量instantaneouspowerdoubleYes瞬時電力量を表す実数。単位はパラメータ設定による。
瞬時電力量単位unitstringYes瞬時電力量の単位を表す。例:'W' 'kW'
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "instantaneouspower" : 38.4,
  "unit" : "W"
}
GET /gotapi/powerMeter/integratedPower
API Pattern
one-shot
Summary
スマートデバイスが計測した積算電力量を取得する。
Description
指定した日時から過去24時間分の計測値を24または48分割して返す。(1時間または30分ごとの値を返す。)
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
取得対象スマートデバイス
datedateTimeNo取得日付。
RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」形式
省略時はAPI実行日時が指定される
unitstringNo積算電力量単位。積算電力量の単位を指定。
省略時は'Wh'
countintegerNo積算電力量コマ数。24時間分の積算電力量を指定数で返す。
24: 24分割=1時間単位(デフォルト)
48: 48分割=30分単位
powerFlowstringNo積算電力量方向指定。取得する積算電力量の方向を指定。
normal : 正方向
reverse : 逆方向
省略時はnormal (正方向)
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0: 正常応答
0以外: 異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
積算電力量integratedpowerarray(double)Yes24時間分の計測値を返す。
サイズが24または48のnumberの配列。各値は積算電力量を表す実数。単位はパラメーター設定による。時間順に格納されているため、最初の要素は24時間前のもの。

例: リクエストで date=2015-08-24T15:14:00+0900, count=24 を指定した場合、0から23までの各インデックスに対応する時間帯は下記のとおり。
0 : 2015-08-23T15:00 ~ 15:59
:
23 :2015-08-24T14:00 ~ 14:59
積算電力量単位unitstringYes積算電力量の単位を表す。例:'Wh' 'kWh'
積算電力量コマ数countintegerYes積算電力量コマ数(24または48)
積算電力量方向powerFlowstringYes積算電力量方向を表す。'normal' 'reverse'
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "integratedpower" : [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 ],
  "unit" : "Wh",
  "count" : 24,
  "powerFlow" : "normal"
}

Proximity Profile

Ver. 2.0.0

Description

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

Operations

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

Remote Controller Profile

Ver. 2.0.0

Description

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

Operations

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

ServiceDiscovery Profile

Ver. 2.0.0

Description

DeviceConnectシステム上のサービス検索機能を提供するAPI。

Operations

GET /gotapi/serviceDiscovery
API Pattern
one-shot
Summary
DeviceConnectサービスの検索を行う。
Description
DeviceConnectサービス検索機能を提供するAPI。 取得できる情報としては、サービスID、サービス名、ネットワーク種別、利用可能状態やデバイス固有のコンフィグ情報がある。
Parameters
NameTypeRequiredDescription
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
サービス一覧servicesarray(object)YesDeviceConnectサービスの配列。
サービスIDidstringYesサービスを識別するためのID。
サービス名namestringYesサービスの名前。
ネットワーク種別typestringNoホストデバイスと接続するためのネットワークの種別。
利用可能状態onlinebooleanYesサービスが利用可能であるかどうかを示すフラグ。
コンフィグconfigstringNoサービス固有の設定がある場合には、ここに文字列として格納される。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "services" : [ {
    "id" : "example-service-id",
    "name" : "Example Service",
    "online" : true
  } ]
}
PUT /gotapi/serviceDiscovery/onServiceChange
API Pattern
event
Summary
DeviceConnectサービス一覧の変更通知を受領する。
Description
DeviceConnectサービスの追加・削除・利用可能状態変更を通知するためのイベント。
Parameters
NameTypeRequiredDescription
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Event
Logical NamePhysical NameTypeRequiredDescription
サービスIDserviceIdstringYesイベントを送信したサービスのID
プロファイル名profilestringYesプロファイル名。
インターフェース名interfacestringYesインターフェース名。
アトリビュート名attributestringYesアトリビュート名。
オブジェクトnetworkServiceobjectYesイベントの内容を保持するオブジェクト。
サービス一覧servicesarray(object)YesDeviceConnectサービスの配列。
サービスIDidstringYesサービスを識別するためのID。
サービス名namestringYesサービスの名前。
ネットワーク種別typestringNoホストデバイスと接続するためのネットワークの種別。
利用可能状態onlinebooleanYesサービスが利用可能であるかどうかを示すフラグ。
コンフィグconfigstringNoサービス固有の設定がある場合には、ここに文字列として格納される。
Example Event
{
  "profile" : "serviceDiscovery",
  "attribute" : "onServiceChange",
  "networkService" : {
    "services" : [ {
      "id" : "example-service-id",
      "name" : "Example Service",
      "online" : true
    } ]
  }
}
DELETE /gotapi/serviceDiscovery/onServiceChange
API Pattern
event
Summary
DeviceConnectサービス一覧の変更通知の受領を停止する。
Parameters
NameTypeRequiredDescription
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

ServiceInformation Profile

Ver. 2.0.0

Description

DeviceConnectシステム上の特定のサービスに関する情報を提供するAPI。

Operations

GET /gotapi/serviceInformation
API Pattern
one-shot
Summary
DeviceConnectシステム上の特定のサービスに関する情報を提供するAPI。
Description
サポートするプロファイル一覧、ネットワークへの接続状態を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
オブジェクトconnectobjectYesネットワークの接続状態
Wi-Fi接続フラグwifibooleanNoWi-Fiの接続を提供しない場合は省略。
Bluetooth接続フラグbluetoothbooleanNoBluetoothの接続を提供しない場合は省略。
BLE接続フラグblebooleanNoBLEの接続を提供しない場合は省略。
NFC接続フラグNFCbooleanNoNFCの接続を提供しない場合は省略。
プロファイル一覧supportsarray(string)Yesサポートしているプロファイル名の配列。
各プロファイルのDeviceConnectAPI仕様定義supportApisobjectNo指定されたサービスのサポートするプロファイル名をキーとして、そのプロファイルのAPIを定義するSwagger 2.0ドキュメントを提供する。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connect" : {
    "ble" : true
  },
  "supports" : [ "example" ],
  "supportApis" : {
    "example" : {
      "swagger" : "2.0",
      "basePath" : "/gotapi/example",
      "info" : {
        "title" : "Example Profile",
        "version" : "1.0",
        "description" : ""
      },
      "paths" : {
        "/message" : {
          "post" : {
            "x-type" : "one-shot",
            "summary" : "Post a message.",
            "parameters" : [ {
              "name" : "serviceId",
              "in" : "query",
              "required" : true,
              "type" : "string"
            }, {
              "name" : "message",
              "in" : "query",
              "required" : true,
              "type" : "string"
            } ],
            "responses" : {
              "200" : {
                "description" : ""
              }
            }
          }
        }
      }
    }
  }
}

Setting Profile

Ver. 2.0.0

Description

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

Operations

GET /gotapi/setting/date
API Pattern
one-shot
Summary
スマートデバイスの日時を取得する。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
日付datedateTimeYesRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式の日付。 例: 2015-05-17T10:02:20+09:00
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "date" : "2015-05-17T10:02:20+09:00"
}
PUT /gotapi/setting/date
API Pattern
one-shot
Summary
スマートデバイスの日時の設定依頼を送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
datedateTimeYesRFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式の日付。 例: 2015-05-17T10:02:20+09:00
Response
Logical NamePhysical 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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
輝度levelfloatYesディスプレイの輝度を割合で示す 範囲 (0.0 <= level <= 1.0)
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "level" : 0.5
}
PUT /gotapi/setting/display/brightness
API Pattern
one-shot
Summary
スマートデバイスのライト明度の設定依頼を送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
levelfloatYesディスプレイの輝度を割合で示す 範囲 (0.0 <= level <= 1.0)
Response
Logical NamePhysical 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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
消灯するまでの時間timelongYesディスプレイが消灯するまでの時間 (ミリ秒)
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "time" : 120000
}
PUT /gotapi/setting/display/sleep
API Pattern
one-shot
Summary
スマートデバイスの画面消灯設定依頼を送る。
Parameters
NameTypeRequiredDescription
serviceIdstringYesサービスID。
timelongYesディスプレイが消灯するまでの時間 (ミリ秒)
Response
Logical NamePhysical 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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
音量levelfloatYes音量を割合で示す。(0.0 <= level <= 1.0)
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "level" : 1
}
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
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Example Response
{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

Sphero Profile

Ver. 2.0.0

Description

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

Operations

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

StressEstimation Profile

Ver. 2.0.0

Description

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

Operations

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

System Profile

Ver. 2.0.0

Description

DeviceConnectシステム情報を提供するAPI。

Operations

GET /gotapi/system
API Pattern
one-shot
Summary
DeviceConnectシステム情報を提供するAPI。
Description
DeviceConnectシステムのバージョンやサポートするAPI一覧、インストールされているプラグイン一覧などのアプリケーション情報を取得する。
Parameters
NameTypeRequiredDescription
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
プロファイル一覧supportsarray(string)YesDevice Connect Managerのサポートするプロファイル名の配列。
プラグイン一覧pluginsarray(object)YesDeviceConnectシステムにインストールされているプラグインについての情報の配列。
IDidstringYesDeviceConnectシステム上でプラグインを識別するためのID。
名前namestringYesプラグインの名前。
バージョンversionstringYesプラグインのバージョン名。
プロファイル一覧supportsarray(string)Yesプラグインのサポートするプロファイル名の配列。
パッケージ名packageNamestringNoDeviceConnectシステムの実行環境(例:Android)でプラグインを識別するための名前。
PUT /gotapi/system/device/wakeup
API Pattern
one-shot
Summary
デバイスプラグインの機能を有効にする。
Description
プラグインによっては、設定画面が起動してデバイスとの接続を行う。
Parameters
NameTypeRequiredDescription
pluginIdstringYes
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
DELETE /gotapi/system/events
API Pattern
one-shot
Summary
リクエスト送信元のオリジンに紐づくイベントを一挙に解除する。
Parameters
NameTypeRequiredDescription
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答
システム名productstringYesDeviceConnectシステムの名前。
システムバージョンversionstringYesDeviceConnectシステムのバージョン名。
署名hmacstringNoレスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。
PUT /gotapi/system/keyword
API Pattern
one-shot
Summary
DeviceConnectシステムに対し、ユーザーが登録したキーワードの表示要求をする。
Parameters
NameTypeRequiredDescription
Response
Logical NamePhysical NameTypeRequiredDescription
処理結果resultintegerYes0:正常応答
0以外:異常応答