智能云广播控制主机（产品型号：GSSM2P）开发者文档

GemeOpen

写几行代码，就可以控制的智能设备！

智能云广播控制主机开发者文档

产品型号：GSSM2P

产品概要信息

基本描述

本款智能云广播控制主机采用钣金金属外壳，坚固耐用。
设备支持远程音频播报、远程音频插播以及 TTS 文字转语音合成；配备丰富接口，可搭配无源音箱实现左右双声道输出 60W 总功率。
供电方式灵活，支持电源适配器供电、接线端子直流供电两种方案可选，自带 1GB 内存卡，可本地存储大约 500 首音频；自带天线接口，可安装于电箱内部，实现园区、校园等场景的语音广播、音频插播等需求。改成左右声道各 30W

主要特点

WiFi+以太网连接，可外接两台无源音箱，总功率 60W，DC12-24V供电
支持MQTT/TCP/HTTP/MCP协议，自带原生MCP Server 接受Agent控制
支持本地云端音频播放，TTS文字转语音，48种拟人音色

产品图片

技术支持

企业微信扫一扫

武汉智鸟科技有限责任公司

企业官网：www.smart-bird.cn

服务热线：130-0715-9689

办公地址：湖北省武汉市高新大道光谷崇文中心B1栋1401、1409

广播控制

音量加

player-add-vol

指令简介

增加设备音量。设备收到指令后音量上调（10），最高到最大音量，超出上限时保持最大值不变。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "add-volume",
"messageId" : "202201241610366046",
"type" : "player"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定动作	add-volume
2	channel	String	通道	left
3	freq	int	频率，单位(Khz)	31
4	gain	int	增益，单位dB，范围-13到13。	-13
5	messageId	String	消息ID字段	202201241610366046
6	type	String	指令类型	player

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-add-volume",
"mac" : "206ef1883b7c",
"message" : "OK",
"messageId" : "202201241610366046",
"source" : "command",
"success" : true,
"volume" : 85
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	channel	String	左右	left
2	commandName	String	指令名称	player-add-volume
3	freq	int	频率，单位(Khz)	31
4	gain	int	增益，单位dB，范围-13到13。	-13
5	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	206ef1883b7c
6	message	String	执行返回结果	OK
7	messageId	String	消息ID字段	202201241610366046
8	name	String	歌曲名字	001.mp3
9	size	int	歌曲大小（单位字节）	12099546
10	source	String	指令回复“command"	command
11	success	boolean	执行结果	true
12	volume	int	音量大小（0-100）	85

删除SD卡音频文件

player-delete

指令简介

从SD卡中删除指定歌曲，通过 name 参数指定歌曲名（不含扩展名），设备在播放列表中查找并删除该歌曲及其文件。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "delete",
"name" : "我爱中国",
"type" : "player"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定动作	delete
2	name	String	音频名	我爱中国
3	type	String	指令类型	player

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-delete",
"mac" : "206ef1883b7c",
"message" : "OK",
"messageId" : "202201241610366046",
"name" : "我爱中国",
"source" : "command",
"success" : true
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-delete
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	206ef1883b7c
3	message	String	执行返回结果	OK
4	messageId	String	消息ID字段	202201241610366046
5	name	String	歌曲名字	我爱中国
6	source	String	指令回复“command"	command
7	success	boolean	执行结果	true

下载音频文件到SD卡

player-download

指令简介

从指定URL下载音频并保存到SD卡，通过 name 参数指定保存的歌曲名、url 参数指定音频地址（仅支持 http，不支持 https）。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "download",
"name" : "饿狼传说",
"type" : "player",
"url" : "http://smart-bird-oss.smart-bird.cn/music/2025/%E9%A5%BF%E7%8B%BC%E4%BC%A0%E8%AF%B4.mp3"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定动作	download
2	name	String	保存到在sd，歌曲名字	饿狼传说
3	type	String	指令类型	player
4	url	String	下载的http地址	http://smart-bird-oss.smart-bird.cn/music/2025/%E9%A5%BF%E7%8B%BC%E4%BC%A0%E8%AF%B4.mp3

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-download",
"mac" : "2026bb16aa14",
"progress" : 0,
"source" : "command",
"status" : 0
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-download
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	2026bb16aa14
3	progress	int	进度值（0-100%）	0
4	source	String	指令回复“command"	command
5	status	int	状态 0：开始，1：进行中，2：结束	0

获取播放器参数

player-getParams

指令简介

查询设备当前播放器参数。设备收到指令后返回当前音量、播放模式等信息，用于查看设备播放状态。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "getParams",
"type" : "player"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定动作	getParams
2	type	String	指令类型	player

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-getParams",
"eqGains" : [-13, -10, -5, 0, 3, 5, 3, 0, -5, -10, -13, -10, -5, 0, 3, 5, 3, 0, -5, -10],
"mac" : "2026bb16aa14",
"playMode" : "ListLoopPlay",
"sdCardFreeSpace" : 256,
"sdCardTotalSpace" : 512,
"sdCardUsage" : 26,
"source" : "command",
"volume" : 70
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-getParams
2	eqGains	List	eqGains: int[20] EQ均衡器增益值前10个为左声道，后10个为右声道，一一对应以下10个频段：频段(Hz): 31 62 125 250 500 1K 2K 4K 8K 16K 每个频段增益范围: -13 ~ +13 -13 = 最大削减 0 = 不调整（原始） +13 = 最大增益示例（左右声道相同）: [-13, -10, -5, 0, 3, 5, 3, 0, -5, -10, ← 左声道 -13, -10, -5, 0, 3, 5, 3, 0, -5, -10] ← 右声道	[-13, -10, -5, 0, 3, 5, 3, 0, -5, -10, -13, -10, -5, 0, 3, 5, 3, 0, -5, -10]
3	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	2026bb16aa14
4	playMode	String	播放模式：（OnePlay：播完一首就停），（OneLoopPlay：单曲循环），（RandomPlay：随机播放），（ListLoopPlay：列表循环）	ListLoopPlay
5	sdCardFreeSpace	int	内存卡剩余空间，单位：MB	256
6	sdCardTotalSpace	int	内存卡总大小，单位：MB	512
7	sdCardUsage	int	内存卡使用率，单位：%	26
8	source	String	指令回复“command"	command
9	volume	int	音量大小（0-100）	70

查询SD卡音频文件

player-getSongList

指令简介

获取SD卡内的歌曲列表，设备返回播放列表中的所有歌曲名称。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "getSongList",
"type" : "player"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定动作	getSongList
2	type	String	指令类型	player

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-getSongList",
"fileCount" : 1,
"mac" : "2026bb16aa14",
"songs" :
{
"name" : "我爱中国",
"size" : 8504797
},
"source" : "command"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-getSongList
2	fileCount	int	歌曲数量	1
3	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	2026bb16aa14
4	name	String	歌曲名字	我爱中国
5	size	int	歌曲大小（单位字节）	8504797
6	songs	Object	所有歌曲信息
7	source	String	指令回复“command"	command

播放网络音频

player-http-play

指令简介

播放指定URL的网络音频，通过 url 参数传入音频地址（仅支持 http，不支持 https）。priority 为 high 时走高优先级通道优先播放，否则按普通优先级播放。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "http-play",
"messageId" : 20260520,
"priority" : high,
"type" : "player",
"url" : "http://smart-bird-oss.smart-bird.cn/music/2025/%E9%9F%B3%E7%AE%B1%E7%AE%80%E4%BB%8B.mp3"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定字段	http-play
2	messageId		业务流水号。由请求方生成的唯一标识，响应方原样回显，用于请求与响应的关联匹配。	20260520
3	priority		若有这个字段，表示插播，	high
4	type	String	指令类型	player
5	url	String	url地址	http://smart-bird-oss.smart-bird.cn/music/2025/%E9%9F%B3%E7%AE%B1%E7%AE%80%E4%BB%8B.mp3

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-http-play",
"mac" : "2026bb16aa14",
"message" : "ok",
"source" : "command",
"success" : true,
"url" : "http://smart-bird-oss.smart-bird.cn/music/2025/%E9%9F%B3%E7%AE%B1%E7%AE%80%E4%BB%8B.mp3"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-http-play
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	2026bb16aa14
3	message	String	执行返回结果	ok
4	source	String	指令回复“command"	command
5	success	boolean	执行结果	true
6	url	String	url地址	http://smart-bird-oss.smart-bird.cn/music/2025/%E9%9F%B3%E7%AE%B1%E7%AE%80%E4%BB%8B.mp3

播放下一曲

player-next

指令简介

播放SD卡播放列表中的下一首歌曲。设备收到指令后切换到当前歌曲的下一曲并播放，若当前为最后一首则循环到第一首。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "next",
"type" : "player"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定动作	next
2	type	String	指令类型	player

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-next",
"mac" : "4CEBD60BFD62",
"message" : "OK",
"messageId" : "202201241610366046",
"name" : "我爱中国",
"source" : "command",
"success" : true
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-next
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	4CEBD60BFD62
3	message	String	执行返回结果	OK
4	messageId	String	消息ID字段	202201241610366046
5	name	String	歌曲名字	我爱中国
6	source	String	指令回复“command"	command
7	success	boolean	执行结果	true

设置播放器参数

player-params-set

指令简介

设置设备音量（volume，0-100）、播放模式（playMode：OnePlay播放一次/OneLoopPlay单曲循环/ListLoopPlay列表循环/RandomPlay随机播放）和EQ音效（eqGains，20个数值，左右声道各10段，范围-13~13），未传字段保持不变。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "setParams",
"eqGains" : [-13, -10, -5, 0, 3, 5, 3, 0, -5, -10, -13, -10, -5, 0, 3, 5, 3, 0, -5, -10],
"playMode" : "ListLoopPlay",
"type" : "player",
"volume" : 85
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定动作	setParams
2	eqGains	List	eqGains: int[20] EQ均衡器增益值前10个为左声道，后10个为右声道，一一对应以下10个频段：频段(Hz): 31 62 125 250 500 1K 2K 4K 8K 16K 每个频段增益范围: -13 ~ +13 -13 = 最大削减 0 = 不调整（原始） +13 = 最大增益示例（左右声道相同）: [-13, -10, -5, 0, 3, 5, 3, 0, -5, -10, ← 左声道 -13, -10, -5, 0, 3, 5, 3, 0, -5, -10] ← 右声道	[-13, -10, -5, 0, 3, 5, 3, 0, -5, -10, -13, -10, -5, 0, 3, 5, 3, 0, -5, -10]
3	playMode	String	播放模式：（OnePlay：播完一首就停），（OneLoopPlay：单曲循环），（RandomPlay：随机播放），（ListLoopPlay：列表循环）	ListLoopPlay
4	type	String	指令类型	player
5	volume	int	音量大小（0-100）	85

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-params-set",
"eqGains" : [-13, -10, -5, 0, 3, 5, 3, 0, -5, -10, -13, -10, -5, 0, 3, 5, 3, 0, -5, -10],
"mac" : "2026bb16aa14",
"message" : "ok",
"playMode" : "ListLoopPlay",
"source" : "command",
"success" : true,
"volume" : 85
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-params-set
2	eqGains	List	eqGains: int[20] EQ均衡器增益值前10个为左声道，后10个为右声道，一一对应以下10个频段：频段(Hz): 31 62 125 250 500 1K 2K 4K 8K 16K 每个频段增益范围: -13 ~ +13 -13 = 最大削减 0 = 不调整（原始） +13 = 最大增益示例（左右声道相同）: [-13, -10, -5, 0, 3, 5, 3, 0, -5, -10, ← 左声道 -13, -10, -5, 0, 3, 5, 3, 0, -5, -10] ← 右声道	[-13, -10, -5, 0, 3, 5, 3, 0, -5, -10, -13, -10, -5, 0, 3, 5, 3, 0, -5, -10]
3	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	2026bb16aa14
4	message	String	执行返回结果	ok
5	playMode	String	播放模式：（OnePlay：播完一首就停），（OneLoopPlay：单曲循环），（RandomPlay：随机播放），（ListLoopPlay：列表循环）	ListLoopPlay
6	source	String	指令回复“command"	command
7	success	boolean	执行结果	true
8	volume	int	音量大小（0-100）	85

暂停播放

player-pause

指令简介

暂停当前正在播放的音频。设备收到指令后暂停播放，可通过继续播放指令恢复。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "pause",
"messageId" : "202201241610366046",
"type" : "player"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定动作	pause
2	messageId	String	消息ID字段	202201241610366046
3	type	String	指令类型	player

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-pause",
"mac" : "4CEBD60BFD62",
"message" : "OK",
"messageId" : "202201241610366046",
"source" : "command",
"success" : true
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-pause
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	4CEBD60BFD62
3	message	String	执行返回结果	OK
4	messageId	String	消息ID字段	202201241610366046
5	source	String	指令回复“command"	command
6	success	boolean	执行结果	true

播放SD卡音频

player-play

指令简介

播放SD卡内存储的歌曲。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "play",
"messageId" : "202201241610366046",
"type" : "player"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定动作	play
2	messageId	String	消息ID字段	202201241610366046
3	type	String	指令类型	player

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-play",
"mac" : "4CEBD60BFD62",
"message" : "OK",
"messageId" : "202201241610366046",
"source" : "command",
"success" : true
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-play
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	4CEBD60BFD62
3	message	String	执行返回结果	OK
4	messageId	String	消息ID字段	202201241610366046
5	source	String	指令回复“command"	command
6	success	boolean	执行结果	true

播放上一曲

player-prev

指令简介

播放SD卡播放列表中的上一首歌曲。设备收到指令后切换到当前歌曲的上一曲并播放，若当前为第一首则循环到最后一首。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "prev",
"type" : "player"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	指令名称	prev
2	type	String	指令类型	player

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-prev",
"mac" : "4CEBD60BFD62",
"message" : "OK",
"messageId" : "202201241610366046",
"name" : "晴天",
"source" : "command",
"success" : true
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-prev
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	4CEBD60BFD62
3	message	String	执行返回结果，播放的歌曲地址	OK
4	messageId	String	消息ID字段	202201241610366046
5	name	String	歌曲名字	晴天
6	source	String	指令回复“command"	command
7	success	boolean	执行结果	true

播放指定SD卡歌曲

player-sd-play

指令简介

高优先级播放SD卡中指定的歌曲，通过 name 参数指定歌曲名（不含扩展名）。priority 为 high 时走高优先级通道优先播放，可打断当前正在播放的音频。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "sd-play",
"name" : "明天-会更好",
"priority" : "high",
"type" : "player"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定字段	sd-play
2	name	String	歌曲名字，无需后缀	明天-会更好
3	priority	String	若有这个字段，表示插播，	high
4	type	String	指令类型	player

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-sd-play",
"mac" : "2026bb16aa14",
"message" : "ok",
"name" : "半岛铁盒",
"source" : "command",
"success" : true
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-sd-play
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	2026bb16aa14
3	message	String	执行返回结果	ok
4	name	String	歌曲名字	半岛铁盒
5	source	String	指令回复“command"	command
6	success	boolean	执行结果	true

停止播放

player-stop

指令简介

停止当前正在播放的音频。设备收到指令后停止播放并释放播放资源，与暂停不同，停止后需重新下发播放指令。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "stop",
"messageId" : "202201241610366046",
"type" : "player"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定动作	stop
2	messageId	String	消息ID字段	202201241610366046
3	type	String	指令类型	player

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-stop",
"mac" : "4CEBD60BFD62",
"message" : "OK",
"messageId" : "202201241610366046",
"source" : "command",
"success" : true
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-stop
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	4CEBD60BFD62
3	message	String	执行返回结果	OK
4	messageId	String	消息ID字段	202201241610366046
5	source	String	指令回复“command"	command
6	success	boolean	执行结果	true

音量减

player-sub-vol

指令简介

减小设备音量。设备收到指令后音量下调10，最低到音量 0（静音），到达下限时保持不变。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "sub-volume",
"messageId" : "202201241610366046",
"type" : "player"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	固定动作	sub-volume
2	messageId	String	消息ID字段	202201241610366046
3	type	String	指令类型	player

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-sub-volume",
"mac" : "4CEBD60BFD62",
"message" : "ok",
"messageId" : "202201241610366046",
"source" : "command",
"success" : true,
"volume" : 80
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	001.MP3	String	歌曲名字
2	channel	String	左右通道	left
3	commandName	String	指令名称	player-sub-volume
4	freq	int	频率，单位(Khz)	31
5	gain	int	增益，单位dB，范围-13到13。	-13
6	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	4CEBD60BFD62
7	message	String	执行返回结果	ok
8	messageId	String	消息ID字段	202201241610366046
9	name	String	歌曲名字	003.mp3
10	size	int	歌曲大小（单位字节）	12041911
11	source	String	指令回复“command"	command
12	success	boolean	执行结果	true
13	volume	int	音量大小（0-100）	80

TTS云端合成

TTS语音合成

controller-play

指令简介

将指定文本合成为语音并播放，text 为要播报的文本（最大150个中文字），voice 为音色名称，两者均必填。voice 支持：Cherry、Serena、Ethan、Chelsie、Momo、Vivian、Moon、Maia、Kai、Nofish、Bella、Jennifer、Ryan、Katerina、Aiden、Eldric_Sage、Mia、Mochi、Bellona、Vincent、Bunny、Neil、Elias、Arthur、Nini、Ebona、Seren、Pip、Stella、Bodega、Sonrisa、Alek、Dolce、Sohee、Ono_Anna、Lenn、Emilien、Andre、Radio_Gol、Jada、Dylan、Li、Marcus、Roy、Peter、Sunny、Eric、Rocky、Kiki。

向设备发送指令

服务端向设备订阅topic发送消息

{
"action" : "tts-play",
"text" : "您好，我是 Rocky，各个国家都有各个国家的国歌，啲啲国家都有啲啲国家嘅国歌",
"type" : "player",
"voice" : "Rocky"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	action	String	学习红外码指令默认填"learn"	tts-play
2	text	String	文字转语音文本	您好，我是 Rocky，各个国家都有各个国家的国歌，啲啲国家都有啲啲国家嘅国歌
3	type	String	固定值"player"	player
4	voice	String	通义大模型，千问TTS 音色选择	Rocky

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "player-tts-play",
"mac" : "9070691a66f4",
"message" : "OK",
"source" : "command",
"success" : true,
"text" : "您好，我是 Rocky，各个国家都有各个国家的国歌，啲啲国家都有啲啲国家嘅国歌"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	player-tts-play
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	9070691a66f4
3	message	String	执行结果描述：对命令执行结果的文本说明。执行完成且无异常：ok ；如果出现异常，返回异常结果描述。	OK
4	source	String	指令回复“command"	command
5	success	boolean	执行结果，执行成功：true；执行失败：false	true
6	text	String	文字转语音文本	您好，我是 Rocky，各个国家都有各个国家的国歌，啲啲国家都有啲啲国家嘅国歌

设备维护

重置/恢复出厂设置

controller-reset

指令简介

恢复出厂设置后配网信息和自定义信息都会清空，请谨慎操作！

向设备发送指令

服务端向设备订阅topic发送消息

{
"messageId" : "202201241610366046",
"system" : "reset",
"type" : "setting"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	messageId	String	消息ID字段	202201241610366046
2	system	String	复位	reset
3	type	String	设置	setting

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "controller-reset",
"mac" : "206ef1883b7c",
"message" : "ok",
"messageId" : "202201241610366046",
"source" : "command",
"success" : true
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	controller-reset
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	206ef1883b7c
3	message	String	执行返回结果	ok
4	messageId	String	消息ID字段	202201241610366046
5	source	String	指令回复“command"	command
6	success	boolean	执行结果	true

设备软重启

controller-restart

指令简介

软重启后，通过指令设置的参数将生效，同时设备将重新连接Wifi/4G网络，注意设备IP地址可能发生变化

向设备发送指令

服务端向设备订阅topic发送消息

{
"messageId" : "202201241610366046",
"system" : "restart",
"type" : "setting"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	messageId	String	消息ID字段	202201241610366046
2	system	String	重启	restart
3	type	String	设备设置固定传"setting"	setting

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "controller-restart",
"mac" : "206ef1883b7c",
"message" : "ok",
"messageId" : "202201241610366046",
"source" : "command",
"success" : true
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	controller-restart
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	206ef1883b7c
3	message	String	执行返回结果	ok
4	messageId	String	消息ID字段	202201241610366046
5	source	String	指令回复“command"	command
6	success	boolean	执行结果	true

获取设备信息

info-all

指令简介

获取设备信息一般会包含：设备通断电状态、MAC/IMEI、固件版本、设备内网IP地址、设备WIFI网络名称等信息，不同的产品返回的信息有所差异

向设备发送指令

服务端向设备订阅topic发送消息

{
"messageId" : "7518068202",
"type" : "info"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	messageId	String	业务流水号。由请求方生成的唯一标识，响应方原样回显，用于请求与响应的关联匹配。	7518068202
2	type	String	固定值"xxx"	info

设备返回信息

设备向服务端订阅topic上报消息

{
"code" : "GSSM2P",
"commandName" : "info-all",
"ip" : "192.168.1.113",
"keyLock" : 0,
"mac" : "44b176dc6620",
"messageId" : "7518068202",
"source" : "command",
"version" : "1.0.2",
"wifiLock" : 0
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	code	String	设备型号代码	GSSM2P
2	commandName	String	指令名称	info-all
3	ip	String	设备连接WIFI后获取的IP	192.168.1.113
4	keyLock	int	按键锁，0：关闭，1：开启	0
5	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	44b176dc6620
6	messageId	String	业务流水号。由请求方生成的唯一标识，响应方原样回显，用于请求与响应的关联匹配。	7518068202
7	source	String	指令回复“command"	command
8	version	String	当前固件版本号	1.0.2
9	wifiLock	int	配网锁，0：关闭，1：开启	0

查询网络连接信息

info-connect

指令简介

查询设备以太网、wifi、4G联网信息

向设备发送指令

服务端向设备订阅topic发送消息

{
"type" : "connect"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	type	String	固定值"connect"	connect

设备返回信息

设备向服务端订阅topic上报消息

{
"bssid" : "a0c5f2b73086",
"commandName" : "info-connect",
"connMethod" : "wifi",
"dhcpEnable" : 1,
"gateway" : "10.168.1.1",
"local_ip" : "10.168.1.126",
"mac" : "9070691a688c",
"signal" : -75,
"source" : "command",
"ssid" : "gemeopen",
"subnet" : "255.255.255.0"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	bssid	String	路由器 MAC 地址	a0c5f2b73086
2	commandName	String	指令名称	info-connect
3	connMethod	String	网络连接方式wifi或者ethernet	wifi
4	dhcpEnable	int	自动寻址1：开启， 0：关闭，默认开启	1
5	gateway	String	默认网关	10.168.1.1
6	local_ip	String	IP地址	10.168.1.126
7	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	9070691a688c
8	signal	int	信号强度，显示规则为： signal<= 0 && signal>= -50 //信号最好 signal< -50 && signal>= -70 //信号较好 signal< -70 && signal>= -80 //信号一般 signal<-80 && signal>= -100 //信号较差 signal没有在0～（-100)之间，表示无信号	-75
9	source	String	指令回复“command"	command
10	ssid	String	设备当前连接的WIFI名称	gemeopen
11	subnet	String	子网掩码	255.255.255.0

获取设备通讯信息

info-protocol

指令简介

获取设备通讯信息

向设备发送指令

服务端向设备订阅topic发送消息

{
"messageId" : "202201241610366046",
"type" : "protocol"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	messageId	String	消息ID字段	202201241610366046
2	type	String	通讯信息	protocol

设备返回信息

设备向服务端订阅topic上报消息

{
"clientId" : "206ef1883b7c",
"commandName" : "info-protocol",
"mac" : "206ef1883b7c",
"messageId" : "202201241610366046",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/xneyoF/fHgbhpVjKJPH/206ef1883b7c/subscribe",
"server" : "mqtt.smart-bird.cn",
"source" : "command",
"subscribe" : "/topic/qos1 ",
"username" : "fHgbhpVjKJPH"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	clientId	String	自定义MQTT客户端ID注意：不可重复	206ef1883b7c
2	commandName	String	指令名称	info-protocol
3	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	206ef1883b7c
4	messageId	String	消息ID字段	202201241610366046
5	port	String	端口号	1883
6	protocol	String	协议类型，MQTT协议固定传"mqtt"	mqtt
7	publish	String	自定义MQTT发布主题注意:不可重复	/xneyoF/fHgbhpVjKJPH/206ef1883b7c/subscribe
8	server	String	自定义MQTT服务器地址	mqtt.smart-bird.cn
9	source	String	指令回复“command"	command
10	subscribe	String	自定义设备MQTT订阅主题注意:不可与发布主题重复	/topic/qos1
11	username	String	自定义MQTT服务器用户名	fHgbhpVjKJPH

以太网静态IP配置

setting-ethernet-dhcpEnable

指令简介

以太网连接情况下，通过当前指令，可以给设备配置固定IP。

向设备发送指令

服务端向设备订阅topic发送消息

{
"connMethod" : "ethernet",
"dhcpEnable" : 0,
"dns" : "192.168.0.1",
"gateway" : "192.168.0.1",
"subnet" : "255.255.255.0",
"type" : "setting"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	connMethod	String	网络连接方式wifi或者ethernet	ethernet
2	dhcpEnable	int	自动寻址1：开启， 0：关闭，默认开启	0
3	dns	String	DNS服务器地址	192.168.0.1
4	gateway	String	默认网关	192.168.0.1
5	subnet	String	子网掩码	255.255.255.0
6	type	String	固定值"xxx"	setting

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "setting-connMethod-config",
"mac" : "9070691a66f4",
"message" : "ok",
"source" : "command",
"success" : true
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	setting-connMethod-config
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	9070691a66f4
3	message	String	执行结果描述：对命令执行结果的文本说明。执行完成且无异常：ok ；如果出现异常，返回异常结果描述。	ok
4	source	String	指令回复“command"	command
5	success	boolean	执行结果，执行成功：true；执行失败：false	true

自定义HTTP配置

setting-http

指令简介

用于配置http回调地址，用来设备事件推送地址，注意不支持https

向设备发送指令

服务端向设备订阅topic发送消息

{
"protocol" : "http",
"type" : "custom",
"url" : "http://192.168.0.137:8080"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	protocol	String	协议类型	http
2	type	String	固定值"custom"	custom
3	url	String	url地址	http://192.168.0.137:8080

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "setting-http",
"mac" : "9070691a66f4",
"protocol" : "http",
"source" : "command",
"url" : "http://192.168.0.137:8080"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	setting-http
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	9070691a66f4
3	protocol	String	协议类型	http
4	source	String	指令回复“command"	command
5	url	String	url地址	http://192.168.0.137:8080

设置按键控制锁

setting-key-lock

指令简介

设置设备按键锁开关，keyLock 为 0 表示解锁（按键可用）、1 表示锁定（禁用按键），设置后立即生效。

向设备发送指令

服务端向设备订阅topic发送消息

{
"keyLock" : 0,
"type" : "setting"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	keyLock	int	按键锁，0：关闭，1：开启	0
2	type	String	固定值"setting"	setting

设备返回信息

设备向服务端订阅topic上报消息

{
"bssid" : "742ad779046",
"code" : "GSSM2P",
"commandName" : "setting-key-lock",
"ip" : "192.168.122.119",
"keyLock" : 0,
"mac" : "2026bb16aa14",
"signal" : -75,
"source" : "command",
"ssid" : "gemeopen",
"version" : "1.0.0",
"wifiLock" : 0
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	bssid	String	路由器 MAC 地址	742ad779046
2	code	String	设备型号代码	GSSM2P
3	commandName	String	指令名称	setting-key-lock
4	ip	String	设备连接WIFI后获取的IP	192.168.122.119
5	keyLock	int	按键锁，0：关闭，1：开启	0
6	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	2026bb16aa14
7	signal	int	信号强度，显示规则为： signal<= 0 && signal>= -50 //信号最好 signal< -50 && signal>= -70 //信号较好 signal< -70 && signal>= -80 //信号一般 signal<-80 && signal>= -100 //信号较差 signal没有在0～（-100)之间，表示无信号	-75
8	source	String	指令回复“command"	command
9	ssid	String	设备当前连接的WIFI名称	gemeopen
10	version	String	当前固件版本号	1.0.0
11	wifiLock	int	配网锁，0：关闭，1：开启	0

自定义MQTT

setting-mqtt

指令简介

设置设备连接的MQTT服务器，配置 server（服务器地址）、port（端口）、clientId（客户端ID）、username（用户名）、password（密码）、subscribe（订阅主题）、publish（发布主题），并指定 protocol 为 mqtt，保存后设备重启生效。

向设备发送指令

服务端向设备订阅topic发送消息

{
"clientId" : "admin",
"password" : "123456",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/topic/qos0",
"server" : "192.168.0.66",
"subscribe" : "/topic/qos1",
"type" : "custom",
"username" : "admin"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	clientId	String	自定义MQTT客户端ID注意：不可重复	admin
2	password	String	密码	123456
3	port	String	端口号	1883
4	protocol	String	协议类型	mqtt
5	publish	String	自定义MQTT发布主题注意:不可重复	/topic/qos0
6	server	String	自定义MQTT服务器地址	192.168.0.66
7	subscribe	String	自定义设备MQTT订阅主题注意:不可与发布主题重复	/topic/qos1
8	type	String	设备设置固定传"setting"	custom
9	username	String	自定义MQTT服务器用户名	admin

设备返回信息

设备向服务端订阅topic上报消息

{
"clientId" : "admin",
"commandName" : "setting-mqtt",
"mac" : "4CEBD60BFD62",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/topic/qos0",
"server" : "192.168.0.66",
"source" : "command",
"subscribe" : "/topic/qos1",
"username" : "admin
"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	clientId	String	自定义MQTT客户端ID注意：不可重复	admin
2	commandName	String	指令名称	setting-mqtt
3	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	4CEBD60BFD62
4	port	String	端口号	1883
5	protocol	String	协议类型	mqtt
6	publish	String	自定义MQTT发布主题注意:不可重复	/topic/qos0
7	server	String	自定义MQTT服务器地址	192.168.0.66
8	source	String	指令回复“command"	command
9	subscribe	String	自定义设备MQTT订阅主题注意:不可与发布主题重复	/topic/qos1
10	username	String	自定义MQTT服务器用户名	admin

自定义TCP

setting-tcp

指令简介

设备支持通过MQTT方式自定义TCP信息，注意：通过MQTT自定义TCP信息后，需要将设备断电重启或者向设备发送重启命令才可生效。

向设备发送指令

服务端向设备订阅topic发送消息

{
"port" : "8080",
"protocol" : "tcp",
"server" : "192.168.0.137",
"type" : "custom"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	port	String	端口号	8080
2	protocol	String	协议类型	tcp
3	server	String	自定义MQTT服务器地址	192.168.0.137
4	type	String	设备设置固定传"setting"	custom

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "setting-tcp",
"mac" : "4CEBD60BFD62",
"port" : "8080",
"protocol" : "tcp",
"server" : "192.168.0.66",
"source" : "command"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	setting-tcp
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	4CEBD60BFD62
3	port	String	端口号	8080
4	protocol	String	协议类型	tcp
5	server	String	自定义MQTT服务器地址	192.168.0.66
6	source	String	指令回复“command"	command

设备WiFi信息配置

setting-wifi-config

指令简介

设置设备连接的WiFi，通过 ssid 参数指定网络名称、password 参数指定密码，保存后设备重启生效。但当前产品，在网线连接且连通正常情况下，会优先以太网连接。

向设备发送指令

服务端向设备订阅topic发送消息

{
"password" : "123456",
"ssid" : "GemeOpen",
"type" : "setting"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	password	String	密码	123456
2	ssid	String	设备当前连接的WIFI名称	GemeOpen
3	type	String	固定值"xxx"	setting

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "setting-wifi-config",
"mac" : "4CEBD60BFD62",
"message" : "ok",
"source" : "command",
"success" : true
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	setting-wifi-config
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	4CEBD60BFD62
3	message	String	执行结果描述：对命令执行结果的文本说明。执行完成且无异常：ok ；如果出现异常，返回异常结果描述。	ok
4	source	String	指令回复“command"	command
5	success	boolean	执行结果，执行成功：true；执行失败：false	true

WiFi静态IP信息配置

setting-wifi-dhcpEnable

指令简介

设备默认为动态获取ip，通过该接口开启静态IP，需重启生效配置的静态IP需和路由器处于同一网段下

向设备发送指令

服务端向设备订阅topic发送消息

{
"dhcpEnable" : 0,
"dns" : "192.168.0.1",
"gateway" : "192.168.0.1",
"subnet" : "255.255.255.0",
"type" : "setting"
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	dhcpEnable	int	自动寻址1：开启， 0：关闭，默认开启	0
2	dns	String	DNS服务器地址	192.168.0.1
3	gateway	String	默认网关	192.168.0.1
4	subnet	String	子网掩码	255.255.255.0
5	type	String	固定值"xxx"	setting

设备返回信息

设备向服务端订阅topic上报消息

{
"commandName" : "setting-wifi-dhcpEnable",
"mac" : "4CEBD60BFD62",
"message" : "ok",
"source" : "command",
"success" : true
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	commandName	String	指令名称	setting-wifi-dhcpEnable
2	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	4CEBD60BFD62
3	message	String	执行结果描述：对命令执行结果的文本说明。执行完成且无异常：ok ；如果出现异常，返回异常结果描述。	ok
4	source	String	指令回复“command"	command
5	success	boolean	执行结果，执行成功：true；执行失败：false	true

设置WiFi配网锁

setting-wifi-lock

指令简介

wifi配网锁定后，设备无法通过长按配网按钮进入配网操作，仅能通过MQTT/TCP协议解锁配网功能

向设备发送指令

服务端向设备订阅topic发送消息

{
"messageId" : "202201241610366046",
"type" : "setting",
"wifiLock" : 0
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	messageId	String	消息ID字段	202201241610366046
2	type	String	类型	setting
3	wifiLock	int	配网锁，0：关闭，1：开启	0

设备返回信息

设备向服务端订阅topic上报消息

{
"bssid" : "742ad779046",
"code" : "GSSM2P",
"commandName" : "setting-wifi-lock",
"ip" : "192.168.122.119",
"keyLock" : 0,
"mac" : "4CEBD60BFD62",
"messageId" : "202201241610366046",
"signal" : -75,
"source" : "command",
"ssid" : "GemeOpen",
"version" : "1.0.9",
"wifiLock" : 0
}

字段属性

#	字段名称	字段类型	字段说明	示例值
1	bssid	String	路由器 MAC 地址	742ad779046
2	code	String	设备型号代码	GSSM2P
3	commandName	String	指令名称	setting-wifi-lock
4	ip	String	设备连接网络后获取的IP	192.168.122.119
5	keyLock	int	按键锁，0：关闭，1：开启	0
6	mac	String	wifi设备MAC地址或4G设备的IMEI号，唯一标识	4CEBD60BFD62
7	messageId	String	消息ID字段	202201241610366046
8	signal	int	信号强度，显示规则为： signal<= 0 && signal>= -50 //信号最好 signal< -50 && signal>= -70 //信号较好 signal< -70 && signal>= -80 //信号一般 signal<-80 && signal>= -100 //信号较差 signal没有在0～（-100)之间，表示无信号	-75
9	source	String	指令回复“command"	command
10	ssid	String	设备当前连接的WIFI名称	GemeOpen
11	version	String	当前固件版本号	1.0.9
12	wifiLock	int	配网锁，0：关闭，1：开启	0