com.asus.robotframework.API

Class Utility

java.lang.Object

com.asus.robotframework.API.Utility

public class Utility
extends java.lang.Object

Provide composite function.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Utility.BlueLightMode
static interface	Utility.CapEventType
static interface	Utility.PlayAction
static interface	Utility.SensorType Those types are used for SensorManager.

Method Summary

Modifier and Type	Method and Description
int	followUser() Ask robot follow the nearest user There are two "onResult" callback during FollowUser processing: 1.
int	getLastKidnapTime() Get ths last kidnap time in milliseconds since January 1, 1970 00:00:00.0 UTC.
java.lang.String	getScreenBlueLightFilterMode() Gets the level of screen blue light filter mode
int	lookAtUser(float doa) Ask robot to look at user in robot front
int	playAction(int number) Perform predefined actions by turning neck and wheels.
int	playEmotionalAction(RobotFace face, int playAction) Perform robot expression and predefined action.
int	resetToDefaultSetting() Reset to default setting, include voice trigger, touch only signal, pat on head action, daily dialogue mode, ask back action and always listen mode.
boolean	setScreenBlueLightFilterMode(java.lang.String mode) Sets the screen blue light filter mode
int	trackUser() Ask robot track the nearest user

Methods inherited from class java.lang.Object

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

Method Detail

followUser

public int followUser()

Ask robot follow the nearest user There are two "onResult" callback during FollowUser processing: 1. "FOLLOW_ME_START_FIND_USER" : plugin start to find user 2. "FOLLOW_ME_FOUND_USER": plugin has found user, will start to follow

Returns:

serial number of the command

getLastKidnapTime

public int getLastKidnapTime()

Get ths last kidnap time in milliseconds since January 1, 1970 00:00:00.0 UTC.

Value will return by onResult callback, Bundle result contain key "last_kidnap_time_millis" and type is long.

Returns:

serial number of the command

See Also:

RobotCallback.onResult(int, int, RobotErrorCode, Bundle)

getScreenBlueLightFilterMode

public java.lang.String getScreenBlueLightFilterMode()

Gets the level of screen blue light filter mode

Returns:

the level of blue light filter mode, or null if the operation is fail

lookAtUser

public int lookAtUser(float doa)

Ask robot to look at user in robot front

Parameters:

doa - direction of arrival

Returns:

serial number of the command

playAction

public int playAction(int number)

Perform predefined actions by turning neck and wheels. Use Utility.PlayAction to set action number, naming with loop will be incessant replay. Use RobotAPI.cancelCommandBySerial(int), RobotAPI.cancelCommand(int) (int)} or RobotAPI.cancelCommandAll() (int)} to cancel action.

Parameters:

number - number of predefined action

Returns:

serial number of the command

See Also:

Utility.PlayAction

playEmotionalAction

public int playEmotionalAction(RobotFace face,
                               int playAction)

Perform robot expression and predefined action. Use Utility.PlayAction to set action number, naming with loop will be incessant replay. Use RobotAPI.cancelCommandBySerial(int), RobotAPI.cancelCommand(int) (int)} or RobotAPI.cancelCommandAll() (int)} to cancel action.

Parameters:

face - face expression ID

playAction - action ID

Returns:

serial number of the command

See Also:

DialogSystem.setExpression(RobotFace), Utility.PlayAction

resetToDefaultSetting

public int resetToDefaultSetting()

Reset to default setting, include voice trigger, touch only signal, pat on head action, daily dialogue mode, ask back action and always listen mode.

Returns:

serial number of the command

setScreenBlueLightFilterMode

public boolean setScreenBlueLightFilterMode(java.lang.String mode)

Sets the screen blue light filter mode

Parameters:

mode - The level of blue light filter mode. The sequence of levels is "RdStrong", "Rd03", "Rd02", "Rd01", and "DEF". The "RdStrong" is highest level, and "DEF" is used to cancel blue light filter mode.

Returns:

true if and only if the operation succeeded.

See Also:

Utility.BlueLightMode

trackUser

public int trackUser()

Ask robot track the nearest user

Returns:

Serial number of the command.