4 ‐ The Taspter 2 API

Web HTTP REST API of the robot

The robot's server is listening for HTTP requests. You can use HTTP GET and POST methods with wrapped data so as to make the robot move.

HTTP methods in use

HTTP methods in use: GET, POST

Method	Parameters	Encoding for results	Format for results
GET	host, port, path	UTF-8	JSON
POST	host, port, path, method=POST	UTF-8	JSON

List of features

This base URL matches the following pattern: https://robot-address:robot-port uri (e.g. http://127.0.0.1:4242)

Feature	Method	Path	Body data	Comment
Status	GET	/status	not defined	Returns the status of the robot's server, in JSON format
Reset	POST	/reset	{}	Resets the robot to its initial state (i.e. moves its arms to their initial states)
Dance	POST	/dance	{}	Makes the robot dance! (-ㅂ-)/ ♥ ♥ ♥
Stop dancing	POST	/stopDancing	{}	Stops the dance of the robot :(
Set arms' angles (t1, t2, t3)	POST	/setAngles	{'theta1': t1, 'theta2': t2, 'theta3': t3}	Sets the angles of the arms of the bot to t1, t2 and t3
Set position (x,y,z)	POST	/setPosition	{'x': x, 'y': y, 'z': z}	Sets the robot to the 3D position (x, y, z)
Get angles	GET	/angles	not defined	Gets the arms angles of the bot
Get position	GET	/position	not defined	Gets the 3D position of the robot
Angles for position (a, b, c)	GET	/anglesForPosition/x/a/y/b/z/c	not defined	Gets the angles of the arms of the bot for the 3D coordinates (a, b, c) where a in X axis, b in Y axis and c in Z axis
Position for screen coordinates (x, y)	GET	/positionForScreenCoordinates/x/a/y/b	not defined	Converts the 2D device-landmark point coordinates to the 3D robot-landmark point coordinates
Tap to a point at (x,y)	POST	/tap	{'x': x, 'y': y}	Makes the robot tap on (x, y)
Tap to a point at (x,y) n times	POST	/nTap	{'n': n, x': x, 'y': y}	Makes the robot tap on (x, y) n times
Long tap to a point at (x,y) during duration ms	POST	/longTap	{'x': x, 'y': y, 'duration': duration}	Makes the robot tap on (x, y) with finger kept pressed during duration ms
Swipe from (a,b) to (c,d)	POST	/swipe	{'startX': a, 'startY': b, 'endX': c, 'endY', d}	Makes the robot swipe from (a, b) to (c, d)
Swipe from (a,b) to (c,d) n times	POST	/nSwipe	{'n': n, startX': a, 'startY': b, 'endX': c, 'endY', d}	Makes the robot swipe n times from (a, b) to (c, d)
Send keys	POST	/sendKeys		Not implemented yet
Get calibration data	GET	/calibrationData	not defined	Gets the calibration data used by the bot
Set calibration data	POST	/setCalibrationData	JSON format of calibration data	Defines the calibration data the robot should use
Get the Z-axis value contact	GET	/contactZ	not defined	Gets the Z-axis value of the robot where the device's screen should be touched
Draw square	POST	/drawSquare	{'n': n, 'length': l}	Draws a square with a side length valued to l, where n is a divider of l to define the number of points to draw (l/n), using points based on the robot's landmark
Draw star	POST	/drawStar	not defined	Draws a raw star
Draw triangle	POST	/drawTriangle	{'x1': x1, 'y1': y1, 'x2': x2, 'y2': y2, 'x3': x3, 'y3': y3}	Draws a triangle using points based on the 2D device landmark
Draw circle	POST	/drawCircle	{'x': x, 'y': y, 'r': r}	Draws circle with center on (x,y) and the r radius, using points based on 2D device landmark
Draw cross	POST	/drawCross	{'x1': x1, 'y1': y1, 'x2': x2, 'y2': y2, 'x3': x3, 'y3': y3, 'x4': x4, 'y4': y4}	Draws a cross, using points in the robot's landmark, with two strokes: (x1,y1) -> (x3, y3) and (x2,y2) -> (x4, y4)
Draw spiral	POST	/drawSpiral	{'x': x, 'y': y, 'r': r, 'n': n}	Draws a spiral with center on (x,y) and the r radius, using points based on the 2D device landmark, and n levels
Draw SVG	POST	/drawSvg	{'rawContent': xml-content}	Draws an SVG picture based from its content (xml-content). Device should be in landscape mode ;-)
Draw random pattern	POST	/drawRandomPattern	{'n': n, 'minWidth': miw, 'minHeight': mih, 'maxWidth': maw, 'maxheight': mah}	Draws a random pattern based on continuous strokes based on n points within a defined area based on 2D device landmark
Tap random points	POST	/tapRandomPoints	{'n': n, 'minWidth': miw, 'minHeight': mih, 'maxWidth': maw, 'maxheight': mah}	Taps on n random points within a defined area based on 2D device landmark