{"id":1358,"date":"2018-06-28T15:45:30","date_gmt":"2018-06-28T06:45:30","guid":{"rendered":"http:\/\/robonoid.bluecomtech.com\/?page_id=1358"},"modified":"2018-06-28T15:45:31","modified_gmt":"2018-06-28T06:45:31","slug":"specifications-uri-definition","status":"publish","type":"page","link":"http:\/\/robonoid.bluecomtech.com\/en_US\/specifications-uri-definition","title":{"rendered":"Specifications - URI Definition"},"content":{"rendered":"

Basic Specification<\/h2>\n

Network host of Control Server is normally “localhost (127.0.0.1)”<\/strong>. Its port is decided by port<\/code> property written in config.json<\/strong>. (Default value is 17264.)<\/p>\n

The server provides REST API. Thus, anyone can use each resource and command using following syntax.<\/p>\n

<\/code><\/pre>\n
<VERSION><\/code> is string of API version. Basically its keeps pace to major version of the application. (For-instance: In ControlServer_Win_v2.0.1<\/strong>, <VERSION><\/code> is v2<\/strong>.)<\/p>\n
Returned JSON Format When Get a Resource<\/h3>\n
When you create GET request, the server returns JSON like below.<\/p>\n
<\/code><\/pre>\n
Returned JSON Format When a Command Runs<\/h3>\n
When you create HTTP request (not GET) or call each command, the server returns JSON like below.<\/p>\n
<\/code><\/pre>\n
Resources List<\/h2>\n
Command-line Stream (cmdstream)<\/h3>\n
Could be gotten WebSocket based stream resource that controls PLEN.<\/p>\n
Sending command name and each argument with \/ (slash)<\/strong> as separator, you can call directly commands implemented by Python. (See also…<\/a>)<\/p>\n
<\/code><\/pre>\n
Returned value is stringified returned value on Python runtime environment.<\/p>\n
Motion (motions)<\/h3>\n
Could be gotten motion resource that defines PLEN’s movement. Please set slot number you want to access to <SLOT:integer><\/code>.<\/p>\n
<\/code><\/pre>\n\n\n\n\n\n\n\n
HTTP Request<\/th>\nOperation<\/th>\n<\/tr>\n<\/thead>\n
GET<\/strong><\/td>\nGet a motion resource.<\/td>\n<\/tr>\n
DELETE<\/strong><\/td>\nDelete a motion resource. (Overwrite empty motion actually.)<\/td>\n<\/tr>\n
PUT<\/strong><\/td>\nOverwrite a motion resource.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
<\/code><\/pre>\n\n\n\n\n\n\n
Commands<\/th>\nOperation<\/th>\n<\/tr>\n<\/thead>\n
play<\/strong><\/td>\nPlay a motion.<\/td>\n<\/tr>\n
stop<\/strong><\/td>\nStop a motion.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Version Information (version)<\/h3>\n
Could be gotten version information resource.<\/p>\n
<\/code><\/pre>\n\n\n\n\n\n
HTTP Request<\/th>\nOperation<\/th>\n<\/tr>\n<\/thead>\n
GET<\/strong><\/td>\nGet version information of PLEN.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Construction Information of the Server (metadata)<\/h3>\n
Could be gotten server information resources below.<\/p>\n
    \n
  • API version<\/li>\n
  • Required firmware version of PLEN<\/li>\n<\/ul>\n
    <\/code><\/pre>\n\n\n\n\n\n
    HTTP Request<\/th>\nOperation<\/th>\n<\/tr>\n<\/thead>\n
    GET<\/strong><\/td>\nGet construction information of the server.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Commands List (Doable by Itself)<\/h2>\n
    Connect to PLEN (connect)<\/h3>\n
    <\/code><\/pre>\n
    Disconnect from PLEN (disconnect)<\/h3>\n
    <\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
    Basic Specification<\/h2>\n
    Network host of Control Server is normally “localhost (127.0.0.1)”<\/strong>. Its port is decided by port<\/code> property written in config.json<\/strong>…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"spay_email":""},"jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/P9Nvgc-lU","_links":{"self":[{"href":"http:\/\/robonoid.bluecomtech.com\/en_US\/wp-json\/wp\/v2\/pages\/1358"}],"collection":[{"href":"http:\/\/robonoid.bluecomtech.com\/en_US\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"http:\/\/robonoid.bluecomtech.com\/en_US\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"http:\/\/robonoid.bluecomtech.com\/en_US\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/robonoid.bluecomtech.com\/en_US\/wp-json\/wp\/v2\/comments?post=1358"}],"version-history":[{"count":1,"href":"http:\/\/robonoid.bluecomtech.com\/en_US\/wp-json\/wp\/v2\/pages\/1358\/revisions"}],"predecessor-version":[{"id":1359,"href":"http:\/\/robonoid.bluecomtech.com\/en_US\/wp-json\/wp\/v2\/pages\/1358\/revisions\/1359"}],"wp:attachment":[{"href":"http:\/\/robonoid.bluecomtech.com\/en_US\/wp-json\/wp\/v2\/media?parent=1358"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}