CRI ADX  Last Updated: 2024-07-17 10:48 p
通信用动态程序库的接口

通信用动态库接口中提供了以下API。

函数 说明
criAcApiClient_Initialize 初始化通信库
criAcApiClient_Finalize 终止通信库
criAcApiClient_Connect 执行与CRI Atom Craft连接
criAcApiClient_Disconnect 解除与CRI Atom Craft连接
criAcApiClient_GetStatus 获取与CRI Atom Craft的连接状态
criAcApiClient_Call 发送命令字符串到CRI Atom Craft并等待其完成
criAcApiClient_GetResponseBufferLength 获取保存了CRI Atom Craft的API执行结果的JSON字符串的长度
criAcApiClient_GetResponseBuffer 获取已保存在CRI Atom Craft的API执行结果的JSON字符串
注解
通信用动态库仅在从Python以外的编程语言执行Robot时使用。
详细信息,请参照 从其他编程语言执行


criAcApiClient_Initialize

初始化通信库。

格式

int criAcApiClient_Initialize(void);

输入的参数

返回值

成功时为 0,失败时为0以外的值


criAcApiClient_Finalize

终止通信库。

格式

void criAcApiClient_Finalize(void);

输入的参数

返回值


criAcApiClient_Connect

执行与CRI Atom Craft连接。

格式

int criAcApiClient_Connect(const char* hostIpAddress, unsigned short port);

输入的参数

名称
hostIpAddress CRI Atom Craft 的IP地址
port 用于连接的端口编号

返回值

成功时为0,失败时为0以外的值


criAcApiClient_Disconnect

解除与CRI Atom Craft连接。

格式

void criAcApiClient_Disconnect(void);

输入的参数

返回值


criAcApiClient_GetStatus

获取与CRI Atom Craft的连接状态。

格式

int criAcApiClient_GetStatus(void);

输入的参数

返回值

处于连接状态时为0,未连接状态时为0以外的值


criAcApiClient_Call

发送命令字符串到CRI Atom Craft并等待其完成。

格式

int criAcApiClient_Call(const char* json_request, int json_request_len);

输入的参数

名称
hostIpAddress CRI Atom Craft 的IP地址
port 用于连接的端口编号

返回值

成功时为0以上
失败时为0以下


criAcApiClient_GetResponseBufferLength

获取保存了CRI Atom Craft的API执行结果的JSON字符串的长度。

格式

int criAcApiClient_GetResponseBufferLength(void);

输入的参数

返回值

JSON字符串的长度(不包含终端字符)


criAcApiClient_GetResponseBuffer

获取保存了CRI Atom Craft的API执行结果的JSON字符串。
除了 criAcApiClient_GetResponseBufferLength 外,缓冲区内还需要终端字符的长度。
因此,至少需要以 criAcApiClient_GetResponseBufferLength 获取的值 +1 为长度的缓冲区。

格式

int criAcApiClient_GetResponseBuffer(char* buffer, int buffer_length);

输入的参数

名称
buffer 用于写入API执行结果字符串的字符串缓冲区
buffer_length 可以写入到缓冲区的字符串的长度

返回值

成功时为0,失败时为0以外的值