...

获取充电座位置。如果找不到充电座则返回(0,0)。

com. slamtec slamware action包

IAction接口

接口，表示机器人的动作。提供接口来执行该动作。

已知子接口：IMoveAction, ISweepMoveAction

方法

...

List<ImpactSensorInfo> getSensors()

获取到机器人所有的传感器信息，返回值是list集合

HashMap<Integer, ImpactSensorValue> getSensorValues()

...

获取到机器人所有的传感器信息，返回值是hashMap集合

...

ImpactSensorValue getSensorValue(Integer var1)

...

根据key 获取到机器人对应的传感器信息

getProgress()

获取动作进程（0~1）。返回值为动作进程（double）。

getStatus()

获取动作状态。返回值为动作状态。

waitUntilDone()

等待动作完成。返回值为完成的动作结果。

boolean isEmpty()

检查当前动作是否为空。

int getActionId()

获取当前动作id。

String getReason()

获取当前action结束后返回的字符串，成功后会返回不为null且长度为0的字符串，失败后会返回说明失败原因的字符串，如“failed”表示action失败, “aborted”表示action被打断(主动调用cancel或在action未结束时启动新的action)，
对于moveTo接口返回的action，“unreachable”表示目标点不可达(搜索路径失败)。

IMoveAction IAction接口

继承自 IAction

已知超接口：IAction

已知子接口：ISweepMoveAction

接口：表示移动动作。

方法

getRemainingMilestones()

获取剩余里程碑。返回值为剩余的里程碑。

getRemainingPath()

获取到下一里程碑的剩余路径。返回值为到下一里程碑的剩余路径。

继承自com.slamtec.slamware.action.IAction接口的方法如下：

cancel, getActionName, getProgress, getStatus, waitUntilDone

 pause()

暂停机器人的当前动作。

 resume()

恢复机器人暂停之前进行的动作。

ISweepMoveAction IAction接口

继承自 IMoveAction

已知超接口：IAction, IMoveAction

接口，表示清扫时的移动动作。

方法

继承自com.slamtec.slamware.action.IMoveAction接口的方法如下：

getRemainingMilestones, getRemainingPath

继承自com.slamtec.slamware.action.IAction接口的方法如下：

cancel, getActionName, getProgress, getStatus, waitUntilDone

path类

类，表示一条路径。

构造器

方法

getPoints() 

获取点。

setPoints(java.util.Vector<Location> points)

设置点。

ActionStatus枚举

public enum ActionStatus, 继承自 java.lang.Enum<ActionStatus>, 表示动作的状态。

枚举常量

WAITING_FOR_START

动作已创建但未开始。

RUNNING

动作正在进行。

FINISHED

动作成功完成。

PAUSED

动作已暂停。

STOPPED

动作已停止。

ERROR

动作遇到错误。

MoveDirection 枚举

public enum MoveDirection, 继承自 java.lang.Enum<MoveDirection>, 人工控制机器人时要求机器人移动的方向。

枚举常量

FORWARD

当前移动动作为向前。

BACKWARD

当前移动动作为向后。

TURN_RIGHT

当前移动动作为向右。

TURN_LEFT

当前移动动作为向左。

com.slamtec.slamware.discovery包

AbstractDiscover.BleConfigureListener 接口

封闭类：AbstractDiscover

方法

onConfigureSuccess()

配置成功。

onConfigureFailure(java.lang.String error)

配置失败。

String error枚举常量

BLE_CONFIG_ERROR_BLE_DISCONNECTED

断开连接

BLE_CONFIG_ERROR_WRITTING_FAIL

配置失败

BLE_CONFIG_ERROR_SSID_REQUIRED

SSID无效

BLE_CONFIG_ERROR_UNABLE_CONNECT_WIFI

无法连接至WiFi

BLE_CONFIG_ERROR_INVALID_PWD

密码错误

AbstractDiscover 类

public abstract class AbstractDiscover, abstract discover 接口。

已知子类：DeviceManager

嵌套类

构造器

getMode()

获取模式。

setListener(AbstractDiscover.DiscoveryListener listener)

设置listener。

getStatus(DiscoveryMode mode)

获取状态。

start(DiscoveryMode mode)

开始。

stop(DiscoveryMode mode)

结束。

AbstractDiscover.DiscoveryListener 类

封闭类：AbstractDiscover

构造器

onStartDiscovery(AbstractDiscover discover)

Discovery扫描开始的回调函数。

onStopDiscovery(AbstractDiscover discover)

Discovey扫描停止的回调函数。

onDiscoveryError(AbstractDiscover discover, java.lang.String error)

Discovery错误的回调函数。

onDeviceFound(AbstractDiscover discover, Device device)

发现设备的回调函数。

BleDevice 类

继承自 Device

构造器

BleDevice(BluetoothDevice device)

创建对象BleDevice。

方法

getDevice()

获取设备device。

canBeFoundWith(DiscoveryMode mode)

在discovery模式开启的状态下能否发现设备。

由Device  类中的canBeFoundWith指定

Device类

public abstract class Device, 表示一台设备。

已知子类：

BleDevice, MdnsDevice

构造器

Device()

创建对象Device。

方法

getManufactureId()

获取Manufacture id。

setManufactureId(int manufactureId)

设置manufacture id。

getModelId()

获取mode id。

setModelId(int modelId)

设置mode id。

getManufactureName()

获取manufacture name。

setManufactureName(java.lang.String manufactureName)

设置manufacture name。

getModelName()

获取mode name。

setModelName(java.lang.String modelName)

设置mode name。

getHardwareVersion()

获取 hard ware version。

setHardwareVersion(int hardwareVersion)

设置hardware version。

getSoftwareVersion()

获取 software version。

setSoftwareVersion(int softwareVersion)

设置software version。

getSerialNumber()

获取serial number。

setSerialNumber(java.lang.String serialNumber)

设置serial number。

canBeFoundWith(DiscoveryMode mode)

在discovery模式开启的状态下能否发现设备。

getDeviceId()

获取device id。

setDeviceId(java.util.UUID deviceId)

设置device id。

getDeviceName()

获取device name。

setDeviceName(java.lang.String deviceName)

设置device name。

DeviceManager 类

继承自 AbstractDiscover

The manager to manage devices。

Nested classes/interfaces inherited from class

com.slamtec.slamware.discovery.AbstractDiscover:

AbstractDiscover.BleConfigureListener,

AbstractDiscover.DiscoverStatus,

AbstractDiscover.DiscoveryListener

构造器

方法

connect(java.lang.String host, int port)

直接连接到SLAMWARE Core（该方法常用于Android设备通过高速总线直接连接到SLAMWARE Core）。返回值为连接到的平台。

参数

...

connect(Device device)

连接到指定的基于SLAMWARE的设备。返回值为连接到的设备。

参数

...

pair(Device device,java.lang.String wifiSSID, java.lang.String wifiPassword, AbstractDiscover.BleConfigureListener listener)

通过SSID和密码匹配SLAMWARE 设备。

参数

...

setListener(AbstractDiscover.DiscoveryListener listener)

由AbstractDiscover  类中的setListener指定

getStatus(DiscoveryMode mode)

由AbstractDiscover类中的getStatus指定。

start(DiscoveryMode mode)

由AbstractDiscover类中的start指定

stop(DiscoveryMode mode)

由AbstractDiscover类中的stop指定

getMode()

由AbstractDiscover类中的getMode指定

MdnsDevice 类

继承自 Device

构造器

方法

getAddr()

获取地址。

getPort()

获取端口。

canBeFoundWith(DiscoveryMode mode)

由Device类中的canBeFoundWith指定

AbstractDiscover.DiscoverStatus 枚举

封闭类

AbstractDiscover

枚举常量

STOPPED

停止。

WORKING

工作。

ERROR

错误。

DiscoveryMode 枚举

表明机器人如何被发现。

枚举常量

BLE

BLE 模式。

MDNS

mdns

com.slamtec.slamware.FirmwareUpdate包

FirmwareUpdateInfo类

public class FirmwareUpdateInfo表示固件更新信息。

构造器

方法

getBrief()

获取简明信息, 数据类型为字符串string。

getCurrent()

获取当前固件版本, 数据类型为字符串string。

getLatest()

获取最新固件版本, 数据类型为字符串string。

getReleaseDate()

获取固件发布日期, 数据类型为字符串string。

FirmwareUpdateProgress类

public class FirmwareUpdateProgress表示固件更新进程。

构造器

FirmwareUpdateProgress(int currentStep, int totalStep, int currentStepProgress, java.lang.String currentStepName)

创建对象FirmwareUpdateProgress且参数为currentStep/totalStep/currentStepProgress/currentStepName。

方法

getCurrentStep()

获取当前步骤，数据类型为int。

getCurrentStepName()

获取当前步骤名称，数据类型为字符串string。

getCurrentStepProgress()

获取当前步骤进程，数据类型为int。

getTotalStep()

获取所有步骤，数据类型为int。

com.slamtec.slamware.geometry包

Line类

public class Line,表示一条线。

构造器

方法

getStartPoint()

获取起始点。

setStartPoint(PointF startPointF)

设置起始点。

getEndPoint()

获取结束点。

setEndPoint(PointF endPoint)

设置结束点。

getStartX()

获取start x。

getStartY()

获取star y。

getEndX()

获取end x。

getEndY()

获取end y。

getSegmentId()

获取segment id。

setSegmentId(int segmentId)

设置Segment id。

PointF 类

public class PointF,表示一个2d浮点数据类型。

构造器

方法

getX()

获取X。

setX(float x)

设置X。

getY()

获取Y。

setY(float y)

设置Y。

Size 类

public class Size， 表示整数型的size数据类型。

构造器

方法

getWidth()

获取width。

setWidth(int width)

设置width。

getHeight()

获取height。

setHeight(int height)

设置height。

com.slamtec.slamware.robot包

HealthInfo类

public class HealthInfo，表示机器人的健康状况。

嵌套类  

构造器

方法

getErrors()

获取错误信息。返回值为错误信息列表。

isError()

获取是否是错误信息。返回数据类型为Boolean。

isFatal()

获取是否是致命错误信息。返回数据类型为Boolean。

isWarning()

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

setError(boolean error)

是否设置错误信息。

参数

...

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

设置为错误信息列表。

参数

...

setFatal(boolean fatal)

设置为致命错误信息。

参数

...

setWarning(boolean warning)

设置为警告。

参数

...

HealthInfo.BaseError类

封闭类： HealthInfo

Fields

BaseErrorComponentMotion

机器人底盘运动错误。

BaseErrorComponentPower

机器人底盘充电错误。

BaseErrorComponentSensor

机器人底盘传感器错误。

BaseErrorComponentSystem

机器人底盘系统错误。

BaseErrorComponentUnknown

机器人底盘未知错误。

BaseErrorComponentUser

机器人底盘用户错误。

BaseErrorLevelError

底盘错误等级为错误。

BaseErrorLevelFatal

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

BaseErrorLevelUnknown

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

BaseErrorLevelWarn

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

构造器

BaseError()

创建对象BaseError（）

BaseError(int id, int errorCode, int errorLevel, int errorComponent, int componentErrorCode, java.lang.String errorMessage)

创建对象BaseError（）。

参数

...

IMoveAction moveTo(Location location, MoveOption option, float yaw)

使机器人移动到指定的位置。 location 指定的位置，moveOption 是移动时候的参数，可以为：

IMoveAction moveTo(java.util.List locations, MoveOption option, float yaw)

参考上面的注释，只是移动到很多点

publishDepthCamFrame(int sensorId,DepthCameraFrame depthCameraFrame)

将深度摄像头的数据传递给底盘，其中sensorId 是通过底盘配置的sensorId, depthCameraFrame是深度摄像头数据对象。

com. slamtec slamware action包

IAction接口

接口，表示机器人的动作。提供接口来执行该动作。

已知子接口：IMoveAction, ISweepMoveAction

方法

cancel()

取消本次操作。

getActionName()

获取动作名称。返回值为动作名称（string）。

getProgress()

获取动作进程（0~1）。返回值为动作进程（double）。

getStatus()

获取动作状态。返回值为动作状态。

waitUntilDone()

等待动作完成。返回值为完成的动作结果。

boolean isEmpty()

检查当前动作是否为空。

int getActionId()

获取当前动作id。

String getReason()

获取当前action结束后返回的字符串，成功后会返回不为null且长度为0的字符串，失败后会返回说明失败原因的字符串，如“failed”表示action失败, “aborted”表示action被打断(主动调用cancel或在action未结束时启动新的action)，
对于moveTo接口返回的action，“unreachable”表示目标点不可达(搜索路径失败)。

IMoveAction IAction接口

继承自 IAction

已知超接口：IAction

已知子接口：ISweepMoveAction

接口：表示移动动作。

方法

getRemainingMilestones()

获取剩余里程碑。返回值为剩余的里程碑。

getRemainingPath()

获取到下一里程碑的剩余路径。返回值为到下一里程碑的剩余路径。

继承自com.slamtec.slamware.action.IAction接口的方法如下：

cancel, getActionName, getProgress, getStatus, waitUntilDone

ISweepMoveAction类

 pause()

暂停机器人的当前动作。

 resume()

恢复机器人暂停之前进行的动作。

ISweepMoveAction IAction接口

继承自 IMoveAction

已知超接口：IAction, IMoveAction

接口，表示清扫时的移动动作。

方法

继承自com.slamtec.slamware.action.IMoveAction接口的方法如下：

getRemainingMilestones, getRemainingPath

继承自com.slamtec.slamware.action.IAction接口的方法如下：

cancel, getActionName, getProgress, getStatus, waitUntilDone

path类

类，表示一条路径。

构造器

方法

getPoints() 

获取点。

setPoints(java.util.Vector<Location> points)

设置点。

ActionStatus枚举

public enum ActionStatus, 继承自 java.lang.Enum<ActionStatus>, 表示动作的状态。

枚举常量

WAITING_FOR_START

动作已创建但未开始。

RUNNING

动作正在进行。

FINISHED

动作成功完成。

PAUSED

动作已暂停。

STOPPED

动作已停止。

ERROR

动作遇到错误。

MoveDirection 枚举

public enum MoveDirection, 继承自 java.lang.Enum<MoveDirection>, 人工控制机器人时要求机器人移动的方向。

枚举常量

FORWARD

当前移动动作为向前。

BACKWARD

当前移动动作为向后。

TURN_RIGHT

当前移动动作为向右。

TURN_LEFT

当前移动动作为向左。

com.slamtec.slamware.discovery包

AbstractDiscover.BleConfigureListener 接口

封闭类：AbstractDiscover

方法

onConfigureSuccess()

配置成功。

onConfigureFailure(java.lang.String error)

配置失败。

String error枚举常量

BLE_CONFIG_ERROR_BLE_DISCONNECTED

断开连接

BLE_CONFIG_ERROR_WRITTING_FAIL

配置失败

BLE_CONFIG_ERROR_SSID_REQUIRED

SSID无效

BLE_CONFIG_ERROR_UNABLE_CONNECT_WIFI

无法连接至WiFi

BLE_CONFIG_ERROR_INVALID_PWD

密码错误

AbstractDiscover 类

public abstract class AbstractDiscover, abstract discover 接口。

已知子类：DeviceManager

嵌套类

构造器

getMode()

获取模式。

setListener(AbstractDiscover.DiscoveryListener listener)

设置listener。

getStatus(DiscoveryMode mode)

获取状态。

start(DiscoveryMode mode)

开始。

stop(DiscoveryMode mode)

结束。

AbstractDiscover.DiscoveryListener 类

封闭类：AbstractDiscover

构造器

onStartDiscovery(AbstractDiscover discover)

Discovery扫描开始的回调函数。

onStopDiscovery(AbstractDiscover discover)

Discovey扫描停止的回调函数。

onDiscoveryError(AbstractDiscover discover, java.lang.String error)

Discovery错误的回调函数。

onDeviceFound(AbstractDiscover discover, Device device)

发现设备的回调函数。

BleDevice 类

继承自 Device

构造器

BleDevice(BluetoothDevice device)

创建对象BleDevice。

方法

getDevice()

获取设备device。

canBeFoundWith(DiscoveryMode mode)

在discovery模式开启的状态下能否发现设备。

由Device  类中的canBeFoundWith指定

Device类

public abstract class Device, 表示一台设备。

已知子类：

BleDevice, MdnsDevice

构造器

Device()

创建对象Device。

方法

getManufactureId()

获取Manufacture id。

setManufactureId(int manufactureId)

设置manufacture id。

getModelId()

获取mode id。

setModelId(int modelId)

设置mode id。

getManufactureName()

获取manufacture name。

setManufactureName(java.lang.String manufactureName)

设置manufacture name。

getModelName()

获取mode name。

setModelName(java.lang.String modelName)

设置mode name。

getHardwareVersion()

获取 hard ware version。

setHardwareVersion(int hardwareVersion)

设置hardware version。

getSoftwareVersion()

获取 software version。

setSoftwareVersion(int softwareVersion)

设置software version。

getSerialNumber()

获取serial number。

setSerialNumber(java.lang.String serialNumber)

设置serial number。

canBeFoundWith(DiscoveryMode mode)

在discovery模式开启的状态下能否发现设备。

getDeviceId()

获取device id。

setDeviceId(java.util.UUID deviceId)

设置device id。

getDeviceName()

获取device name。

setDeviceName(java.lang.String deviceName)

设置device name。

DeviceManager 类

继承自 AbstractDiscover

The manager to manage devices。

Nested classes/interfaces inherited from class

com.slamtec.slamware.discovery.AbstractDiscover:

AbstractDiscover.BleConfigureListener,

AbstractDiscover.DiscoverStatus,

AbstractDiscover.DiscoveryListener

构造器

方法

connect(java.lang.String host, int port)

直接连接到SLAMWARE Core（该方法常用于Android设备通过高速总线直接连接到SLAMWARE Core）。返回值为连接到的平台。

参数

connect(Device device)

连接到指定的基于SLAMWARE的设备。返回值为连接到的设备。

参数

pair(Device device,java.lang.String wifiSSID, java.lang.String wifiPassword, AbstractDiscover.BleConfigureListener listener)

通过SSID和密码匹配SLAMWARE 设备。

参数

setListener(AbstractDiscover.DiscoveryListener listener)

由AbstractDiscover  类中的setListener指定

getStatus(DiscoveryMode mode)

由AbstractDiscover类中的getStatus指定。

start(DiscoveryMode mode)

由AbstractDiscover类中的start指定

stop(DiscoveryMode mode)

由AbstractDiscover类中的stop指定

getMode()

由AbstractDiscover类中的getMode指定

MdnsDevice 类

继承自 Device

构造器

方法

getAddr()

获取地址。

getPort()

获取端口。

canBeFoundWith(DiscoveryMode mode)

由Device类中的canBeFoundWith指定

AbstractDiscover.DiscoverStatus 枚举

封闭类

AbstractDiscover

枚举常量

STOPPED

停止。

WORKING

工作。

ERROR

错误。

DiscoveryMode 枚举

表明机器人如何被发现。

枚举常量

BLE

BLE 模式。

MDNS

mdns

com.slamtec.slamware.FirmwareUpdate包

FirmwareUpdateInfo类

public class FirmwareUpdateInfo表示固件更新信息。

构造器

方法

getBrief()

获取简明信息, 数据类型为字符串string。

getCurrent()

获取当前固件版本, 数据类型为字符串string。

getLatest()

获取最新固件版本, 数据类型为字符串string。

getReleaseDate()

获取固件发布日期, 数据类型为字符串string。

FirmwareUpdateProgress类

public class FirmwareUpdateProgress表示固件更新进程。

构造器

FirmwareUpdateProgress(int currentStep, int totalStep, int currentStepProgress, java.lang.String currentStepName)

创建对象FirmwareUpdateProgress且参数为currentStep/totalStep/currentStepProgress/currentStepName。

方法

getCurrentStep()

获取当前步骤，数据类型为int。

getCurrentStepName()

获取当前步骤名称，数据类型为字符串string。

getCurrentStepProgress()

获取当前步骤进程，数据类型为int。

getTotalStep()

获取所有步骤，数据类型为int。

com.slamtec.slamware.geometry包

Line类

public class Line,表示一条线。

构造器

方法

getStartPoint()

获取起始点。

setStartPoint(PointF startPointF)

设置起始点。

getEndPoint()

获取结束点。

setEndPoint(PointF endPoint)

设置结束点。

getStartX()

获取start x。

getStartY()

获取star y。

getEndX()

获取end x。

getEndY()

获取end y。

getSegmentId()

获取segment id。

setSegmentId(int segmentId)

设置Segment id。

PointF 类

public class PointF,表示一个2d浮点数据类型。

构造器

方法

getX()

获取X。

setX(float x)

设置X。

getY()

获取Y。

setY(float y)

设置Y。

Size 类

public class Size， 表示整数型的size数据类型。

构造器

方法

getWidth()

获取width。

setWidth(int width)

设置width。

getHeight()

获取height。

setHeight(int height)

设置height。

com.slamtec.slamware.robot包

HealthInfo类

public class HealthInfo，表示机器人的健康状况。

嵌套类  

构造器

方法

getErrors()

获取错误信息。返回值为错误信息列表。

isError()

获取是否是错误信息。返回数据类型为Boolean。

isFatal()

获取是否是致命错误信息。返回数据类型为Boolean。

isWarning()

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

setError(boolean error)

是否设置错误信息。

参数

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

设置为错误信息列表。

参数

setFatal(boolean fatal)

设置为致命错误信息。

参数

setWarning(boolean warning)

设置为警告。

参数

HealthInfo.BaseError类

封闭类： HealthInfo

Fields

BaseErrorComponentMotion

机器人底盘运动错误。

BaseErrorComponentPower

机器人底盘充电错误。

BaseErrorComponentSensor

机器人底盘传感器错误。

BaseErrorComponentSystem

机器人底盘系统错误。

BaseErrorComponentUnknown

机器人底盘未知错误。

BaseErrorComponentUser

机器人底盘用户错误。

BaseErrorLevelError

底盘错误等级为错误。

BaseErrorLevelFatal

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

BaseErrorLevelUnknown

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

BaseErrorLevelWarn

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

构造器

BaseError()

创建对象BaseError（）

BaseError(int id, int errorCode, int errorLevel, int errorComponent, int componentErrorCode, java.lang.String errorMessage)

创建对象BaseError（）。

参数

方法

getComponentErrorCode()

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

getErrorCode()

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

getErrorComponent()

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

getErrorLevel()

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

getErrorMessage()

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

getId()

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

setComponentErrorCode(int componentErrorCode)

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

setErrorCode(int errorCode)

设置错误代码。返回值为错误代码。数据类型为int。

setErrorComponent(int errorComponent)

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

setErrorLevel(int errorLevel)

设置错误等级。返回值为错误等级。数据类型为int。

setErrorMessage(java.lang.String errorMessage)

设置错误信息。返回值为错误信息。数据类型string。

setId(int id)

设置Id。返回值为Id。数据类型为int。

LaserPoint 类

public class LaserPoint, 表示一个激光扫描点。

构造器

方法

getDistance()

获取距离。

setDistance(float distance)

设置距离。

getAngle()

获取角度。

setAngle(float angle)

设置角度。

isValid()

测量是否有效。

setValid(boolean valid)

将值设为有效。

LaserScan 类

public class LaserScan，表示激光扫描。

构造器

方法

getLaserPoints()

获取激光点。

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

设置激光点。

getPose()

获取姿态。

setPose(Pose pose)

设置姿态。

Location 类

public class Location，表示3d空间中机器人的位置。

构造器

方法

distanceTo(Location that)

获取到Location的距离。

getX()

获取X值。

setX(float v)

设置X值。

getY()

获取Y值。

setY(float v)

设置Y值。

getZ()

获取Z值。

setZ(float v)

设置Z值。

Map 类

public class Map，表示地图。

构造器

getOrigin()

获取origin。

setOrigin(PointF origin)

设置origin。

getDimension()

获取dimension。

setDimension(Size dimension)

设置dimensions。

getResolution()

获取resolution。

setResolution(PointF resolution)

设置resolution。

getTimestamp()

获取 time stamp。

setTimestamp(long timestamp)

设置time stamp。

getMapArea()

获取map area。

getData()

获取data。

setData(byte[] data)

设置data。

NetworkMode类

Fields

构造器

NetworkMode()

创建对象NetworkMode()。

Pose 类

public class Pose，表示机器人姿态。

构造器

方法

Location getLocation()

获取Location。

setLocation(Location location)

设置Location。

getRotation()

获取rotation。

setRotation(Rotation rotation)

设置rotation。

getX()

获取X。

setX(float v)

设置X。

getY()

获取Y。

setY(float v)

设置Y。

getZ()

获取Z。

setZ(float v)

设置Z。

getYaw()

获取yaw。

setYaw(float v)

设置yaw。

getRoll()

获取roll。

setRoll(float v)

设置roll。

getPitch()

获取pitch。

setPitch(float v)

设置pitch。

Rotation 类

public class Rotation。

构造器

方法

getYaw()

获取yaw。

setYaw(float yaw)

设置Yaw。

getRoll()

获取roll。

setRoll(float roll)

设置roll。

getPitch()

获取pitch。

setPitch(float pitch)

设置pitch。

SystemParameters 类

构造器

Fields

SYSPARAM_ROBOT_SPEED

机器人速度。

SYSVAL_ROBOT_SPEED_HIGH

机器人高速度。

SYSVAL_ROBOT_SPEED_MEDIUM

机器人中速度。

SYSVAL_ROBOT_SPEED_LOW

机器人低速度。

SleepMode枚举

枚举常量

Unknown

目标Slamware固件不支持该命令

Awake

设备处于已唤醒状态，可以立刻响应命令

WakingUp

设备处于正在被唤醒中的状态，需要少许时间响应命令

Asleep

设备处于已休眠状态，需要稍长时间响应命令

DockingStatus枚举

枚举常量

Unknown

Docking状态未知（目标Slamware固件不支持）

OnDock

设备在充电座上

NotOnDock

设备不在充电座上

PowerStatus类

构造器

public PowerStatus(boolean isDCConnected, DockingStatus dockingStatus, boolean isCharging,
int batteryPercentage, SleepMode sleepMode)

方法

public boolean isDCConnected() 

直流电源连接

public DockingStatus getDockingStatus() 

Docking状态

public boolean isCharging()

设备是否处于充电状态

public int getBatteryPercentage()

电池电量（从0~100）

public SleepMode getSleepMode()

设备休眠模式

GridMap类

方法

public Location getOrigin() 

获取原点位置。

public void setOrigin(Location origin) 

设置原点位置，

public Size getDimension() 

获取grid地图尺寸。

public void setDimension(Size dimension) 

设置grid地图尺寸。

public PointF getResolution()

获取grid地图分辨率。

public void setResolution(PointF resolution)

设置grid地图分辨率。

public byte[] getMapData() 

获取grid地图信息。

public void setMapData(byte[] mapData) 

设置grid地图信息。

public void clear()

清除grid地图信息。

CompositeMap类

构造器

public CompositeMap()

默认构造器。

public CompositeMap(CompositeMap another) 

赋值构造器。

方法

public MapMetaData getMetaData() 

获取Composite map属性信息。

public void setMetaData(MapMetaData data) 

设置Composite map属性信息。

public ArrayList<MapLayer> getMaps() 

获取Composite map地图信息。

public void setMaps(ArrayList<MapLayer> maps) 

设置Composite map地图信息。

MapKind枚举

枚举常量

EXPLORE_MAP

利用SLAM算法创建的地图。

SWEEP_MAP

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

UWB_MAP

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

MapType枚举

枚举常量

BITMAP_8BIT

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

MapLayer类

地图层。

构造器

MapLayer()

创建MapLayer对象。

方法

getMetaData()

获取到地图数据。

getName()

获取到地图名称。

getUsage()

获取到地图用法。

clear()

清除所有数据。

PoseMap类

继承自MapLayer。

构造器

PoseMap()

创造PoseMap对象。

方法

getPoses()

获取到当前Poses map集合。

setPoses()

设置当前Poses map集合数据。

PointMap类

构造器

PointMap()

创建PointMap对象。

方法

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

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

getMapArea()

获取到当前地图区域的rectF。

getPoints()

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

setPoints()

设置所有的点。

RecoverLocalizationMovement枚举

当前发生move进行重新定位的枚举。

Unknown

未知当前位置信息。

NoMove

没有发生移动。

RotateOnly

紧紧发生了位置旋转。

Any

当前所有的位置都发生了变化。

RecoverLocalizationOptions类

重新定位选项。

构造器

RecoverLocalizationOptions()

创建RecoverLocalizationOptions对象。

方法

getMaxRecoverTimeInMilliSeconds()

获取从新定位的最大时间。

setMaxRecoverTimeInMilliSeconds(Integer maxRecoverMS)

设置从新定位的最大时间。

setRecoverMovementType(RecoverLocalizationMovement movementType)

设置从新定位需要传入的参数，该参数是当前发生的movement。

RecoverLocalizationMovement getRecoverMovementType()

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

SensorType枚举

机器人传感器类型。

Bumper

碰撞传感器。

Cliff

防跌落传感器。

Sonar

超声波传感器。

DepthCamera

深度摄像头传感器。

WallSensor

沿墙传感器。

SlamcoreShutdownParam类

底盘重启参数类。

构造器

SlamcoreShutdownParam()

创建SlamcoreShutdownParam对象。

方法

int getRestartTimeIntervalMinute()

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

setRestartTimeIntervalMinute(int restartTimeIntervalMinute)

设置底盘重启时间参数。

SleepMode 枚举

当前底盘休眠模式。

Unknown

未知模式。

Awake

醒着的模式。

WakingUp

正在唤醒模式。

Asleep

睡眠模式。

RestartMode枚举

枚举常量

SOFT

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

HARD

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

 LineMap类

方法

public HashMap<String, CompositeLine> getLines() 

获取line map数据。

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

设置line map数据。

public void clear()

清除line map数据。

PointsMap类

 public ArrayList<PointPDF> getPoints()

获取points map数据。

 public void setPoints(ArrayList<PointPDF> points) 

设置points map数据。

public void clear() 

清除points map数据。

 ImpactSensorInfo 类

 构造器

ImpactSensorInfo(int sensorId, Pose pose, ImpactSensorType type, SensorType coreSensorType, float refreshFreq)

创建ImpactSensorInfo对象。

方法

getSensorId()

获取传感器的id。

getPose()

获取当前传感器的位置。

getKind()

获取到传感器种类。

getType()

获取到传感器类型。

ImpactSensorType枚举

Digital

数字类传感器。

Analog

模拟信号类传感器。

ImpactSensorValue类

构造器

ImpactSensorValue(long time, float value)

创建对象参数是 time，value。

方法

getTime()

获取时间。

getValue()

获取值。

方法

getComponentErrorCode()

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

getErrorCode()

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

getErrorComponent()

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

getErrorLevel()

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

getErrorMessage()

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

getId()

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

setComponentErrorCode(int componentErrorCode)

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

setErrorCode(int errorCode)

设置错误代码。返回值为错误代码。数据类型为int。

setErrorComponent(int errorComponent)

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

setErrorLevel(int errorLevel)

设置错误等级。返回值为错误等级。数据类型为int。

setErrorMessage(java.lang.String errorMessage)

设置错误信息。返回值为错误信息。数据类型string。

setId(int id)

设置Id。返回值为Id。数据类型为int。

LaserPoint 类

public class LaserPoint, 表示一个激光扫描点。

构造器

方法

getDistance()

获取距离。

setDistance(float distance)

设置距离。

getAngle()

获取角度。

setAngle(float angle)

设置角度。

isValid()

测量是否有效。

setValid(boolean valid)

将值设为有效。

LaserScan 类

public class LaserScan，表示激光扫描。

构造器

方法

getLaserPoints()

获取激光点。

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

设置激光点。

getPose()

获取姿态。

setPose(Pose pose)

设置姿态。

Location 类

public class Location，表示3d空间中机器人的位置。

构造器

方法

distanceTo(Location that)

获取到Location的距离。

getX()

获取X值。

setX(float v)

设置X值。

getY()

获取Y值。

setY(float v)

设置Y值。

getZ()

获取Z值。

setZ(float v)

设置Z值。

Map 类

public class Map，表示地图。

构造器

getOrigin()

获取origin。

setOrigin(PointF origin)

设置origin。

getDimension()

获取dimension。

setDimension(Size dimension)

设置dimensions。

getResolution()

获取resolution。

setResolution(PointF resolution)

设置resolution。

getTimestamp()

获取 time stamp。

setTimestamp(long timestamp)

设置time stamp。

getMapArea()

获取map area。

getData()

获取data。

setData(byte[] data)

设置data。

NetworkMode类

Fields

构造器

NetworkMode()

创建对象NetworkMode()。

Pose 类

public class Pose，表示机器人姿态。

构造器

方法

Location getLocation()

获取Location。

setLocation(Location location)

设置Location。

getRotation()

获取rotation。

setRotation(Rotation rotation)

设置rotation。

getX()

获取X。

setX(float v)

设置X。

getY()

获取Y。

setY(float v)

设置Y。

getZ()

获取Z。

setZ(float v)

设置Z。

getYaw()

获取yaw。

setYaw(float v)

设置yaw。

getRoll()

获取roll。

setRoll(float v)

设置roll。

getPitch()

获取pitch。

setPitch(float v)

设置pitch。

Rotation 类

public class Rotation。

构造器

方法

getYaw()

获取yaw。

setYaw(float yaw)

设置Yaw。

getRoll()

获取roll。

setRoll(float roll)

设置roll。

getPitch()

获取pitch。

setPitch(float pitch)

设置pitch。

SystemParameters 类

构造器

Fields

SYSPARAM_ROBOT_SPEED

机器人速度。

SYSVAL_ROBOT_SPEED_HIGH

机器人高速度。

SYSVAL_ROBOT_SPEED_MEDIUM

机器人中速度。

SYSVAL_ROBOT_SPEED_LOW

机器人低速度。

SleepMode枚举

枚举常量

Unknown

目标Slamware固件不支持该命令

Awake

设备处于已唤醒状态，可以立刻响应命令

WakingUp

设备处于正在被唤醒中的状态，需要少许时间响应命令

Asleep

设备处于已休眠状态，需要稍长时间响应命令

DockingStatus枚举

枚举常量

Unknown

Docking状态未知（目标Slamware固件不支持）

OnDock

设备在充电座上

NotOnDock

设备不在充电座上

PowerStatus类

构造器

public PowerStatus(boolean isDCConnected, DockingStatus dockingStatus, boolean isCharging,
int batteryPercentage, SleepMode sleepMode)

方法

public boolean isDCConnected() 

...

public DockingStatus getDockingStatus() 

...

public boolean isCharging()

设备是否处于充电状态

public int getBatteryPercentage()

电池电量（从0~100）

public SleepMode getSleepMode()

设备休眠模式

GridMap类

方法

public Location getOrigin() 

获取原点位置。

public void setOrigin(Location origin) 

设置原点位置，

public Size getDimension() 

获取grid地图尺寸。

public void setDimension(Size dimension) 

设置grid地图尺寸。

public PointF getResolution()

获取grid地图分辨率。

public void setResolution(PointF resolution)

设置grid地图分辨率。

public byte[] getMapData() 

获取grid地图信息。

public void setMapData(byte[] mapData) 

设置grid地图信息。

public void clear()

清除grid地图信息。

CompositeMap类

构造器

public CompositeMap()

默认构造器。

public CompositeMap(CompositeMap another) 

赋值构造器。

方法

public MapMetaData getMetaData() 

获取Composite map属性信息。

public void setMetaData(MapMetaData data) 

设置Composite map属性信息。

public ArrayList<MapLayer> getMaps() 

获取Composite map地图信息。

public void setMaps(ArrayList<MapLayer> maps) 

设置Composite map地图信息。

MapKind枚举

枚举常量

EXPLORE_MAP

利用SLAM算法创建的地图。

SWEEP_MAP

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

MapType枚举

枚举常量

BITMAP_8BIT

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

RestartMode枚举

枚举常量

SOFT

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

HARD

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

 LineMap类

方法

public HashMap<String, CompositeLine> getLines() 

获取line map数据。

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

设置line map数据。

public void clear()

清除line map数据。

PointsMap类

 public ArrayList<PointPDF> getPoints()

获取points map数据。

 public void setPoints(ArrayList<PointPDF> points) 

设置points map数据。

public void clear() 

清除points map数据。

com.slamtec.slamware.exceptions包

...

未能找到路径，异常信息为“Failed to find path”。 

RequestFailException类

请求失败异常 请求失败，异常信息为“Request Failed” 。

RequestTimeOutException类

请求时间超时异常 请求时间超时，异常信息为“Request Time Out” 。

UnauthorizedRequestException类

未授权请求异常 请求未授权，异常信息为“Unauthorized request.” 。

UnsupportedCommandException类

不支持的命令异常 Unsupported 命令不支持，异常信息为“ Unsupported Command”。

com.slamtec.slamware.message包

DepthCameraFrame类

构造器

DepthCameraFrame()

创建DepthCameraFrame 对象。

方法

setMinValidDistance(float minValidDistance)

...

com.slamtec.slamware.sdp包

Action类

继承自 IAction。

方法

cancel()

取消本次操作。

getActionName()

...

释放所有指针资源。

CompositeMapHelper 

地图工具类地图工具类。

构造器

CompositeMapHelper() 

创建CompositeMapHelper对象。

方法

loadFile(String var1)

根据路径加载地图。

saveFile(String var1, CompositeMap var2)

根据路径保存地图。