标准协议

## ⼀、Launcher 启动节点

启动节点︔⽤于配置各功能节点是否启动，及统⼀授权。

### Service: /r_launcher/init
初始化
此服务由开发者进⾏调⽤
说明︓发送此消息来传⼊APPID三元组，⽤于统⼀授权︔节点内部在收到此消息时，会读取配置⽂件来决定启
动哪些功能节点。
新增︓⽀持传⼊配置⽂件路径

```
# Request
# Request
string appid            # 应用ID
string appkey           # 应用公钥
string appsecret        # 应用密钥
string uid              # 设备唯一码
string iot_productkey    # IoT产品公钥
string iot_secret        # IoT产品密钥
string cfg_path          # 配置文件路径
---
# Respond
int32 err_code           # 错误码
string err_msg           # 错误描述

```

### 全局配置
Launcer节点收到init消息后，会进⾏全局统⼀初始化配置，通过读取配置⽂件中的字段来进⾏各节点的初始化
流程︔
配置⽂件格式如下︓

```json
{
	//"init_node_info":"初始化节点, true表⽰需要启动, false表⽰不需要启动",
	"init_node":{
		"aiui":true,
		"iot":false,
		"xrtc":false,
		"cv":false
	},
	//"init_param_info":"初始化参数",
	"init_param":{
		"scene":"main",
		"work_dir":"/path/to/work/dir/xxxxxxxxxxxxx",
		"ability":"spark_xtts"
	},
	//"log_info":"⽇志配置",
	"log":{
		//"level_info":"DEBUG:0, INFO:1, WARN:2, ERROR:3, CRITICAL:4, Default:2",
		"level":2,
		//"format_info":"time:1, thread:2, level:4, function:8, file:16, line:32,
		ALL:-1, OFF:0, Default:47",
		"format":55,
		//"output_info":"console:0, logcat:1, file:2, OFF:0,
		Default:0(Linux/Windows/iOS),1(Android)",
		"output":0,
		//"file_size_info":"max size of log file, unit:KB, range:10~10240,
		default:1024",
		"file_size":1024,
		//"save_path_info":"log saving path, Default: curent work directory",
		"save_path":".",
		"//save_mode_info":"log file saving mode, 0:delete first half then append,
		1:rename current file then append in new one, Default:0",
		"save_mode":0,
		//"color_info":"print level with ANSI color",
		"color":true
	},
	...
	}
```

## ⼆、AIKit AI能力节点

AIKit包含CV能⼒、交互AIUI及IoT三⼤节点，使⽤统⼀的话题/服务和消息类型
各节点的话题及服务列举如下︓

|节点名称 |主题 |类型 |说明|
|---|---|---|---|
|r_aiui |r_aiui/start |服务 |启动能⼒|
||r_aiui/write |话题 |写⼊数据|
||r_aiui/result |话题 |下发结果|
||r_aiui/stop |服务| 停⽌能⼒|
|r_cv |r_cv/init |服务 |预留，⽤于初始化各⼦能⼒|
||r_cv/start |服务 |启动能⼒|
||r_cv/write |话题 |写⼊数据|
||r_cv/result |话题 |下发结果|
||r_cv/stop |服务 |停⽌能⼒|
|r_iot |r_iot/write| 话题 |写⼊数据|
||r_iot/result |话题 |下发结果|

说明︓开头的r_表⽰robot的简写︔
下⾯对各消息进⾏说明，节点名称统⼀以r_aikit代替

### Service: /r_aikit/init

初始化⼦能⼒
此服务由开发者进⾏调⽤
说明︓由于节点可能包含多个⼦能⼒，需要在启动时通过此服务来制定需要初始化哪些即将会⽤到的能⼒︔⽐
如CV节点下包含⼈脸识别、⼿势识别、物体检测等能⼒，需要在启动时根据实际需求决定初始化哪些能⼒︔

```
# Request
string appid        # 应用ID
string appkey       # 应用公钥
string appsecret    # 应用密钥
string cfg_path     # 配置文件路径
string uid          # 设备唯一码
---
# Respond
int32 err_code       # 错误码
string err_msg       # 错误描述
```

### Service: /r_aikit/start
启动能⼒
此服务由开发者进⾏调⽤
说明︓通过传⼊能⼒ID来区分具体需要启动的能⼒，⽐如⼿势识别、标准AIUI及带唤醒的AIUI等等︔

```
# Request
string abilityId; // 能⼒ID
AIKitMsgs/BizParam param; // 能⼒参数
---
# Respond
int32 errCode; // 错误码
const char *abilityId; // 能⼒ID
uint64 handle; // 会话句柄
```

### Topic: /r_aikit/write
写⼊数据
此主题由AIKit各节点内部订阅，开发者发布此主题来进⾏交互
Message:

```
uint64 handle; // 会话句柄
AIKitMsgs/InputData data; // 实际数据
```

### Service: /r_aikit/stop
停⽌能⼒
此服务由开发者进⾏调⽤

```
# Request
uint64 handle; // 会话句柄
---
# Respond
int32 errCode; // 错误码
string desc; // 会话句柄
```

### Topic: /r_aikit/result
输出结果
此主题由开发者订阅，AIKit节点产⽣的结果通过此主题来发布
Message:

```
int32 type; // 结果类型，分为正常结果、错误和事件
AIKitMsgs/OutputData data; // 结果数据，根据类型的不同来区分数据格式
```

## 三、XRTC 音视频监控节点

视频推流节点
### Service: /r_xrtc/room
进⼊房间
此主题由XRTC节点内部订阅，开发者发布此主题来进⾏交互
Message:

```
# Request
uint8 action        # 动作类型，1:进入房间 0:退出房间
string roomid       # 房间号
---
# Respond
int32 err_code       # 错误码
string err_msg       # 错误描述

```

### Service: /r_xrtc/switch_role
切换⾓⾊（预留功能，暂不支持）
此主题由XRTC节点内部订阅，开发者发布此主题来进⾏交互
Message:

```
# Request
string room_id; // 房间号
---
# Respond
int32 errCode; // 错误码
string errMsg; // 错误描述
```

### Topic: /r_xrtc/error
报错信息
此主题由开发者订阅，XRTC节点产⽣的结果通过此主题来发布
Message:

```
int32 err; // 错误类型
string errMsg; // 错误描述
```