PLEN Playground - Wiki

User Tools

Site Tools

You are here: index.html » Specifications » URI Definition
specifications:uri

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision Both sides next revision
specifications:uri [2016/07/25 09:21]
Guvalif created 		specifications:uri [2016/12/08 10:45]
Guvalif
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)// 
- 
 <markdown> <markdown>
 URI Definition URI Definition
 =============================================================================== ===============================================================================
  
-基本仕様+Basic Specification
 ------------------------------------------------------------------------------- -------------------------------------------------------------------------------
  
-コントロールサーバーのホストは通常**"localhost (127.0.0.1)"**であり、 +Network host of Control Server is normally **"localhost (127.0.0.1)"**. 
-ポートは**config.json**内の`port`プロパティに従って決定されます。(規定値は17264です。)+Its port is decided by `port` property written in **config.json**. (Default value is 17264.)
  
-コントロールサーバーはREST APIを提供し、ユーザーは以下の書式により、 +The server provides REST API. 
-各種リソースやコマンドを使用することができます。+Thus, anyone can use each resource and command using following syntax.
  
 ``` ```
Line 18: Line 16:
 ``` ```
  
-`<VERSION>`はAPIのバージョンを表す文字列であり、アプリケーション自体のメジャーバージョンに追随します。 +`<VERSION>` is string of API version string. 
-(例: **ControlServer_Win_v2.0.1**であれば、**v2**となります。)+Basically its keeps pace to major version of the application. 
 +(For-instance: In **ControlServer_Win_v2.0.1**, `<VERSION>` is **v2**.)
  
-### リソース取得時に返却されるJSONのフォーマット+### Returned JSON Format When Get a Resource
  
-GETリクエストを実行した際、以下のようなJSONが返却されます。+When you create GET request, the server returns JSON like below.
  
 ```json ```json
Line 32: Line 31:
 ``` ```
  
-### コマンド実行時に返却されるJSONのフォーマット+### Returned JSON Format When a Command Runs
  
-GET以外のHTTPリクエスト，および各種コマンドを実行した際、以下のようなJSONが返却されます。+When you create HTTP request (not GET) or call each command, the server returns JSON like below.
  
 ```json ```json
Line 47: Line 46:
  
  
-リソース一覧+Resources List
 ------------------------------------------------------------------------------- -------------------------------------------------------------------------------
  
-### コマンドラインストリーム (cmdstream)+### Command-line Stream (cmdstream)
  
-WebSocketを用いてPLENを操作するストリームリソースを提供します。+Could be gotten WebSocket based stream resource that controls PLEN.
  
-コマンド名と各引数を**/ (スラッシュ)**で区切って送信することで、 +Sending command name and each argument with **/ (slash)** as separator, 
-Pythonで実装されているコマンドを直接呼び出すことが可能です。 +you can call directly commands implemented by Python. 
-([参考](https://github.com/plenprojectcompany/plen-ControlServer/blob/master/control_server/drivers/abstract.py))+([See also...](https://github.com/plenprojectcompany/plen-ControlServer/blob/master/control_server/drivers/abstract.py))
  
 ```javascript ```javascript
Line 64: Line 63:
 ``` ```
  
-戻り値は、Python上での各コマンドの戻り値を文字列化したものです。+Returned value is stringified returned value on Python runtime environment.
  
-### モーション (motions)+### Motion (motions)
  
-PLENの動作を定義するモーションリソースを提供します。 +Could be gotten motion resource that defines PLEN's movement. 
-`<SLOT:integer>`にはアクセスしたいモーションリソースのスロット番号を指定します。+Please set slot number you want to access to `<SLOT:integer>`.
  
 ``` ```
Line 75: Line 74:
 ``` ```
  
-|HTTPリクエスト|動作                                                            | +|HTTP Request|Operation                                                   | 
-|:-------------|:---------------------------------------------------------------| +|:-----------|:-----------------------------------------------------------| 
-|**GET**       |モーションリソースを取得します。                                | +|**GET**     |Get a motion resource.                                      | 
-|**DELETE**    |モーションリソースを削除します。(空のモーションを書き込みます。)| +|**DELETE**  |Delete a motion resource. (Overwrite empty motion actually.)| 
-|**PUT**       |モーションリソースを上書きします。                              |+|**PUT**     |Overwrite a motion resource.                                |
  
 ``` ```
Line 86: Line 85:
 ``` ```
  
-|コマンド|動作                    | +|Commands|Operation     | 
-|:-------|:-----------------------| +|:-------|:-------------| 
-|**play**|モーションを再生します。| +|**play**|Play a motion.| 
-|**stop**|モーションを停止します。|+|**stop**|Stop a motion.|
  
-### バージョン情報 (version)+### Version Information (version)
  
-PLEN本体のバージョン情報に関するリソースを提供します。+Could be gotten version information resource.
  
 ``` ```
Line 99: Line 98:
 ``` ```
  
-|HTTPリクエスト|動作                                | +|HTTP Request|Operation                       | 
-|:-------------|:-----------------------------------| +|:-----------|:-------------------------------| 
-|**GET**       |バージョン情報リソースを取得します。|+|**GET**     |Get version information of PLEN.|
  
-### サーバー構成情報 (metadata)+### Construction Information of the Server (metadata)
  
-以下のようなサーバー構成情報に関するリソースを提供します。+Could be gotten server information resources below.
  
-- APIのバージョン +- API version 
-- 要求するPLENのファームウェアバージョン+- Required firmware version of PLEN
  
 ``` ```
Line 114: Line 113:
 ``` ```
  
-|HTTPリクエスト|動作                                  | +|HTTP Request|Operation                                  | 
-|:-------------|:-------------------------------------| +|:-----------|:------------------------------------------| 
-|**GET**       |サーバー構成情報リソースを取得します。|+|**GET**     |Get construction information of the server.|
  
  
-単独実行可能コマンド一覧+Commands List (Doable by Itself)
 ------------------------------------------------------------------------------- -------------------------------------------------------------------------------
  
-### PLENへの接続 (connect)+### Connect to PLEN (connect)
  
 ``` ```
Line 128: Line 127:
 ``` ```
  
-### PLENからの切断 (disconnect)+### Disconnect from PLEN (disconnect)
  
 ``` ```
specifications/uri.txt · Last modified: 2021/04/01 13:51 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki