# 京东云YAT产品接入流程

修改时间

内容

版本

2021.12.28

增加BLE配网选择和模组规格书

0.1

2022.1.5

增加1.2.6 上位机模拟器

0.2

2022.02.23

1.4.2增加产品漏出规范

0.3

2022.02.25

1.2.3增加门锁通讯协议

0.4

#京东-自定义接入流程

庆科联系人

客户经理：chenyf@mxchip.com

技术经理：gaopf@mxchip.com

#一、方案介绍

#1.0 注册成为开发者

参考链接： http://smartdev.jd.com/docCenterDoc/view/2/101/95400002/95500003#topMaoDot (opens new window)

注意：为了产品可以正常发布上线，账号必须是企业账号。

#1.1 产品创建

产品配网方式有两种:WIFI/BLE,请按照电控规格书要求来选择。

#1.2 产品配置

#1.2.1 配置产品基本信息

#1.2.2 配置产品功能定义

注意：保持和产品规格书功能一致，避免出现申请模组样品之后修改产品属性的情况；

原因：在申请模组样品之后，产品属性会整理出来一份代码导入到模组中，如改动后台产品功能，代码需重新编译烧写。

如基本参数不满足产品功能定义，可在后台申请增加参数

#1.2.3 一U一密

产品建议使用一U一密的方式来加密

https://www.yuque.com/docs/share/85043510-3447-45a5-a344-49f48b143306?# (opens new window) 《京东-一U一密申请》

#1.2.4 样品申请流程

模组样品请走正规渠道，向庆科商务端获取

#1.2.5 H5页面

H5页面根据产品配置表自动生成，在产品后台直接拖拽，不需要二次开发。

H5拖拽工具在后台产品的(控制页)页面，使用在线设计工具，

点击在线设计工具出现左侧功能栏，出现不同标准组件，点击拖拽到中间APP模拟界面区域即可，

拖拽完成后，点击保存，上传。

如需定制开发H5请联系庆科。

注：H5定制开发会收取一定费用开发费，项目开发也需一定时间

#1.2.6 上位机模拟器

MCU端可以使用模拟器来辅助调试程序

📎MXchip_YAT_Tool-v0.1.2.rar

主界面

1、数据接收区

默认显示为hex格式数据。该区域显示所有交互产生的每条指令的TX、RX时间和数据帧。点击清空按钮可以清空数据接收区的所有内容。点击数据保存按钮保存已经记录的交互数据。

2、数据发送区

勾选自动发送按钮按照间隔时间周期性发送自定义数据帧。勾选16进制发送以HEX格式发送数据。点击清空按钮可以清空自动发送区的所有内容。

3、串口初始化

选择自动扫描到的对应串口，波特率默认设置为115200

4、庆科LOGO

点击可以进入上海庆科官网，获取所需对应型号WIFI模组的参考资料

Home界面

1、WiFi模组基本信息

该区域显示WIFI固件版本、UTC时间、连接路由器状态、周边热点状态等信息

2、连接模块

打开串口后首先点击连接模块按钮测试WIFI模组与硬件串口助手连接是否正确

3、常用指令

该部分包含YAT协议中 大部分获取WIFI工作状态的指令。每条指令操作是否成功都会有相应的弹窗提示。

#1.3 开发

板卡厂或品牌厂商按照YAT指令集进行开发，如需模组厂商协助处理后台信息，可向庆科提供原始账号密码。

也可添加庆科账号来管理产品。

添加账号流程

授权开发者账号：mxchip2019

#1.3.1 串口协议

两份串口通讯协议请配合来看，有问题请联系庆科技术经理

家电通讯协议：

https://mxchip.yuque.com/docs/share/efd294fd-16e9-4ae1-a4e7-be6a934bc2fe?# (opens new window) 《FogCloud云模块YAT通信协议》

https://mxchip.yuque.com/docs/share/5156f822-1fb2-4292-aa43-37f39991d7e6?# (opens new window) 《京东平台YAT对接协议》

保险柜对接协议：

https://mxchip.yuque.com/docs/share/efd294fd-16e9-4ae1-a4e7-be6a934bc2fe?# (opens new window) 《FogCloud云模块YAT通信协议》

https://mxchip.yuque.com/docs/share/558cc5cb-ccf2-486f-ab2b-c9eecedaf15c?# (opens new window) 《京东保险柜YAT对接协议》

#1.3.2沙箱板APP调试

沙箱环境APP下载地址https://smartdev.jd.com/docCenterDownload/list/2#155500001 (opens new window)

ios系统下载地址和设置方式

需要贵司发个邮件，发送邮件说明联调背景、联调方、联调人员名单（姓名+岗位+京东账号）、测试时间 yanpengcheng7@jd.com

Android下载地址

Android设置沙箱环境：

打开小家APP，点击我的，

点击设置：

点击关于我们：

点击debug设置：

环境选择为沙箱环境：

最后杀死APP，重新进入就OK啦。

#1.4 测试

开发完成之后，研发自测验证产品所有基本功能之后，进入整机测试环节。

  • 自动化测试APP下载地址：（用于整机自动化测试）

https://smartdev.jd.com/docCenterDownload/list/2#155500001 (opens new window)

#1.4.1 品牌方/板卡商测试

  • 后台自动化测试内容；

#1.4.2 京东验收测试

线上提交审核之后，还需线下寄送设备/开发板到京东（若设备需要寄回，平台将会采用到付形式寄出）。

京东验证项包括

1、 外包装、详情页、说明书、sku。

2、 安全项、功能、用户体验。

整体耗时：5天左右

品牌漏出规范

产品在提交测试之前需要提交产品说明书和产品外包装机身素材。

按照京东小家品牌漏出规范设计产品包材

#1.5 产品发布上线

京东验收通过后，产品发布，正式上线并销售。上线后，平台会将产品贴上“京东小家”的标签，该标签代表该产品可通过京东小家App、京鱼座音箱控制，可用于产品的包装、说明书、商品详情页面等地方。

#1.6 分工说明

序号

流程

操作方

备注

1

京东IOT后台创建账号

品牌方/板卡商

2

产品创建（选择自定义接入）

品牌方/板卡商

3

产品配置（产品基本信息）

品牌方/电控厂

4

配置产品属性

品牌方/电控厂

4

串口协议获取

电控厂\庆科

5

样品申请流程参考

品牌方\庆科

6

板卡开发及研发测试

（先按照文档和后台属性表开发板卡，研发自测验证后，进入整机测试环节）

品牌方/电控厂

7

后台自动化测试（测试用例填写）

品牌方/电控厂

8

京东认证测试（客户提供整机或功能完整板卡）

品牌方/电控厂，京东

9

产品发布上线

京东

#二、 项目开发流程

#2.0开发流程

  1. 模组商根据收到的配置信息生成定制模块并寄给设备厂商；
  2. 设备商根据拿到的模块和开发资料开发调试。

#2.1 整体交互流程

说明：

  • 支持模组型号：EMW3080V2/EMW5080V2/EMW3090V2/EMC3020/EMC5020
  • 通讯方式目前都是UART串口通讯，波特率支持：115200
  • 模块分板载天线和外置天线，可根据产品实际使用场景采购。

#2.2 模块的数据手册

📎DS0127CN_EMW5080_V2.4.pdf

📎DS0122CN_EMW3080_V2.4.pdf

📎DS0125CN_EMW3090_V2.6.pdf

📎DS0193CN_EMC5020_V0.2.pdf

📎DS0177CN_EMC3020_V1.3.pdf

#三、烧录说明

#3.1 烧录方式

#3.1.1 量产模式-庆科烧录或者客户自己烧录配置文件

*   <span class="ne-text">BAT系统：全在线化处理（请和庆科对接）。</span>
*   <span class="ne-text">客户自己烧录请自行整理烧录流程</span>

#3.1.2 调试过程烧录

EMC3020/EMC5020烧录方法： https://www.yuque.com/docs/share/370d6866-1733-4ab0-9177-548d0948ee71?# (opens new window) 《EMC3020/5020京东项目烧录流程》

EMW5080/EMW3080烧录方法：https://www.yuque.com/docs/share/2638fe69-2e1e-425a-a170-60ceba3a46d3?# (opens new window) 《MX1290系列》

#四、配置文件

#属性配置表规则

{
	"joylink": {
		"configuration": {
			"cid": "xxx",
			"brand": "xxxx",
			"softap_ssid": "xxxx",
			"pub_key": "xxxx",
			"private_key": "xxxx"
		},
		"properties": [{
			"tag": 1,
			"identifier": "bool_value",
			"dataType": "bool"
		}, {
			"tag": 2,
			"identifier": "enum_value",
			"dataType": "enum"
		}, {
			"tag": 3,
			"identifier": "char_value",
			"dataType": "char"
		}, {
			"tag": 4,
			"identifier": "short_value",
			"dataType": "short"
		}, {
			"tag": 5,
			"identifier": "int_value",
			"dataType": "int"
		}, {
			"tag": 6,
			"identifier": "float_value",
			"dataType": "float"
		}, {
			"tag": 7,
			"identifier": "double_value",
			"dataType": "double"
		}, {
			"tag": 8,
			"identifier": "text_value",
			"dataType": "text"
		}]
	}
}

申请样品时联系庆科，庆科输出。

#五、特别注意事项

#6.1 TLV数据类型和长度对应：

类型

标识符

大小

布尔型

bool

1 Byte

枚举

enum

1 Byte

字符型

char

1 Byte

短整型

short

2 Bytes

整型

int

4 Bytes

单精度浮点型

float

4 Bytes

双精度浮点型

double

8 Bytes

文本型

text

1-254 Bytes

嵌套型

struct

1-254 Bytes

#6.2解绑指令

京东平台没有设备端解绑功能，解绑指令（0x23）将执行清除feedid。切换账号绑定设备前，需要先清除feedid。 既发送解绑指令。

#MCU清除Feedid配网流程

#6.3软件协议

串口协议自下而上分为SLIP层、IMC层。SLIP层负责原始数据的封包和解包。IMC层负责业务逻辑处理。

SLIP（Serial Line Internet Packet）层

...

START

PAYLOAD

END

...

START

PAYLOAD

END

...

1 Byte

2...1026 Byte

1 Byte

1 Byte

2...1026 Byte

1 Byte

START

起始符，标志数据包的开始，定义十六进制：0xC0

PAYLOAD

载荷数据。

其中：

  • 0xC0 ****要替换为 0xDB 0xDC
  • 0xDB ****要替换为 0xDB 0xDD
  • 0xD0 ****要替换为 0xDB 0xDE

END

结束符，标志数据包的结束，定义十六进制：0xD0

IMC（int****er MCU Communication）层

TYPE

PAYLOAD

CRC8

1 Byte

0...1024 Byte

1 Byte

命令

载荷数据

PAYLOAD 的CRC校验值

更新时间: 2023/11/29 13:52:34

← 中移云YAT对接协议 →