机智云名词定义解释

说明

此文档将对机智云相关的术语进行定义与解析。如果在开发过程中遇到一些术语不太理解的可以参阅此文档。

云端名词定义

1.ProductKey

定义：产品标识码，开发者通过机智云后台创建新产品后，自动生成的一个32位字符串。在机智云的数据库中是一个唯一的号码，开发者将ProductKey写入设备主控MCU后，机智云通过此标识码对设备进行识别并自动完成注册。

解析：设备接入机智云的前提是，需要机智云认同这个设备。Productkey是设备接入机智云的一个重要参数，该参数的基本含义是：一款设备识别码。例如某公司生产空调、热水器，空调和热水器是不同款设备，该公司设备接入机智云，至少需要两个Productkey参数。在开发MCU过程中，需要使用到该参数。Product Key在机智云官网上可以查看到，请参考下图：

Alt text

Productkey在开发过程中的角色：

Alt text

2.Product Secret

定义：产品密钥，在生成Productkey的时候云端会对应生成一个Product Secret，该参数为关键性机密参数，不应向第三方泄露。该参数在绑定远程设备（一般为GPRS接入方案）的时候会使用到。

3.DID

定义：设备号，当一个设备初次接入机智云时，机智云自动根据ProductKey以及设备Wi-Fi模块MAC地址为此设备注册一个did，此did全网唯一，用于与用户的绑定及后续操作。

Alt text

4.AppID

定义：应用标识码，当开发者需要为一款智能产品开发应用（包括iOS、Android、Web应用等）时，后台会自动生成一个AppID，并与此设备进行关联。应用开发时需要填入此AppID。

解析：在云端创建一个产品的同时需要在该产品下添加一个应用，并区分Android与iOS等。AppID主要在开发APP的时候用到。并且在app中注册的所有用户绑定在该Appid下。Appid可以在机智云官网上可以查看到。

Alt text

5.App Secret

定义：应用密钥，在云端生成AppID的时候，会对应生成一个App Secret，该参数在APP端SDK注册手机用户时，获取手机短信验证码的时候会用到。

6.小循环

定义：智能设备与手机、智能设备与智能设备之间，通过连接同一个路由器实现局域网内部的通信（查看状态或控制），我们称之为小循环。

7.大循环

定义：智能设备通过路由器或直接接入互联网以实现用户的远程监测与控制，我们称为大循环。

Alt text

设备端名词定义

1.Gagent

定义：全称Gizwits Agent，运行于Wi-Fi模块中，设备通过GAgent接入机智云服务器。目前已兼容国内主流的Wi-Fi模块，开发者也可以通过获取GAgent二次开发包实现自定义的模块接入机智云。

解析：Gagent是机智云运行在Wi-Fi模组的应用程序，Gagent主要作用是使得wifi模块主动连接机智云服务器，并实现与云端的TCP/UDP通信。因此，在开发者产品的控制电路板上集成Wifi模块，只需要实现与Wifi模组的串口通信，即可直接接入机智云服务器，而不需要处理底层的网络传输处理。如图所示：

Alt text

2.PassCode

定义：设备通行证，用于校验用户的绑定/控制权限。当用户发起设备绑定时，只要是合法操作即可拿到此通行证，通过此通行证绑定设备并对设备进行有效期内的查看、控制等操作。GAgent首次运行时生成随机数作为设备通行证，生成后保存在非易失性存储器上。设备上线时需要上报给服务器。

Alt text

3.Onboarding

定义：也叫配置入网，用户将一款基于Wi-Fi的物联网设备配置连接上路由器的过程称为Onboarding。新设备第一次使用时需要知道路由器的账号和密码，以通过路由器连接互联网。由于大多数的物联网设备没有自带的屏幕和键盘，所以需要通过智能手机向设备发送路由器的SSID和密码，这个过程机智云称为Onboarding。机智云提供的Wi-Fi设备接入SDK中已经内置了此配置的功能。

Alt text

4.Station模式

Station模式（简称sta）, 类似于无线终端，sta本身并不接受无线的接入，它可以连接到AP，一般无线网卡即工作在该模式。

5.AP模式

AP模式: Access Point，提供无线接入服务，允许其它无线设备接入，提供数据访问，一般的无线路由/网桥工作在该模式下。AP和AP之间允许相互连接。

6.AirLink

定义：机智云对各种SmartConfig、SmartLink这种UDP广播报方式对设备配置入网的技术统称，兼容了多个Wi-Fi模块厂商的配置协议，总结了一套良好用户体验的标准Onboarding操作流程，机智云的Wi-Fi 设备接入SDK已经内置AirLink技术。

7.SoftAP

定义：由于目前各个Wi-Fi模块厂商的Smart Config协议均未完全成熟，也不支持5G路由器信号。机智云在提供了AirLink配置模式的同时也支持SoftAP模式配置设备接入路由器。当设备进入SoftAP配置模式时，设备本身将成为一个AP，智能手机可直接与设备进行连接，然后在手机上的界面上输入路由器的SSID和密码，设备接收到信息的时候会自动尝试连接路由器，连接成功则自动切换到正常使用的模式。

开发者中心工具名词定义

1.虚拟设备

虚拟设备是机智云云端可自动生成的一个仿真智能硬件，可模拟要开发或正在开发的智能硬件，来进行云端设备控制、手机APP控制、上报数据等需求。
不管您是否已经做好智能硬件，在初次使用机智云时，都可通过虚拟设备和调试APP了解机智云接入原理，让您直观体验机智云接入服务。

开发者或企业研发人员在机智云平台开发时，如果正式的智能硬件产品产品还未完全开发完成，就可以很方便地使用该“虚拟设备”与正式产品的控制APP进行调试和验证，加快研发周期，降低研发成本。
开发者或企业研发人员在机智云平台开发时，如果正式产品的控制APP还未完全开发好，就可以很方便地使用该“调试APP”对正式产品进行调试和验证，加快研发周期，降低研发成本。

使用教程：http://docs.gizwits.com/zh-cn/quickstart/README.html#%E6%96%B0%E6%89%8B%E5%88%9D%E4%BD%93%E9%AA%8C

2.MCU代码自动生成器

为了降低开发者的开发门槛，缩短开发周期，降低开发资源投入，机智云推出了代码自动生成服务。云端会根据产品定义的数据点生成对应产品的设备端代码。
自动生成的代码实现了机智云通信协议的解析与封包、传感器数据与通信数据的转换逻辑，并封装成了简单的API，且提供了多种平台的实例代码。当设备收到云端或APP端的数据后，程序会将数据转换成对应的事件并通知到应用层，开发者只需要在对应的事件处理逻辑中添加传感器的控制函数，就可以完成产品的开发。
使用自动生成的代码开发产品，就不必再处理协议相关的部分了，开发者可以将节省出来的精力集中在产品的核心功能开发上。

生成MCU方案代码

MCU代码自动生成功能特性如下:

自动生成服务支持的硬件方案有：独立MCU方案、SOC方案。
独立MCU方案支持的硬件平台有：51单片机、MSP430、STM32、arduino，含正点原子等，支持生成支持8位、16位、32位的MCU
SOC方案支持的硬件平台有：ESP8266平台，含8M、16M、32M模组
能与Cubemx无缝对接

使用教程：http://docs.gizwits.com/zh-cn/deviceDev/DevSDK/%E4%BB%A3%E7%A0%81%E8%87%AA%E5%8A%A8%E7%94%9F%E6%88%90%E5%B7%A5%E5%85%B7.html

3.APP代码自动生成器

APP的代码自动生成工具：当开发者在产品项目上创建对应的数据点后，云端会根据产品定义的数据点生成对应产品的APP参考代码，一键点击生成下载，编译安装即可完成专属物联网APP。

开发者下载源码后，只需要优化UI和设计设备控制界面控制逻辑，源码的控制页面编写了机智云SDK控制设备的标准流程，APP源码二次开发过程中只需按照该流程进行相关代码的优化即可快速完成针对自身产品的智能控制APP。

目前APP生成的源码支持 Andriod、iOS、APICloud平台。

Alt text

自动生成的APP代码模块化集成了一个智能硬件APP必备功能，主要包括：

1.用户部分：用户注册，找回密码、第三方登录（微信登录、QQ登录）
2.配置设备入网（Arilink+SoftAP）
3.设备发现，列表展示
4.设备控制
5.消息推送：设备报警后给APP推送报警信息，主要合作推送平台是极光推送和百度推送。

使用教程：http://docs.gizwits.com/zh-cn/UserManual/devApp.html

4.D3 Engine

D3 Engine,全称 Dynamic Data Director Engine,是机智云为开发者提供的傻瓜式的数据处理、开发引擎。“使用D3引擎，只需“拖拉拽”即可轻松创建APP和短信推送规则，即可将设备、用户数据与外部第三方数据进行有机整合。使用门槛低，小白也可轻松利用D3引擎来创建APP和短信推送规则”

D3 可以灵活定义数据的输入，能将设备、用户数据与外部第三方数据进行有机整合，还可以支持脚本解析与自定义数据输入，满足不同开发者的数据处理需要。主要特点如下：

1）多样的数据源：支持自定义多种数据源，第三方公共数据甚至您的ERP系统的数据输入。
2）强大的规则处理：基于决策树算法支持灵活多重条件组合。
3）灵活的输出：除了App推送、邮件、短信等服务，还可以支持回调服务以及存储服务；存储服务通过数据平台的计算与开放API服务对各类应用提供数据服务，降低各类应用的开发成本以及面对海量数据的性能处理风险。

目前D3 Engine仅支持企业开发者试用或购买GDCS的客户使用。

Alt text

使用教程：http://docs.gizwits.com/zh-cn/UserManual/D3.html

5.产测工具

机智云产测工具是一个对产品进行批量测试的工具App，使用产测工具，可以快速检验工厂生产线上的成品或者半成品。

您可以在页面中定义产品产测的测试项，再对工厂的设备进行相关定义项的自动测试。设备针对测试项测试通过后，表示产品合格。在大型生产中，通过产测工具，能够有效的监测批量产品质量，保证产品功能。

name

使用教程：http://docs.gizwits.com/zh-cn/deviceDev/%E4%BA%A7%E6%B5%8B%E5%B7%A5%E5%85%B7%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3.html

6.OTA固件升级

OTA 英文全称是Over-the-Air Technology，即空间下载技术。当设备连上云端时会收到OTA升级通知，再通过HTTP完成固件升级。
机智云的OTA服务主要提供以下功能：

1）OTA通知服务，即离线升级。当设备的固件程序有新版本发布，OTA 通知服务会推送升级通知到设备。
2）OTA透传服务，即在线升级。设备固件程序通过M2M 消息服务透传到设备端。
3）支持一个产品同时有多个推送
4）支持wifi/mcu升级
5）支持定向升级。可指定设备mac地址、区域、旧固件版本进行推送。
6）支持定时推送。可自定义推送周期及推送时段。
7）OTA进度统计分析

远程对设备Wi-Fi，MCU模块进行固件程序升级，修复固件程序Bug或新增功能当设备连上云端时会收到OTA升级通知，再通过HTTP完成固件升级。

GAgent OTA使用教程：http://docs.gizwits.com/zh-cn/UserManual/OTA.html
MCU OTA使用教程：http://docs.gizwits.com/zh-cn/UserManual/MCUOTA.html

7.SNoti服务

SNoti服务是机智云为企业或产品运营商提供的设备管理类服务，用于实时推送设备与产品相关的事件，远程控制设备。主要的功能如下：

1）设备实时数据推送；
2）产品相关事件推送；
3）设备远程控制。

企业客户可通过SNoti提供的安全数据传输通道，实时的接收设备的数据，用于设备信息归类整理，设备状态统计，设备监控等；也可以通过远程控制功能，实时发送业务指令控制在线设备。

使用教程：http://docs.gizwits.com/zh-cn/Cloud/NotificationAPI.html

8.企业API

企业API是机智云为接入机智云平台的企业开发者提供的开放API服务。

使用企业API的企业将设备接入到机智云平台后，通常还有进一步基于接入机智云设备数据开展企业某个垂直领域的业务需求，如用户管理、订单管理等，以满足企业开发者的运营管理需要。

企业API就是从接入机智云平台的企业的运营管理的需求出发，为企业的业务管理系统提供REST API接口，为企业提供企业视角全局的设备管理、数据分析等功能，让企业更关注业务管理系统本身，减少不必要的开发成本与时间。

使用教程：http://docs.gizwits.com/zh-cn/Cloud/enterprise_api.html

9.应用邮件模板

app用户用邮箱注册成功时会收到一个注册成功邮箱，通过邮箱找回密码时会收到一个找回密码邮箱。
通过应用邮件的配置可自行自定义设置邮件模板的内容，并可配置第三方邮件服务器，或者使用机智云代发服务器。
实时大数据
通过拖放的方式生成API，用于对产品数据点进行实时大数据统计分析。

10.离线数据

离线数据下载是机智云为接入机智云平台的企业开发者提供的数据服务。
通过机智云提供的安全下载链接，企业客户可以下载设备历史的通讯日志数据（单次最多可下载3个月的数据）。便于企业做数据分析、数据挖掘和制定数据报告。

客户端开发相关工具

1.机智云开源框架

开源框架是机智云出品的，包含Wi-Fi类智能硬件app通用功能的一套源码。只要是使用机智云协议的产品，开发者开发配套的app时都可以直接使用该框架的源码实现快速开发，从而也满足app的开发周期短、成本低的要求。

开源框架包括智能硬件app通用的5个模块，分别是：初始化模块、用户模块、配置模块、设备列表模块、控制模块。

iOS版开源框架：https://gitee.com/dantang/GizOpenSource_AppKit_iOS
Andriod版开源框架：https://gitee.com/dantang/GizOpenSource_AppKit_Android
APICloud版开源框架：https://github.com/gizwits/GizOpenSourceAppKit_APICloud
或在下载中心下载：https://download.gizwits.com/zh-cn/p/95/96

2.设备接入SDK

设备接入SDK封装了手机（包括PAD等设备）与机智云智能硬件的通讯过程，以及手机与云端的通讯过程。这些过程包括配置入网、发现、连接、控制、心跳、状态上报、报警通知等。

使用SDK，可以使得开发者快速完成APP开发，开发者仅需关注APP的UI和UE设计即可，而相对复杂的协议与错误处理等事项可忽略。另外还提供了APICloud版本的wifi设备接入SDK，可以使用JS语言更加快速完成APP开发。

下载地址：https://download.gizwits.com/zh-cn/p/95/97

3.统计分析SDK

统计分析SDK用于将数据进行云存储、云获取和云计算，蓝牙产品是主要使用对象。产生的数据会通过手机传输到云存储器中，如需数据调用，则通过接口获取即可。
目前提供的基本数据运算有：数据求和、数据平均、数据最大值及最小值查找等。

下载地址：https://download.gizwits.com/zh-cn/p/95/111

开发与调试工具

1.调试APP（IoE Demo）

调试APP（IoE Demo）又称机智云调试APP，简称“机智云APP”。可在应用商店搜索“机智云”下载，或在下载中心下载：https://download.gizwits.com/zh-cn/p/98/99

机智云APP是全球首款IoT设备通用调试工具，可按照实际智能硬件产品的需求自定义功能，可自动生成可响应的控制页面，有完整的用户注册、登陆和注销流程，可以完成智能硬件的配置入网、设备搜索、设备绑定、设备登录、设备控制、远程控制、状态更新、本地远程切换等基本操作和调试需求。

2.机智云串口调试助手

机智云串口调试助手是一款提供设备快速开发的强力助手，拥有双串口调试、模拟MCU、效验和计算等功能。双串口调试可以让嵌入式开发清晰地分析模组和MCU之间的数据交互，迅速定位问题；模拟MCU可以在设备未开发完成时同时开发APP，缩减开发周期，另外可以用于验证模组的可用性等。

下载地址：https://download.gizwits.com/zh-cn/p/98/119

3.产测工具

使用产测工具，可以快速检验工厂生产线上的成品或者半成品。产测工具是一个简单的手机APP，可以在用户产品中定义产测的测试项，再对工厂的设备进行相关定义项的自动测试。设备针对测试项测试通过后，表示产品合格。

产测工具可以将设备并行处理，平均5～10秒可以完成一个设备的测试，从而大大提高测试的速度。

产测工具下载：https://download.gizwits.com/zh-cn/p/98/100