com.asus.robotframework.API

Class VisionControl

java.lang.Object

com.asus.robotframework.API.VisionControl

public class VisionControl
extends java.lang.Object

Provide visual function

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VisionControl.Config

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INTERVAL_IN_MS

Method Summary

Modifier and Type	Method and Description
int	cancelDetectFace() Cancel the running detect face process.
int	cancelRecognizePerson() Cancel the running recognize person process.
int	deleteFaceEnrollData(java.lang.String id) Delete Face Enroll Data
int	requestDetectFace(VisionConfig.FaceDetectConfig config) Request detect faces, and the result is returned by RobotCallback.onDetectFaceResult(java.util.List<com.asus.robotframework.API.results.DetectFaceResult>).
int	requestFaceEnrollList() Get enrolled FaceID list.
int	requestRecognizePerson(int intervalInMS) Request robot to recognize person who has enrolled, and the result is returned by RobotCallback.onRecognizePersonResult(java.util.List<com.asus.robotframework.API.results.RecognizePersonResult>).
int	requestRecognizePerson(VisionConfig.PersonRecognizeConfig config) Request detect person, and the result is returned by RobotCallback.onRecognizePersonResult(java.util.List<com.asus.robotframework.API.results.RecognizePersonResult>).
int	startFaceEnrollProgress(java.lang.String id) Start Face Enroll Progress in RobotFaceEnrollMode.MODE_WITH_POSE_CHECK mode
int	startFaceEnrollProgress(java.lang.String id, RobotFaceEnrollMode mode) Start Face Enroll Progress
int	startPictureEnrollProgress(java.lang.String id, java.lang.String pictureFolderPath) Start Picture Enroll Progress 1.Letting users choose picture by themselves, you can use file picker and copy the files to the pictureFolderPath then call this api to finish the rest enroll work (For Example: https://github.com/jaiselrahman/FilePicker) 2.Every Picture size should under 5MB

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INTERVAL_IN_MS

public static final int DEFAULT_INTERVAL_IN_MS

See Also:

Constant Field Values

Method Detail

cancelDetectFace

public int cancelDetectFace()

Cancel the running detect face process.

Returns:

serial number of the command

cancelRecognizePerson

public int cancelRecognizePerson()

Cancel the running recognize person process.

Returns:

serial number of the command

deleteFaceEnrollData

public int deleteFaceEnrollData(java.lang.String id)

Delete Face Enroll Data

Parameters:

id - the specific id you assign to the user when enroll

Returns:

Serial number of the command.

requestDetectFace

public int requestDetectFace(VisionConfig.FaceDetectConfig config)

Request detect faces, and the result is returned by RobotCallback.onDetectFaceResult(java.util.List<com.asus.robotframework.API.results.DetectFaceResult>). A face list will be returned as detecting faces. DetectFaceResult.getFaceLoc() of the mass center the visible user's face with trackID with respect to Robot Base Coordinates (in meters), x axis means robot to user depth, y means left/right shift, z means user height above ground.

Parameters:

config - Configuration of person detection

Returns:

serial number of the command

See Also:

RobotCallback.onDetectFaceResult(List), VisionConfig.FaceDetectConfig

requestFaceEnrollList

public int requestFaceEnrollList()

Get enrolled FaceID list. Call to query how many ID have enroll and each has enrolled, return by RobotCallback.onEnrollGetAllIDList(Map)
{userA_ID, userA_enrollCount, userB_ID, userB_enrollCount, ... }.

Returns:

Serial number of the command.

See Also:

RobotCallback.onEnrollGetAllIDList(Map)

requestRecognizePerson

public int requestRecognizePerson(int intervalInMS)

Request robot to recognize person who has enrolled, and the result is returned by RobotCallback.onRecognizePersonResult(java.util.List<com.asus.robotframework.API.results.RecognizePersonResult>).

Parameters:

intervalInMS - Desired interval in milliseconds

Returns:

serial number of the command

See Also:

RobotCallback.onRecognizePersonResult(List)

requestRecognizePerson

public int requestRecognizePerson(VisionConfig.PersonRecognizeConfig config)

Request detect person, and the result is returned by RobotCallback.onRecognizePersonResult(java.util.List<com.asus.robotframework.API.results.RecognizePersonResult>).

Parameters:

config - Configuration of person recognition

Returns:

serial number of the command

See Also:

RobotCallback.onRecognizePersonResult(List)

startFaceEnrollProgress

public int startFaceEnrollProgress(java.lang.String id)

Start Face Enroll Progress in RobotFaceEnrollMode.MODE_WITH_POSE_CHECK mode

Parameters:

id - the unique info to represent every user

Returns:

Serial number of the command.

See Also:

RobotFaceEnrollMode

startFaceEnrollProgress

public int startFaceEnrollProgress(java.lang.String id,
                                   RobotFaceEnrollMode mode)

Start Face Enroll Progress

Parameters:

id - the unique info to represent every user

mode - the mode of face enroll

Returns:

Serial number of the command.

startPictureEnrollProgress

public int startPictureEnrollProgress(java.lang.String id,
                                      java.lang.String pictureFolderPath)

Start Picture Enroll Progress

1.Letting users choose picture by themselves, you can use file picker and copy the files to the pictureFolderPath then call this api to finish the rest enroll work (For Example: https://github.com/jaiselrahman/FilePicker)

2.Every Picture size should under 5MB

Parameters:

id - the unique info to represent every user

pictureFolderPath - the folder path where the picture is

Returns:

Serial number of the command.