robotdll.h - Library robotdll.dll for controlling robot using Robotnacka protocol (c) 2005-2007, FMFI UK Bratislava, robotika.sk

Instructions:

• Link your application with robotdll.lib and include this header file in your source code
• Create a new robot control object by calling robot_init() function
• Remember to delete the object by calling robot_done() not later than when your application terminates
• Always pass the handle returned by robot_init() in the id parameter of the function calls

This header file applies both to Windows and Linux versions of libraries.

Author:

Pavel Petrovic, ppetrovic (@t)acm.org

Entity	Type	Scope	Short Description
robot_adduser	function	public	Adds new user to the currently selected user file.
robot_alwayswait	function	public	Set the waiting mode for the robot object.
robot_bk	function	public	Move the robot backwards a steps.
robot_bkspeed	function	public	Start moving the robot with left-wheel speed -l and right wheel speed -rt.
robot_bkx	function	public	Start moving the robot with left-wheel speed -l and right wheel speed -rt, but stop after any of the two wheels makes enough steps.
robot_calibrate	function	public	Set the robot calibration parameters used by this robot object.
robot_condition	function	public	Set robot sensor condition.
robot_connect	function	public	Connect to the local or remote robot.
robot_connected	function	public	Determine if the connection has been lost.
robot_deluser	function	public	Remove existing user from the currently selected user file.
robot_done	function	public	Release the robot object.
robot_drawcalib	function	public	Draw calibration image.
robot_drawtext	function	public	Draw text with specified Borland-type CHR font.
robot_exclusive	function	public	Request entering or leaving exclusive access on the remote robot.
robot_fd	function	public	Move the robot forward a steps.
robot_fdspeed	function	public	Start moving the robot with left-wheel speed l and right wheel speed rt.
robot_fdx	function	public	Start moving the robot with left-wheel speed l and right wheel speed rt, but stop after any of the two wheels makes enough steps.
robot_getactivity	function	public	Determine the current activity of the robot.
robot_getnum	function	public	Get the robot number, which describes the robot capabilities (additive bits): 1 - pen, 2 - gripper, 4 - camera
robot_getport	function	public	Retrieve the serial port name or IP address that the robot component uses.
robot_getsensors	function	public	Poll the robot sensors.
robot_getversion	function	public	Get firmware version.
robot_getvoltage	function	public	Poll the robot battery voltage.
robot_globalpos	function	public	Retrieve (and optionally initialize) the robot position as stored at the remote robot.
robot_gripper	function	public	Control the robot gripper.
robot_init	function	public	Creates new robot object.
robot_isalive	function	public	Determine if the connection with the robot is alive.
robot_isdone	function	public	Determine if the robot finished executing the command.
robot_listusers	function	public	Retrieve space-separated list of users in the current users file.
robot_logfile	function	public	Set logfile where all commands sent to the turtle will be dumped, use "off" to turn logging off (default).
robot_logoff	function	public	Request that the user currently enjoying exclusive access will be logged off (requires admin password).
robot_lt	function	public	Turn the robot left a steps.
robot_ltspeed	function	public	Start moving the robot with left-wheel speed -l and right wheel speed rt.
robot_ltx	function	public	Start moving the robot with left-wheel speed -l and right wheel speed rt, but stop after any of the two wheels makes enough steps.
robot_message	function	public	Send a message to another robot object connected to the same remote robot.
robot_messages	function	public	Turn the reception of messages from other users on and off.
robot_moveto	function	public	High-level command that will move the robot to specified coordinates from its current position.
robot_password	function	public	Set the admin password for this robot object.
robot_pd	function	public	Put the robot pen down.
robot_portnumber	function	public	Setup the network port number for remote connections.
robot_pos	function	public	Retrieve (and possibly reset) the current odometry position of the robot.
robot_pu	function	public	Lift the robot pen up.
robot_replay	function	public	Replay sequence of commands performed by the robot from a filename (possibly produced by the robot_logfile command).
robot_reset	function	public	Reset the robot.
robot_rt	function	public	Turn the robot right a steps.
robot_rtspeed	function	public	Start moving the robot with left-wheel speed l and right wheel speed -rt.
robot_rtx	function	public	Start moving the robot with left-wheel speed l and right wheel speed -rt, but stop after any of the two wheels makes enough steps.
robot_satisfied	function	public	Determine if the condition has been satisfied.
robot_server	function	public	Start the robot server - listen for incoming TCP/IP connections from other remote robot objects.
robot_setcomparam	function	public	Set the communication parameters for local serial port (Win32).
robot_setsimpos	function	public	Request change of the position of the remote simulated robot.
robot_textsize	function	public	Determine the text size of the text as would be drawn by the robot.
robot_tone	function	public	Play sound of specified frequency and duration.
robot_user	function	public	Set the name of the user that operates with this robot object.
robot_userfile	function	public	Setup a userfile (that contains list of users and passwords) for this robot object.
robot_wait	function	public	Wait until the current command completes or timeout elapses.