com.slamtec.slamware.robot包

HealthInfo

表示机器人的健康状况。

方法

getErrors()

获取错误信息列表。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回值为错误信息列表。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
ArrayList<HealthInfo.BaseError> errors = healInfo.getErrors();

   

isError()

获取是否是错误信息。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回数据类型为boolean。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
boolean error = healInfo.isError();

   

isFatal()

获取是否是致命错误信息。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回数据类型为boolean。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
boolean fatal = healInfo.isFatal();

   

isWarning()

获取是否是警告信息。返回数据类型为boolean。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回数据类型为boolean。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
boolean warning = healInfo.isWarning();

   

setError(boolean error)

是否设置错误信息。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
error boolean 是否设置错误信息标志,true:设置 false:禁止 -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
healInfo.setError(true);

   

setErrors(java.util.ArrayList<HealthInfo.BaseError> errors)

设置错误信息列表。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
errors java.util.ArrayList 欲设置的错误信息列表 -
注意事项

示例代码


//此方法废

   

setFatal(boolean fatal)

设置为致命错误信息。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
fatal boolean 是否设置致命错误信息标志 true:设置 false:禁止 -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
healInfo.setFatal(true);

   

setWarning(boolean warning)

设置为警告。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
warning boolean 是否设置警告信息标志 true:设置 false:禁止 -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
healInfo.setWarning(true);

   

HealthInfo.BaseError

Fields

BaseErrorLevelHealthy

机器人底盘健康错误等级

BaseErrorComponentMotion

机器人底盘运动错误。

BaseErrorComponentPower

机器人底盘充电错误。

BaseErrorComponentSensor

机器人底盘传感器错误。

BaseErrorComponentSystem

机器人底盘系统错误。

BaseErrorComponentUnknown

机器人底盘未知错误。

BaseErrorComponentUser

机器人底盘用户错误。

BaseErrorLevelError

底盘错误等级为错误。

BaseErrorLevelFatal

底盘错误等级为致命错误。

BaseErrorLevelUnknown

底盘错误等级为未知错误。

BaseErrorLevelWarn

底盘错误等级为警告错误。

BaseComponentErrorTypeUnknown

底盘组件错误类型未知

BaseComponentErrorTypeUser

底盘组建错误类型为用户系统错误

BaseComponentErrorTypeSystemNone

(未使用)

BaseComponentErrorTypeSystemEmergencyStop

底盘组建错误类型为系统急停按钮按下

BaseComponentErrorTypeSystemTemperatureHigh

底盘组建错误类型为系统温度过高

BaseComponentErrorTypeSystemTemperatureLow

底盘组建错误类型为系统温度过低

BaseComponentErrorTypeSystemWatchDogOverFlow

底盘组建错误类型为看门狗超时

BaseComponentErrorTypeSystemCtrlBusDisconnected

底盘组建错误类型为底盘连接断开

BaseComponentErrorTypeSystemSlamwareRebooted

底盘组建错误类型为slamware重新启动

BaseComponentErrorTypePowerNone

(未使用)

BaseComponentErrorTypePowerControllerDown

底盘组建错误类型为电源控制板连接断开

BaseComponentErrorTypePowerPowerLow

底盘组建错误类型为低电量

BaseComponentErrorTypePowerOverCurrent

底盘组建错误类型为电流过高

BaseComponentErrorTypeMotionNone

(未使用)

BaseComponentErrorTypeMotionControllerDown

底盘组建错误类型为电机控制器异常

BaseComponentErrorTypeMotionMotorAlarm

底盘组建错误类型为电机报警

BaseComponentErrorTypeMotionMotorDown

底盘组建错误类型为电机异常

BaseComponentErrorTypeMotionOdometryDown

底盘组建错误类型为里程计异常

BaseComponentErrorTypeMotionBrushStall

(未使用)

BaseComponentErrorTypeMotionBlowerStall

(未使用)

BaseComponentErrorTypeSensorNone

(未使用)

BaseComponentErrorTypeSensorControllerDown

底盘组建错误类型为传感器板断开

BaseComponentErrorTypeSensorBumperDown

底盘组建错误类型为碰撞传感器断开

BaseComponentErrorTypeSensorCliffDown

底盘组建错误类型为跌落传感器断开

BaseComponentErrorTypeSensorSonarDown

底盘组建错误类型为超声波传感器断开

BaseComponentErrorTypeSensorDustbinBlock

(未使用)

BaseComponentErrorTypeSensorDustbinGone

(未使用)

BaseComponentErrorTypeSensorWallIrDown

(未使用)

BaseComponentErrorTypeSensorMagTapeTriggered

底盘组建错误类型为磁传感器触发

BaseComponentErrorTypeSensorMagSelfTestFailed

底盘组建错误类型为磁传感器自检失败

方法

getComponentErrorCode()

获取组件错误代码。返回数据类型为int。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回值为组件错误码

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
ArrayList<HealthInfo.BaseError> baseErrors = healInfo.getErrors();
Iterator it = baseErrors.iterator();
while(it.hasNext()){
    HealthInfo.BaseError baseError = (HealthInfo.BaseError)it.next();
    int compnentErrorCode = baseError.getComponentErrorCode();
}

   

getErrorCode()

获取错误代码。返回数据类型为int。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回错误码

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
ArrayList<HealthInfo.BaseError> baseErrors = healInfo.getErrors();
Iterator it = baseErrors.iterator();
while(it.hasNext()){
    HealthInfo.BaseError baseError = (HealthInfo.BaseError)it.next();
    int errCode = baseError.getErrorCode();
}

   

getErrorComponent()

获取错误组件。返回数据类型为int。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回错误组件

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
ArrayList<HealthInfo.BaseError> baseErrors = healInfo.getErrors();
Iterator it = baseErrors.iterator();
while(it.hasNext()){
    HealthInfo.BaseError baseError = (HealthInfo.BaseError)it.next();
    int errComponent = baseError.getErrorComponent();
}

   

getErrorLevel()

获取错误等级。返回数据类型为int。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回错误等级

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
ArrayList<HealthInfo.BaseError> baseErrors = healInfo.getErrors();
Iterator it = baseErrors.iterator();
while(it.hasNext()){
    HealthInfo.BaseError baseError = (HealthInfo.BaseError)it.next();
    int errLevel = baseError.getErrorLevel();
}

   

getErrorMessage()

获取错误信息。返回数据类型为string。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回错误信息字符串

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
ArrayList<HealthInfo.BaseError> baseErrors = healInfo.getErrors();
Iterator it = baseErrors.iterator();
while(it.hasNext()){
    HealthInfo.BaseError baseError = (HealthInfo.BaseError)it.next();
    String errMessge = baseError.getErrorMessage();
}

   

getId()

获取错误id。返回数据类型为int。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回错误id号

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
HealthInfo healthInfo = platform.getRobotHealth();
ArrayList<HealthInfo.BaseError> baseErrors = healInfo.getErrors();
Iterator it = baseErrors.iterator();
while(it.hasNext()){
    HealthInfo.BaseError baseError = (HealthInfo.BaseError)it.next();
    int errId = baseError.getId();
}

   

setComponentErrorCode(int componentErrorCode)

设置组件错误代码。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
componentErrorCode int 组件错误码 -
注意事项

示例代码


此方法废弃

   

setErrorCode(int errorCode)

设置错误代码。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
errorCode int 错误码 -
注意事项

示例代码


此方法废弃

   

setErrorComponent(int errorComponent)

设置错误组件。返回值为错误组件。数据类型为int。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
errorComponent int 错误组件 0:用户
1:系统
2:电源
3:电机
4:传感器
255:未知组件
注意事项

示例代码


此方法废弃

   

setErrorLevel(int errorLevel)

设置错误等级。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
errorLevel int 错误等级 0:正常
1:警告
2:错误
3:致命
255:未知
注意事项

示例代码


此方法废弃

   

setErrorMessage(java.lang.String errorMessage)

设置错误信息。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
errorMessage java.lang.String 错误信息字符串 -
注意事项

示例代码


此方法废弃

   

setId(int id)

设置错误信息Id。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
id int 错误信息Id -
注意事项

示例代码


此方法废弃

   

LaserPoint

方法

getDistance()

获取距离。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回值为激光扫描距离

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
LaserScan laserScan = platform.getLaserScan();
Vector<LaserPoint> laserPoints = laserScan.getLaserPoints();
Iterator itor = laserPoints.iterator();
while(itor.hasNext()) {
    LaserPoint pt = (LaserPoint)itor.next();
    float distance = pt.getDistance();
}

   

setDistance(float distance)

设置距离。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
distance float 激光扫描的距离 -
注意事项

示例代码


此方法废弃

   

getAngle()

获取角度。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回值为激光扫描的角度(rad)

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
LaserScan laserScan = platform.getLaserScan();
Vector<LaserPoint> laserPoints = laserScan.getLaserPoints();
Iterator itor = laserPoints.iterator();
while(itor.hasNext()) {
    LaserPoint pt = (LaserPoint)itor.next();
    float angle = pt.getAngle();
}

   

setAngle(float angle)

设置角度。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
angle float 激光扫描的角度(rad) -
注意事项

示例代码


此方法废弃

   

isValid()

测量是否有效。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回是否有效,类型为boolean

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
LaserScan laserScan = platform.getLaserScan();
Vector<LaserPoint> laserPoints = laserScan.getLaserPoints();
Iterator itor = laserPoints.iterator();
while(itor.hasNext()) {
    LaserPoint pt = (LaserPoint)itor.next();
    boolean valid = pt.isValid();
}

   

setValid(boolean valid)

将值设为有效。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
valid boolean 是否设为有效 true:有效 false:无效 -
注意事项

   

LaserScan类

构造器

LaserScan()

创建对象LaserScan。

LaserScan(java.util.Vector<LaserPoint> laserPoints)

创建对象LaserScan且以LaserPoints为参数。

LaserScan(java.util.Vector<LaserPoint> laserPointsPose pose)

创建对象LaserScan且以LaserPointPose为参数。

LaserScan(LaserScan rhs)

创建对象LaserScan且以LaserScan为参数。

方法

getLaserPoints()

获取激光点集合。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回值为激光扫描点集合,类型为Vector<LaserPoint>

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
LaserScan laserScan = platform.getLaserScan();
Vector<LaserPoint> laserPoints = laserScan.getLaserPoints();

   

setLaserPoints(java.util.Vector<LaserPoint> laserPoints)

设置激光点集合。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
laserPoints java.util.Vector<LaserPoint> 激光扫描点集合 -
注意事项

示例代码


Vector laserPoints = new Vector();
laserScan.setLaserPoints(laserPoints);

   

getPose()

获取姿态。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前机器姿态,类型为Pose

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
Pose pose = platform.getPose();

   

setPose(Pose pose)

设置姿态。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
pose Pose 当前机器姿态 -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
Pose pose = new Pose();//根据当前自己的环境设置当前的pose
platform.setPose(pose);

   

Location

方法

distanceTo(Location that)

获取到Location的距离。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回离另一位置的距离值,类型为float

参数说明
参数名称 参数类型 描述 备注
that Location 某一位置点,以计算到当前位置点的距离 -
注意事项

示例代码


Location location1 = new Location(1.5f,1.5f,1.5f);
Location location2 = new Location(3.5f,3.5f,3.5f);
float distance = location1.distanceTo(location2);

   

getX()

获取X值。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前位置的X坐标值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


Location location1 = new Location(1.5f,1.5f,1.5f);
float x = location1.getX();

   

setX(float v)

设置X坐标值。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
v float X坐标值 -
注意事项

示例代码


Location location1 = new Location(1.5f,1.5f,1.5f);
location1.setX(1.8f);

   

getY()

获取Y坐标值。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前位置的Y坐标值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


Location location1 = new Location(1.5f,1.5f,1.5f);
float y = location1.getY();

   

setY(float v)

设置Y坐标值。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
v float Y坐标值 -
注意事项

示例代码


Location location1 = new Location(1.5f,1.5f,1.5f);
location1.setY(3.0f);

   

getZ()

获取Z坐标值。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前位置的Z坐标值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


Location location1 = new Location(1.5f,1.5f,1.5f);
float z = location1.getZ();

   

setZ(float v)

设置Z坐标值。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
v float Z坐标值 -
注意事项

示例代码


Location location1 = new Location(1.5f,1.5f,1.5f);
location1.setZ(1.8f);

   

Map

方法

getOrigin()

获取Origin。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前地图的origin坐标,类型为PointF

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
RectF area = platform.getKnownArea(MapType.BITMAP_8BIT);
Map map = platform.getMap(MapType.BITMAP_8BIT, area);
PointF point = map.getOrigin();

   

setOrigin(PointF origin)

设置Origin。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
origin PointF 地图的origin坐标 -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
RectF area = platform.getKnownArea(MapType.BITMAP_8BIT);
Map map = platform.getMap(MapType.BITMAP_8BIT, area);
map.setOrigin(new PointF(1.0f, 1.0f));

   

getDimension()

获取Dimension。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前地图的Dimension,类型为Size

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
RectF area = platform.getKnownArea(MapType.BITMAP_8BIT);
Map map = platform.getMap(MapType.BITMAP_8BIT, area);
Size dimension = map.getDimension();

   

setDimension(Size dimension)

设置Dimension。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
dimension Size 地图的dimension -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
RectF area = platform.getKnownArea(MapType.BITMAP_8BIT);
Map map = platform.getMap(MapType.BITMAP_8BIT, area);
map.setDimension(new Size(320, 240));

   

getResolution()

获取Resolution。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前地图的Resolution,类型为PointF

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
RectF area = platform.getKnownArea(MapType.BITMAP_8BIT);
Map map = platform.getMap(MapType.BITMAP_8BIT, area);
PointF resolution = map.getResolution();

   

setResolution(PointF resolution)

设置Resolution。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
resolution PointF 地图的resolution -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
RectF area = platform.getKnownArea(MapType.BITMAP_8BIT); 
Map map = platform.getMap(MapType.BITMAP_8BIT, area);
map.setResolution(new PointF(0.05f, 0.05f));

   

getTimestamp()

获取Timestamp。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前时间戳值,类型为long

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
RectF area = platform.getKnownArea(MapType.BITMAP_8BIT); 
Map map = platform.getMap(MapType.BITMAP_8BIT, area);
long timestamp = map.getTimestamp();

   

setTimestamp(long timestamp)

设置Timestamp。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
timestamp long 时间戳值 -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
RectF area = platform.getKnownArea(MapType.BITMAP_8BIT); 
Map map = platform.getMap(MapType.BITMAP_8BIT, area);
map.setTimestamp(0);

   

getMapArea()

获取MapArea。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前地图的区域,类型为RectF

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
RectF area = platform.getKnownArea(MapType.BITMAP_8BIT); 
Map map = platform.getMap(MapType.BITMAP_8BIT, area);
RectF mapArea = map.getMapArea();

   

getData()

获取数据。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前地图的数据值,类型为byte[]

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
RectF area = platform.getKnownArea(MapType.BITMAP_8BIT); 
Map map = platform.getMap(MapType.BITMAP_8BIT, area);
byte[] mapData = map.getData();

   

setData(byte[] data)

设置数据。

Stability: 3 - Stable

Added in v2.5.0

返回值

void

参数说明
参数名称 参数类型 描述 备注
data byte[] 地图数据 -
注意事项

示例代码


//该方法暂时无用

   

NetworkMode

Fields

NetworkModeAP

网络模式为AP。

NetworkModeStation

网络模式为Station。

NetworkModeWifiDisabled

Wifi禁用的网络模式。    

Pose

方法

Location getLocation()

获取Location。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前位置,类型为Location

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
Pose pose = platform.getPose();
Location location = pose.getLocation();

   

setLocation(Location location)

设置Location。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
location Location 机器位置 属性为x,y,z
注意事项

示例代码


Pose pose = new Pose();
pose.setLocation(new Location(0.0f, 0.0f, 0.0f));

   

getRotation()

获取rotation。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前的rotation,类型为Rotation

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
Pose pose = platform.getPose();
Rotation rotation = pose.getRotation();

   

setRotation(Rotation rotation)

设置rotation。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
rotation Rotation 机器rotation 属性为yaw,roll,pitch
注意事项

示例代码


Pose pose = new Pose();
pose.setRotation(new Rotation(0.0f, 0.0f, 0.0f));

   

getX()

获取X。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前X值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
Pose pose = platform.getPose();
float x = pose.getX();

   

setX(float v)

设置X。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
v float 机器X坐标值 -
注意事项

示例代码


Pose pose = new Pose();
pose.setX(0.0f);

   

getY()

获取Y。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前Y值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
Pose pose = platform.getPose();
float y = pose.getY();

   

setY(float v)

设置Y。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
v float 机器Y坐标值 -
注意事项

示例代码


Pose pose = new Pose();
pose.setY(0.0f);

   

getZ()

获取Z。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前Z值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
Pose pose = platform.getPose();
float z = pose.getZ();

   

setZ(float v)

设置Z。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
v float 机器Z坐标值 -
注意事项

示例代码


Pose pose = new Pose();
pose.setZ(0.0f);

   

getYaw()

获取yaw。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前yaw值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
Pose pose = platform.getPose();
float yaw = pose.getYaw();

   

setYaw(float v)

设置yaw。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
v float 机器yaw值 -
注意事项

示例代码


Pose pose = new Pose();
pose.setYaw(0.0f);

   

getRoll()

获取roll。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前roll值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
Pose pose = platform.getPose();
float roll = pose.getRoll();

   

setRoll(float v)

设置roll。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
v float 机器roll值 -
注意事项

示例代码


Pose pose = new Pose();
pose.setRoll(0.0f);

   

getPitch()

获取pitch。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前pitch值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
Pose pose = platform.getPose();
float pitch = pose.getPitch();

   

setPitch(float v)

设置pitch。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
v float 机器pitch值 -
注意事项

示例代码


Pose pose = new Pose();
pose.setPitch(0.0f);

   

Rotation

方法

getYaw()

获取yaw。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前yaw值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
Pose pose = platform.getPose();
Rotation rotation = pose.getRotation();
float yaw = rotation.getYaw();

   

setYaw(float yaw)

设置yaw。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
yaw float 机器yaw值 -
注意事项

示例代码


Rotation rotation = new Rotation();
rotation.setYaw(0.0f);

   

getRoll()

获取roll。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前roll值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
Pose pose = platform.getPose();
Rotation rotation = pose.getRotation();
float roll = rotation.getRoll();

   

setRoll(float roll)

设置roll。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
roll float 机器roll值 -
注意事项

示例代码


Rotation rotation = new Rotation();
rotation.setRoll(0.0f);

   

getPitch()

获取pitch。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前pitch值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
Pose pose = platform.getPose();
Rotation rotation = pose.getRotation();
float pitch = rotation.getPitch();

   

setPitch(float pitch)

设置pitch。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
pitch float 机器pitch值 -
注意事项

示例代码


Rotation rotation = new Rotation();
rotation.setPitch(0.0f);

   

SystemParameters

Fields

SYSPARAM_ROBOT_SPEED

机器人速度。

SYSVAL_ROBOT_SPEED_HIGH

机器人高速度。

SYSVAL_ROBOT_SPEED_MEDIUM

机器人中速度。

SYSVAL_ROBOT_SPEED_LOW

机器人低速度。    

SleepMode枚举

枚举常量。

Unknown

目标Slamware固件不支持该命令。

Awake

醒着的模式。(当前雷达处于工作状态,机器人可以立刻工作)。

WakingUp

正在唤醒模式。(当调用wakeup()方法后,就处于当前状态)。

Asleep

睡眠模式。(当前雷达处于休眠状态,机器人不会立刻工作,调用wakeup()方法可以将雷达处于WakingUp状态,然后处于Awake)。    

DockingStatus枚举

枚举常量。

Unknown

Docking状态未知(目标Slamware固件不支持)。

OnDock

设备在充电座上。

NotOnDock

设备不在充电座上。    

PowerStatus

方法

public boolean isDCConnected()

直流电源连接。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回电源是否连接,类型为boolean

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
PowerStatus powerStatus = platform.getPowerStatus();
boolean isDCConnected = powerStatus.isDCConnected();

   

public DockingStatus getDockingStatus()

Docking状态。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回充电桩状态,类型为DockingStatus

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
PowerStatus powerStatus = platform.getPowerStatus();
DockingStatus dockingStatus = powerStatus.getDockingStatus();

   

public boolean isCharging()

设备是否处于充电状态。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器是否正在充电,类型为boolean

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
PowerStatus powerStatus = platform.getPowerStatus();
boolean isCharging = powerStatus.isCharging();

   

public int getBatteryPercentage()

电池电量(从0~100)。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前电量,类型为int

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
PowerStatus powerStatus = platform.getPowerStatus();
int batteryPercent = powerStatus.getBatteryPercentage();

   

public SleepMode getSleepMode()

设备休眠模式。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器当前休眠模式,类型为SleepMode

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
PowerStatus powerStatus = platform.getPowerStatus();
SleepMode sleepMode = powerStatus.getSleepMode();

   

GridMap

MapLayer的子类。

方法

public Location getOrigin()

获取原点位置。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回原点位置,类型为Location

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("explore")) {
        GridMap gridMap = (GridMap)mapLayer;
        Location origin = gridMap.getOrigin();
    }
}

   

public void setOrigin(Location origin)

设置原点位置。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
origin Location 原点位置 属性x,y,z
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("explore")) {
        GridMap gridMap = (GridMap)mapLayer;
        gridMap.setOrigin(new Location(1.0f, 1.0f, 0.0f));
    }
}

   

public Size getDimension()

获取grid地图尺寸。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回地图尺寸,类型为Size

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("explore")) {
        GridMap gridMap = (GridMap)mapLayer;
        Size dimension = gridMap.getDimension();
    }
}

   

public void setDimension(Size dimension)

设置grid地图尺寸。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
dimension Size 地图尺寸 -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("explore")) {
        GridMap gridMap = (GridMap)mapLayer;
        gridMap.setDimension(new Size(320, 240));
    }
}

   

public PointF getResolution()

获取grid地图分辨率。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回地图分辨率,类型为PointF

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("explore")) {
        GridMap gridMap = (GridMap)mapLayer;
        PointF point = gridMap.getResolution();
    }
}

   

public void setResolution(PointF resolution)

设置grid地图分辨率。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
resolution PointF 地图分辨率 -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("explore")) {
        GridMap gridMap = (GridMap)mapLayer;
        gridMap.setResolution(new PointF(0.05f, 0.05f));
    }
}

   

public byte[] getMapData()

获取grid地图信息。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回地图数据,类型为byte[]

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("explore")) {
        GridMap gridMap = (GridMap)mapLayer;
        byte[] mapData = gridMap.getMapData();
    }
}

   

public void setMapData(byte[] mapData)

设置grid地图信息。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
mapData byte[] 地图信息数据 -
注意事项

示例代码


该方法暂时无用

   

public void clear()

清除该图层对象的所有数据。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("explore")) {
        GridMap gridMap = (GridMap)mapLayer;
        gridMap.clear();
    }
}

   

CompositeMap

方法

public MapMetaData getMetaData()

获取Composite map属性信息。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回CompositeMap的属性信息,类型为MapMetaData

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
MapMetaData metaData = compisteMap.getMetaData();

   

public void setMetaData(MapMetaData data)

设置Composite map属性信息。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
data MapMetaData CompositeMap的属性信息 -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
compisteMap.setMetaData(new MapMetaData());

   

public ArrayList<MapLayer> getMaps()

获取Composite map地图信息。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回CompositeMap的图层集合,类型为ArrayList

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();

   

public void setMaps(ArrayList<MapLayer> maps)

设置Composite map地图信息。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
maps ArrayList CompositeMap地图图层集合 -
注意事项

示例代码


该方法暂时不用

   

MapKind枚举

枚举常量。

EXPLORE_MAP

利用SLAM算法创建的地图。

SWEEP_MAP

清扫操作使用的地图(仅适用于扫地机版本机器人)。

UWB_MAP

机器人根据UWB技术获取位置,形成的地图。

   

MapType枚举

枚举常量。

BITMAP_8BIT

位图,每个像素是一个带符号的8bit integer。

   

MoveOption

方法

isAppending()

是否是追加模式。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回表示是否是追加模式的boolean值。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
boolean appending = mvOpts.isAppending();

setAppending()

设置追加模式。

Stability: 3 - Stable

Added in v2.5.0

返回值

无。

参数说明
参数名称 参数类型 描述 备注
appending boolean 是否用追加模式 -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
boolean appending = true;
mvOpts.setAppending(appending);

isMilestone()

是否是里程碑(作为路径的关键点)。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回表示是否是里程碑的boolean值。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
boolean milestone = mvOpts.isMilestone();

setMilestone()

设置是否是里程碑(作为路径的关键点)。

Stability: 3 - Stable

Added in v2.5.0

返回值

无。

参数说明
参数名称 参数类型 描述 备注
milestone boolean 是否是里程碑 -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
boolean milestone = true;
mvOpts.setMilestone(milestone);

isNoSmooth()

该接口目前无效。

Stability: 3 - Stable

Added in v2.5.0

返回值

该接口目前无效。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

无。

示例代码


该接口目前无效

setNoSmooth()

该接口目前无效。

Stability: 3 - Stable

Added in v2.5.0

返回值

无。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

无。

示例代码


该接口目前无效

isKeyPoints()

是否使用虚拟轨道。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回表示是否使用虚拟轨道的boolean值。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
boolean keyPoints = mvOpts.isKeyPoints();

setKeyPoints()

设置是否使用虚拟轨道。

Stability: 3 - Stable

Added in v2.5.0

返回值

无。

参数说明
参数名称 参数类型 描述 备注
keyPoints boolean 是否使用虚拟轨道 -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
boolean keyPoints = true;
mvOpts.setKeyPoints(keyPoints);

isPrecise()

是否精确移动。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回表示是否精确移动的boolean值。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
boolean precise = mvOpts.isPrecise();

setPrecise()

设置是否精确移动。

Stability: 3 - Stable

Added in v2.5.0

返回值

无。

参数说明
参数名称 参数类型 描述 备注
precise boolean 是否精确移动 -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
boolean precise = true;
mvOpts.setPrecise(precise);

isWithYaw()

是否到达目标点后调整朝向。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回表示是否到达目标点后调整朝向的boolean值。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
boolean withYaw = mvOpts.isWithYaw();

setWithYaw()

设置是否到达目标点后调整朝向。

Stability: 3 - Stable

Added in v2.5.0

返回值

无。

参数说明
参数名称 参数类型 描述 备注
withYaw boolean 是否到达目标点后调整朝向 -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
boolean withYaw = true;
mvOpts.setWithYaw(withYaw);

isReturnUnreachableDirectly()

是否“无法达到目标点时直接返回Unreachable”。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回表示是否“无法达到目标点时直接返回Unreachable”的boolean值。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
boolean returnUnreachableDirectly = mvOpts.isReturnUnreachableDirectly();

setReturnUnreachableDirectly()

设置是否“无法达到目标点时直接返回Unreachable”。

Stability: 3 - Stable

Added in v2.5.0

返回值

无。

参数说明
参数名称 参数类型 描述 备注
returnUnreachableDirectly boolean 是否“无法达到目标点时直接返回Unreachable” -
注意事项

如果目标点无法到达,当“无法达到目标点时直接返回Unreachable”设为true时,将直接按照Unreachable处理,如果为false,则会先尝试目标点附近的点是否可以到达。

示例代码


MoveOption mvOpts = new MoveOption();
boolean returnUnreachableDirectly = true;
mvOpts.setReturnUnreachableDirectly(returnUnreachableDirectly);

isTrackWithOA()

是否使用轨道优先导航。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回表示是否使用轨道优先导航的boolean值。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
boolean trackWithOA = mvOpts.isTrackWithOA();

setTrackWithOA()

设置是否使用轨道优先导航。

Stability: 3 - Stable

Added in v2.5.0

返回值

无。

参数说明
参数名称 参数类型 描述 备注
trackWithOA boolean 是否使用轨道优先导航 -
注意事项

当要使用轨道优先导航时,isKeyPoints()必须也设置为true。

示例代码


MoveOption mvOpts = new MoveOption();
mvOpts.setKeyPoints(true);
mvOpts.setTrackWithOA(true);

getSpeedRatio()

获取速率比率。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回表示速率比率的Double对象。

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
Double speedRatio = mvOpts.getSpeedRatio();

setSpeedRatio()

设置速率比率。

Stability: 3 - Stable

Added in v2.5.0

返回值

无。

参数说明
参数名称 参数类型 描述 备注
speedRatio Double 速率比率 -
注意事项

无。

示例代码


MoveOption mvOpts = new MoveOption();
Double speedRatio = 1.0;
mvOpts.setSpeedRatio(speedRatio);

   

MapLayer

方法

getMetaData()

获取到当前图层属性数据。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前图层属性数据,类型为MapMetaData

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    MapMetaData metaData = mapLayer.getMetaData();
}

   

getName()

获取当前图层名称。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前图层名称,类型为java.lang.String

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    String name = mapLayer.getName();
}

   

getUsage()

获取当前图层用法。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前图层用法,类型为java.lang.String

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    String usage = mapLayer.getUsage();
}

   

clear()

清除图层信息

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

调用后该图层对象的所有信息都会被清空。

示例代码


mapLayer.clear();

   

PoseMap

MapLayer的子类。

方法

getPoses()

获取pose集合。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回pose集合,类型为HashMap

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("point_of_interest")) {
        PoseMap poseMap = (PoseMap)mapLayer;
        HashMap poses = poseMap.getPoses();
    }
    mapLayer.clear();
}

   

setPoses(HashMap<String, CompositePose> data)

设置poses集合数据。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
data HashMap poses集合 -
注意事项

示例代码


该方法暂时不用

   

PointMap

Map的子类。

方法

PointMap(java.util.List points, long timestamp)

根据points集合和timeStamp 创建对象。

Stability: 3 - Stable

Added in v2.5.0

返回值

参数说明
参数名称 参数类型 描述 备注
points java.util.List 地图点的集合 -
timestamp long 当前时间戳 -
注意事项

示例代码


List list = new ArrayList();
//list.add()........
long time = 12222222l;
PointMap pointMap = new PointMap(list,time);

   

getPoints()

获取到所有的点,返回值类型是集合。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回所有点的集合,类型为List

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


List list = new ArrayList();
//list.add()........
long time = 12222222l;
PointMap pointMap = new PointMap(list,time);
List points = pointMap.getPoints();

   

setPoints(List<PointPDF> points)

设置所有的点。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
points List 地图点的集合 -
注意事项

示例代码


该方法暂时不用

   

PointsMap

MapLayer的子类。

getPoints()

获取到所有的点,返回值类型是ArrayList

Stability: 3 - Stable

Added in v2.5.0

返回值

返回所有点的集合,类型为ArrayList

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


ArrayList points = pointsMapLayer.getPoints();

   

setPoints(ArrayList<PointPDF> points)

设置所有的点。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
points ArrayList 地图点的集合 -
注意事项

示例代码


ArrayList points = new ArrayList();
// add ...
pointsMapLayer.setPoints(points);

   

RecoverLocalizationMovement枚举

枚举常量。根据当前机器人的行为进行的重定位行为。

Unknown

未知当前机器人行为(一般不用)。

NoMove

当前机器人不移动。

RotateOnly

当前机器人仅仅进行旋转时。

Any

当前机器人进行任意行为。

RecoverLocalizationOptions

方法

getMaxRecoverTimeInMilliSeconds()

获取重新定位的最大时间(ms)。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回重新定位的最大时间,类型为Integer

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


RecoverLocalizationOptions recoverLocalizationOptions = new RecoverLocalizationOptions();
recoverLocalizationOptions.setMaxRecoverTimeInMilliSeconds(100);
Integer millliSeconds = recoverLocalizationOptions.getMaxRecoverTimeInMilliSeconds();

   

setMaxRecoverTimeInMilliSeconds(Integer maxRecoverMS)

设置重新定位的最大时间(ms)。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
maxRecoverMS Integer 重定位最大时间(ms) -
注意事项

示例代码


RecoverLocalizationOptions recoverLocalizationOptions = new RecoverLocalizationOptions();
recoverLocalizationOptions.setMaxRecoverTimeInMilliSeconds(100);

   

setRecoverMovementType(RecoverLocalizationMovement movementType)

设置重新定位需要传入的参数,该参数是当前发生的movement类型。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
movementType RecoverLocalizationMovement 当前机器的movement类型 -
注意事项

示例代码


RecoverLocalizationOptions recoverLocalizationOptions = new RecoverLocalizationOptions();
recoverLocalizationOptions.setRecoverMovementType(RecoverLocalizationMovement.Unknown);

   

RecoverLocalizationMovement getRecoverMovementType()

获取重新定位时,当前机器人发生的movement。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回机器重定位时的movement类型,类型为RecoverLocalizationMovement

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


RecoverLocalizationOptions recoverLocalizationOptions = new RecoverLocalizationOptions();
recoverLocalizationOptions.setRecoverMovementType(RecoverLocalizationMovement.Unknown);
RecoverLocalizationMovement movement = recoverLocalizationOptions.getRecoverMovementType();

   

SensorType枚举

机器人传感器类型。

Unknown

未知类型传感器。

Bumper

碰撞传感器。

Cliff

防跌落传感器。

Sonar

超声波传感器。

DepthCamera

深度摄像头传感器。

WallSensor

沿墙传感器。

MagTapeDetector

磁带传感器。

SlamcoreShutdownParam

底盘重启参数类。

方法

int getRestartTimeIntervalMinute()

获取到底盘多少分钟重启。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回底盘重启的时间间隔,类型为int

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
SlamcoreShutdownParam slamcoreShutdownParam = new SlamcoreShutdownParam();
int minute = slamcoreShutdownParam.getRestartTimeIntervalMinute();

   

setRestartTimeIntervalMinute(int restartTimeIntervalMinute)

设置底盘重启时间参数。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
restartTimeIntervalMinute int 底盘重启时间(分钟) -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445);
SlamcoreShutdownParam slamcoreShutdownParam = new SlamcoreShutdownParam();
slamcoreShutdownParam.setRestartTimeIntervalMinute(10);
platform.shutdownSlamcore(slamcoreShutdownParam);

   

SleepMode枚举

当前底盘休眠模式。

枚举常量

Unknown

未知模式。

Awake

醒着的模式。(当前雷达处于工作状态,机器人可以立刻工作)。

WakingUp

正在唤醒模式。(当调用wakeup()方法后,就处于当前状态)。

Asleep

睡眠模式。(当前雷达处于休眠状态,机器人不会立刻工作,调用wakeup()方法可以将雷达处于WakingUp状态,然后处于Awake)。

RestartMode枚举

枚举常量

SOFT

软重启模块,仅重启模块中的核心部分。

HARD

硬重启模块,整个模块重新启动,可能会花费较长的时间。

LineMap

MapLayer的子类。

方法

public HashMap<String, CompositeLine> getLines()

获取line map数据。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回line的数据集合,类型为HashMap

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("virtual_walls")) {
        LineMap wallLayer = (LineMap)mapLayer;
        HashMap walls = wallLayer.getLines();
    }
    else if(mapLayer.getUsage().equals("virtual_tracks")) {
        LineMap trackLayer = (LineMap)mapLayer;
        HashMap tracks = trackLayer.getLines();
    }
}

   

public void setLines(HashMap<String, CompositeLine> lines)

设置line map数据。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
lines HashMap 当前图层的line集合 -
注意事项

示例代码


该方法暂时不用

   

public void clear()

清除该图层对象的所有数据。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("virtual_walls") || mapLayer.getUsage().equals("virtual_tracks")) {
        LineMap lineMap = (LineMap)mapLayer;
        lineMap.clear();
    }
}

   

PointsMap

方法

public ArrayList<PointPDF> getPoints()

获取points map数据。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回points map点的集合,类型为ArrayList

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("pointsmap")) {
        PointsMap pointMap = (PointsMap)mapLayer;
        ArrayList points = pointMap.getPoints();
    }
}

   

public void setPoints(ArrayList<PointPDF> points)

设置points map数据。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
points ArrayList 当前图层点的集合 -
注意事项

示例代码


该方法暂时不用

   

public void clear()

清除该图层对象的所有数据。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回类型为void

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
CompositeMap compisteMap = platform.getCompositeMap();
ArrayList maps = compisteMap.getMaps();
Iterator itor = maps.iterator();
while(itor.hasNext()) {
    MapLayer mapLayer = (MapLayer)itor.next();
    if(mapLayer.getUsage().equals("pointsmap")) {
        PointsMap pointMap = (PointsMap)mapLayer;
        pointMap.clear();
    }
}

   

ImpactSensorInfo

方法

getSensorId()

获取传感器的id。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回传感器id,类型为int

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
List sensorInfos = platform.getSensors();
Iterator itor = sensorInfos.iterator();
while(itor.hasNext()) {
    ImpactSensorInfo sensorInfo = (ImpactSensorInfo)itor.next();
    int sensorId = sensorInfo.getSensorId();
}

   

getPose()

获取当前传感器的位置。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前传感器位置,类型为Pose

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
List sensorInfos = platform.getSensors();
Iterator itor = sensorInfos.iterator();
while(itor.hasNext()) {
    ImpactSensorInfo sensorInfo = (ImpactSensorInfo)itor.next();
    Pose pose = sensorInfo.getPose();
}

   

getKind()

获取到传感器种类。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前传感器种类,类型为SensorType

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
List sensorInfos = platform.getSensors();
Iterator itor = sensorInfos.iterator();
while(itor.hasNext()) {
    ImpactSensorInfo sensorInfo = (ImpactSensorInfo)itor.next();
    SensorType sensorType = sensorInfo.getKind();
}

   

getType()

获取到传感器类型。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前传感器类型,类型为ImpactSensorType

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
List sensorInfos = platform.getSensors();
Iterator itor = sensorInfos.iterator();
while(itor.hasNext()) {
    ImpactSensorInfo sensorInfo = (ImpactSensorInfo)itor.next();
    ImpactSensorType impactSensorType = sensorInfo.getType();
}

   

ImpactSensorType枚举

枚举常量

Unknown

未知类传感器。

Digital

数字类传感器。

Analog

模拟信号类传感器。

ImpactSensorValue

方法

getTime()

获取时间。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回当前时间戳,类型为long

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
ImpactSensorValue sensorValue = platform.getSensorValue(0);
long timestamp = sensorValue.getTime();

   

getValue()

获取值。

Stability: 3 - Stable

Added in v2.5.0

返回值

返回传感器当前值,类型为float

参数说明
参数名称 参数类型 描述 备注
- - -
注意事项

示例代码


AbstractSlamwarePlatform platform = DeviceManager.connect("192.168.11.1",1445); 
ImpactSensorValue sensorValue = platform.getSensorValue(0);
float value = sensorValue.getValue();