# Cleaner Robot
## Sweeper product program introduction
### 方案概述
作为一种新兴的智能家电产品，扫地机器人受到越来越多的关注，助力于更好的家居清洁。随着扫地机器人功能的完善，APP远程智能控制逐渐成为必备功能，以满足人们快节奏生活下的家居清洁需要。通过APP的定时预约、远程操控、个性化清洁等操作，将机器与手机连接，随时随地掌控家居清洁。
涂鸦智能作为行业领先的AI+IoT平台方案商，针对惯导型、视觉型、激光型等不同扫地机器人产品，可提供WIFI模组、IoT SDK、云平台、个性化APP在内的整体解决方案，满足不同客户，不同产品的智能化和个性化需求。
**系统介绍**
1、嵌入式单元，实现产品配网，将扫地机数据上传至云端，并接收云端指令。
* IoT模组，针对普通MCU型扫地机，串口通信方式；
* IoT SDK，针对Linux为主控的扫地机；
2、涂鸦云，全球部署的IoT平台，对所有设备和APP进行连接。
3、APP单元，提供多种形式的APP，实现对扫地机远程控制。
* 公版APP，适用于产品快速对接，提供自定义LOGO的OEM版本；
* 定制APP，适用于定制产品，满足各产品的个性化定制需求；
* APP SDK，适用于用户自研APP；
4、语音单元，支持Amazon Alexa、Google Assistant等语音接入。
5、运维管理平台，可对产品OTA、运行情况、活跃情况等进行综合管理。
### 支持品类
支持惯导型、视觉型、激光型、以及IPC复合型的多种产品方案的接入；
### 主要功能
#### 扫地机通用功能
* 快速配网：支持EZ和AP两种配网方式；
* 实时控制：机器启动、自动回充、手动遥控、模式清扫、吸力调节等；
* 实时状态：清扫状态、电池电量、清扫时长、清扫面积、耗材寿命等；
* 设备配置：耗材管理、寻找机器、音量设置、水箱调节等个性化配置；
* 清扫记录：支持清扫记录及清扫结果云端存储；
* 预约清扫：支持云端定时、本地定时两种方案；
* 故障告警：支持机器故障、告警、通知等消息推送；
* 设备分享：支持家庭管理、成员间设备分享；
* OTA升级：支持提示/静默等方式的设备及模组升级；
* 多语言管理：支持多种语言的配置管理和切换；
* 语音包管理：支持多种语音包的配置管理和切换；
#### 惯导型扫地机功能
* 地图显示：支持清扫区/障碍区/充电桩/实时位置等信息的房间地图显示；
#### 视觉型扫地机功能
* 地图显示：支持清扫区/障碍区/充电桩/实时位置等信息的房间地图显示；
* 路径显示：支持清扫路径显示；
* 地图编辑：虚拟墙/禁区设置；
* 模式清扫：自动/沿边/定点/指哪扫哪/划区清扫；
#### 激光型扫地机功能
* 地图显示：支持清扫区/障碍区/充电桩/实时位置等信息的房间地图显示；
* 路径显示：支持清扫路径、导航路径显示、支持当前点方位显示；
* 地图编辑：虚拟墙/禁扫区域/禁拖区域设置、区域命名；
* 地图管理：支持房间导航地图云端管理和切换使用；
* 模式清扫：自动/指哪扫哪/划区/局部清扫；
* 预约设置：支持清扫、勿扰预约设置；
### 相关开发模块
#### 硬件模组
针对MCU型主板，可提供WR3型物联模组。
* 内置低功耗 32 位 CPU，可以兼作应用处理器
* 主频 125MHz
* 工作电压：3V-3.6V
* 外设：7×GPIOs, 2×UARTs, 1×ADC
* Wi-Fi 连通性
* 802.11 B/G/N20/N40
* 通道 <1-14@2.4GHz>
* 支持WPA/WPA2 安全模式
* 802.11b 模式下+20dBm 的输出功率
* 支持 Smart Config 功能（包括Android 和 IOS 设备）
* 板载PCB 天线和外接天线IPEX 连接器
* 通过CE,FCC,SRRC 认证
* 工作温度：-20℃ to 85℃
#### IoT SDK
针对Linux型主板，可提供基于主芯片平台的IoT SDK。
#### APP SDK
提供Android和IOS两种APP SDK。
### 部分公版UI方案
#### 惯导型扫地机
#### 激光型扫地机
#### 视觉及IPC型扫地机
### 地图部分说明
#### 数据通道
1. 提供增量和全量两种数据通道：
* 增量通道：机器端单包数据增量式上报，APP端全量获取并实时接收，适用于惯导型扫地机；
* 全量通道：机器端累积数据一次性上报，实时通知，APP端全量获取，适用于激光型扫地机地图数据上报。
2. 数据上报和存储支持国内外部署；
3. 数据传输频率可实现1Hz频率上报和更新；
#### 地图显示
**地图大小**
* 惯导型扫地机可支持255x255, 500x500, 800x800等分辨率大小，具体由机器端决定，APP端适配；
* 激光型扫地机地图大小不做限制，由机器实时上报，机器端上报精度通常为0.05m，对应APP端为1个像素单元。路径点精度通常设定为0.1个像素。
**地图编辑**
* 支持虚拟墙（两点直线方式）、禁区（矩形方式）、区域（矩形方式）等编辑功能，支持区域自定义名称、区域旋转、长度显示、颜色配色等；
* 支持非法禁区的预警提示；
**地图管理**
* 机器地图云端存储，支持云端地图数据下发至机器，实现切图切换（机器配合）；
**路径优化**
* 支持扫地机方向显示；（需机器端配合）
* 支持转场路径隐藏，仅显示清扫路径；（需机器配合）
* 支持清扫路径圆滑处理；
## Sweeping machine docking development process
### 准备工作
在涂鸦IoT平台，注册开发者账号，开启产品智能化。
为了使用日志查询、权限分享等相关功能，请开通企业版权限。
IoT平台链接：
### 流程概述
Step1 - 产品定义：在IoT平台定义产品的具体功能，核心是数据传输内容及格式；
Step2 - 界面配置：根据产品特点，选择和配置个性化的UI，核心是风格、颜色、图标等；
Step3 - 硬件选型：根据产品PCB的特点及要求，选择适配的WiFi通讯模组；
Step4 - MCU开发：对MCU控制程序进行适配开发，核心是配网、数据交互、地图传输等；
Step5 - APP构建：构建具有厂商特点的APP，核心是LOGO、欢迎页、设备页等；
Step6 - 运营管理：配置APP界面多国语言、申请开通智能音箱、设备OTA升级等核心操作；
### 具体操作
### 产品定义
#### 新建产品
在涂鸦IoT平台创建产品，选择【小家电】-【扫地机器人】，点击“创建产品”即可开始创建产品。
**相关说明：**
1. 产品名称：实际设备的默认名，将显示在APP中设备页；
2. 通讯类型：硬件连接涂鸦云的方式，目前支持Wifi方式；
#### 功能定义
**如何定义DP**
涂鸦平台将设备与云端传输的数据，抽象成不同类型的DP，在定义DP时，可根据机器功能，分类成不同的DP点，用于控制和显示。
为满足不同开发需求，涂鸦平台提供标准化功能和自定义功能：
* 标准功能：针对常规扫地机功能的标准化，与IoT平台提供的APP面板相对应，用于快速开发；
* 自定义功能：自定义扫地机的附加功能项，用于扩展机器功能；
**标准化功能**
标准功能涵盖清扫开关、清扫状态等功能点。同时，枚举型功能允许用户新增类型，如清扫模式，工作状态，错误码等，新增后，APP设备控制页会同步更新。
**自定义功能**
对于机器的扩展功能，可在“自定义功能”中进行新增，新增后，在APP的设备控制界面的设置页中会生成相应的控制项。
IoT平台提供布尔、数值、枚举、字符、故障、raw等数据类型，支持上下行。
详细介绍参考：
### 界面配置
产品定义后，可以选择不同风格的面板（设备控制页），作为扫地机的交互页面。在IoT平台，提供公版面板、自定义面板、自由配置面板，以及开发调试面板，供用户选择。
公版面板：样式与交互固定，与【标准功能】对应，支持背景、颜色等内容的配置，用于产品量产。
自由配置面板：支持自由设置页面控件及样式，用于自定义产品；
调试面板：以开关选项方式显示机器端数据，用于开发阶段调试；
### 模组选型
扫地机电控，主板通过云模组，与涂鸦云和APP进行通讯连接。在产品新建后，选择适用的云模组，并根据主板、云模组的接口电路及产品要求，完成硬件电路的开发。
目前，惯导型扫地机产品可供选用的是WR3 WIFI模组，模组详细说明，请参考：
### MCU开发
#### MCU程序开发
云模组通过串口通讯方式与MCU对接，MCU端根据【产品定义】步骤中定义的功能DP，实现机器数据与云端的交互。MCU开发过程主要涉及协议的解析、数据的上报与接收、地图数据的上报等。
MCU开发，有两种方式可选择：
**1）串口协议方式**
MCU根据串口协议，自行组包和解包，实现数据的上报和执行；
**2）SDK方式**
移植IoT平台封装好的SDK接口文件，MCU直接调用相关函数，实现数据的上报和执行。 开发详情，请参考：
#### 机器功能调试
在产品开发的验证和调试阶段，为了验证技术方案、或APP面板的功能，可采用IoT平台提供的调试助手及调试面板，实现APP端和机器端的数据通讯，辅助开发过程的开发调试。
**仿真助手**
涂鸦云仿真助手，PC机与云模组通过串口连接，模拟MCU收发机器功能DP数据，可在APP端实时体验交互效果。
适用于在MCU程序开发前，对所定义的产品功能进行验证，以及调试过中数据有效性的验证。
仿真助手使用详情，请参考：
**面板调试**
在设备配网功能调试完成后，可以通过APP对扫地机进行配网，在APP上对扫地机进行相关操作，验证指令收发，APP显示、机器执行等是否正确。
同时，MCU在开发前期，可以借助调试面板功能，单独调试某个DP的逻辑是否正确。
调试面板只保留数据收发操作，不含交互逻辑，可以在【界面配置】环节选择，适用于开发过程的调试。
**日志查询**
开通调试过程中，会遇到DP数据收发过程查询的需求。IoT平台提供日志查询功能，可以查看扫地机MCU与APP间的数据通讯情况，适用于异常情况下，排查各端的操作情况。
【说明】日志查询功能，需要开通“企业版”账户权限，并在运营平台操作。
### APP构建
当机器功能开发完成后，将涉及自有品牌APP的构建。涂鸦平台提供在线OEM APP的功能。
在IoT的【APP工作台】，可配置APP名称、LOG、配网文案、产品图标等信息，生成具备厂商标识信息和个性化的OEM APP。
详细操作请参考：
### 相关配置
#### 多语言配置
当产品目标市场是海外区域时，需要将APP界面的语言调整成相应区域的语种，目前可支持大部分国家和地区。
在IoT平台“拓展功能”的“多语言配置”，可对设置功能点进行多语言编辑，完成编辑后。当手机调整系统语言后，APP界面语言也随之调整。
#### OTA升级
为了满足机器功能升级，平台支持MCU OTA功能。
在IoT平台“拓展功能”的“固件升级”，可以自定义上传MCU固件，固件版本、升级信息等都支持自定义管理。
