文档首页

硬件对接流程

乐摇摇串口板协议对接流程

什么是串口板对接

乐摇摇提供联网模组/芯片,厂商把模组与设备主板连接,基于标准化的硬件通信协议进行开发,使设备获得联网通讯能力以及一体化的sass服务。智能化的设备上整合了移动支付、远程管理、数据分析、渠道运营、广告投放等能力,让投放商可以在任何时间、地点进行监控管理,提升整体管理效率与渠道收益。

串口方案

乐摇摇提供了两种串口解决方案,分布是:串口版和集成芯片,两者实现的功能一样,只是与主板连接方式、价格上存在差异。厂商可根据自身需求选择。

对比项 串口板 集成芯片
图片 3e85d78f617448cd80ca3b51ba496a16.png f1373f178e7f487fb2329decd910a4cf.png
数据交互方式 通过串口进行数据交互,与设备双向通讯:向设备发送控制指令、接受设备上报数据 通过串口进行数据交互,与设备双向通讯:向设备发送控制指令、接受设备上报数据
品类通用性
通讯方式 4G 2G/4G/WIFI
安装方式 与主板连接 通过焊接与主板连接
研发能力 嵌入式开发 嵌入式开发
优点 安装方便
应用扩展度高,可基于业务二次开发 | 应用扩展度高,可基于业务二次开发 价格优惠 尺寸小

开发指南

前言

针对厂商设备主板与乐摇摇串口联网模组对接,平台提供标准串口数据通讯协议、自动生成参数界面、串口调试工具,简化开发过程,使设备快速联网获得增值功能。本文档基于乐摇摇串口联网模组与设备主板的标准对接流程编写。

操作指南

下载串口协议对接操作指南

开发流程

如果您是首次接入乐摇摇联网方案,请按以下流程进行对接。下文将针对各个步骤进行详细描述。

4e21b2376bae43c5a1095d0a2fffb3db.jpg

注册开发账号

在厂商使用乐摇摇串口方案前,需要先注册乐摇摇开发者账号。

操作步骤:

1电脑打开乐摇摇开放平台网址:https://open.leyaoyao.com

2点击注册右上角,完善册信息,提交即可。

f5a065f3282047308305f48ee32f88cc.png

注:开发者账号与设备管理账号不互通,需要重新注册

创建产品

注册成功后,即可进入开发者中心。

2ae47381cab54a0d995533d621d4b10b.png

点击创建产品出现弹窗,请按要求完善产品信息。

908ecc04a2a04bfbaf540c0590791732.png

c4b5c8f5875c401785bada15fe4898b3.png

主板信息填写与要求

名称 详情
设备类型 支持娃娃机、兑币机、售货机、按摩椅、洗衣机、充电桩、高尔夫出球机
主板名称 填写格式:公司名称+设备类型,如乐摇摇娃娃机
接口类型 接口类型支持RS232、TTL_3V3、TTL_5V
波特率 38400(推荐)
主板原图 提供清晰的主板图片,以便硬件人员后续提供技术支持

3f1f740b23d445cebede69d737ce4c18.png | | 主板接线方式 | 提供清晰的主板接线图片,以便硬件人员后续提供技术支持

5ecf99297e6046afb1da55aa5c237714.png | | 联系人手机号 | 审核通过后,短信通知会发生至该手机号 |

提交成功后,请等待乐摇摇工作人员审核。审核时间大约需要3个工作日。

1审核通过后会有短信通知发送至您的手机;

2若审核失败,请重新编辑产品信息,提交审核。

e5aae4a30af94db192f08b481abc57da.png

参数配置

产品信息审核通过后,系统为产品生成对应的登录标识。

登录标识:用以识别对接主板身份的标识码,每个产品都有且只有一个(请把登录标识烧录到设备中。当设备激活时,会上报到云端鉴权认证设备参数)。

进入主板参数配置页面,参数配置由3部分组成,包括基础参数、终端参数、故障参数。参数配置是对产品功能的抽象表示,可以通过不同功能类型定义。目前平台提供:布尔型、数值型、枚举型、故障型这四种参数类型。对于如何定义功能点,下文将有详细介绍。

5734aa2340b945e894c35100265d7466.png

基础参数

适用功能:用于扩展功能,查询指令和设置指令固定,分别是0x05/0x06

功能案例:几币一局、背景音乐、游戏时间……

数据传输类型:可下发可上报

c5c3e645aa7e430c84c3b391813a1fea.png

终端参数

适用功能:用于扩展功能,查询指令和设置指令可自定义

功能案例:

  1. 带参数:本地账目查询,带具体查询参数
  2. 不带参数:恢复出厂设置,清当前局 数等

数据传输类型:可下发可上报

026f7e2261a84923b3a3bcda28c92efb.png

故障参数

适用功能:专门用于上报和统计故障的功能点

功能案例:光眼传感器故障、电机故障、高温故障……

注意:故障型的数据格式为bitmap型,可支持多故障定义。故障型功能只支持数据上报,当设备状态改变(正常→故障或故障→正常),即上报数据

18b6027b504b4964a278550393acba45.png

参数相关概念

功能名称 即具体智能设备功能的抽象,用于描述产品功能及其参数
参数长度 串口协议数据区字段的字节数,范围1-4
查询指令
设置指令 串口协议的CMD码
参数类型 布尔型(bool):非真即假的二值型变量。如:开关功能,开/关
枚举型(enum):自定义的有限集合值。如:工作档位,低档/中档/高档
整数型(integer):可线性调节数值型的功能,仅限整数,如电压调整,电压范围0-40V
浮点型(floating):适用于可线性调节类型的数据。如:温度调节,温度范围20-40℃
数据传输类型 可下发可上报:指令数据可以下发给设备,设备数据可以上报给云端;
只上报:数据只支持从设备上报;
只下发:数据只支持从云端下发;

功能类型详解

布尔型

适用功能:非真即假的二值型变量功能。

功能案例:设备的开关、背景音乐播放等功能,均可采用布尔型表示。

数据传输类型:可下发可上报

f1f33fc49d494f168b148ad46542b1b2.png

整数****型

适用功能:适用于可线性调节类型的数据,仅限整数

功能案例:电压调节,电压范围0-40,单位为V,表达含义为该产品可调节温度0-40V。数据传输类型:可下发可上报

4f01889c0af647a5a42474069245f2b7.png

浮点****型

适用功能:适用于可线性调节类型的数据,分为float(高低位方式)和float(乘10方式),仅限小数

功能案例:游戏时间,时间范围0.000-40.000,单位为s,表达含义为该产品可调节启动时间0.000-40.000s。

数据传输类型:可下发可上报

1a630561ca2840158600112a03ba3f6b.png

枚举型

适用功能:该功能下有有限的自定义值集合。

功能案例:

  1. 档位:低档/中档/高档;
  2. 模式:舒适模式、睡眠模式、智能模式、节能模式;
  3. 数据传输类型:可下发可上报
  4. 0d8996ff80dd412da48c4bb4868b200f.png

界面预览

系统根据你配置的参数,自动生成设备参数管理界面,通过微信扫码二维码即可查看。确定功能、界面是否符合,若符合点击下一步即可,若不符合,返回参数配置界面调整。

5bd25fc8c10a4526b620407d08fe643d.png

产品发布上线

5aea59eca0664b70a6765c4bfdced908.png

产品开发完成,进入试产/量产环节,确认产品功能将不会更改后,可申请将产品发布上线。

发布、同步须知 :

  1. 点击发布 ,主板参数完成入库对接,若发布后修改了参数,需点击同步。
  2. 发布后请厂商务必做好主板调试,主板调试完成,发布前请联系乐摇摇对接人员。

硬件调测

通讯协议

根据对接的设备类型生成串口通讯协议,可下载参考。

SDK

为了让嵌入式工程师更快、更稳定完成MCU程序,乐摇摇已经将《乐摇摇串口通讯协议》进行解析,并提供基础框架代码。在此基础上进行修改、补充,可快速完成 MCU 程序。您可以点击下载SDK。

SDK包含串口协议和公用函数两部分:

7bc2abb3f1764ed38bbea681753802ac.png

虚拟参数测试

通过虚拟设备模拟真实设备上报数据的行为,可以快速验证接口功能的开发。

用你的微信绑定虚拟设备,即可对虚拟设备进行远程控制及查看通讯日志。

9be00aff7a414763a137239ed542f9d3.png

串口调试助手

efc09bae2e0b4a888c945f72c86c3d7d.png

1把对接主板与电脑通过usb接口连接,保持主板处于通电状态。

2选择串口保持打开状态,在查询链接文本框输入16位数字的设备登录唯一码,点击【查询链接】,会模拟设备向主板下发数据。

3检验数据是否发送正常、格式是否正确。

正式环境调测

注册设备后台

1关注乐摇摇微信企业号

2进入设备管理后台,注册账号

ea28a21888934d8f82c21ecc52dcf310.png

注册绑定支付盒子

1登录账号,进入设备管理后台,点击设备注册,扫描盒子注册二维码进行绑定。

2按照需求编辑各项信息,提交注册。

7a17b0a895d54bb1b20e454ee46cf3b3.png

功能测试

(1)扫描乐摇摇盒子支付二维码,模拟线上支付启动。

7d119b61ae67405f98f94214521c2d63.jpg

(2)点击进入设备管理,点选设备,调试参数设置功能。

abb6270dc4e142cca9ac418ab1e3464c.jpg

待各项功能调试无误后,在产品正式投入使用前,请联系乐摇摇工作人员将产品发布上线。

已有账号,立即登录