com.asus.robotframework.API

Class RobotAPI

java.lang.Object

com.asus.robotframework.API.RobotAPI

public class RobotAPI
extends java.lang.Object

This API provides a interface to all robot features.

Field Summary

Fields

Modifier and Type	Field and Description
RobotContacts	contacts
ExtraMethod	extra B2B customer use only
MotionControl	motion
DialogSystem	robot
Slam	slam
Utility	utility
VisionControl	vision
WheelLights	wheelLights

Constructor Summary

Constructors

Constructor and Description
RobotAPI(android.app.Activity activity) constructor with default callback
RobotAPI(android.app.Activity activity, RobotCallback callback) constructor with user defined callback
RobotAPI(android.content.Context context) constructor with default callback
RobotAPI(android.content.Context context, RobotCallback callback) constructor with user defined callback
RobotAPI(android.app.Service service) constructor with default callback
RobotAPI(android.app.Service service, RobotCallback callback) constructor with user defined callback

Method Summary

Modifier and Type	Method and Description
int	cancelCommand(int command) Cancel specific robot command
int	cancelCommandAll() Cancel all robot commands
int	cancelCommandBySerial(int serial) Cancel specific command by using the serial number.
static java.lang.String	getVersion() Get the robot api version string
void	release() Release all robot API resource
void	setCallback(RobotCallback callback) Set the callback to receive all the events from robot framework.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

contacts

public final RobotContacts contacts

extra

public final ExtraMethod extra

B2B customer use only

motion

public final MotionControl motion

robot

public final DialogSystem robot

slam

public final Slam slam

utility

public final Utility utility

vision

public final VisionControl vision

wheelLights

public final WheelLights wheelLights

Constructor Detail

RobotAPI

public RobotAPI(android.app.Activity activity)

constructor with default callback

Parameters:

activity - this application self

RobotAPI

public RobotAPI(android.app.Activity activity,
                RobotCallback callback)

constructor with user defined callback

Parameters:

activity - this application self

callback - listener that will receive all the callbacks from the RobotFramework.

RobotAPI

public RobotAPI(android.content.Context context)

constructor with default callback

Parameters:

context - context of the application package implementing this class

RobotAPI

public RobotAPI(android.content.Context context,
                RobotCallback callback)

constructor with user defined callback

Parameters:

context - context of the application package implementing this class

callback - listener that will receive all the callbacks from the RobotFramework.

RobotAPI

public RobotAPI(android.app.Service service)

constructor with default callback

Parameters:

service - this application self

RobotAPI

public RobotAPI(android.app.Service service,
                RobotCallback callback)

constructor with user defined callback

Parameters:

service - this application self

callback - listener that will receive all the callbacks from the RobotFramework.

Method Detail

cancelCommand

public int cancelCommand(int command)

Cancel specific robot command

Parameters:

command - specifies the command to cancel

Returns:

serial number of the command.

cancelCommandAll

public int cancelCommandAll()

Cancel all robot commands

Returns:

serial number of the command

cancelCommandBySerial

public int cancelCommandBySerial(int serial)

Cancel specific command by using the serial number.

Parameters:

serial - specifies the command serial to cancel

Returns:

serial number of the command

getVersion

public static java.lang.String getVersion()

Get the robot api version string

Returns:

api version

release

public void release()

Release all robot API resource

setCallback

public void setCallback(RobotCallback callback)

Set the callback to receive all the events from robot framework. It will replace current callback.

Parameters:

callback - the callback function