本页提供了基于Windows平台开发SLAMWARE SDK的API参考。 |
基于Windows操作系统对Slamware SDK进行应用开发,您的开发环境需满足如下条件:
|
Slamware SDK包含了大量您开发过程中可能会用到的资源、代码、和项目文件,其目录结构组织如下:
目录 | 说明 |
---|---|
bin | 预编译的工具 |
dll | 动态链接库文件 |
docs | 参考文档 |
include | SDK相关的头文件 |
lib | 预编译的库文件 |
samples | 样例程序 |
workspaces | 项目文件 |
在include目录下,我们包含了Slamware SDK以及它所依赖的所有库的头文件:
目录 | 说明 |
---|---|
boost | Boost 1.53.0 |
Eigen | Eigen矩阵库 |
json | JsonCpp库的头文件 |
rpos | Slamware SDK相关的头文件 |
点击Next(下一步)
在Solution Explorer(解决方案)中右键单击您刚刚创建的项目,并单击Properties(属性)菜单,打开属性面板:
在左侧列表中,选择VC++ Directories(VC++目录)
完成后,您的项目属性页应当与下图相似:
点击OK(确定)完成配置。
在Solution Explorer中您的项目下的Source Files目录上,右键单机,并在菜单中选择Add(添加)->New Item(新项目)
选择C++ File (.cpp),并将文件命名成main.cpp
在弹出的编辑器中输入如下代码:
#include <rpos/robot_platforms/slamware_core_platform.h> #include <iostream> using namespace std; using namespace rpos::robot_platforms; int main(int argc, char* argv[]) { SlamwareCorePlatform platform = SlamwareCorePlatform::connect("192.168.11.1", 1445); cout << "Base version: " << platform.getSDPVersion() << endl; return 0 } |
在Visual Studio的主菜单中,单击Debug(调试)->Start Debugging(开始调试)即可编译运行您的程序。
对象 | 说明 |
---|---|
rpos::core::Location类 | 位置 |
rpos::core::Rotation类 | 旋转姿态 |
rpos::core::Pose类 | 姿态 |
rpos::core::Action类 | 动作 |
rpos::core::ActionStatus枚举 | 动作执行状态 |
rpos::core::Feature类 | 特征类 |
rpos::core::RectangleF类 | 矩形(float型) |
rpos::core::Vector2f类 | 二维向量(float型) |
rpos::core::Vector2i类 | 二维向量(int型) |
rpos::core::LaserPoint类 | 激光雷达扫描点 |
rpos::core::RobotPlatform类 | 机器人平台基类 |
rpos::robot::heading::HeadingMode枚举 | 机器人移动时头朝向的方式 |
rpos::robot::heading::RobotHeading类 | 机器人头朝向某个物体或者方向的设置 |
rpos::robot::option::MoveOption结构体 | 存储机器人运行时的设置。 |
rpos::actions::MoveAction类 | 移动动作 |
rpos::features::ArtifactProvider类 | 器物功能特征,包括了虚拟墙功能。 |
rpos::features::LocationProvider类 | 定位功能特征。 |
rpos::features::MotionPlanner类 | 路径规划功能特征。 |
rpos::features::SweepMotionPlanner类 | 清扫路径规划功能特征类。 |
rpos::features::SystemResource类 | 系统资源功能特征类。 |
rpos::features::location_provider::Map类 | 地图基类。 |
rpos::features::location_provider::MapType枚举 | MapType枚举表示地图的类型。 |
rpos::features::location_provider::BitmapMap类 | 位图地图。 |
rpos::features::location_provider::BitmapMapPixelFormat枚举 | BitmapMapPixelFormat枚举表示位图地图的像素格式。 |
rpos::features::motion_planner::Path类 | 代表一条路径。 |
rpos::features::system_resource::LaserScan类 | 代表一次激光扫描数据。 |
rpos::robot_platforms::SlamwareCorePlatform类 | Slamware CORE对象 |
Location类用于表示三维空间中的一个坐标,由x,y,z三个成员组成,遵循右手坐标系
rpos/core/pose.h
创建一个Location对象,并自动将x、y、z都设为0
创建一个Location对象,将x、y、z设定为相应的值
拷贝构造函数
赋值运算符
x属性
Location location; std::cout<<location.x()<<std::endl; // output 0 location.x() = 10; std::cout<<location.x()<<std::endl; // output 10 |
y属性,用法请参见x属性
z属性,用法请参见x属性
表示物体在三维坐标系中的旋转姿态。Rotation使用弧度作为角度单位
rpos/core/pose.h
创建一个Rotation对象,并将yaw,pitch,roll都设定为0
创建一个Rotation对象,并将yaw,pitch,roll都设定为相应值
拷贝构造函数
赋值运算符
摇摆角(单位:弧度),遵循Tait-Bryan angles规则,请参见维基百科相关定义。用法请参见Location::x()的示例
俯仰角
翻滚角
Pose包含了Location和Rotation数据,即对象在三维空间中的完整姿态
pos/core/pose.h
构造一个x、y、z、yaw、pitch、roll都为0的Pose对象
构造一个location和rotation为对应值的Pose对象
构造一个location为对应值,yaw、pitch、roll皆为0的Pose对象
构造一个rotation为对应值,x、y、z皆为0的Pose对象
拷贝构造函数
赋值运算符
位置,详见Location类
旋转,详见Rotation类
x属性
Location location; std::cout<<location.x()<<std::endl; // output 0 location.x() = 10; std::cout<<location.x()<<std::endl; // output 10 |
y属性,用法请参见x属性
z属性,用法请参见x属性
摇摆角(单位:弧度),遵循Tait-Bryan angles规则,请参见维基百科相关定义
用法请参见Location::x()的示例
俯仰角
翻滚角
rpos/core/action.h
拷贝构造函数
赋值运算符
获得当前动作状态,返回值详见ActionStatus枚举
取消当前动作
等待动作完成或出错,返回值为动作结束时的动作状态,详见ActionStatus枚举
将rpos::core::Action的对象转换成子类的对象
rpos::core::Action someAction = robotPlatform.startSomeAction(); rpos::actions::MoveAction moveAction = someAction.cast<rpos::actions::MoveAction>; |
ActionStatus枚举列举了动作的状态
rpos/core/action.h
动作正在等待开始
动作正在进行
动作已经完成
动作已经暂停
动作已经停止(取消)
动作执行过程中出现错误
Feature类表示一个特征,即一个特定的功能集合。
rpos/core/feature.h
拷贝构造函数
赋值运算符
RectangleF类表示一个矩形,其坐标参数的类型为float
rpos/core/geometory.h
创建一个x、y、width、height都为0的矩形。
创建一个位置和大小为指定值的矩形
创建一个位置和大小为指定值的矩形
拷贝构造函数
RectangleF& operator=(const RectangleF&)
赋值运算符
矩形的位置(左上角)
矩形的大小
矩形左上角的x坐标
矩形左上角的y坐标
矩形的宽度
矩形的高度
矩形左侧的x坐标
矩形右侧的x坐标(right=x+width)
矩形顶部的y坐标
矩形底部的y坐标(bottom=y+height)
判断点是否在矩形的范围内
判断矩形是否是全空的(即width() < epsilon或height()<epsilon)
判断目标矩形是否完全在本矩形的区域内
计算本矩形和目标矩形重合的部分,并将本矩形设定为该重合部分矩形
二维向量,元素数据类型为float型
rpos/core/geometry.h
构造一个新的向量,其x、y的值是不确定的
构造一个x、y为指定的值的向量
拷贝构造函数
赋值运算符
二维向量的x分量
二维向量的y分量
二维向量,元素数据类型为int型
rpos/core/geometry.h
构造一个新的向量,其x、y的值是不确定的
构造一个x、y为指定的值的向量
拷贝构造函数
赋值运算符
二维向量的x分量
二维向量的y分量
激光雷达测距的单点数据,包括了距离、角度、是否有效等信息
rpos/core/laser_point.h
创建一个新的LaserPoint对象
创建一个距离、角度、有效性为指定值的LaserPoint对象
拷贝构造函数
赋值运算符
距离数据(单位:米)
本次测量的角度(单位:弧度)
本次测量是否有效
机器人平台是一系列设备组合而成的整体,提供一系列的特征从而提供功能。RobotPlatform类是所有机器人平台的基类。
rpos/core/robot_platform.h
拷贝构造函数
赋值运算符
获得该机器人平台提供的所有特征
将RobotPlatform对象转换成子类对象,示例请参考rpos::core::Action::cast<>
HeadingMode枚举表示机器人移动时头朝向的方式。
rpos/features/motion_planner/move_heading.h
机器人按照自己的方式随意行走
机器人行走时头与前进方向成固定角度
机器人行走时头始终朝向某个物体或者某点
机器人行走时头始终朝向某个固定的方向
RobotHeading类表示机器人在行走的时候的头朝向某个物体或者方向的设置。
rpos/features/motion_planner/move_heading.h
构造函数
构造函数
赋值运算符。
获取机器人行走时头朝向的角度或者物体的位置,头朝向与位置或者角度的对应关系如下:
朝向 | 值 |
---|---|
HeadingModeAuto | Pose值不可用 |
HeadingModeFixAngle或者HeadingModeDirection | Pose的Rotation参数可用 |
HeadingModeCircleMotion | Pose的Location参数可用 |
获取机器人行走时头朝向设置,可以参考rpos::robot::heading::HeadingMode
MoveOption结构体存储机器人运行时的设置。
rpos/features/motion_planner/move_option.h
如果机器人正在执行其他的移动动作,该参数决定新的点是追加或是替换既有节点。
机器人是否通过路径搜索的方式前往目的地。
机器人行走时头朝向设置。参考rpos::robot::heading::RobotHeading
MoveAction类表示一个移动的动作,它包含了当前机器人规划的路径、检查点列表、移动的进程。
rpos/features/motion_planner/move_action.h
继承自rpos::core::Action类
该构造器仅限SDK内部使用。
拷贝构造函数
赋值运算符
获得已经规划好的,剩余的路径
获得剩余的里程碑
器物功能特征,包括了虚拟墙功能。
rpos/features/artifact_provider.h
继承自rpos::core::Feature类
该构造器仅限SDK内部使用。
拷贝构造函数。
赋值运算符。
获取系统中所有的虚拟墙。
添加虚拟墙。
添加虚拟墙。
清除指定的虚拟墙。
清除所有的虚拟墙。
定位功能特征,包括了自动建图和定位的功能(亦即SLAM功能)。
rpos/features/location_provider.h
继承自rpos::core::Feature类
该构造器仅限SDK内部使用。
拷贝构造函数。
赋值运算符。
获得该定位功能特征提供的所有地图类型。
获得该定位功能特征提供的指定地图类型指定区域的地图数据。
上载指定地图类型指定区域的地图数据到该定位功能特征,返回是否成功。
获得指定地图类型的地图中,已经完成建图的区域。
清除地图数据。
获得机器人在上述地图坐标系统中的坐标。
获得机器人在上述地图坐标系统中的姿态。
上载当前机器人的姿态到上述地图坐标系统中,返回是否成功。
获得机器人是否启用定位功能。
设置机器人是否启用定位功能。
获取机器人指定地图类型的更新功能,默认地图类型为探索地图。
enum MapKind {
EXPLORERMAP = 0,
探索地图
SWEEPERMAP = 10,
清扫地图
UWBMAP = 20
辅助定位地图
设置机器人指定类型的更新功能。
路径规划功能特征,包括了动态路径规划功能和自动壁障功能。
rpos/features/motion_planner.h
继承自rpos::core::Feature类
该构造器仅限SDK内部使用。
拷贝构造函数。
赋值运算符。
让机器人沿着路径移动(机器人会逐一走过路径中的节点,在节点之间尽量走圆滑的曲线,如果遇到障碍物,机器人会自动避开)。
名称 | 类型 | 说明 |
---|---|---|
locations | const std::vector<rpos::core::Location>& | 期望机器人经过的点 |
appending | bool | 如果机器人正在执行其他的移动动作,该参数决定新的点是追加或是替换既有节点 |
isMilestone | bool | 当该参数为true时,机器人会将上述点视作关键点,通过路径搜索的方式前往目的地; 当参数为false时,会被视作普通点,不会启用路径搜索功能。 |
让机器人移动到目标位置。
名称 | 类型 | 说明 |
---|---|---|
location | const rpos::core::Location& | 期望机器人经过的点 |
appending | bool | 如果机器人正在执行其他的移动动作,该参数决定新的点是追加或是替换既有节点 |
isMilestone | bool | 当该参数设为true时,机器人会将上述点视作关键点,通过路径搜索的方式前往目的地; 当参数设为false时,会被视作普通点,不会启用路径搜索功能。 |
获得机器人当前正在进行的移动动作。您可以使用Action::isEmpty()方法判断它是否存在。当机器人当前没有正在进行的动作时,它Action::isEmpty()将会返回true。
使用机器人内置的寻路算法寻找前往指定目的地的路径。
清扫路径规划功能特征类。该类中的功能主要针对扫地机专属版本Slamware Core所提供的清扫和自动回充功能。
rpos/features/sweep_motion_planner.h
继承自rpos::core::Feature类
该构造器仅限SDK内部使用。
拷贝构造函数。
赋值运算符。
让机器人进行清扫。(此接口仅适用于扫地机版本)
让机器人定点打扫。(此接口仅适用于扫地机版本)
让机器人回家充电。
获取设备信息。设备信息包括设备ID,制造商,型号,硬件版本,软件版本。
rpos/features/device_info.h
构造函数。
构造一个特定设备信息的函数。
赋值运算符。
deviceID属性。
manufacturerID属性。
manufacturerName属性。
modelID属性。
modelName属性。
硬件版本属性。
软件版本属性。
系统资源功能特征类。该类提供了对原始激光扫描数据、电源管理系统等相关资源的访问API。
rpos/features/system_resource.h
继承自rpos::core::Feature类
该构造器仅限SDK内部使用。
拷贝构造函数。
赋值运算符。
获得电池电量,返回值的单位是百分比。比如电池剩余为56%,则该返回值为56。
电池是否处于充电状态。
外部电源是否连接。
系统温度。
底盘的版本号。
获取原始激光扫描数据。
启用心跳功能。启用后,客户应用程序将会有规律地向Slamware Core发送数据以表示连接正常。如在设定的时间内未收到返回数据token,系统将判定Slamware core和客户应用程序断开连接,从而取消正在执行的操作。该功能使客户应用程序崩溃后再重新启动时的状态及行为更具可控性。
参数名称 | 类型 | 说明 |
---|---|---|
heartBeatTimeoutInSeconds | int | 心跳超时时间,单位为秒。即超过该设定时间后将判定为超时。 |
刷新心跳。同一时刻仅一个token起作用。如果第二次调用startHeartBeat,之前的token以及timeout将失效,系统将采用新的token和timeout时间。
参数名称 | 类型 | 说明 |
---|---|---|
token | features::system_resource::HeartBeatToken | 信令,每次启用心跳功能后返回数据为与该次启动操作唯一对应的信令。 该信令同步传到refreshHeartBeat和stopHeartBeat,以防止后续操作时误调用。 |
停止心跳功能。
地图基类,泛指定位功能获得的地图。
rpos/features/location_provider.h
该构造器仅限SDK内部使用。
拷贝构造函数。
赋值运算符。
获得这张地图所包含的区域。
获得这张地图左上角的坐标。
获得地图的尺寸(两个维度的像素个数)
获得地图的分辨率(在各个维度上,每个像素代表多少米)
获得地图生成的时间。
设置地图数据。
获得地图数据。
将地图转换成特定类型的子类对象。
MapType枚举表示地图的类型。
rpos/features/location_provider.h
每像素8位的位图。
位图地图。
rpos/features/location_provider.h
继承自rpos::features::location_provider::Map类
该构造器仅限SDK内部使用。
拷贝构造函数。
赋值运算符。
继承自rpos::features::location_provider::Map类的方法
获得地图的像素格式。
BitmapMapPixelFormat枚举表示位图地图的像素格式。
rpos/features/location_provider.h
位图中的每个像素占用1个字节。
Path对象是一系列Location对象的集合,代表一条路径。
rpos/features/motion_planner.h
创建一个由一系列点组成的路径。
拷贝构造函数。
赋值运算符。
获得路径中的所有点。
LaserScan对象是一系列LaserPoint对象的集合,代表一次激光扫描的数据。
rpos/features/system_resource.h
创建一个由一系列激光扫描点组成的扫描数据。
拷贝构造函数。
赋值运算符。
获取激光扫描数据。
compositeMapReader.h
SlamwareCorePlatform对象代表一个基于Slamware的机器人,用以获取设备的状态、控制设备的行为。
rpos/robot_platforms/slamware_core_platform.h
读取地图文件,参数为文件路径名。在成功读取地图后会返回一个CompositeMap对象的指针,否则抛出 CompositeMapException 类型的异常。
读取地图文件,参数为宽字符文件路径名。在成功读取地图后会返回一个CompositeMap对象的指针,否则抛出 CompositeMapException 类型的异常。
读取地图文件,参数为文件路径名。在成功读取地图后会返回一个CompositeMap对象的指针,并且rErrMsg为空,否则会返回空指针,rErrMsg为错误的描述。
读取地图文件,参数为宽字符文件路径名。成功读取地图后会返回一个CompositeMap对象的指针,并且rErrMsg为空,否则会返回空指针,rErrMsg为错误的描述。
获取当前地图的所有信息。
保存地图文件,参数为文件路径名。设置CompositeMap以及保存文件的路径名,成功保存文件后,函数正常退出,否则抛出 CompositeMapException 类型的异常。
保存地图文件,参数为宽字符文件路径名。设置CompositeMap以及保存文件的路径名,成功保存文件后,函数正常退出,否则抛出 CompositeMapException 类型的异常。
保存地图文件,参数为文件路径名。设置CompositeMap以及保存文件的路径名,成功保存文件后,函数返回true,否则返回false,rErrMsg为错误的描述。
保存地图文件,参数为宽字符文件路径名。设置CompositeMap以及保存文件的路径名,成功保存文件后,函数返回true,否则返回false,rErrMsg为错误的描述。
继承自rpos::core::RobotPlatform类
该构造器仅限SDK内部使用。
拷贝构造函数。
赋值运算符。
连接到指定的Slamware设备。
名称 | 类型 | 说明 |
---|---|---|
host | const std::string& | Slamware Core的IP地址 |
port | int | Slamware Core的端口(通常为1445) |
timeout_in_ms | int | 连接超时时间,单位为毫秒 |
断开与CORE之间的连接。
获取系统中所有的虚拟墙。
添加虚拟墙。
添加多个虚拟墙。
清除指定的虚拟墙。
清除所有的虚拟墙。
获得该Slamware CORE提供的所有地图类型。
获得该Slamware CORE提供的指定地图类型指定区域的地图数据。
名称 | 类型 | 说明 |
---|---|---|
type | rpos::features::location_provider::MapType | 地图的数据类型 |
area | core::RectangleF | 地图的区域 |
kind | rpos::features::location_provider::MapKind | 地图类型 |
rpos::feature::location_provider:MapType mapType = rpos::feature::location_provider:MapType::MapTypeBitmap8Bit; rpos::feature::location_provider:Mapkind mapKind = rpos::feature::location_provider:MapKind::EXPLORERMAP; rpos::core::Rectangle knownArea = robotPlatform.getKnownArea(mapType, mapKind); rpos::feature::location_provider:Map map = robotPlatform.getMap(mapType, knownArea, mapKind); |
注: 扫地机版本mapkind可以使用SWEEPERMAP
上载指定地图类型指定区域的地图数据到该Slamware CORE。
名称 | 类型 | 说明 |
---|---|---|
map | rpos::features::location_provider::Map | 地图 |
type | rpos::features::location_provider::MapType | 地图数据类型 |
kind | rpos::features::location_provider::MapKind | 地图类型 |
partially | bool | 是否部分更新地图 |
rpos::feature::location_provider:MapType mapType = rpos::feature::location_provider:MapType::MapTypeBitmap8Bit; rpos::feature::location_provider:Mapkind mapKind = rpos::feature::location_provider:MapKind::EXPLORERMAP; rpos::core::Rectangle knownArea = robotPlatform.getKnownArea(mapType, mapKind); rpos::feature::location_provider:Map map = robotPlatform.getMap(mapType, knownArea, mapKind); bool bRet = robotPlatform.setMap(map, mapType, mapKind); |
上载指定地图类型指定区域的地图数据到该Slamware CORE。
名称 | 类型 | 说明 |
---|---|---|
pose | core::Pose | 机器人的pose信息 |
map | rpos::features::location_provider::Map | 地图 |
type | rpos::features::location_provider::MapType | 地图数据类型 |
kind | rpos::features::location_provider::MapKind | 地图类型 |
partially | bool | 是否部分更新地图 |
rpos::core::Pose pose; rpos::feature::location_provider:MapType mapType = rpos::feature::location_provider:MapType::MapTypeBitmap8Bit; rpos::feature::location_provider:Mapkind mapKind = rpos::feature::location_provider:MapKind::EXPLORERMAP; rpos::core::Rectangle knownArea = robotPlatform.getKnownArea(mapType, mapKind); rpos::feature::location_provider:Map map = robotPlatform.getMap(mapType, knownArea, mapKind); bool bRet = robotPlatform.setMap(pose, map, mapType, mapKind); |
获得指定地图类型的地图中,已经完成建图的区域。
rpos::feature::location_provider:MapType mapType = rpos::feature::location_provider:MapType::MapTypeBitmap8Bit; rpos::feature::location_provider:Mapkind mapKind = rpos::feature::location_provider:MapKind::EXPLORERMAP; rpos::core::Rectangle knownArea = robotPlatform.getKnownArea(mapType, mapKind); |
清除地图数据。
清除指定地图类型的地图数据。
获得机器人在上述地图坐标系统中的坐标。
获得机器人在上述地图坐标系统中的姿态。
获得机器人在上述地图坐标系统中的姿态。
获取地图定位。
设定是否启用定位功能。
获得是否启用地图更新功能。
设定是否启用地图更新功能。
获取雷达定位点的可信度(返回一个0到100的数值,数值越高 当前雷达点的定位越可信,建议取50以上的定位点)
让机器人沿着路径移动(机器人会逐一走过路径中的节点,在节点之间尽量走圆滑的曲线,如果遇到障碍物,机器人会自动避开)。
参数详细参考 rpos::action::MoveAction MoveTo(const std::vector<rpos::core::Location>&, bool, bool)
让机器人移动到目标位置。
参数详细参考 rpos::action::MoveAction MoveTo(const rpos::core::Location&, bool, bool)
让机器人沿着路径移动(机器人会逐一走过路径中的节点,并根据MoveAction参数的变量决定机器人行走的方式和移动过朝向)。
名称 | 类型 | 说明 |
---|---|---|
locations | const std::vector<rpos::core::Location>& | 期望机器人经过的点 |
moveOption | rpos::robot::option::MoveOption | 如果机器人正在执行其他的移动动作,该参数决定新的点是追加或是替换既有节点 |
yaw | float | 表示设备的旋转角度,默认为。 |
moveOption详细可参考rpos::robot::option::MoveOption
std::vector<rpos::core::Location> locations; rpos::core::Location location(1,1); locations.push rpos::robot::option::MoveAction moveOption; moveOption.appending = false; moveOption.isMilestone = true; rpos::core::Pose pose(Rotation(2)); rpos::robot::heading::RobotHeading robotHeading(rpos::robot::heading::HeadingMode::HeadingModeFixAngle, pose); moveOption.robotHeading = robotHeading; rpos::actions::MoveAction moveInfo = robotPlatform.moveTo(locations, moveOption); |
让机器人沿着路径移动(机器人会逐一走过路径中的节点,并根据MoveAction参数的变量决定机器人行走的方式和移动过朝向)。
详细参考 rpos::actions::MoveAction moveTo(const std::vector<rpos::core::Location>&,rpos::robot::option::MoveAction&)
控制机器人的运行方向
名称 | 类型 | 说明 |
---|---|---|
direction | const rpos::core::Direction& | 机器人运行的方向 |
rpos::core::ACTION_DIRECTION actionDirection = rpos::core::ACTION_DIRECTION::FORWARD; rpos::core::Direction direction(actionDirection); rpos::actions::MoveAction moveBy = platform.moveBy(direction); |
注:direction参数rpos::core::ACTION_DIRECTION取值说明如下
值 | 说明 |
---|---|
FORWARD | 向前 |
BACKWARD | 向后 |
TURNRIGHT | 向右 |
TURNLEFT | 向左 |
根据指定的移动方式控制机器人向指定的方向移动。MoveOptions设置暂时不支持。
struct RPOS_CORE_API MoveOptions
{
MoveOptions();
MoveOptionFlag flag;
boost::optional<double> speed_ratio;
};
enum MoveOptionFlag
MoveOptionFlagNone = 0,
MoveOptionFlagAppending = 1,//增加点
MoveOptionFlagMilestone = 2,//路径搜索
MoveOptionFlagNoSmooth = 4,
MoveOptionFlagKeyPoints = 8,//沿着虚拟轨道移动。
MoveOptionFlagPrecise = 16,// 精确到目标点,10cm。
MoveOptionFlagWithYaw = 32
以指定的角度移动。
根据theta角和MoveOptions中的speed_ratio控制机器人移动,实现设备以规定角度和速度移动,持续200ms。
使机器人水平转动到特定的角度。
根据指定的移动方式控制机器人旋转到特定的角度。MoveOptions设置暂时不支持。
使机器人水平转动一定的角度。
根据指定的移动方式控制机器人旋转到一定的角度。MoveOptions设置暂时不支持。
获得机器人当前正在进行的移动动作。
您可以使用rpos::core::Action::isEmpty()方法判断它是否存在。当机器人当前没有正在进行的动作时,它rpos::core::Action::isEmpty()将会返回true。
使用机器人内置的寻路算法寻找前往指定目的地的路径。
命令机器人开始打扫。(此接口仅适用于扫地机版本)
在机器人处于扫地状态下,可以命令机器人定点清扫。(此接口仅适用于扫地机版本)
在机器人处于扫地状态下,可命令机器人返回充电位置。(此接口仅适用于扫地机版本)
获得机器人电池剩余电量(0表示完全没电,100表示电量全满)。
获得机器人是否正在充电。
获得直流电源是否插上。
获得机器人核心温度。单位是0.1℃,比如该函数的返回结果为452,则表示机器人的核心温度为45.2℃。
获得机器人底盘的版本号。
获得SDK的版本号。
获得上一次激光扫描的原始数据。
根据指定的重启模式(默认软复位)执行重启操作。
RestartModeSoft(软复位),重启SDK,速度较快。建议使用。
RestartModeHard(硬复位),速度较慢,需要几分钟时间。不建议经常使用。
调整系统参数
名称 | 类型 | 说明 |
---|---|---|
param | const std::string& | 调整的参数名 |
value | Const std::string & | 调整的参数值 |
注:目前只支持调整系统速度的设置
param只能取值为SYSPARAM_ROBOT_SPEED
value对应可取如下三种
1.SYSVAL_ROBOT_SPEED_HIGH (高)
2.SYSVAL_ROBOT_SPEED_MEDIUM (中)
3.SYSVAL_ROBOT_SPEED_LOW (低)
Bool bRet = platform.setSystemParameter(SYSPARAM_ROBOT_SPEED, SYSVAL_ROBOT_SPEED_HIGH); |
获取系统参数
名称 | 类型 | 说明 |
---|---|---|
param | const std::string& | 要获取的系统参数名 |
注:目前只支持调整系统速度的设置
param只能取值为SYSPARAM_ROBOT_SPEED
std::string robotSpeed = platform.getSystemParameter(SYSPARAM_ROBOT_SPEED); |
获取设备信息。设备信息包括设备ID,制造商ID,制造商名称,型号ID,型号名称,硬件版本,软件版本。
具体返回值信息请参考:rpos::features::system_resource::DeviceInfo类
获取机器人当前的状态信息
清除机器人当前出错的状态信息
配置机器人的网络信息
网络状况 | ssid | password | channel |
---|---|---|---|
NetworkModeAp | 可选 | 可选 | 可选 |
NetworkModeStation | 必选 | 可选 | -- |
NetworkModeWifiDisabled | -- | -- | -- |
注:目前暂只支持以上三中mode形式,ssid,password,channel三个选项的信息如上表(--表示不可用)
std::map<std::string, std::string> options; options["ssid"] = "Slamtec"; options["password"] = "slamtect"; Bool bRet = platform.configureNetwork(rpos::features::system_resource::NetworkMode::NetworkModeStation,options); |
获取机器人当前的网络信息。
注:目前返回的结果只包含mode,ssid和ip三个选项的值
用于获取机器人上已安装的所有碰撞传感器,返回值为ImpactSensorInfo列表。
ImpactSensorInfo数据结构如下:
struct ImpactSensorInfo { impact_sensor_id_t id; rpos::core::Pose pose; ImpactSensorType type; float refreshFreq; }; |
字段说明:
字段名称 | 单位 | 说明 |
---|---|---|
Id |
| Id字段为后续API中会用到的数值。 |
Pose |
| Pose字段表示传感器的安装姿态,即传感器相对于机器人中间的位置和方向。 |
Type |
| 如果机器人正在执行其他的移动动作,该参数表示传感器类型,为ImpactSensorTypeDigital 或ImpactSensorTypeAnalog中的一种。 前者表示普通的碰撞传感器,只有发生碰撞和不发生碰撞两种状态。 后者表示距离传感器,如超声波测距传感器,红外测距传感器等。 |
refreshFreq | Hz | 表示传感器刷新频率,Hz表示每秒刷新次数。 |
用于获取当前碰撞传感器状态,返回值为map,key字段为上述API中获得的id,value字段是ImpactSensorValue类型,数据结构如下:
struct ImpactSensorValue { impact_sensor_timestamp_t time; float value; }; |
字段说明:
字段名称 | 类型 | 单位 | 说明 |
---|---|---|---|
Time | Long | 微秒 | 表示获得该数据的时间。 |
Value | Float | 米 | 表示该碰撞传感器检测到的与障碍物之间的距离。 若传感器为数字传感器,则0~FLT_EPSILON表示发生了碰撞,FLT_MAX表示没有发生碰撞(建议用“<FLT_EPSILON”来判断); 若传感器为模拟传感器,则value表示传感器和障碍物之间的距离,FLT_MAX表示没有检测到障碍物。 (建议用“<1000”来判断,1000为场景中最长轴长度的两倍) |
获取指定传感器的数据。返回值为ImpactSensorValue数组。
获取指定传感器的数据。返回值为ImpactSensorValue。
设置当前的地图信息。
Composite map由两个MapLayer组成,GridMapLayer和LineMapLayer
MapLayer 名称 | 描述 |
---|---|
GridMapLayer | 表示网格地图,存放信息包括explorer map和sweep map |
LineMapLayer | 表示线地图,存放信息为虚拟墙 |
auto pose = platform.getPose(); rpos::robot_platforms::objects::Metadata metadata; std::vector< boost::shared_ptr<rpos::robot_platforms::objects::MapLayer> > maps; auto map_layer_v_walls = boost::make_shared<rpos::robot_platforms::objects::LineMapLayer>(); maps.push_back(map_layer_v_walls); map_layer_v_walls->setUsage("virtual_walls"); map_layer_v_walls->setType(rpos::robot_platforms::objects::LineMapLayer::Type); rpos::robot_platforms::objects::Line line(Point(0, 0), Point(10, 10)); line.name ="1"; map_layer_v_walls->lines()[line.name] = line; rpos::robot_platforms::objects::CompositeMap compositeMap(metadata, maps); platform. setCompositeMap (compositeMap, pose); |
metadata.setUsage()函数取值如下:
值 | 说明 |
---|---|
explore | 表示设置为探索地图 |
sweep | 表示设置为清扫地图 |
virtual_walls | 表示设置为虚拟墙 |
注:如果设置的有地图信息可以先设置区域信息,函数如下:
启用心跳功能。启用后,客户应用程序将会有规律地向Slamware Core发送数据以表示连接正常。如在设定的时间内未收到返回数据token,系统将判定Slamware core和客户应用程序断开连接,从而取消正在执行的操作。该功能使客户应用程序崩溃后再重新启动时的状态及行为更具可控性。
参数名称 | 类型 | 说明 |
---|---|---|
heartBeatTimeoutInSeconds | int | 心跳超时时间,单位为秒。即超过该设定时间后将判定为超时。 |
刷新心跳。同一时刻仅一个token起作用。如果第二次调用startHeartBeat,之前的token以及timeout将失效,系统将采用新的token和timeout时间。
参数名称 | 类型 | 说明 |
---|---|---|
token | features::system_resource::HeartBeatToken | 信令,每次启用心跳功能后返回数据为与该次启动操作唯一对应的信令。 该信令同步传到refreshHeartBeat和stopHeartBeat,以防止后续操作时误调用。 |
停止心跳功能。
/**
* The dc cord is connected
*/
bool isDCConnected;
/**
* The robot is on dock
*/
DockingStatus dockingStatus;
/**
* The robot is charging
*/
bool isCharging;
/**
* Battery level (0 ~ 100)
*/
int batteryPercentage;
/**
* Robot sleep mode
*/
SleepMode sleepMode;
/**
* Sleep mode of device
*/
enum SleepMode {
/**
* The targeting core firmware doens't support this command
*/
SleepModeUnknown,
/**
* The device is awake, it will response to commands immediately
*/
SleepModeAwake,
/**
* The device is waking up, please wait for some time
*/
SleepModeWakingUp,
/**
* The device is asleep, it might take some time to wake device up
*/
SleepModeAsleep
};
/**
* Docking status of the robot
*/
enum DockingStatus {
/**
* The docking status is unknown (doens't supported by the targeting Slamware firmware)
*/
DockingStatusUnknown,
/**
* The robot is on the dock
*/
DockingStatusOnDock,
/**
* The robot is not on the dock
*/
DockingStatusNotOnDock
};
从休眠状态唤醒设备。
int getSweepTimeMs();
当前设备处于清扫状态时,获取从开始清扫时刻到此时刻的清扫时间。当前设备不处于清扫状态时,获取上一次清扫动作的清扫时间。
当前设备处于清扫状态时,获取当前清扫动作的清扫面积。当前设备不处于清扫状态时,获取上一次清扫动作的清扫面积。
获取充电座位置。如果找不到充电座则返回(0,0)。
获取辅助定位信息。
rpos::system::types::_u32 id;
core::Location location;
float circular_error_probability;//range
std::vector<std::string> tags;
actions::MoveAction recoverLocalization(const core::RectangleF& area);
设备位置发生意外变化之后,设备会在指定区域内重定位。(如果未指定面积大小,会有一个缺省面积。)
获取扫地机的清扫轨迹。参数表示使用者已获得的轨迹点的数量,为0时返回完整轨迹。
获取所有虚拟墙或虚拟轨道的信息。根据如下参数来确定获取的是虚拟墙或虚拟轨道的信息。
参数名称 | 说明 |
---|---|
ArtifactUsageVirtualWall | 虚拟墙,用于限制设备的活动范围。 |
ArtifactUsageVirtualTrack | 虚拟轨道,用于为设备提供预设的路线,设备将尽可能按照虚拟轨道移动。 |
添加虚拟墙或虚拟轨道。
移除指定的虚拟墙或虚拟轨道。
移除所有虚拟墙或虚拟轨道。
获取版本更新信息。
参数名称 | 数据类型 | 说明 |
---|---|---|
currentVersion | string | 当前版本信息 |
newVersion | string | 最新版本信息 |
newVersionReleaseDate | string | 最新版本信息发布时间 |
newVersionChangeLog | string | 最新版本的发布说明 |
开始更新固件。
获取固件更新进程。
UpdateFirmwareStep currentStep; // Range from 0 to {totalSteps - 1}.
unsigned int totalSteps; // The number of total steps.
std::string currentStepName; // The name of the current step.
unsigned int currentStepProgress; // Expressed as a percentage.
UpdateProgressStatus status; // Current status
enum UpdateFirmwareStep
{
UpdateFirmwarePreparing,
UpdateFirmwarePrepareFinished,
UpdateFirmwareDownloading,
UpdateFirmwareDownloadFinished,
UpdateFirmwareUpdating,
UpdateFirmwareUpdateFinished
};
enum UpdateProgressStatus
{
UpdateProgressSuccess,
UpdateProgressError,
UpdateProgressInit,
UpdateProgressUpgrade
}