This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
specifications:uri [2015/09/12 22:44] 127.0.0.1 external edit |
specifications:uri [2016/07/25 09:21] Guvalif created |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)// | ||
+ | |||
< | < | ||
URI Definition | URI Definition | ||
- | ============== | + | =============================================================================== |
+ | |||
+ | 基本仕様 | ||
+ | ------------------------------------------------------------------------------- | ||
+ | |||
+ | コントロールサーバーのホストは通常**" | ||
+ | ポートは**config.json**内の`port`プロパティに従って決定されます。(規定値は17264です。) | ||
+ | |||
+ | コントロールサーバーはREST APIを提供し、ユーザーは以下の書式により、 | ||
+ | 各種リソースやコマンドを使用することができます。 | ||
+ | |||
+ | ``` | ||
+ | http://< | ||
+ | ``` | ||
+ | |||
+ | `< | ||
+ | (例: **ControlServer_Win_v2.0.1**であれば、**v2**となります。) | ||
+ | |||
+ | ### リソース取得時に返却されるJSONのフォーマット | ||
+ | |||
+ | GETリクエストを実行した際、以下のようなJSONが返却されます。 | ||
+ | |||
+ | ```json | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ``` | ||
+ | |||
+ | ### コマンド実行時に返却されるJSONのフォーマット | ||
+ | |||
+ | GET以外のHTTPリクエスト,および各種コマンドを実行した際、以下のようなJSONが返却されます。 | ||
+ | |||
+ | ```json | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | ``` | ||
+ | |||
+ | |||
+ | リソース一覧 | ||
+ | ------------------------------------------------------------------------------- | ||
+ | |||
+ | ### コマンドラインストリーム (cmdstream) | ||
+ | |||
+ | WebSocketを用いてPLENを操作するストリームリソースを提供します。 | ||
+ | |||
+ | コマンド名と各引数を**/ | ||
+ | Pythonで実装されているコマンドを直接呼び出すことが可能です。 | ||
+ | ([参考](https:// | ||
+ | |||
+ | ```javascript | ||
+ | var socket = new WebSocket(' | ||
+ | |||
+ | socket.send('< | ||
+ | ``` | ||
+ | |||
+ | 戻り値は、Python上での各コマンドの戻り値を文字列化したものです。 | ||
+ | |||
+ | ### モーション (motions) | ||
+ | |||
+ | PLENの動作を定義するモーションリソースを提供します。 | ||
+ | `< | ||
+ | |||
+ | ``` | ||
+ | http:// | ||
+ | ``` | ||
+ | |||
+ | |HTTPリクエスト|動作 | ||
+ | |: | ||
+ | |**GET** | ||
+ | |**DELETE** | ||
+ | |**PUT** | ||
+ | |||
+ | ``` | ||
+ | http:// | ||
+ | http:// | ||
+ | ``` | ||
+ | |||
+ | |コマンド|動作 | ||
+ | |: | ||
+ | |**play**|モーションを再生します。| | ||
+ | |**stop**|モーションを停止します。| | ||
+ | |||
+ | ### バージョン情報 (version) | ||
+ | |||
+ | PLEN本体のバージョン情報に関するリソースを提供します。 | ||
+ | |||
+ | ``` | ||
+ | http:// | ||
+ | ``` | ||
+ | |||
+ | |HTTPリクエスト|動作 | ||
+ | |: | ||
+ | |**GET** | ||
+ | |||
+ | ### サーバー構成情報 (metadata) | ||
+ | |||
+ | 以下のようなサーバー構成情報に関するリソースを提供します。 | ||
+ | |||
+ | - APIのバージョン | ||
+ | - 要求するPLENのファームウェアバージョン | ||
+ | |||
+ | ``` | ||
+ | http:// | ||
+ | ``` | ||
+ | |||
+ | |HTTPリクエスト|動作 | ||
+ | |: | ||
+ | |**GET** | ||
+ | |||
+ | |||
+ | 単独実行可能コマンド一覧 | ||
+ | ------------------------------------------------------------------------------- | ||
+ | |||
+ | ### PLENへの接続 (connect) | ||
+ | |||
+ | ``` | ||
+ | http:// | ||
+ | ``` | ||
+ | |||
+ | ### PLENからの切断 (disconnect) | ||
- | fix me. | + | ``` |
+ | http:// | ||
+ | ``` | ||
</ | </ |