C SDK on TiJet

参数读写

Mon, 01 Jan 0001 00:00:00 +0000

参数读写

读写服务端配置参数，通过 Key 命名约定区分全局参数与驱动板参数。

`tijet_client_set_parameter`

设置参数。

通过 Key 命名约定区分全局参数与驱动板参数：

"key" → 全局参数
"board.N.key" → 驱动板编号 N 的参数（N 为板号）
client: 客户端句柄。
key: 参数名（区分大小写，UTF-8 编码），支持层级命名。
value: 参数值（JSON 字符串格式，参见 param_type_convention 节）。
返回: TIJET_OK — 设置成功
返回: TIJET_ERR_NOT_CONNECTED — 未连接
返回: TIJET_ERR_INVALID_ARG — client / key / value 为 NULL
返回: TIJET_ERR_SERVER — 服务端拒绝该参数

使用示例：

// 全局参数
tijet_client_set_parameter(cli, "print_speed", "100");
// 驱动板 #0 的参数
tijet_client_set_parameter(cli, "board.0.print_speed", "80");

参见: tijet_client_get_parameter()

`tijet_client_get_parameter`

获取参数（单次调用）。

不再需要"两次调用"模式——调用方预分配至少 TIJET_MAX_PARAM_VALUE 字节的缓冲区，传入 buf_size 告知容量，一次调用即可获取参数值。

通过 Key 命名约定区分全局参数与驱动板参数（同 set）。

错误码

Mon, 01 Jan 0001 00:00:00 +0000

错误码

所有接口函数返回的状态码。

`TIJET_OK`

操作成功。

`TIJET_ERR_INVALID_ARG`

参数无效（NULL 指针、越界等）。

`TIJET_ERR_NOT_CONNECTED`

尚未连接到服务器。

`TIJET_ERR_TIMEOUT`

操作超时。

`TIJET_ERR_BUFFER_TOO_SMALL`

用户提供的缓冲区太小。调用 tijet_client_last_error() 获取所需大小。

`TIJET_ERR_SERVER`

服务器返回错误。

`TIJET_ERR_INTERNAL`

内部错误（内存不足、线程错误等）。

`tijet_client_t`

客户端句柄（opaque pointer）。

通过 tijet_client_create() 创建，用毕后必须调用 tijet_client_destroy() 释放。内部结构不对外暴露，所有操作均通过本头文件中声明的函数完成。

打印数据

Mon, 01 Jan 0001 00:00:00 +0000

打印数据

向服务端发送打印数据。

`tijet_client_set_print_data`

发送打印数据到服务端。

client: 客户端句柄。
data: 二进制打印数据缓冲区。
data_len: 数据长度（字节）。
index: 打印数据序号（由业务层传入，用于去重 / 顺序控制）。
is_static: 0 = 普通数据（一次性打印），非 0 = 静态数据（重复打印同一份）。静态数据会被服务端缓存以优化重复传输。
checksum_buf (输出): 校验和输出缓冲区。传 NULL 表示不关心校验和。
checksum_buf_size (输入/输出):
[in] checksum_buf 的容量（字节）。checksum_buf 为 NULL 时传 0。
[out] 校验和字符串所需字节数（含结尾 \0）。当前实现输出 64 字符的 SHA-256 十六进制字符串，需要 65 字节。
返回: TIJET_OK — 发送成功
返回: TIJET_ERR_NOT_CONNECTED — 未连接
返回: TIJET_ERR_INVALID_ARG — client / data 为 NULL 或 data_len 为 0
返回: TIJET_ERR_BUFFER_TOO_SMALL — checksum_buf 不足

连接管理

Mon, 01 Jan 0001 00:00:00 +0000

连接管理

建立与断开打印服务的连接。

`tijet_client_connect`

连接到打印服务。

自动识别地址类型：

包含 : 后跟数字端口（如 127.0.0.1:50051）→ TCP 直连
其他非空字符串 → Unix Domain Socket（自动添加 unix: 前缀）
NULL 或空字符串 → 使用 TIJET_DEFAULT_UDS_PATH
client: 客户端句柄。
address: 服务地址（UTF-8 字符串）。传 NULL 或空字符串使用默认 UDS 路径。
返回: TIJET_OK — 连接成功
返回: TIJET_ERR_INVALID_ARG — client 为 NULL
返回: TIJET_ERR_TIMEOUT — 连接超时
返回: TIJET_ERR_SERVER — 服务端拒绝连接

注意: 重复调用会先断开当前连接再重新连接。参见: tijet_client_disconnect() 参见: TIJET_DEFAULT_UDS_PATH

`tijet_client_disconnect`

断开与服务端的连接。

自动停止事件订阅和日志订阅（若已启动），安全关闭 gRPC channel。未连接时调用是安全的（空操作）。

client: 客户端句柄。
返回: TIJET_OK — 断开成功
返回: TIJET_ERR_INVALID_ARG — client 为 NULL

`tijet_client_is_connected`

查询是否已连接。

日志订阅

Mon, 01 Jan 0001 00:00:00 +0000

日志订阅

订阅服务端的远程日志推送（WatchLogs）。

`tijet_client_set_log_callback`

注册服务端日志回调。

必须在 tijet_client_start_log_subscription() 之前调用。如未注册，日志默认写入客户端 spdlog（需链接 spdlog 库）。

client: 客户端句柄。
callback: 日志回调函数。传 NULL 恢复默认（spdlog 输出）。
user_data: 用户自定义数据，回调时原样传入。可以为 NULL。

注意: 回调在内部日志线程中执行，务必保证线程安全。参见: tijet_log_callback_t 参见: tijet_client_start_log_subscription()

`tijet_client_stop_log_subscription`

停止日志订阅。

安全关闭日志流并等待内部线程退出，阻塞直到线程完全退出。未启动订阅时调用是安全的（空操作）。

client: 客户端句柄。
返回: TIJET_OK — 停止成功
返回: TIJET_ERR_INVALID_ARG — client 为 NULL

参见: tijet_client_start_log_subscription()

生命周期

Mon, 01 Jan 0001 00:00:00 +0000

生命周期

客户端句柄的创建与销毁。

`tijet_client_create`

创建客户端实例。

分配并初始化内部资源。返回的句柄在使用前需要调用 connectToServer() 建立与服务端的连接。

返回: 非 NULL 的客户端句柄。内部内存分配失败时返回 NULL。

注意: 用毕后必须调用 tijet_client_destroy() 释放。

参见: tijet_client_destroy()

`tijet_client_destroy`

销毁客户端实例。

自动断开连接（如有）、释放所有内部资源。传入 NULL 是安全的（空操作）。

client: 客户端句柄。可以为 NULL。

参见: tijet_client_create()

事件订阅

Mon, 01 Jan 0001 00:00:00 +0000

事件订阅

订阅服务端的异步事件推送。

`tijet_client_set_event_callback`

注册服务端事件回调。

必须在 tijet_client_start_event_subscription() 之前调用。未注册回调时启动事件订阅不会产生效果。

client: 客户端句柄。
callback: 事件回调函数。传 NULL 取消注册。
user_data: 用户自定义数据，回调时原样传入。可以为 NULL。

注意: 回调在内部事件线程中执行，务必保证线程安全。参见: tijet_event_callback_t 参见: tijet_client_start_event_subscription()

`tijet_client_stop_event_subscription`

停止事件订阅。

安全关闭事件流并等待内部线程退出，阻塞直到线程完全退出。未启动订阅时调用是安全的（空操作）。

client: 客户端句柄。
返回: TIJET_OK — 停止成功
返回: TIJET_ERR_INVALID_ARG — client 为 NULL

参见: tijet_client_start_event_subscription()

网络配置

Mon, 01 Jan 0001 00:00:00 +0000

网络配置

配置设备网络（IP / 掩码 / 网关）。

`tijet_client_network_config`

配置设备网络参数。

client: 客户端句柄。
ip: IPv4 地址（如 "192.168.1.100"）。传 NULL 或空字符串跳过。
ip_mask: 子网掩码（如 "255.255.255.0"）。传 NULL 或空字符串跳过。
gateway: 默认网关（如 "192.168.1.1"）。传 NULL 或空字符串跳过。
返回: TIJET_OK — 配置成功
返回: TIJET_ERR_NOT_CONNECTED — 未连接
返回: TIJET_ERR_SERVER — 服务端返回配置错误
返回: TIJET_ERR_INVALID_ARG — client 为 NULL

注意: 三个参数中至少应提供一个非空值。全为空将返回 TIJET_ERR_INVALID_ARG。

元信息

Mon, 01 Jan 0001 00:00:00 +0000

元信息

错误信息查询与版本信息。

`tijet_client_last_error`

获取最近一次错误的可读描述。

client: 客户端句柄。返回: 指向静态错误字符串的指针。无错误时返回 "No error"。该指针在下次对同一句柄的操作前一直有效。

注意: 返回的字符串不需要（也不能）由调用方释放。

`tijet_client_version`

获取 SDK 版本号。

返回: 版本字符串，格式 "major.minor.patch"，如 "1.0.0"。返回的字符串为静态常量，不可释放。

`TIJET_VERSION_MAJOR`

SDK 主版本号。

`TIJET_VERSION_MINOR`

SDK 次版本号。

`TIJET_VERSION_PATCH`

SDK 修订版本号。

`TIJET_SHA256_HEX_LEN`

SHA-256 十六进制字符串长度（不含结尾 \0）。