Difference between revisions of "Rest api"

From RobotinoWiki
(/data/digitalinputarray)
(PUT)
Line 61: Line 61:
 
value being true or false.
 
value being true or false.
  
==PUT==
+
==PUT or POST==
  
 
===/data/omnidrive===
 
===/data/omnidrive===
Line 72: Line 72:
 
}
 
}
 
</pre>
 
</pre>
 
+
Matlab example
 +
<pre>webwrite('http://192.168.1.192/data/omnidrive',jsonencode(struct('vx',0.1,'vy',0,'omega',0)))</pre>
 
===/data/digitaloutputarray===
 
===/data/digitaloutputarray===
 
<pre>
 
<pre>

Revision as of 16:26, 21 February 2019

Installation

Robotino rest icon 64.png REST-API is already running at http://RobotinoIP.

Package links

The restapid is part of robotino-daemons package.

GET

/cam0

Get camera image from cam0. The response is image/jpeg.

/data/festoolcharger

Get data from Festool Li-Ion batteries.

/data/powermanagement

Get information about voltage and system current.

/data/charger0

Data for build in charger 0

/data/charger1

Data for build in charger 1

/data/controllerinfo

HW and SW version.

/data/services

Data of Robotino specific services.

/data/servicestatus/xxx

Status of service xxx.

/data/analoginputarray

Data of all analog inputs.

{
  [val0,val1,val2,...,val7]
}

/data/digitalinputarray

Data of all digital inputs.

{
  [val0,val1,val2,...,val7]
}

values being true or false

/data/bumper

Status of Robotinos bumper

{
  "value" : value
}

value being true or false.

PUT or POST

/data/omnidrive

Set forwward and rotational velocity. You have to send data periodically at least every 200ms. If no data is received for more than 200ms Robotino will stop.

{
  "vx": "x-vel in m/s",
  "vy" : "y-vel in m/s",
  "omega" : "rot-vel in rad/s"
}

Matlab example

webwrite('http://192.168.1.192/data/omnidrive',jsonencode(struct('vx',0.1,'vy',0,'omega',0)))

/data/digitaloutputarray

{
  [val0,val1,....val7]
}

value being true or false

/data/relayarray

{
  [val0,val1]
}

val0,val1 being false or true

/data/uploadProgram

Upload Robotino View program to /home/robotino/programs.

{
  "name" : "filename with extension",
  "size" : size of raw (unencoded) binary data,
  "data" : file data base64 encoded
}

Response

{
  "message" : "message what happend on the server",
  "success" : boolean showing if operation was successfull
}