使用手册

Go SDK

使用 draft pure Go SDK 集成 device client、automation、telemetry、firmware 与 signaling。

Status 与安装

Go SDK 是 draft/internal package,不在第一批五 package user delivery bundle。以 Go 1.21+ import github.com/hkt999rtk/rtk_cloud_client/packages/golang/rtkc,并 pin approved commit/release。

Client、auth 与能力

rtkc.NewClient/ClientConfig 创建 client。所有 network call 接受 context.Context;传递 deadline/cancellation 并确定性地 close session/client。使用 token refresh helper 或 auth package 的 PKI CSR/mTLS helper,保护 PEM/PKCS#11 key。以 rtkc.WithCorrelation 加入 sanitized correlation ID。

Module 包含 device lifecycle、owner WebSocket transport、MQTT hook、WebRTC signaling、telemetry 与 firmware vocabulary。Application 仍负责 media engine、persistent state、rollout policy 与 product authorization。

验证

执行 CGO_ENABLED=0 go build ./...CGO_ENABLED=0 go test ./...。Release manifest 未改变 status 前,不宣称 public distribution。

其他手册章節

繼續閱读相关手册章節。

SDK 总览

选择 package 并理解支持边界。

开启章節

开始使用

安装 SDK、设置 client 并完成第一次 request。

开启章節

认证与安全

安全处理 token、PKI、TLS、key 与 media。

开启章節

生命周期与错误

处理 timeout、retry、cancel、callback 与 shutdown。

开启章節

能力工作流

集成 provisioning、device、telemetry、OTA、command 与 signaling。

开启章節

Video Cloud 工作流

集成 Live WebRTC signaling 与 encrypted stored video。

开启章節

Native C/C++ SDK

使用 stable C ABI、C++ wrapper、transport 与 streaming upload。

开启章節

Android Kotlin SDK

使用 coroutine、signaling、Media3 与 secure key provider。

开启章節

iOS Swift SDK

使用 async API、signaling、AVPlayer、Keychain 与 Secure Enclave。

开启章節

JavaScript/TypeScript SDK

在 browser 与 Node.js 集成 typed ESM package。

开启章節

FreeRTOS/Pro2 SDK

集成 board、transport、media 与 WebRTC answerer adapter。

开启章節

Sample applications

正确使用 Android、iOS、Web、Linux 与 Pro2 sample。

开启章節

调试与兼容性

诊断认证、transport、upload、playback 与版本问题。

开启章節