AGVC SDK API  0.7.0
agvc_interface 命名空间参考

类

class  AgvcInterface
class  RpcClient
 RPC客户端 更多...
class  OutputBuilder
 向输出数据中增加 更多...
class  InputParser
 解析输入 更多...
class  RtdeClient
 RTDE客户端 更多...
class  ScriptWriter
class  ScriptClient
 SCRIPT客户端 更多...
struct  Point2d
 二维点 更多...
struct  Pose2d
 二维位姿 更多...
struct  Speed
 速度 更多...
struct  Header
 头部信息 更多...
struct  AgvDetails
 agv 信息 更多...
struct  RunningInfo
 agv 运行信息 更多...
struct  SaveMapWorkingStatus
 接口saveMap的工作状态 更多...
struct  SwitchMapWorkingStatus
 接口switchMap的工作状态 更多...
struct  ChangeModeWorkingStatus
 接口changeRunningMode的工作状态 更多...
struct  RelocationWorkingStatus
 接口Relocation的工作状态 更多...
struct  SetPngMapAllInfoWorkingStatus
 接口setPngMapAllInfo的工作状态 更多...
struct  GetPngMapAllInfoWorkingStatus
 接口getPngMapAllInfo的工作状态 更多...
struct  GetGridMapWorkingStatus
 接口getGridMapFromAgv的工作状态 更多...
struct  SendGridMapWorkingStatus
 接口sendGridMapToAgv的工作状态 更多...
struct  GetPngMapWorkingStatus
struct  SendPngMapWorkingStatus
 接口sendBase64PngMapToAgv的工作状态 更多...
struct  SetGridMapAllInfoWorkingStatus
 接口setGridMapAllInfo的工作状态 更多...
struct  GetGridMapAllInfoWorkingStatus
 接口getGridMapAllInfo的工作状态 更多...
struct  PreviewPngMapWorkingStatus
 接口previewPngMapFromAgv的工作状态 更多...
struct  AsyncInterfaceResultStatus
 异步接口运行状态 暂时存在12个异步接口：saveMap, switchMap, changeRunningMode, relocation, sendBase64PngMapToAgv getGridMapAllInfo, setGridMapAllInfo, sendGridMapToAgv, getGridMapFromAgv getPngMapAllInfo, setPngMapAllInfo, getBase64PngMapFromAgv 更多...
struct  StationMark
 站点 更多...
struct  PathStation
 通过站点表示路径 更多...
struct  MapInfo
 地图信息 更多...
struct  MapVirtualArea
 地图中的虚拟区域 更多...
struct  MapAllInfo
 包含当前地图、当前地图上的站点、当前地图上的路径、当前地图上的虚拟区域信息 更多...
struct  IpAddressInfo
 IP地址 更多...
struct  AdjustParam
 agv 到点后二次调整位置参数设置 更多...
struct  NavGoalType
 使 agv 导航到目标位置（控制信息） 更多...
struct  NavInfo
 导航状态信息 / 自动充电状态信息 更多...
struct  AutoChargingCommand
 自动充电信息 更多...
struct  FirmwareUpdateParam
 配置要更新固件的模块及固件路径 更多...
struct  FirmwareUpdateProcessInfo
 固件更新过程信息 更多...
struct  CalibrationProcessInfo
struct  RtdeRecipe
 RTDE菜单 更多...
class  AgvcException

类型定义

using AgvcInterfacePtr = std::shared_ptr<AgvcInterface>
using RpcClientPtr = std::shared_ptr<RpcClient>
using RtdeClientPtr = std::shared_ptr<RtdeClient>
using ScriptClientPtr = std::shared_ptr<ScriptClient>
typedef FeedbackStatus NavStatus
 agv 导航状态
typedef FeedbackStatus SaveMapStatus
 保存地图异步接口状态，调用接口 saveMap 后的状态
typedef FeedbackStatus SwitchMapStatus
 切换地图异步接口状态，调用接口 switchMap 后的状态
typedef FeedbackStatus ChangeRunningModeStatus
 切换运行模式异步接口状态，调用接口 changeRunningMode 后的状态
typedef FeedbackStatus RelocationStatus
 重定位状态，调用接口 relocation 后的状态
typedef FeedbackStatus SetPngMapAllInfoStatus
 上传Png地图全部信息接口状态，调用接口 setPngMapAllInfo 后的状态
typedef FeedbackStatus GetPngMapAllInfoStatus
 获取Png地图全部信息接口状态，调用接口 getPngMapAllInfo 后的状态
typedef FeedbackStatus GetGridMapStatus
 获取栅格地图接口状态，调用接口 getGridMapFromAgv 后的状态
typedef FeedbackStatus SendGridMapStatus
 发送栅格地图接口状态，调用接口 sendGridMapToAgv 后的状态
typedef FeedbackStatus GetPngMapStatus
 获取png地图接口状态，调用接口 getBase64PngMapFromAgv 后的状态
typedef FeedbackStatus SendPngMapStatus
 发送png地图接口状态，调用接口 sendBase64PngMapToAgv 后的状态
typedef FeedbackStatus SetGridMapAllInfoStatus
 设置栅格地图全部信息接口状态，调用接口 setGridMapAllInfo 后的状态
typedef FeedbackStatus GetGridMapAllInfoStatus
 获取栅格地图全部信息接口状态，调用接口 getGridMapAllInfo 后的状态
typedef FeedbackStatus PreviewPngMapStatus
 获取栅格地图全部信息接口状态，调用接口 previewPngMapFromAgv 后的状态
typedef FeedbackStatus CalibrationStatus
 标定状态
typedef MapInfo OccupancyGridMap
 栅格地图
typedef MapInfo Base64PngMap
 Base64编码的png地图图片

枚举

enum  AgvcErrorCodes : int { ENUM_AgvcErrorCodes_DECLARES }
enum class  RunningMode {
  NONE = 0 , START = 1 , MAPPING = 2 , NAVIGATE = 3 ,
  CHARGING = 4 , MAINTAIN = 5 , STOP = 6
}
 agv 运行模式 更多...
enum class  PathShape { NONE = 0 , LINE = 1 , ARC = 2 , BEZIER = 3 }
 路径的形状 更多...
enum class  MapFormat { NONE = 0 , OCCUPANCY_GRID = 1 , BASE64_PNG = 2 }
 地图格式 更多...
enum class  MapVirtualAreaType { NONE = 0 , OBSTACLE = 1 , SLOW_DOWN = 2 , INFLATE = 3 }
 地图中虚拟区域的类型 更多...
enum class  MapVirtualAreaShape {
  NONE = 0 , LINE = 1 , ARC = 2 , CIRCLE = 3 ,
  POLYGON = 4
}
 地图中虚拟区域的形状 更多...
enum class  NavType { NONE = 0 , FREE_TO_POSE = 1 , FREE_TO_STATION = 2 , PATH_TO_STATION = 3 }
 agv 导航类型 更多...
enum class  AutoChargingType {
  NONE = 0 , LOW_POWER_TO_BOARD = 1 , HIGH_POWER_LEAVE_BOARD = 2 , FORCE_TO_BOARD = 3 ,
  FORCE_LEAVE_BOARD = 4
}
 自动充电类型 更多...
enum class  FeedbackStatus {
  NONE = 0 , FINISHED = 1 , FAILED = 2 , RUNNING = 3 ,
  PAUSED = 4 , CANCELED = 5
}
 一个操作执行后反馈的状态 更多...
enum class  FirmwareUpdateMode { NONE = 0 , UPDATE = 1 , FORCED_UPDATE = 2 , NOT_UPDATE = 3 }
 模块固件更新配置 更多...
enum class  ScriptRuntimeState { RUNNING = 0 , PAUSED = 1 , STOPPED = 2 , ABORTING = 3 }
enum class  CalibrationType { NONE = 0 , LASER_ODOM = 1 }
 标定类型 更多...
enum  error_type {
  parse_error = -32700 , invalid_request = -32600 , method_not_found = -32601 , invalid_params = -32602 ,
  internal_error = -32603 , server_error , invalid
}
enum  ExceptionCode {
  EC_DISCONNECTED = -1 , EC_NOT_LOGINED = -2 , EC_INVAL_SOCKET = -3 , EC_REQUEST_BUSY = -4 ,
  EC_SEND_FAILED = -5 , EC_RECV_TIMEOUT = -6 , EC_RECV_ERROR = -7 , EC_PARSE_ERROR = -8 ,
  EC_INVALID_REQUEST = -9 , EC_METHOD_NOT_FOUND = -10 , EC_INVALID_PARAMS = -11 , EC_INTERNAL_ERROR = -12 ,
  EC_SERVER_ERROR = -13 , EC_INVALID = -14
}

函数

const char * returnValue2Str (int retval)

类型定义说明

◆ AgvcInterfacePtr

using agvc_interface::AgvcInterfacePtr = std::shared_ptr<AgvcInterface>

在文件 agvc_interface.h 第 802 行定义.

◆ Base64PngMap

typedef MapInfo agvc_interface::Base64PngMap

Base64编码的png地图图片

Header header; // 地图id，地图名称，当前时间，map_id为地图的唯一id
double resolution; // 分辨率，每个正方形像素表示的宽度，单位 m
uint32_t width; // 地图宽度，多少个像素宽度
uint32_t height; // 地图高度，多少个像素高度
Pose2d origin; // {x(m) y(m) theta(rad)} // 地图原点在真实地图下的坐标，指地图原点对应的实际位置坐标。 // 一张地图中，左下角为地图原点；
MapFormat format; // 地图格式，=MapFormat::BASE64_PNG
std::vector<int8_t> data; // 地图数据信息；Base64编码的png地图图片，可以将data类型转换为string类型使用

在文件 type.h 第 682 行定义.

◆ CalibrationStatus

typedef FeedbackStatus agvc_interface::CalibrationStatus

标定状态

NONE = 0, // 空
FINISHED = 1, // 标定完成
FAILED = 2, // 标定失败
RUNNING = 3, // 正在采集数据
PAUSED = 4, // 无效值
CANCELED = 5, // 取消标定

在文件 type.h 第 380 行定义.

◆ ChangeRunningModeStatus

typedef FeedbackStatus agvc_interface::ChangeRunningModeStatus

切换运行模式异步接口状态，调用接口 changeRunningMode 后的状态

NONE = 0, // 切换运行模式接口未执行
FINISHED = 1, // 切换运行模式接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // 切换运行模式中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 248 行定义.

◆ GetGridMapAllInfoStatus

typedef FeedbackStatus agvc_interface::GetGridMapAllInfoStatus

获取栅格地图全部信息接口状态，调用接口 getGridMapAllInfo 后的状态

NONE = 0, // 获取栅格地图全部信息接口未执行
FINISHED = 1, // 获取栅格地图全部信息接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // 栅格地图全部信息获取中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 356 行定义.

◆ GetGridMapStatus

typedef FeedbackStatus agvc_interface::GetGridMapStatus

获取栅格地图接口状态，调用接口 getGridMapFromAgv 后的状态

NONE = 0, // 获取栅格地图接口未执行
FINISHED = 1, // 获取栅格地图接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // 栅格地图获取中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 296 行定义.

◆ GetPngMapAllInfoStatus

typedef FeedbackStatus agvc_interface::GetPngMapAllInfoStatus

获取Png地图全部信息接口状态，调用接口 getPngMapAllInfo 后的状态

NONE = 0, // 获取地图信息接口未执行
FINISHED = 1, // 获取地图信息接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // 地图信息获取中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 284 行定义.

◆ GetPngMapStatus

typedef FeedbackStatus agvc_interface::GetPngMapStatus

获取png地图接口状态，调用接口 getBase64PngMapFromAgv 后的状态

NONE = 0, // 获取png地图接口未执行
FINISHED = 1, // 获取png地图接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // 获取png地图中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 320 行定义.

◆ NavStatus

typedef FeedbackStatus agvc_interface::NavStatus

agv 导航状态

NONE = 0, // 空
FINISHED = 1, // 向站点导航完成
FAILED = 2, // 向站点导航失败
RUNNING = 3, // 正在向站点导航
PAUSED = 4, // 向站点导航暂停
CANCELED = 5, // 向站点导航取消

在文件 type.h 第 212 行定义.

◆ OccupancyGridMap

typedef MapInfo agvc_interface::OccupancyGridMap

栅格地图

Header header; // 地图id，地图名称，当前时间，map_id为地图的唯一id
double resolution; // 分辨率，每个正方形栅格的宽度，单位 m
uint32_t width; // 地图宽度，多少个栅格宽度
uint32_t height; // 地图高度，多少个栅格高度
Pose2d origin; // {x(m) y(m) theta(rad)} // 栅格地图原点在真实地图下的坐标，指栅格原点对应的实际位置坐标。 // 一张栅格地图中，左下角为栅格地图原点；
MapFormat format; // 地图格式，=MapFormat::OCCUPANCY_GRID
std::vector<int8_t> data; // 地图数据信息；0 表示可通行，100 表示被占用，-1 表示未知

在文件 type.h 第 667 行定义.

◆ PreviewPngMapStatus

typedef FeedbackStatus agvc_interface::PreviewPngMapStatus

获取栅格地图全部信息接口状态，调用接口 previewPngMapFromAgv 后的状态

NONE = 0, // 预览地图接口未执行
FINISHED = 1, // 预览地图接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // 预览地图接口获取中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 368 行定义.

◆ RelocationStatus

typedef FeedbackStatus agvc_interface::RelocationStatus

重定位状态，调用接口 relocation 后的状态

NONE = 0, // 重定位接口未执行
FINISHED = 1, // 重定位接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // 重定位中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 260 行定义.

◆ RpcClientPtr

using agvc_interface::RpcClientPtr = std::shared_ptr<RpcClient>

在文件 rpc.h 第 147 行定义.

◆ RtdeClientPtr

using agvc_interface::RtdeClientPtr = std::shared_ptr<RtdeClient>

在文件 rtde.h 第 284 行定义.

◆ SaveMapStatus

typedef FeedbackStatus agvc_interface::SaveMapStatus

保存地图异步接口状态，调用接口 saveMap 后的状态

NONE = 0, // 保存地图接口未执行
FINISHED = 1, // 保存地图接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // 保存地图中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 224 行定义.

◆ ScriptClientPtr

using agvc_interface::ScriptClientPtr = std::shared_ptr<ScriptClient>

在文件 script.h 第 188 行定义.

◆ SendGridMapStatus

typedef FeedbackStatus agvc_interface::SendGridMapStatus

发送栅格地图接口状态，调用接口 sendGridMapToAgv 后的状态

NONE = 0, // 发送栅格地图接口未执行
FINISHED = 1, // 发送栅格地图接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // 发送栅格地图中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 308 行定义.

◆ SendPngMapStatus

typedef FeedbackStatus agvc_interface::SendPngMapStatus

发送png地图接口状态，调用接口 sendBase64PngMapToAgv 后的状态

NONE = 0, // 发送png地图接口未执行
FINISHED = 1, // 发送png地图接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // png地图发送中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 332 行定义.

◆ SetGridMapAllInfoStatus

typedef FeedbackStatus agvc_interface::SetGridMapAllInfoStatus

设置栅格地图全部信息接口状态，调用接口 setGridMapAllInfo 后的状态

NONE = 0, // 发送栅格地图全部信息接口未执行
FINISHED = 1, // 发送栅格地图全部信息接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // 栅格地图发送中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 344 行定义.

◆ SetPngMapAllInfoStatus

typedef FeedbackStatus agvc_interface::SetPngMapAllInfoStatus

上传Png地图全部信息接口状态，调用接口 setPngMapAllInfo 后的状态

NONE = 0, // 设置地图信息接口未执行
FINISHED = 1, // 设置地图信息接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // 地图信息上传中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 272 行定义.

◆ SwitchMapStatus

typedef FeedbackStatus agvc_interface::SwitchMapStatus

切换地图异步接口状态，调用接口 switchMap 后的状态

NONE = 0, // 切换地图接口未执行
FINISHED = 1, // 切换地图接口执行完毕
FAILED = 2, // 无效值
RUNNING = 3, // 切换地图中
PAUSED = 4, // 无效值
CANCELED = 5, // 无效值

在文件 type.h 第 236 行定义.

枚举类型说明

◆ AgvcErrorCodes

enum agvc_interface::AgvcErrorCodes : int
枚举值
ENUM_AgvcErrorCodes_DECLARES 

在文件 type.h 第 71 行定义.

◆ AutoChargingType

enum class agvc_interface::AutoChargingType
strong

自动充电类型

自从
0.7.0
注解
高电量阈值与低电量阈值在对外配置参数中进行修改
枚举值
NONE 

空

LOW_POWER_TO_BOARD 

低电量自动上桩； 如果当前电量低于低电量阈值，开始上桩；否则，不执行上桩；

HIGH_POWER_LEAVE_BOARD 

高电量自动下桩； 如果当前电量高于高电量阈值，开始下桩；否则，不执行下桩；

FORCE_TO_BOARD 

强制自动上桩； 无视当前电量

FORCE_LEAVE_BOARD 

强制自动下桩； 无视当前电量

在文件 type.h 第 151 行定义.

◆ CalibrationType

enum class agvc_interface::CalibrationType
strong

标定类型

枚举值
NONE 

空

LASER_ODOM 

激光-码盘里程计标定

在文件 type.h 第 196 行定义.

◆ error_type

enum agvc_interface::error_type
枚举值
parse_error 

解析错误

invalid_request 

无效请求

method_not_found 

方法未找到

invalid_params 

无效参数

internal_error 

内部错误

server_error 

服务器错误

invalid 

无效

在文件 type.h 第 826 行定义.

◆ ExceptionCode

enum agvc_interface::ExceptionCode
枚举值
EC_DISCONNECTED 

断开连接

EC_NOT_LOGINED 

未登录

EC_INVAL_SOCKET 

无效套接字

EC_REQUEST_BUSY 

请求繁忙

EC_SEND_FAILED 

发送失败

EC_RECV_TIMEOUT 

接收超时

EC_RECV_ERROR 

接收错误

EC_PARSE_ERROR 

解析错误

EC_INVALID_REQUEST 

无效请求

EC_METHOD_NOT_FOUND 

方法未找到

EC_INVALID_PARAMS 

无效参数

EC_INTERNAL_ERROR 

内部错误

EC_SERVER_ERROR 

服务器错误

EC_INVALID 

无效

在文件 type.h 第 837 行定义.

◆ FeedbackStatus

enum class agvc_interface::FeedbackStatus
strong

一个操作执行后反馈的状态

枚举值
NONE 

空

FINISHED 

成功

FAILED 

失败

RUNNING 

正在运行

PAUSED 

暂停

CANCELED 

取消

在文件 type.h 第 163 行定义.

◆ FirmwareUpdateMode

enum class agvc_interface::FirmwareUpdateMode
strong

模块固件更新配置

枚举值
NONE 

空 默认不更新固件

UPDATE 

更新固件

FORCED_UPDATE 

强制更新固件

NOT_UPDATE 

不更新固件

在文件 type.h 第 176 行定义.

◆ MapFormat

enum class agvc_interface::MapFormat
strong

地图格式

枚举值
NONE 
OCCUPANCY_GRID 

占用栅格地图

BASE64_PNG 

base64编码的png地图

在文件 type.h 第 105 行定义.

◆ MapVirtualAreaShape

enum class agvc_interface::MapVirtualAreaShape
strong

地图中虚拟区域的形状

枚举值
NONE 
LINE 

直线

ARC 

圆弧

CIRCLE 

圆形

POLYGON 

多边形

在文件 type.h 第 126 行定义.

◆ MapVirtualAreaType

enum class agvc_interface::MapVirtualAreaType
strong

地图中虚拟区域的类型

枚举值
NONE 
OBSTACLE 

虚拟墙

SLOW_DOWN 

减速区

INFLATE 

膨胀区

在文件 type.h 第 115 行定义.

◆ NavType

enum class agvc_interface::NavType
strong

agv 导航类型

枚举值
NONE 

空

FREE_TO_POSE 

自由导航到任意点

FREE_TO_STATION 

自由导航到站点

PATH_TO_STATION 

路径导航到站点

在文件 type.h 第 138 行定义.

◆ PathShape

enum class agvc_interface::PathShape
strong

路径的形状

枚举值
NONE 
LINE 

直线

ARC 

圆弧

BEZIER 

贝塞尔曲线 B_SPLINE = 4 // B样条曲线

在文件 type.h 第 93 行定义.

◆ RunningMode

enum class agvc_interface::RunningMode
strong

agv 运行模式

枚举值
NONE 
START 

开始模式

MAPPING 

建图模式

NAVIGATE 

导航模式

CHARGING 

自动充电模式

MAINTAIN 

维护模式

STOP 

停止模式

在文件 type.h 第 79 行定义.

◆ ScriptRuntimeState

enum class agvc_interface::ScriptRuntimeState
strong
枚举值
RUNNING 
PAUSED 
STOPPED 
ABORTING 

在文件 type.h 第 185 行定义.

函数说明

◆ returnValue2Str()

const char * agvc_interface::returnValue2Str ( int retval)
inline

在文件 type.h 第 885 行定义.

引用了 ENUM_AgvcErrorCodes_DECLARES.