Skip to content

连接与设备信息 ​

接口概览 | 通用参数和返回值

构造与连接 ​

SDKClient ​

cpp
SDKClient(
    ErrorHandler error_callback = [](const std::error_code&) {},
    ConnectionConfig connection_config = ConnectionConfig(),
    TransportProtocol type = TransportProtocol::Udp);

创建 SDK 客户端。type 支持 TransportProtocol::Udp 和 TransportProtocol::WebSocket,默认使用 UDP。

ConnectionConfig 的连接与重连参数:

字段说明
connect_timeout_ms连接和握手超时时间,默认 5000 ms,最小 500 ms
auto_reconnect是否开启自动重连,默认 false
reconnect_interval_ms自动重连间隔,默认 1000 ms,最小 500 ms

Connect ​

cpp
std::error_code Connect(
    std::string ip, std::string port, bool block = false,
    ConnectHandler handler = [](const std::error_code&) {});

建立传输连接并完成协议握手。只有握手成功后才算连接成功。

从 SDK v0.2.3 起,首次连接因传输、握手、协议不匹配或控制被拒绝而失败后,可在同一个 SDKClient 实例上再次调用 Connect()。异步连接应等待本次失败结果再由应用线程发起重试。

参数说明
ip机器人地址,例如 192.168.234.1 或 192.168.168.168
portUDP 通常使用 8082,WebSocket 使用 8081
blockfalse:异步连接;true:阻塞等待连接完成
handler异步连接结果回调
cpp
SDKClient client;
auto ec = client.Connect("192.168.234.1", "8082", true);
if (ec) {
    std::cerr << "connect failed: " << ec.message() << std::endl;
}

Disconnect ​

cpp
std::error_code Disconnect(
    bool block = false,
    DisConnectHandler handler = [](const std::error_code&) {});

主动断开连接。UDP 模式下 SDK 会先发送断开通知,再释放连接资源。

IsConnected ​

cpp
bool IsConnected() const;

返回 true 表示已经完成握手并处于 ConnectionState::CONNECTED 状态。

GetConnectionState ​

cpp
ConnectionState GetConnectionState() const;

返回当前连接状态:

枚举值整数值含义
DISCONNECTING0断开中
DISCONNECTED1已断开
CONNECTING2连接中
HANDSHAKING3握手中
CONNECTED4已连接
RECONNECTING5自动重连中

版本和设备信息 ​

函数原型说明
Versionconst std::string& Version() constSDK 版本
ProtocolVersionconst std::string& ProtocolVersion() const通信协议版本
SystemVersionconst std::string& SystemVersion() const握手得到的机器人系统版本
GetDeviceInfoDeviceInfo GetDeviceInfo() const获取握手缓存的机型和序列号
cpp
struct DeviceInfo {
    DeviceType device_type = DeviceType::UNKNOWN;
    std::string sn;
};

示例:

cpp
auto ec = client.Connect("192.168.234.1", "8082", true);
if (!ec) {
    const auto info = client.GetDeviceInfo();
    std::cout << DeviceTypeName(info.device_type)
              << " / " << info.sn << std::endl;
}

连接成功前或断开后,device_type 可能为 DeviceType::UNKNOWN,sn 可能为空。

M1 机型判断 ​

SDK 会在握手时返回 DeviceType。启动后应先调用 GetDeviceInfo(),再根据返回型号启用功能。M1 相关枚举值见 M1 回调、数据类型与状态参考。

调用当前型号不支持的操作时,SDK 返回 Errc::UnsupportedDeviceOperation,不会发送协议命令。

回充、离桩、外设电源和状态 LED 取决于设备硬件与系统配置。完整的接口支持范围见官方机型能力矩阵。

完整的接口组合方式见 M1 示例程序与故障排查。