DriveController - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki
スマートデバイスの駆動処理を提供するAPI。
API | 概要 |
---|---|
POST /gotapi/driveController/move | スマートデバイスを指定された方向に移動開始する。 |
PUT /gotapi/driveController/rotate | スマートデバイスを指定された向きに回転を行う。 |
DELETE /gotapi/driveController/stop | スマートデバイスに移動停止リクエストを送る。 |
one-shot
スマートデバイスを指定された方向に移動開始する。
デバイスが動作する方向のキャリブレーションなどに関しては、 デバイスの仕様により変わってくる。 speedが指定されていない場合は移動を行わないこと。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
angle | float | Yes | 角度。デバイスの方向 (degree) 0~360 |
speed | float | Yes | 速度。デバイスの動く速度 0.0~1.0 |
論理名 | 物理名 | データ型 | 必須 | 説明 |
---|---|---|---|---|
処理結果 | result | integer | Yes | 0: 正常応答 0以外: 異常応答 |
システム名 | product | string | Yes | DeviceConnectシステムの名前。 |
システムバージョン | version | string | Yes | DeviceConnectシステムのバージョン名。 |
署名 | hmac | string | No | レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }
one-shot
スマートデバイスを指定された向きに回転を行う。
デバイスが動作する角度のキャリブレーションなどに関しては、 デバイスの仕様により変わってくる。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
angle | float | Yes | 角度。デバイスの方向 (degree) 0~360 |
論理名 | 物理名 | データ型 | 必須 | 説明 |
---|---|---|---|---|
処理結果 | result | integer | Yes | 0: 正常応答 0以外: 異常応答 |
システム名 | product | string | Yes | DeviceConnectシステムの名前。 |
システムバージョン | version | string | Yes | DeviceConnectシステムのバージョン名。 |
署名 | hmac | string | No | レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }
one-shot
スマートデバイスに移動停止リクエストを送る。
すでにスマートデバイスが移動停止している場合に、 移動停止リクエストが送られた場合は、エラーを返すことが望ましい。
物理名 | データ型 | 必須 | 説明 |
---|---|---|---|
serviceId | string | Yes | サービスID。取得対象スマートデバイス |
論理名 | 物理名 | データ型 | 必須 | 説明 |
---|---|---|---|---|
処理結果 | result | integer | Yes | 0: 正常応答 0以外: 異常応答 |
システム名 | product | string | Yes | DeviceConnectシステムの名前。 |
システムバージョン | version | string | Yes | DeviceConnectシステムのバージョン名。 |
署名 | hmac | string | No | レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。 |
{ "result" : 0, "product" : "Example System", "version" : "1.0.0" }