本页提供了基于Android操作系统开发SLAMWARE SDK的API参考。 |
基于Android 操作系统对Slamware SDK进行应用开发,您的开发环境需满足如下条件:
|
让测试手机连接上开发的SDP,运行该程序出现界面无崩溃,则代表成功。
1. 测试的手机需是ARM处理器的,×86的将无法运行 2. 不支持模拟器运行 |
包名 | 描述 |
---|---|
com.slamtec.slamware | 包含有主要与slamware相关的类。 |
com.slamtec.slamware.action | 包含有与运动方式相关的类。 |
com.slamtec.slamware.discovery | 包含有与发现设备相关的类。 |
com.slamtec.slamware.FirmwareUpdate | 包含有与固件更新相关的类。 |
com.slamtec.slamware.geometry | 包含有与geometry相关的类。 |
com.slamtec.slamware.robot | 包含有与robot相关的类。 |
com.slamtec.slamware.exceptions | |
com.slamtec.slamware.message | |
com.slamtec.slamware.sdp |
类名 | 描述 |
---|---|
AbstractDiscover | 类, 表示abstract discover interface。 |
AbstractDiscover.BleConfigureListener | 类, 表示BleConfigureListener。 |
AbstractDiscover.DiscoverStatus | 类,表示DiscoverStatus。 |
AbstractDiscover.DiscoveryListener | 类,表示DiscoveryListener。 |
AbstractSlamwarePlatform | 类,定义统一的接口用于和SLAMWARE设备通讯。 |
ActionStatus | 枚举,列举动作状态。 |
BleDevice | 类,表示BleDevice。 |
Device | 类,表示设备。 |
DeviceManager | 类,表示管理设备的管理程序。 |
DiscoveryMode | 枚举,列举发现机器人的模式。 |
FirmwareUpdateInfo | 类,表示固件更新信息。 |
FirmwareUpdateProgress | 类,表示固件更新进程。 |
HealthInfo | 类,表示健康状况。 |
HealthInfo.BaseError | 类,表示底盘健康状况和错误信息。 |
IAction | 接口,表示机器人动作。 |
IMoveAction | 接口,表示移动动作。 |
ISweepMoveAction | 接口,表示清扫动作。 |
LaserPoint | 类,表示激光扫描点。 |
LaserScan | 类,表示一次激光扫描。 |
Line | 类,表示线。 |
Location | 类,表示机器人在3D空间中的位置。 |
Map(Robot) | 类,表示机器人所在的位置地图。 |
Map(SDP) | 类,表示SDP所在的位置地图。 |
MapKind | 枚举,列举地图种类。 |
MapType | 枚举,列举地图数据类型。 |
MdnsDevice | 类,MdnsDevice。 |
MoveDirection | 类,列举人工控制机器人时的方向指令。 |
NetworkMode | 类,表示网络模式。 |
Path | 类,表示路径。 |
PointF | 类,表示2D浮点小数数据类型。 |
Pose | 类,表示机器人姿态。 |
RestartMode | 枚举,列举重启模式。 |
Rotation | 类,表示旋转。 |
Size | 类,表示整数型的Size类别。 |
SlamwareCorePlatform | 类,Abstract Slamware Platform类的子类。 |
SlamwareSdpPlatform | 类,表示SDP扩展平台。 |
SystemParameters | 类,表示系统参数。 |
Abstract Slamware Platform 类,定义统一的接口用于和SLAMWARE设备通讯。
已知子类:SlamwareCorePlatform
AbstractSlamwarePlatform是一个抽象类,不能直接构造该类的对象。请使用DeviceManager连接设备并获取AbstractSlamwarePlatform的对象。
添加虚拟墙至SLAMWARE。
参数名称 | 描述 |
---|---|
wall | 需要添加的虚拟墙 |
添加多个虚拟墙至SLAMWARE。
参数名称 | 描述 |
---|---|
walls | 需要添加的多个虚拟墙。 |
清除当前地图。
移除指定的虚拟墙。
参数名称 | 描述 |
---|---|
id | 需要移除的虚拟墙的id |
从Slamware清除所有虚拟墙。
配置Slamware Core的网络工作模式。数据返回类型布尔值boolean。
参数名称 | 描述 |
---|---|
mode | 网络模式 |
options | 选项 |
当前支持的工作模式主要有:
模式名称 | 描述 |
---|---|
AP模式 | Slamware Core本身作为一个WiFi热点,当用户设备通过Wifi或者有线网络连接该WiFi热点时,会通过DHCP获得一个IP地址,而后通过192.168.11.1来访问设备,这个模式也是Slamware Core出厂的预置模式。 |
Station模式 | Slamware Core本身最为一个WiFi设备,连接到其他的WiFi热点上。同时Slamware Core会自动成为无线网桥,为High Speed Bus上的设备分配IP地址并提供外网访问服务。 |
Disable模式 | Slamware Core关闭自身的无线访问功能,只能通过有限网络访问,其IP地址、网关和DNS服务器均由API调用的参数决定。 |
将Slamware Core配置成AP模式
Platform.configureNetwork(NetworkMode.NetworkModeAp, new HashMap<String, String>());
让Slamware Core连上名字为Slamtec的AP
HashMap<String, String> options = newHashMap<String, String>(); options.put("ssid", "Slamtec"); options.put("password", "Password"); platform.configureNetwork(NetworkMode.NetworkModeStation,options); |
将Slamware Core的IP地址配置为192.168.12.13,默认网关为192.168.12.1,DNS服务器为:114.114.114.114:
HashMap<String, String> options = newHashMap<String, String>(); options.put("ip", "192.168.12.13"); options.put("mask": "255.255.255.0"); options.put("gateway": "192.168.12.1"); options.put("dns": "114.114.114.114"); platform.configureNetwork(NetworkMode.NetworkModeDisabled, options); |
断开与平台之间的连接。
获取SLAMWARE中可用的地图类型。返回值为地图类型列表。
获取电池是否在充电。返回值为布尔值,表明电池是否在充电。
获取电池剩余电量百分比(从0~100)。返回值为电池电量百分比。
获取机器人当前的动作。返回值为机器人当前正在进行的移动动作。
获取机器人是否连接到电源插座。返回值为布尔值,表明机器人是否连接到充电器。
获取设备的UUID。返回值数据类型为string。
请参考FirmwareUpdateInfo类
请参考FirmwareUpdateProgress类
获取设备硬件版本。返回值数据类型为string。
获取已探索到的地图区域。返回值为已探索的地图区域。
参数:type – 地图数据类型
获取已探索到的地图区域。返回值为已探索的地图区域。
参数名称 | 描述 |
---|---|
type | 地图数据类型 |
kind | 地图种类 |
获取最新的LASER扫描。返回值最新的LASER扫描。
获取定位可信度。
获取机器人在上述地图坐标系统中的坐标。返回值为机器人位置信息。
获取设备制造商id。返回值数据类型为int。
获取设备制造商名称。返回值数据类型为string。
从SLAMWARE获取地图数据。返回值为局部地图对象。
参数名称 | 描述 |
---|---|
type | 地图数据类型 |
kind | 地图种类 |
area | 地图区域 |
获取SLAMWARE是否在进行定位。返回值为布尔值表明SLAMWARE是否在进行定位。
获取SLAMWARE是否更新地图。返回值为布尔值表明SLAMWARE是否更新地图。
获取设备型号id。返回数据类型为int。
获取设备型号名称。返回数据类型为string。
获取网络状况。返回数据类型为string。
获取机器人在上述坐标系统中的姿态(包含位置信息和角度信息)。返回值为机器人的姿态。
获取机器人健康状态。返回数据为健康状况。
获取SLAMWARE SDK版本。返回值为标明SLAMWARESDK版本的字符串。
获取SLAMWARE版本。返回值为标明SLAMWARE版本的字符串。
获取设备的软件版本。返回值数据类型为字符串。
获取系统参数。返回值为当前参数的值。
参数名称 | 描述 |
---|---|
param | 获取的参数 |
获取当前存在的虚拟墙。返回值为当前存在的虚拟墙列表。
使机器人返回充电桩(注意:该方法仅适用于支持自动回充功能的机器人版本)。
人工控制机器人的移动。返回值为执行该项操作的移动动作。
(注意:在此状态下,机器人不会进行避障)。需要反复调用该函数来保持机器人的移动状态并调用MoveAction.cancel()函数来及时使机器人停止移动,否则机器人会在持续调用moveBy函数一段时期后停止移动。
参数名称 | 描述 |
---|---|
direction | 期望机器人移动的方向 |
使机器人移动到一系列指定位置。返回值为执行该项操作的移动动作。
参数名称 | 描述 |
---|---|
locations | 机器人前往指定位置经过的一系列节点。 |
使机器人移动到一系列的指定位置。返回值为执行该项操作的移动动作。
参数名称 | 描述 |
---|---|
locations | 机器人前往指定位置经过的一系列节点。 |
appending | 布尔值,用于决定SLAMWARE是清除当前任务建立新的点还是将新的点添加到已有的节点列表中。 |
使机器人移动到一系列的指定位置。返回值为执行该项操作的移动动作。
参数名称 | 描述 |
---|---|
locations | 机器人前往指定位置经过的一系列节点。 |
appending | 布尔值,用于决定SLAMWARE是清除当前任务建立新的点还是将新的点添加到已有的节点列表中。 |
isMilestone | 布尔值,用于决定SLAMWARE是规划路径到一系列节点还是直接前往。当这个参数为true时,机器人会将上述点视作关键点,通过路径搜索的方式前往目的地;当参数为false时,会被视作普通点,不会启用路径搜索功能。 |
使机器人移动到指定地点。返回值为执行该项操作的移动动作。
参数名称 | 描述 |
---|---|
location | 机器人将要到达的点。 |
使机器人移动到指定地点。返回值为执行该项操作的移动动作。
参数名称 | 描述 |
---|---|
location | 机器人将要到达的点。 |
appending | 布尔值,用于决定SLAMWARE是清除当前任务建立新的点还是将新的点添加到已有的节点列表中。 |
使机器人移动到指定地点。返回值为执行该项操作的移动动作。
参数名称 | 描述 |
---|---|
location | 机器人将要到达的点。 |
appending | 布尔值,用于决定SLAMWARE是清除当前任务建立新的点还是将新的点添加到已有的节点列表中。 |
isMilestone | 布尔值,用于决定SLAMWARE是规划路径到该节点还是直接前往。当这个参数为true时,机器人会将上述点视作关键点,通过路径搜索的方式前往目的地;当参数为false时,会被视作普通点,不会启用路径搜索功能。 |
重启SLAMWARE模块。
重启SLAMWARE模块。
参数名称 | 描述 |
---|---|
mode | 重启SLAMWARE模块的模式 |
使机器人旋转一个角度(不同的角度)。返回值为执行该项操作的移动动作。
参数名称 | 描述 |
---|---|
rotation | 机器人被要求旋转的弧度。 |
使机器人旋转到特定的朝向。返回值为执行该项操作的移动动作。
参数名称 | 描述 |
---|---|
orientation | 要求的姿态 |
在地图中寻找使机器人从当前位置移动到指定目标位置的路径。返回值为一条从机器人的当前位置到指定目标位置的路径。
参数名称 | 描述 |
---|---|
location | 目标位置 |
上传地图数据到SLAMWARE。(注意:应与setPose配套使用并确保地图未处于更新或定位状态。)
参数名称 | 描述 |
---|---|
map | 地图 |
上传地图数据到SLAMWARE。(注意:应与setPose配套使用并确保地图未处于更新或定位状态。)
参数名称 | 描述 |
---|---|
map | 地图 |
type | 地图数据类型 |
上传地图数据到SLAMWARE。(注意:应与setPose配套使用并确保地图未处于更新或定位状态。)
参数名称 | 描述 |
---|---|
map | 地图 |
type | 地图数据类型 |
kind | 地图种类 |
获取是否启用定位功能。
参数名称 | 描述 |
---|---|
v | 布尔值,表明SLAMWARE是否该进行定位。 |
获取是否更新地图。
参数名称 | 描述 |
---|---|
v | 布尔值,表明SLAMWARE是否应该更新地图。 |
设置机器人的姿态。
参数名称 | 描述 |
---|---|
pose | 机器人的新姿态 |
设置系统参数。
参数名称 | 描述 |
---|---|
param | 将要进行设置的参数。 |
value | 将要设置的值。 |
获取是否开始固件更新。返回值为boolean表示是否开始更新固件。
使机器人开始清扫(注意:该方法仅适用于扫地机版本的SLAMWARE Core)。返回值为执行该项操作的清扫移动动作。
使机器人开始定点清扫(注意:该方法仅适用于扫地机版本的SLAMWARE Core)。返回值为执行该项操作的清扫移动动作。
表示虚拟墙或者虚拟轨道。
ArtifactUsageVirutalWall
虚拟墙,用于限制设备的活动范围。
ArtifactUsageVirtualTrack
虚拟轨道,用于为设备提供预设的路线,设备将尽可能按照虚拟轨道移动。
获取所有虚拟墙或虚拟轨道的信息。返回值为一个line的列表。
参数名称 | 描述 |
---|---|
usage | 虚拟墙或者虚拟轨道 |
添加虚拟墙或虚拟轨道。
添加多条虚拟墙或虚拟轨道。
移除指定的虚拟墙或虚拟轨道。
移除所有虚拟墙或虚拟轨道。
获取电源相关的信息。
从休眠状态唤醒设备。
当机器人被抱起时可调用此接口进行重定位。
如果area区域为空时,机器人将在当前20*20的区域进行从定位,否则机器人将在指定区域进行重新定位。
根据当前辅助定位设备的信息获取当前机器人的大致位置信息
当机器人被抱起时,可以先调用getAuxLocation()获取机器人当前大致位置信息,然后调用recoverLocalization传入包含有大致位置信息的区域,使机器人尝试重定位。
auto locationPdf = platform. getAuxLocation(); Location location = locationPdf.location; float distant = locationPdf.circular_error_probability; area((location.x() - distant), (location.y() - distant), 2*distant, 2*distant);RectangleF auto act = platform. recoverLocalization(area); act.waitUntilDone(); |
获取当前地图的所有信息。
设置当前的地图信息。
获取充电座位置。如果找不到充电座则返回(0,0)。
接口,表示机器人的动作。提供接口来执行该动作。
已知子接口:IMoveAction, ISweepMoveAction
取消本次操作。
获取动作名称。返回值为动作名称(string)。
获取动作进程(0~1)。返回值为动作进程(double)。
获取动作状态。返回值为动作状态。
等待动作完成。返回值为完成的动作结果。
检查当前动作是否为空。
获取当前动作id。
获取当前action结束后返回的字符串,成功后会返回不为null且长度为0的字符串,失败后会返回说明失败原因的字符串,如“failed”表示action失败, “aborted”表示action被打断(主动调用cancel或在action未结束时启动新的action),
对于moveTo接口返回的action,“unreachable”表示目标点不可达(搜索路径失败)。
继承自 IAction
已知超接口:IAction
已知子接口:ISweepMoveAction
接口:表示移动动作。
获取剩余里程碑。返回值为剩余的里程碑。
获取到下一里程碑的剩余路径。返回值为到下一里程碑的剩余路径。
继承自com.slamtec.slamware.action.IAction接口的方法如下:
cancel, getActionName, getProgress, getStatus, waitUntilDone
暂停机器人的当前动作。
恢复机器人暂停之前进行的动作。
继承自 IMoveAction
已知超接口:IAction, IMoveAction
接口,表示清扫时的移动动作。
继承自com.slamtec.slamware.action.IMoveAction接口的方法如下:
getRemainingMilestones, getRemainingPath
继承自com.slamtec.slamware.action.IAction接口的方法如下:
cancel, getActionName, getProgress, getStatus, waitUntilDone
类,表示一条路径。
创建对象Path。
创建参数为path的对象Path。
创建参数为points的对象Path。
获取点。
设置点。
public enum ActionStatus, 继承自 java.lang.Enum<ActionStatus>, 表示动作的状态。
动作已创建但未开始。
动作正在进行。
动作成功完成。
动作已暂停。
动作已停止。
动作遇到错误。
public enum MoveDirection, 继承自 java.lang.Enum<MoveDirection>, 人工控制机器人时要求机器人移动的方向。
当前移动动作为向前。
当前移动动作为向后。
当前移动动作为向右。
当前移动动作为向左。
封闭类:AbstractDiscover
配置成功。
配置失败。
断开连接
配置失败
SSID无效
无法连接至WiFi
密码错误
public abstract class AbstractDiscover, abstract discover 接口。
已知子类:DeviceManager
AbstractDiscover.BleConfigureListener
AbstractDiscover.DiscoverStatus
AbstractDiscover.DiscoveryListener
创建对象AbstractDiscover。
获取模式。
设置listener。
获取状态。
开始。
结束。
封闭类:AbstractDiscover
创建对象DiscoveryListener。
Discovery扫描开始的回调函数。
Discovey扫描停止的回调函数。
Discovery错误的回调函数。
发现设备的回调函数。
继承自 Device
创建对象BleDevice。
获取设备device。
在discovery模式开启的状态下能否发现设备。
由Device 类中的canBeFoundWith指定
public abstract class Device, 表示一台设备。
已知子类:
BleDevice, MdnsDevice
创建对象Device。
获取Manufacture id。
设置manufacture id。
获取mode id。
设置mode id。
获取manufacture name。
设置manufacture name。
获取mode name。
设置mode name。
获取 hard ware version。
设置hardware version。
获取 software version。
设置software version。
获取serial number。
设置serial number。
在discovery模式开启的状态下能否发现设备。
获取device id。
设置device id。
获取device name。
设置device name。
继承自 AbstractDiscover
The manager to manage devices。
Nested classes/interfaces inherited from class
com.slamtec.slamware.discovery.AbstractDiscover:
AbstractDiscover.BleConfigureListener,
AbstractDiscover.DiscoverStatus,
AbstractDiscover.DiscoveryListener
创建对象DeivceManager。
直接连接到SLAMWARE Core(该方法常用于Android设备通过高速总线直接连接到SLAMWARE Core)。返回值为连接到的平台。
参数名称 | 描述 |
---|---|
host | 设备主机(通常是192.168.11.1) |
port | 端口 |
连接到指定的基于SLAMWARE的设备。返回值为连接到的设备。
参数名称 | 描述 |
---|---|
device | 准备连接的设备 |
通过SSID和密码匹配SLAMWARE 设备。
参数名称 | 描述 |
---|---|
device | 准备配对的设备 |
wifiSSID | WiFi的SSID |
sifiPassword | WiFi的密码 |
listener | 配置监听器 |
由AbstractDiscover 类中的setListener指定
由AbstractDiscover类中的getStatus指定。
由AbstractDiscover类中的start指定
由AbstractDiscover类中的stop指定
由AbstractDiscover类中的getMode指定
继承自 Device
创建对象 MdnsDevice。
获取地址。
获取端口。
由Device类中的canBeFoundWith指定
封闭类
AbstractDiscover
停止。
工作。
错误。
表明机器人如何被发现。
BLE 模式。
mdns
public class FirmwareUpdateInfo表示固件更新信息。
创建对象FirmwareUpdateInfo且参数为current/latest/releasedDate/brief。
获取简明信息, 数据类型为字符串string。
获取当前固件版本, 数据类型为字符串string。
获取最新固件版本, 数据类型为字符串string。
获取固件发布日期, 数据类型为字符串string。
public class FirmwareUpdateProgress表示固件更新进程。
创建对象FirmwareUpdateProgress且参数为currentStep/totalStep/currentStepProgress/currentStepName。
获取当前步骤,数据类型为int。
获取当前步骤名称,数据类型为字符串string。
获取当前步骤进程,数据类型为int。
获取所有步骤,数据类型为int。
public class Line,表示一条线。
创建对象Line且segment id,start point和end point为指定值。
创建对象Line 且segment id, startX, startY, endX, endy 为指定值。
创建对象Line 且以Line为参数。
创建对象Line 且startP和endP为指定值。
获取起始点。
设置起始点。
获取结束点。
设置结束点。
获取start x。
获取star y。
获取end x。
获取end y。
获取segment id。
设置Segment id。
public class PointF,表示一个2d浮点数据类型。
创建对象PointF。
创建对象PointF且x,y为指定值。
创建对象PointF且以PointF为参数。
获取X。
设置X。
获取Y。
设置Y。
public class Size, 表示整数型的size数据类型。
创建对象Size。
创建对象Size且width和height为指定值。
创建对象Size且以Size为参数。
获取width。
设置width。
获取height。
设置height。
public class HealthInfo,表示机器人的健康状况。
HealthInfo.BaseError
创建对象HealthInfo()。
创建对象HealthInfo(),参数为warning/error/fatal/错误列表。
获取错误信息。返回值为错误信息列表。
获取是否是错误信息。返回数据类型为Boolean。
获取是否是致命错误信息。返回数据类型为Boolean。
获取是否是警告信息。返回数据类型为Boolean。
是否设置错误信息。
参数名称 | 描述 |
---|---|
error | 将要处理的错误信息 |
设置为错误信息列表。
参数名称 | 描述 |
---|---|
errors | 错误信息列表 |
设置为致命错误信息。
参数名称 | 描述 |
---|---|
fatal | 致命错误 |
设置为警告。
参数名称 | 描述 |
---|---|
warning | 警告类错误信息 |
封闭类: HealthInfo
机器人底盘运动错误。
机器人底盘充电错误。
机器人底盘传感器错误。
机器人底盘系统错误。
机器人底盘未知错误。
机器人底盘用户错误。
底盘错误等级为错误。
底盘错误等级为致命错误。
底盘错误等级为未知错误。
底盘错误等级为警告错误。
创建对象BaseError()
创建对象BaseError()。
参数名称 | 描述 |
---|---|
error code | 错误代码 |
error level | 错误等级 |
error component | 错误组件 |
componentErrorCode | 组件错误代码 |
errorMessage | 错误信息 |
方法
获取组件错误代码。返回数据类型为int。
获取错误代码。返回数据类型为int。
获取错误组件。返回数据类型为int。
获取错误等级。返回数据类型为int。
获取错误信息。返回数据类型为string。
获取错误id。返回数据类型为int。
设置组件错误代码。返回值为组件错误代码。数据类型为int。
设置错误代码。返回值为错误代码。数据类型为int。
设置错误组件。返回值为错误组件。数据类型为int。
设置错误等级。返回值为错误等级。数据类型为int。
设置错误信息。返回值为错误信息。数据类型string。
设置Id。返回值为Id。数据类型为int。
public class LaserPoint, 表示一个激光扫描点。
创建对象LaserPoint。
创建对象LaserPoint且距离和角度为指定值。
创建对象LaserPoint且距离,角度和有效性为指定值。
创建对象LaserPoint且以LaserPoint为参数。
获取距离。
设置距离。
获取角度。
设置角度。
测量是否有效。
将值设为有效。
public class LaserScan,表示激光扫描。
创建对象LaserScan。
创建对象LaserScan且以LaserPoints为参数。
创建对象LaserScan且以LaserPointPose为参数。
创建对象LaserScan且以LaserScan为参数。
获取激光点。
设置激光点。
获取姿态。
设置姿态。
public class Location,表示3d空间中机器人的位置。
创建对象Location。
创建对象Location且x,y,z为指定值。
创建对象Location且以Location为参数。
获取到Location的距离。
获取X值。
设置X值。
获取Y值。
设置Y值。
获取Z值。
设置Z值。
public class Map,表示地图。
创建对象Map。
获取origin。
设置origin。
获取dimension。
设置dimensions。
获取resolution。
设置resolution。
获取 time stamp。
设置time stamp。
获取map area。
获取data。
设置data。
网络模式为AP。
网络模式为Station。
Wifi禁用的网络模式。
创建对象NetworkMode()。
public class Pose,表示机器人姿态。
创建对象Pose。
创建对象Pose且loc和ros为指定值。
创建对象Pose且x,y,z,yaw,roll,pitch为指定值。
创建对象Pose且以Pose为参数。
获取Location。
设置Location。
获取rotation。
设置rotation。
获取X。
设置X。
获取Y。
设置Y。
获取Z。
设置Z。
获取yaw。
设置yaw。
获取roll。
设置roll。
获取pitch。
设置pitch。
public class Rotation。
创建对象Rotation。
创建对象 Rotation且yaw为指定值。
创建对象Rotation且yaw,pitch,roll为指定值。
创建对象Rotation且以Rotation为参数。
获取yaw。
设置Yaw。
获取roll。
设置roll。
获取pitch。
设置pitch。
创建对象SystemParameters。
机器人速度。
机器人高速度。
机器人中速度。
机器人低速度。
枚举常量
目标Slamware固件不支持该命令
设备处于已唤醒状态,可以立刻响应命令
设备处于正在被唤醒中的状态,需要少许时间响应命令
设备处于已休眠状态,需要稍长时间响应命令
枚举常量
Docking状态未知(目标Slamware固件不支持)
设备在充电座上
设备不在充电座上
public PowerStatus(boolean isDCConnected, DockingStatus dockingStatus, boolean isCharging,
int batteryPercentage, SleepMode sleepMode)
直流电源连接
Docking状态
设备是否处于充电状态
电池电量(从0~100)
设备休眠模式
获取原点位置。
设置原点位置,
获取grid地图尺寸。
设置grid地图尺寸。
获取grid地图分辨率。
设置grid地图分辨率。
获取grid地图信息。
设置grid地图信息。
清除grid地图信息。
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地图信息。
利用SLAM算法创建的地图。
清扫操作使用的地图(仅适用于扫地机版本机器人)。
位图,每个像素是一个带符号的8bit integer。
软重启模块,仅重启模块中的核心部分。
硬重启模块,整个模块重新启动,可能会花费较长的时间。
获取line map数据。
设置line map数据。
清除line map数据。
获取points map数据。
设置points map数据。
清除points map数据。
已连接到机器,异常信息为“Already Connected to the device”。
连接机器人失败,异常信息为“Connection Failed”。
连接丢失,异常信息为“Connection Lost” 。
连接超时,异常信息为“Connection Time Out”。
参数无效,异常信息为“Invalid Argument” 。
操作失败,异常信息为“Operation Failed”。
资源不足,异常信息为“Out of Resource”。
参数解析无效,异常信息为“Failed to parse device data” 。
未能找到路径,异常信息为“Failed to find path”。
请求失败异常 Request Failed
请求时间超时异常 Request Time Out
未授权请求异常 Unauthorized request.
不支持的命令异常 Unsupported Command
创建DepthCameraFrame 对象。
设置深度摄像头最小探测的距离,单位是米。
获取深度摄像头最小探测的距离,单位是米。
设置深度摄像头最大探测的距离,单位是米。
获取深度摄像头最大探测的距离,单位是米。
设置深度摄像头垂直方向朝下最大探测仰度,单位是弧度。
获取深度摄像头垂直方向朝下最大探测仰度,单位是弧度。
设置深度摄像头垂直方向朝上最小探测的仰角,单位是弧度。
获取深度摄像头垂直方向朝上最小探测的仰角,单位是弧度。
设置深度摄像头水平方向朝左最大探测的角度,单位是弧度。
获取深度摄像头水平方向朝左最大探测的角度,单位是弧度。
设置深度摄像头水平方向朝右最小探测的角度,单位是弧度。
获取深度摄像头水平方向朝右最小探测的角度,单位是弧度。
设置深度摄像头数据多少列。
获取深度摄像头数据多少列。
设置深度摄像头数据多少行。
获取深度摄像头数据多少行。
设置深度摄像头采集到的数据,数据大小为行*列(cols*rows),数据的排列由左到右依次往下 ,float的单位是米。
获取深度摄像头采集到的数据,数据大小为行*列(cols*rows),数据的排列由左到右依次往下 ,float的单位是米。
继承自 IAction。
取消本次操作。
获取动作名称。返回值为动作名称(string)。
获取动作进程(0~1)。返回值为动作进程(double)。
获取动作状态。返回值为动作状态。
等待动作完成。返回值为完成的动作结果。
判断当前action是否为空。
获取当前action的id。
获取到当前action的名字。
获取当前action结束后返回的字符串,成功后会返回不为null且长度为0的字符串,失败后会返回失败原因的字符串,如“failed”表示action失败, “aborted”表示action被打断(主动调用cancel或者在action没有结束的时候启动新的action),对于通过moveTo接口返回的action,“unreachable”表示目标点不可达(搜索路径失败)。
释放所有指针资源。
地图工具类
创建CompositeMapHelper对象。
根据路径加载地图。
根据路径保存地图。