1.1 版本与范围
概述
SDK 公开主入口:
- C++17:
include/arm_api.h - C99:
include/c_arm_api.h
连接语义
Arm::Connect()/Arm_Connect()的调用方只需要显式传入controllerIp与可选teachPanelIp。- 当
teachPanelIp留空时,SDK 会按默认连接规则补全地址。
公开模块
| 模块 | 入口 | 说明 |
|---|---|---|
Arm | include/arm_api.h | 主入口 |
ControllerInfo | include/info.h | 信息查询、伺服、软模式 |
AlarmClient | include/alarm.h | 报警查询与复位 |
MotionControl | include/motion.h | 运动、位姿、负载 |
JoggingControl | include/jogging.h | 步进示教、连续点动、停止 |
ProgramManager | include/program.h | 程序执行、程序点位 |
BasScript | include/bas_script.h | 构造器 |
IoSignals | include/io_signals.h | IO 读写 |
RegisterBank | include/registers.h | R/PR/SR/MR/MH/MI |
TrajectoryManager | include/trajectory.h | 轨迹控制 |
RealTimeTrajectoryControl | include/real_time_trajectory.h | 实时轨迹控制 |
ControllerFileManager | include/file_manager.h | 文件管理 |
ExtensionClient | include/extension.h | 插件查询、切换、EasyService 调用 |
TopicPubSub | include/sub_pub.h | WebSocket 订阅发布 |
CoordinateSystemManager | include/coordinate_system.h | 用户 / 工具坐标系管理 |
ModbusClient | include/modbus.h | Modbus 主站与从站句柄 |
发布包依赖
build/build.ps1会生成output/release/cpp17-sdk/、output/release/c99-sdk/, 以及AgilebotCppSdk-cpp17.zip、AgilebotCppSdk-c99.zip。- C++17 发布目录和 zip 包会额外携带编译期 jsoncpp 依赖:
include/json/与lib/jsoncpp.lib。 - C99 头文件不暴露 jsoncpp 类型,因此不携带
include/json/和lib/jsoncpp.lib;两个发布包的runtime/都会携带运行所需的jsoncpp.dll。 - 示例工程优先使用发布包内依赖,不要求接入方机器预装系统环境里的 jsoncpp。
范围说明
- C++17 是主要接口。
- C99 采用
ArmHandle*会话模型,覆盖:core / info / alarm / motion / program / bas-script / jogging / extension / registers / signals / sub-pub / trajectory / file-manager / coordinate / modbus。 - 示例覆盖
ControllerInfo、MotionControl、JoggingControl、ProgramManager、BasScript、ExtensionClient、CoordinateSystemManager,以及 C99Arm Info、C99Arm Alarm、 C99Arm Motion、C99Arm Program、C99Arm Registers、C99Arm Signals、 C99Arm Trajectory、C99Arm FileManager、C99Arm Jogging、C99Arm Extension、 C99Arm SubPub、C99Arm CoordinateSystem、C99Arm Modbus。 - C99 实时轨迹分片通过
ArmTrajectorySegmentC对外提供。
C99 BasScript 构造器
C99 通过 ArmBasScriptHandle / ArmBasExtraParamHandle 提供 BasScript 构造器能力。 常用入口包括 Arm_BasScript_Create() 、 Arm_BasScript_CreateWithName() 、 Arm_BasScript_AppendLine(s) 、 Arm_BasScript_GetText() 与 Arm_BasScript_Execute() 。完整函数见 include/c_arm_bas_script.h 和 4.6 C99 BasScript 构造器。