简体中文
简体中文
English
联系我们
注册
登录
layout空间导航
TuyaOSTuyaOS(旧版)扫地机设备接入

扫地机设备接入

更新时间:2022-11-24 09:19:57下载pdf

本文主要介绍了涂鸦智能扫地机接入方案,内容包含软硬件技术方案介绍和从需求、研发、生产到售后整个产品生命周期的对接说明。

产品方案

完整的扫地机产品智能解决方案由嵌入式、App 和涂鸦云等几部分组成,可以满足不同客户的智能化和个性需求,本章节主要对嵌入式部分进行说明,更详细的产品方案介绍可参考 扫地机产品方案介绍

MCU 通用对接方案

方案说明

涂鸦提供完整的模组、App 和云端服务,设备 MCU 通过串口与模组连接实现设备联网,用户只需按照涂鸦的通用串口协议开发扫地机应用程序。

扫地机设备接入

功能描述

  • 同时支持 EZ 和 AP 配网,开发者可按需选择实现配网方式。
  • 支持 OTA 升级。
  • 支持轻量型地图数据传输。
  • 支持清扫记录云端存储。

Linux 通用 SDK 对接方案

方案说明

  • 涂鸦提供标准的 Linux 系统的扫地机 SDK,用户可将 SDK 集成到设备软件中,完成扫地机应用开发。

  • 扫地机 SDK 运行在用户连云芯片上,实现设备连云能力。

扫地机设备接入

对接开发流程

了解涂鸦

  • 涂鸦 IoT 开发平台 上注册账号并登录。

  • 平台将开发者账号分为个人开发者,企业客户两种类型,两者之间存在差异,适用场景也不同;但是个人开发者类型通过企业认证之后可升级为企业客户类型。

产品定义

通过以下流程在涂鸦 IoT 开发平台创建扫地机产品并定义产品功能;

  • 在涂鸦 IoT 开发平台创建产品,依次选择 创建产品 > 小家电 > 扫地机器人

    扫地机设备接入
    扫地机设备接入
  • 根据您产品的具体类型,选择需要创建的扫地机类型。

    扫地机设备接入
  • 输入自定义的产品名称和产品型号,并按需勾选产品可支持的联网通讯协议,功耗类型默认勾选标准功耗。

    注意:Wi-Fi-蓝牙:产品支持 Wi-Fi,蓝牙两种联网方式,可选模组为双模模组;Wi-Fi: 产品只支持 Wi-Fi 联网方式,可选模组为单 Wi-Fi 模组;蓝牙:产品只支持蓝牙联网方式,可选模组为单蓝牙模组

    扫地机设备接入
  • 新建产品后,涂鸦 IoT 开发平台会自动生成一个 Product ID (简称:PID),PID 是该类产品的产品标识,PID关联了产品的所有的功能点,同一种类型且具有相同功能的扫地机设备共享一个 PID。

    注意:通常只有创建该 PID 的涂鸦 IoT 账号才对该 PID 或者使用该 PID 的设备具有管理权限;其他账号只可通过被授权后才具有管理权限。关于授权的详细新起请参考 企业空间内账号授权授权产品至其他企业

功能解析

名词解释
名词 解释
功能 是指产品具有的功能抽象,是一个产品的重要属性。功能通过不同数据类型进行表示(Datapoint,简称 DP)
功能点 ID 又叫 DP ID,是功能点的编码,设备与云端的功能数据通过 DP ID 进行
功能点名称 又叫 DP 名称,是自定义的功能名称
标识名 即功能点的 code 值,用于 App 显示功能名称的多语言管理,支持字母,数字,下划线,且以字母开头
数据类型
  • 布尔型(bool):非真即假的二值型变量。
  • 数值型(value):适用于可线性调节类型的数。
  • 枚举型(enum):自定义的有限集合值。如:工作状态,standby/smart_clean/wall_clean 等。
  • 故障型(fault):专门用于上报和统计故障的功能点,支持多故障,数据只上报。
  • 字符串型(string):以字符串形式传输的功能点。
  • 透传型(raw):以二进制形式透传的功能点。
  • 数据传输类型
  • 可下发可上报:指令数据可以下发给设备,设备数据可以上报给云端。
  • 只上报:数据只支持从设备上报。
  • 只下发:数据只支持从云端下发。
  • 更多术语请参考 名词解释

    功能定义

    功能分为标准功能自定义功能两种,标准功能指该产品的常用功能,自定义功能即指标准功能不满足用户需求的情况时,可自定义功能;下面将就现有的惯导型,激光型两种扫地机方案的功能定义做一个详细说明。

    • 惯导型扫地机

      创建产品之后,会跳转至添加标准功能页面;如下图所示,惯导型扫地机的标准功能中包含三个必选功能,即不可删除功能,其他标准功能,可按需进行增删。

      标准功能定义和交互可参考 惯导型扫地机标准DP定义和交互说明

      扫地机设备接入
    • 激光型扫地机

      激光型扫地机的标准功能中包含八个必选功能,即不可删除功能,其他标准功能,可按需进行增删。

      激光功能定义和交互可参考 激光扫地机标准DP定义和交互说明

      扫地机设备接入

    产品定义常见问题

    界面配置

    设备面板可分为公版面板,SDK 开发面板和其他类型面板(定制面板)三类;

    扫地机设备接入

    公版面板类别

    惯导型公版面板

    现阶段,陀螺仪公版面板共有四个版本,如下图所示;

    V1,V2 版本的面板地图样式为栅格样式,可支持当前点,障碍点,已清扫点和充电桩的显示;

    V3 版本的面板地图样式为涂抹样式,仅可支持已清扫点和当前点的显示;

    V4 版本的面板采用了全新的 UI 风格和交互,支持三种绘图方式,栅格、涂抹、框图(带路径)。

    扫地机设备接入
    扫地机设备接入
    扫地机设备接入
    扫地机设备接入

    用户可在如下页面进行面板的更换和编辑,可编辑选项包含 界面配置功能配置
    功能配置

    扫地机设备接入

    激光型公版面板

    激光扫地机的公版面板分为如下两个版本,两个版本对应同一份协议,用户可根据面板样式自行选择更换所需的面板。更换方式如下,目前 P2P 方案的激光公版面板支持 界面配置功能配置

    扫地机设备接入

    可更换的面板选择如下:

    扫地机设备接入
    扫地机设备接入

    公版面板配置

    每一个公版面板都默认了定义了一套设置项,因此每一个新创建的 PID 绑定的面板都是一致的,用户若想自定义面板呈现,则可通过面板界面配置功能对 UI 背景色,机器图标等功能做修改或增删,详说明,请参考:扫地机公版面板编辑配置

    SDK 开发面板

    即基于涂鸦面板 SDK 完成各类面板的快速开发,详情可参考链接 快速入门

    定制面板

    定制面板通常是指为指定品牌客户联系涂鸦智能公司单独立项,设计专有的控制界面并经过研发测试,及客户验收通过后,只使用于指定产品的一类面板。

    使用场景包括:

    • 客户需要专有的排版,UI 风格及布局等,需要定制设计。

    • 需要再面板上增加特有的能力。

    定制渠道:

    开发者可按需将定制需求提交给涂鸦项目经理,由涂鸦评估给出定制费用报价,完成付费后,涂鸦将根据需求设计和开发面板,并绑定到开发者的产品下。

    自由配置面板

    自由配置模板基于每个产品功能自动配置一种标准形状的组件,常用于项目的开发调试阶段,配置指南请参考 自由配置模板使用指南

    优点:界面功能模组完全与创建的功能点一致;

    缺点:完全模组化,美观度不足。

    界面配置常见问题

    软硬件开发

    惯导型扫地机

    模组选型

    目前在扫地机产品上,用的比较多的模组型号有WR3(支持2.4G Wi-Fi配网),WBR3(支持2.4G Wi-Fi和蓝牙配网)和WBR3D(支持2.4G/5G Wi-Fi和蓝牙配网),用户可按需选择适合自己产品的模组进行对接,若是想了解其他型号的模组,可联系涂鸦商务进行咨询。

    规格书可查看:

    MCU开发

    模组调试助手使用手册

    涂鸦模组调试助手是一个集成了涂鸦模组通讯协议的串口调试工具,集成了涂鸦模组常用串口协议,既可以模拟模组验证MCU代码逻辑,也可以模拟MCU调试配网功能,可快速验证问题。

    详情可参考 模组调试助手

    MCU SDK移植

    MCU SDK是根据涂鸦开发平台定义的扫地机功能,自动生成的MCU代码,基于此SDK,用户可快速完成MCU程序的开发,移植MCU SDK,详情请参考 MCU SDK 移植

    串口协议解析

    串口协议即涂鸦Wi-Fi串口通用协议,主要用于MCU通用对接方案中涂鸦Wi-Fi模组于用户MCU串口直连做串口通信,串口协议说明,请参考链接:串口协议

    MCU开发常见问题

    激光扫地机

    激光扫地机 SDK 开发快速入门
    SDK 下载

    现阶段是通过线下的途径提供 SDK,需要开发者提所使用平台的交叉编译工具链给涂鸦团队,等待涂鸦团队输出 SDK包。

    SDK 开发手册

    详情请参考 激光扫地机 SDK 开发指南 进行激光扫地机的开发。

    激光协议扫地机协议

    该协议主要是针对涂鸦 IoT 开发平台激光扫地机公版方案,以及一些交互逻辑说明;若协议提及的功能不满足用户需求,可向涂鸦项目经理提出新需求进行评估,协商协议。

    协议获取途径:

    扫地机设备接入
    获取调试设备激活码

    设备需要通过设备激活码去云端激活,通常是通过下单采购的方式获得,但是调试期间,开发者可以在平台获取2对免费的设备激活码用于设备调试;具体的获取方式,请参考链接:如何在涂鸦IoT平台上获取免费的设备激活码

    激光扫地机开发常见问题

    产品配置

    固件升级

    平台固件升级操作方式,请参考 固件升级

    该章节主要介绍固件升级注意事项:

    • 升级已发布的涂鸦模组固件,主要是用于采用MCU通用对接方案,开发者据提示选择模组通用固件后,在固件升级页面可选择模组通用固件方案进行固件升级;

      扫地机设备接入
      扫地机设备接入
      扫地机设备接入
    • 升级新增自定义固件时,注意:

      • 采用MCU通用方案升级MCU固件时,固件类型需选用 MCU固件

        扫地机设备接入
      • 采用Linux通用SDK对接方案升级机器固件时,固件类型需选用 模组固件

        扫地机设备接入
      • 固件升级超时时间可自定义(从开始确认升级到升级包结束设备重启完成所需的时间)。

      • 固件标识名,固件名称(中文),固件名称(英文)均参考命名规则自定义即可。

      • Flash大小和芯片平台针对涂鸦模组应用开发使用,于此处没有影响。

    多语言管理

    多语言管理是指App界面文案的语言管理,开发者可根据产品被售往不同的区域来自行设置该产品可支持的多语言文案显示,包括产品名称,产品功能,设备面板,配网引导,设备消息推送,固件升级等相应的文案。

    扫地机设备接入

    详情可参考 多语言管理

    下文将以扫地机为例,做一个补充说明:

    产品名称多语言配置

    产品首次配网后的默认名称为该产品名称,开发者可在涂鸦IoT平台多语言管理的页面,对该文档进行自主修改;

    扫地机设备接入
    扫地机设备接入

    如上图示修改文案之后,给设备重新配网之后,产品名称就会由默认名称惯导型扫地机转变成修改之后的陀螺仪扫地机

    扫地机设备接入
    产品功能多语言配置

    一个产品的每个功能点,在App上都对应着一个默认文案显示。在文案显示不满足开发者需求的情况下,开发者可按需对文案进行自定义修改,例如:将默认清扫模式沿边改为沿墙模式;

    选择沿边模式右侧的修改文案按钮,将简体中文文案词条值修改成沿边,并单击确定

    扫地机设备接入
    扫地机设备接入

    效果图如下:

    扫地机设备接入
    设备面板多语言配置

    如有未能在 产品功能 中找到文案,可在 设备面板 中找到并进行编辑。编辑之后,预览 App 控制面板。若文案没有随之更改,在 App 设置中清除缓存或手机后台退出 App 后重新扫码预览。如果无法预览成功,请提交工单,涂鸦工作人员会协助您修改。

    例如:在设备面板多语言配置页修改清扫记录文案;

    扫地机设备接入

    修改之后,清除App缓存,并重进面板该页面

    扫地机设备接入

    设备消息推送

    设备消息推送是产品的告知提醒,您可以自定义产品的告警条件,实时监控产品状态。运行产品时,如果某项功能的值超出常规状态,或者您需要通知用户某些实时信息时,即可第一时间将消息触达用户,保障产品正常运行。

    详情参考平台链接:推送设备消息

    例如:新增工作状态=goto_charge的触发条件,当设备上报工作状态=goto_charge的时候,用户就会收到设备开始寻找充电座充电的消息通知

    扫地机设备接入
    扫地机设备接入

    设备配网信息

    创建产品时,开发者可以在"产品配置"设置产品的配网信息,设计一个 PID 维度的配网二维码。即使您修改了配网内容,配网二维码保持不变,终端客户使用 App 扫描二维码时,即可通过最新的配网内容进行配网操作。

    详情请参考 设置配网信息

    产品语音能力

    基于产品功能点,关联平台语音能力,可以帮助开发者在各大语音平台配置产品语音方案。如下图在产品配置页面,点击产品语音能力设置项,进入语音方案配置页面开始语音方案的配置。

    配置教程请参考使用语音工作台

    扫地机设备接入

    语音方案配置页面:

    扫地机设备接入

    设备调试

    设备调试分为真实设备调试虚拟设备调试。前者的作用是使用调试面板,验证真实设备的功能是否正常;后者的作用是通过在云端启动虚拟设备,模拟设备的功能,开发者开发面板时,可以验证面板是否正确,不需要真实设备。

    真实设备调试

    进入设备调试页面,单击新增真实设备调试,添加的方式分通过设备ID添加和通过App账号添加。

    扫地机设备接入
    扫地机设备接入

    虚拟设备调试

    1. 进入设备调试页面,单击新增虚拟调试设备,并使用涂鸦智能 App 扫描二维码。
    扫地机设备接入
    1. 点按 调试 按钮,进入虚拟设备调试页面。
    扫地机设备接入
    1. 查看虚拟设备调试页面。
    扫地机设备接入

    扫码之后,App 会出现后缀名称为***-vdeo**的虚拟设备

    扫地机设备接入

    测试发布

    当程序开发完成后,您需要对产品进行测试,以确保产品质量,涂鸦 IoT 开发平台支持自测和涂鸦协助测试两种方式,只有经过测试后的产品才可以进入发布量产阶段。

    自测

    您可自己在涂鸦 IoT 开发平台下载该产品的测试用例,自行按照用例完成测试,并上传测试报告。

    扫地机设备接入

    您上传的测试报告必须真实合法,涂鸦不对测试报告内容进行审查,声明如下截图:

    扫地机设备接入

    涂鸦测试增值服务

    涂鸦提供有偿测试增值服务,您可以在 IoT 开发平台开通服务,涂鸦会协助您进行产品测试,保证产品质量。

    扫地机设备接入
    扫地机设备接入

    售后支持

    您可以通过以下的方式向涂鸦发起协助请求,涂鸦将全力解决客户的售后问题。

    工单

    您在开发过程中遇到问题可以提交 工单 解决。

    App 反馈支持

    用户可通过涂鸦 App 反馈问题,涂鸦智能 App 与智能生活 App 的反馈路径为: > 常见问题与反馈 > 反馈问题

    扫地机设备接入 扫地机设备接入

    其他

    如果上述方式不能解决问题可以联系涂鸦工作人员处理。