Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

类名

描述

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

类,表示旋转。

ScheduledTask

类,表示预约任务

Size

类,表示整数型的Size类别。

SlamwareCorePlatform

类,Abstract Slamware Platform类的子类。

SlamwareSdpPlatform

类,表示SDP扩展平台。

SystemParameters

类,表示系统参数。

...

AbstractSlamwarePlatform()

AbstractSlamwarePlatform是一个抽象类,不能直接构造该类的对象。请使用DeviceManager连接设备并获取AbstractSlamwarePlatform的对象。

方法

addScheduledTask(ScheduledTask task)

添加预约扫地任务。返回数据类型为布尔值boolean。

参数

...

addWall(Line wall)

添加虚拟墙至SLAMWARE。

参数
参数名称描述
wall需要添加的虚拟墙

addWalls(java.util.List<Line> walls)

添加多个虚拟墙至SLAMWARE。

参数
参数名称描述
walls需要添加的多个虚拟墙。

clearMap()

...

clearWallById(int id)

移除指定的虚拟墙。

参数
参数名称描述
id需要移除的虚拟墙的id

clearWalls()

...

配置Slamware Core的网络工作模式。数据返回类型布尔值boolean。

参数
参数名称描述
mode网络模式
options选项
说明

...

  • 将Slamware Core的IP地址配置为192.168.12.13,默认网关为192.168.12.1,DNS服务器为:114.114.114.114:

    Code Block
    languagejs
    firstline0
    linenumberstrue
    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);

deleteScheduledTask(int taskId)

是否删除预约的清扫任务。数据返回类型为布尔值boolean。

参数

...


disconnect()

断开与平台之间的连接。

getAvailableMaps()

...

获取已探索到的地图区域。返回值为已探索的地图区域。

参数
参数名称描述
type地图数据类型
kind地图种类

getLaserScan()

...

从SLAMWARE获取地图数据。返回值为局部地图对象。

参数
参数名称描述
type地图数据类型
kind地图种类
area地图区域

getMap(MapType type, android.graphics.RectF area)

从SLAMWARE获取地图数据。返回值为局部地图对象。

参数
参数名称描述
type地图数据类型
area地图区域

getMapLocalization()

获取SLAMWARE是否在进行定位。返回值为布尔值表明SLAMWARE是否在进行定位。

...

getRobotHealth()

获取机器人健康状态。返回数据为健康状况。

getScheduledTask(int taskId)

获取预约任务。

参数

...

getScheduledTasks()

获取预约的任务。返回值为预约的任务列表。

getSDKVersion()

获取SLAMWARE SDK版本。返回值为标明SLAMWARESDK版本的字符串。

...

getSystemParameter(java.lang.String param)

获取系统参数。返回值为当前参数的值。

参数
参数名称描述
param获取的参数

getWalls()

...

(注意:在此状态下,机器人不会进行避障)。需要反复调用该函数来保持机器人的移动状态并调用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时,会被视作普通点,不会启用路径搜索功能。

...

restartModule(RestartMode mode)

重启SLAMWARE模块。

参数
参数名称描述
mode重启SLAMWARE模块的模式

...

使机器人旋转一个角度(不同的角度)。返回值为执行该项操作的移动动作。

参数
参数名称描述
rotation机器人被要求旋转的弧度。

...

使机器人旋转到特定的朝向。返回值为执行该项操作的移动动作。

参数
参数名称描述
orientation要求的姿态

searchPath(Location location)

在地图中寻找使机器人从当前位置移动到指定目标位置的路径。返回值为一条从机器人的当前位置到指定目标位置的路径。

参数
参数名称描述
location目标位置

setMap(Map map)

上传地图数据到SLAMWARE。(注意:应与setPose配套使用并确保地图未处于更新或定位状态。)

参数
参数名称描述
map地图

setMap(Map map, MapType type)

上传地图数据到SLAMWARE。(注意:应与setPose配套使用并确保地图未处于更新或定位状态。)

参数
参数名称描述
map地图
type地图数据类型

setMap(Map map, MapType type, MapKind kind)

上传地图数据到SLAMWARE。(注意:应与setPose配套使用并确保地图未处于更新或定位状态。)

参数
参数名称描述
map地图
type地图数据类型
kind地图种类

setMapLocalization(boolean v)

获取是否启用定位功能。

参数
参数名称描述
v布尔值,表明SLAMWARE是否该进行定位。

setMapUpdate(boolean v)

获取是否更新地图。

参数
参数名称描述
v布尔值,表明SLAMWARE是否应该更新地图。

setPose(Pose pose)

设置机器人的姿态。

参数
参数名称描述
pose机器人的新姿态

setSystemParameter(java.lang.String param, java.lang.String value)

设置系统参数。

参数
参数名称描述

param

 将要进行设置的参数。
value将要设置的值。

...

使机器人开始定点清扫(注意:该方法仅适用于扫地机版本的SLAMWARE Core)。返回值为执行该项操作的清扫移动动作。

updateScheduledTask(ScheduledTask task)

...

ArtifactUsage枚举

表示虚拟墙或者虚拟轨道。

枚举常量
ArtifactUsageVirutalWall

虚拟墙,用于限制设备的活动范围。

ArtifactUsageVirtualTrack

虚拟轨道,用于为设备提供预设的路线,设备将尽可能按照虚拟轨道移动。

 List<Line> getLines(ArtifactUsage usage);

获取所有虚拟墙或虚拟轨道的信息。返回值为一个line的列表。

参数

参数名称

描述

task

usage

将被更新的预约任务
 虚拟墙或者虚拟轨道

 boolean addLine(ArtifactUsage usage, Line line);

添加虚拟墙或虚拟轨道。

boolean addLines(ArtifactUsage usage, List<Line> lines);

添加多条虚拟墙或虚拟轨道。

boolean removeLineById(ArtifactUsage usage, int id);

移除指定的虚拟墙或虚拟轨道。

boolean clearLines(ArtifactUsage usage);

移除所有虚拟墙或虚拟轨道。

PowerStatus getPowerStatus();

获取电源相关的信息。

void wakeUp();

从休眠状态唤醒设备。

IMoveAction recoverLocalization(RectF area);

设备位置发生意外变化之后,设备会在指定区域内重定位。(如果未指定面积大小,会有一个缺省面积。)

PointPDF getAuxLocation();

获取辅助定位信息。

CompositeMap getCompositeMap();

获取当前地图的所有信息。

void setCompositeMap(CompositeMap map, Pose pose)

设置当前的地图信息。

Pose getHomePose()

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

com. slamtec slamware action包

...

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

枚举常量

WAITING_FOR_START

动作已创建但未开始。

...

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

枚举常量

FORWARD

当前移动动作为向前。

BACKWARD

...

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

参数
参数名称描述
host设备主机(通常是192.168.11.1)
port端口

...

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

参数
参数名称描述
device准备连接的设备

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

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

参数
参数名称描述
device准备配对的设备
wifiSSIDWiFi的SSID
sifiPasswordWiFi的密码
listener配置监听器

...

AbstractDiscover.DiscoverStatus 枚举

封闭类

AbstractDiscover

枚举常量

STOPPED

停止。

WORKING

工作。

ERROR

...

DiscoveryMode 枚举

表明机器人如何被发现。

枚举常量

BLE

BLE 模式。

MDNS

mdns

com.slamtec.slamware.FirmwareUpdate包

...

setError(boolean error)

是否设置错误信息。

参数
参数名称描述
error将要处理的错误信息

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

设置为错误信息列表。

参数
参数名称描述
errors错误信息列表

setFatal(boolean fatal)

设置为致命错误信息。

参数
参数名称描述
fatal致命错误

setWarning(boolean warning)

设置为警告。

参数
参数名称描述
warning警告类错误信息

HealthInfo.BaseError类

...

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

创建对象BaseError()。

参数
参数名称描述
error code错误代码
error level错误等级
error component错误组件
componentErrorCode组件错误代码
errorMessage错误信息

方法

getComponentErrorCode()

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

...

LaserPoint()

创建对象LaserPoint。

LaserPoint(float distance, float angle)

创建对象LaserPoint且距离和角度为指定值。

LaserPoint(float distance, float angle, boolean valid)

创建对象LaserPoint且距离,角度和有效性为指定值。

LaserPoint(LaserPoint rhs)

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

方法

getDistance()

获取距离。

setDistance(float distance)

...

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()

获取激光点。

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

...

Location()

创建对象Location。

Location(float x, float y, float z)

创建对象Location且x,y,z为指定值。

Location(Location rhs)

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

方法

distanceTo(Location that)

...

Pose()

创建对象Pose。

Pose(Location loc, Rotation rot)

创建对象Pose且loc和ros为指定值。

Pose(float x, float y, float z, float yaw, float roll, float pitch)

创建对象Pose且x,y,z,yaw,roll,pitch为指定值。

Pose(Pose rhs)

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

方法

Location getLocation()

获取Location。

...

Rotation()

创建对象Rotation。

Rotation(float yaw)

创建对象 Rotation且yaw为指定值。

Rotation(float yaw, float pitch, float roll)

创建对象Rotation且yaw,pitch,roll为指定值。

Rotation(Rotation rhs)

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

方法

getYaw()

获取yaw。

setYaw(float yaw)

...

setPitch(float pitch)

设置pitch。

...

SystemParameters 类

构造器

ScheduledTask(int  taskId,  java.lang.String  task,  int  weekRepeat,  boolean  enabled,  int maxDuration, int year, int month, int day, int hour, int minute)

创建对象ScheduledTask()。

方法

getDay()

获取时间信息中的日期,返回数据类型为int。

getHour()

获取时间信息中的小时,返回数据类型为int。

getMaxDuration()

获取最大持续时间,返回数据类型为int。

getMinute()

获取时间信息中的 分钟,返回数据类型为int。

getMonth()

获取时间信息中的 月份, 返回数据类型为int。

getTask()

获取任务,返回数据类型为string。

getTaskId()

获取任务id, 返回数据类型为int。

getWeekRepeat()

获取每周重复清扫信息,返回数据类型为int。

getYear()

获取时间信息中的 年, 返回数据类型为int。

isEnabled()

获取是否开启预约任务, 返回数据类型为boolean。

setDay(int day)

设置日期.

参数

...

setEnabled(boolean enabled)

是否开启。

参数

...

setHour(int hour)

设置小时。

参数

...

setMaxDuration(int maxDuration)

设置最长持续时间。

参数

...

setMinute(int minute)

设置分钟。

参数

...

setMonth(int month)

设置月份。

参数

...

setTask(java.lang.String task)

设置任务。

参数

...

setTaskId(int taskId)

设置任务id。

参数

...

setWeekRepeat(int weekRepeat)

设置周重复。

参数

...

setYear(int year)

设置年份。

参数

...

SystemParameters 类

构造器

SystemParameters()

创建对象SystemParameters。

Fields

SYSPARAM_ROBOT_SPEED

机器人速度。

SYSVAL_ROBOT_SPEED_HIGH

机器人高速度。

SYSVAL_ROBOT_SPEED_MEDIUM

机器人中速度。

SYSVAL_ROBOT_SPEED_LOW

机器人低速度。

SystemParameters()

创建对象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算法创建的地图。

...

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

MapType枚举

枚举常量

BITMAP_8BIT

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

RestartMode枚举

枚举常量

SOFT

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

HARD

...