【资料】产品接入与云端管理
1-注册机智云账号在使用机智服务前,你需要注册一个开发者账号。如何注册账号成为机智云开发者,具体步骤如下:步骤一:进入官网点击http://www.gizwits.com/访问官网。在导航栏中,显示【开发者中心】按钮,如图1-1。https://gizwits.kf5.com/attachments/download/512489/00156e120b7e565fec8f6002d2ee6e5/ 图1-1步骤二:进入开发者中心点击【开发者中心】按钮,可跳转到开发者中心首页(跳转链接为http://site.gizwits.com/zh-cn/developer/)。在开发者中心首页导航栏中,显示【注册】按钮,如图1-2。https://gizwits.kf5.com/attachments/download/512495/00156e120ecf35de1b0a8db771eb33f/ 图1-2步骤三:进入注册页面点击【注册】按钮,即跳转到注册页面,如图1-3。在注册页面中,分“企业用户注册”和“个人用户注册”两种注册方式,可根据自身情况而进行选择注册。步骤四:以“企业用户注册”为例:1)行业分类根据自身企业情况进行选择;行业类型大致分为:互联网公司、家电、智能家居、灯光照明、安防监控、医疗/健康/运动、可穿戴设备、智能玩具、汽车与周边、工业领域、通讯网络设备商、IC原厂、模组/方案商、主控板卡厂、创客空间及行业协会等;如没有以上的行业,可以选择“其他”作为行业类型,如图1-3。https://gizwits.kf5.com/attachments/download/512498/00156e12153c2c7307e5f71a643c393/图1-32)企业名称根据自己的企业进行命名,例如:TEST1(企业名称);成功注册后,登录账号,可以看到有“个人项目”和“企业项目”(项目的名称即是注册时企业命名的名称),如图1-4。https://gizwits.kf5.com/attachments/download/512505/00156e12178af7ad34620b306dadaaf/ 图1-43)登录邮箱及密码填入自己的邮箱,例如QQ邮箱12****8@qq.com(满足格式的邮箱都可申请注册);密码(弱密码保护提示):密码不能是123456、111111、123abc等容易猜测的密码,如图1-5;所以设置密码及确认密码时,尽量提高密码复杂程度,以提高安全性。https://gizwits.kf5.com/attachments/download/512520/00156e1218c234c68083547fd672c02/图1-54)企业信息企业联系人(变量包含不超过 30 字符 )、联系电话(符合电话格式要求即可)、职务(变量包含不超过 32 字符)、需求情况描述(填写好需求之后,会有相应的工作人员去跟进请求)、地区选取栏(企业所在地)。5)机智云了解路径可以根据自己的情况进行选择,大致分为:从新闻媒体了解、朋友同事推荐、行业协会、模块商\芯片商介绍、线下活动、微信\QQ等线上推广、搜索引擎及技术论坛等,如非通过以上方式了解机智云的,可以选择“其他”,如图1-6。https://gizwits.kf5.com/attachments/download/512521/00156e1219f1afc4952f96bf0daf1ff/图1-6
6)《机智云平台服务条款》:介绍机智云平台服务条款的详细情况。7)注册成功填入相应的注册信息,点击【注册】按钮,跳转页面如图(有相应的提示内容),如图1-7。https://gizwits.kf5.com/attachments/download/512527/00156e122126855a6b108109cf0947c/图1-7
8)激活账号注册成功后会收到一封激活邮件,如图1-8;如“收件箱”无邮件,可以点击“垃圾箱”查看邮件是否有收到,如无,可以点击在注册成功跳转页面中的“再次发送激活邮件”可以给邮箱再次发送激活邮件。点击【激活账户】按钮,恭喜你已经成为机智云开发者。https://gizwits.kf5.com/attachments/download/512529/00156e122259b8e1b904a8bd027f8f5/ 图1-89)成功登录企业账号:输入邮箱账号及密码,点击【登录】按钮,成功登录,再次进入开发者中心首页,可以看到有“个人项目”和“企业项目”(项目的名称即是注册时企业命名的名称),如图1-9。
https://gizwits.kf5.com/attachments/download/512540/00156e1228c94dd35282600316f7ebb/图1-9步骤五:以“个人账号注册”为例,如图1-10:1)登录邮箱、密码、联系电话、机智云了解路径及《机智云平台服务条款》注册的条件及详细同“企业账号注册”的方式一样,如图1-10。https://gizwits.kf5.com/attachments/download/512541/00156e122a2589bd35e7b6657c0018f/图1-10
2)注册成功跳转页面、邮箱邮件、激活账号、激活成功跳转登录页面,同“企业账号注册”的方式一样。3)成功登录个人账号,如图1-11,可以看到这里个人账号注册是无企业项目的,只有一个个人项目。https://gizwits.kf5.com/attachments/download/512545/00156e122c290500ee68e4783f98f9b/
2-产品定义
一、产品接入前提在使用机智云服务之前,你首先需要在机智云开发者中心注册一个开发者账号并登录。注册详细操作说明请参考注册机智云账号。二、创建新产品步骤一:点击机智云官网导航栏的“硬件接入”进入”设备列表“页面(http://site.gizwits.com/zh-cn/developer/product),点击页面设备列表栏的【+ 创建新产品】按键,弹出添加产品弹框,如图:https://gizwits.kf5.com/attachments/download/525142/00156e9253d3daa7741ba8da86650c0/步骤二:按照添加产品弹框内的提示填写或选择产品基本信息,点击【添加】,进入“新设备接入向导—编辑数据点”页面https://gizwits.kf5.com/attachments/download/525144/00156e9256082644252be7aa9e365ad/三、通过新设备接入向导完成设备配置编辑产品数据点方法一:通过方案模板创建生成产品数据点前提:用户所拥有的方案模板不为空步骤1: 从“新设备接入向导—编辑数据点”页面显示的模板列表中选择与新产品类似的方案模板,点击方案模板上的【查看】可以查看方案模板的详细数据点列表,点击数据点列表弹框下的【关闭】,可以关闭数据点列表弹框,如图:https://gizwits.kf5.com/attachments/download/525152/00156e9259c17617bb3270d506a2fdb/步骤2:点击方案模板中【应用此模板】按键,弹出提示框,点击提示框上的【添加】即可将模板数据点应用到新的产品,如图:https://gizwits.kf5.com/attachments/download/525161/00156e925eee245c2b4f39dfbb644cf/步骤3:通过方案模板创建生成数据点成功,自动跳转到手动编辑数据点页面,可以对生成的数据点进行编辑、添加或删除。数据点添加,编辑和删除具体操作详情请见数据点定义方法二:手动编辑产品数据点
如果当前用户没有模板或者没有合适的模板,或用户不想使用模板创建产品数据点时,此时用户可以根据新产品的功能手动逐个进行数据点的添加。步骤1:点击“新设备接入向导—编辑数据点”页面的手动编辑数据点选项,进入手动编辑数据点页面。https://gizwits.kf5.com/attachments/download/525174/00156e9263d2bcd7d439f3bf4ae98da/步骤2:点击手动编辑数据点页面的【+新建数据点】按钮,弹出添加数据点弹框。根据提示填写数据点信息并保存,系统将为你的产品创建第一个数据点,你可以继续对数据点进行微调。https://gizwits.kf5.com/attachments/download/525179/00156e9265f1065525166aff64fcc87/步骤3:重复步骤2的添加操作,直到产品功能需要的数据点全部添加完成。对生成的产品数据点你可以继续执行编辑,删除以及添加操作。MCU编程
数据点编辑完成后,点击【下一步】,页面自动跳转到“新设备接入向导—MCU编程”页面,页面显示如下:https://gizwits.kf5.com/attachments/download/525183/00156e9268547d50852d3940f628143/根据上一步添加的产品数据点,页面自动生成了《XX-机智云接入串口通信协议文档》和《XX-机智云接入JSON文档》(其中XX代表产品名称),点击文档名即可进行下载,硬件开发人员只需按照文档指示即可轻松完成硬件开发。设备调试点击“新设备接入向导—MCU编程”页面的【下一步】,进入“新设备接入向导—设备调试”页面,页面包含产品开发资源和轻应用开发资源两项。产品开发资源项:https://gizwits.kf5.com/attachments/download/525186/00156e926cc8a6e1eba022d228404fb/产品开发资源提供android和iOS SDK,集成文档以及Demo APP的下载。当完成了产品数据点编辑后且产品的硬件设备已开发完成,可下载对应的SDK集成到已完成界面设计的移动应用,即可实现设备的控制。同时也可以直接下载并安装Demo App,登录后即可对连接并查看、控制设备。如果设备未完成开发,可以使用机智云提供的虚拟设备进行功能的调试。虚拟设备调试详细说明请戳调试工具轻应用开发项:https://gizwits.kf5.com/attachments/download/525189/00156e92708ac34f7adfc8e4ee593bd/轻应用开发项提供API文档的查看链接,点击即可跳转到API文档说明页面。使用机智云提供的Open APIs(Http / WebSocket),可以快速开发网页或微信应用等基于html的轻应用,用于管理和控制智能设备。完成并退出向导至此,你已完成了一款智能硬件产品的接入,接下来你将进入此设备页面,你可以直接申请发布,也可以继续编辑、查看,删除或调试设备。四、通过方案模板创建产品机智云为广大开发者提供了一系列方案模版,当选择相同产品时可选择直接套用模版,更高效的定义产品。步骤1:点击机智云导航栏的“硬件接入”进入设备列表页面,点击页面右侧导航栏的“方案模板”选项进入方案模板页面:http://site.gizwits.com/zh-cn/developer/producthttps://gizwits.kf5.com/attachments/download/525193/00156e92797574ec16082d8ee50f052/步骤2:在方案模板页面显示的模板列表中选择自己需要用到的模板,点击【应用此模板】,弹出使用方案模板创建新设备弹框,如图:https://gizwits.kf5.com/attachments/download/525195/00156e927b59502c11876fb303b27bf/五、产品管理设备正式上线之前,都可以对设备信息进行修改。只有拥有产品的管理员或开发者权限,才能对产品进行编辑。设备识别码是你的新设备在机智云中的唯一标识,由系统自动生成,无法更改。产品信息查看和编辑步骤1:进入产品管理页面,页面默认显示产品信息,如图:https://gizwits.kf5.com/attachments/download/525200/00156e927da67f3932fb4844502838f/步骤2:点击产品详细信息栏后的编辑图标,进入产品信息编辑页面,如图:https://gizwits.kf5.com/attachments/download/525205/00156e927fff0681332fac0ad3cda4c/步骤3:修改产品信息,点击【保存】,修改成功,页面自动跳转到产品详情信息页面,产品详情变更为修改后的产品信息产品删除
为方便广大开发者的产品管理,可以把暂时不需要用到的产品移至回收站。无论是产品被删除至回收站,还是存在于设备列表中,产品本身数据点及名称、应用属性等数据均不会改变,依旧可以正常使用。进入产品信息编辑页面,点击页面的【删除】,弹出删除确认提示框,点击提示框内【确定】,即可將产品移至回收站,如图:https://gizwits.kf5.com/attachments/download/525207/00156e92824eed8436dcea486f3e4fa/同时,为保证产品在使用上不受影响,删除的产品也可以在回收站中进行还原操作。数据点已进入产品管理页面,点击产品管理页面的”数据点“选项,进入产品数据点页面,如图:https://gizwits.kf5.com/attachments/download/525214/00156e92874cb9398ae08ccc240f342/可继续对产品数据点执行添加,编辑,删除动作,也可以将此设备的数据点方案另存为模板,在开发同类型设备时可重复使用。数据点具体操作请戳数据点定义。虚拟设备点击产品管理页面的”虚拟设备“选项,进入虚拟设备页面。点击页面【启动虚拟设备】,即可登录虚拟设备https://gizwits.kf5.com/attachments/download/525223/00156e928e00f7e8117a8b528ca541a/虚拟设备具体使用请戳调试工具运行状态点击产品管理页面的”运行状态“选项,进入运行状态页面,实时显示设备信息,可以辅助调试:https://gizwits.kf5.com/attachments/download/525234/00156e929399a8620f6a4b28c6ae767/产品开发资源点击产品管理页面的”产品开发资源“选项,进入产品开发资源页面,显示产品开发资源,MCU开发资源,轻应用开发资源3项:https://gizwits.kf5.com/attachments/download/525239/00156e9296f0878a91ba2e19131312b/
3-数据点定义
机智云云端,APP对设备上报的数据进行分析、处理,或设备对机智云云端,APP下发数据进行分析、处理,前提是双方明确数据的含义。机智云后台提供了数据点的定义界面,通过数据点定义,设备与云端、APP端数据通信的含义将得到明确。数据点定义的好处:
[*]明确设备与云端、APP端数据通信的含义。
[*]云端根据数据点定义,解析设备数据,用户可使用“设备运行状态”,“统计分析”等功能。
[*]机智云具有大数据统计接口,通过接口,可快速分析设备数据。
[*]方便APP开发者开发,APP SDK可解析下发/上报等设备数据。
[*]方便MCU开发,机智云根据数据点定义,生成MCU与GAgent通信详细串口通讯协议。
数据点定义之数据点定义步骤:1. 进入硬件接入,选择相应“设备”。如下图:https://gizwits.kf5.com/attachments/download/529067/00156eb6e713ba62aa13ed2b37cf743/2. 选择“数据点”,“新增数据点”https://gizwits.kf5.com/attachments/download/529075/00156eb6e95869a6d9b99fe980680cc/3. 填写数据点“标识名”,“读写类型”,“数据类型”,及“备注”。https://gizwits.kf5.com/attachments/download/529079/00156eb6eb357271c4f14a06178ae62/4. 对已存在“数据点”可进行重新编辑、删除。https://gizwits.kf5.com/attachments/download/529083/00156eb6ed36d8cc2ccf213d63755c9/5. 数据点定义完成后,点击应用。同时可以选择将该产品数据点定义保存为模板,创建新产品时候,可直接引用该产品数据点。https://gizwits.kf5.com/attachments/download/529084/00156eb6eeb419f2231ac4fcc7c3d1c/数据点定义之数据点详解:数据点定义基本内容可分为显示名称,标识名,读写类型,数据类型及备注。概图如下:https://gizwits.kf5.com/attachments/download/529095/00156eb6f2eaad7f16011590ddbd1eb/1. 显示名称:请用最清晰的方式描述一个数据点的名称,默认为等于“标识名”,点击编辑可修改“显示名称”。支持所有中英文及符号字符类型(为了正常显示请避免使用特殊字符)。不在硬件端存储传输,用于虚拟设备及IoE Demo App开发调试时的识别。2. 标识名:用于应用层传输,客户端或业务云开发时需要使用,不在硬件端存储和传输。命名规则遵循标准的开发语言变量名命名规范,支持英文字母、数字和下划线,以英文字母开头。3. 读写类型:① 只读:表示该数据点非控制,数据类型可为布尔值/枚举/数值/扩展等。云端/客户端无法对该数据点数据做出下发控制,只能设备端上报该数据点数据。例如“微信宠物屋”,“红外传感器故障”该数据点。② 可写:表示该数据点可控制,数据类型可为布尔值/枚举/数值/扩展等。设备端可上报该数据点数据;云端/客户端可对该数据点数据做出下发控制。例如“微信宠物屋”,“开启/关闭红色灯”该数据点。③ 报警:表示该数据点非控制,数据类型需为布尔值。云端/客户端无法对该数据点数据做出下发控制,只能设备端上报该数据点数据。例如“微信宠物屋”,“报警1”该数据点。④ 故障:表示该数据点非控制,数据类型需为布尔值。云端会对设备上报的该数据点做统计,可在“运行状态”查看。云端/客户端无法对该数据点数据做出下发控制,只能设备端上报该数据点数据。例如“微信宠物屋”,”报警1”该数据点。4. 数据类型:① 布尔值:表示两个状态:0,或1。如开关状态等,建议使用布尔数据类型。例如“微信宠物屋”,“开启/关闭红色灯”该数据点。② 枚举类型:可定义一个有限的取值集合,每2个值占用1bit。当定义的某个功能(元器件)有固定的若干个值。例如“微信宠物屋”,“设定LED组合颜色”该数据点。③ 数值:填写数值范围,数值可为负数/小数,机智云自动将数值转换为正数。例如“微信宠物屋”,“设定电机转速”该数据点。④ 扩展:填写数据长度,数据内容由用户自定义。机智云不建议使用此类型数据,因为此类型数据机智云无法识别,也就无法使用机智云其他的各种基于数据分析的服务和增值服务。5. 备注:选填,用一段文本描述当前数据点的功能及定义方法,对字符格式不做限制。只用于提高数据点的易读性,如果需要团队协作开发,建议规范填写。数据点定义之编辑数据点: 针对不同类型数据格式,需要填写的参数均有所不同,以下分别对不同数据类型提供编辑方法:1. 布尔型数据类型添加/编辑方法: 布尔型是最简单的格式类型,没有参数,只有两个值:true (1) 、false (0)。如图https://gizwits.kf5.com/attachments/download/529101/00156eb6f61e2d49f4401a82582223a/2. 枚举型数据类型添加/编辑方法: “数据类型”选择[枚举]类型后,在“枚举范围”文本框中直接输入枚举值,每一个值使用英文逗号“,”隔开。点击保存提交后,程序将自动为每一个枚举值添加一个序号,客户端或硬件端开发直接使用枚举序号。如图https://gizwits.kf5.com/attachments/download/529104/00156eb6f7c00899ced9c23a53f2c5b/3. 数值型数据类型添加/编辑方法: “数据类型”选择[数值]类型后,出现数据范围和分辨率文本框,数据范围输入最小值和最大值,分辨率可理解为调节的精度或元器件本身支持的最高精度。数据点编辑如下图。数值类型数据点分辨率的换算方法,可见下文“数据点定义之数值型数据类型换算实现原理”。https://gizwits.kf5.com/attachments/download/529107/00156eb6fa24221bb98a905a5c80349/4. 扩展型数据类型添加/编辑方法: “数据类型”选择[扩展]类型后,出现“数据长度”必填文本框,开发者可输入小于等于2047(单位Byte)的正整数。本质上就是约定了一条指令为此数据点保留的空间长度。数据点定义之数值型数据类型换算实现原理: 如以上提到,在定义数值型数据点的时候,取值范围可以使用包括小数、负数等非uint类型数值,熟悉嵌入式开发的开发者会知道,这些数值在设备端都是不被支持的。机智云为了让设备功能定义更加简单直接、所见即所得,研究出来一套算法,用于将用户输入的数值转换成设备能够识别的uint类型,这套算法的核心公式是:y=kx+m。 y表示“显示值”,就是用户可见的最终数值,也是数据点定义时输入的值。包括 Ymin(最小值) 和 Ymax(最大值)。 x表示“传输值”,就是实际指令间传输使用的数值,云端/客户端接收到的值。一定是uint格式。也包括 Xmin 和 Xmax。 k表示“分辨率”,就是用户输入的分辨率一值,确定了每个取值的步进。 m表示“取值偏移量”或“增量”,算法通过m值将y值偏移到满足x值uint格式的要求,m值默认等于Ymin,确保Xmin=0 。 以下用一个电子温度计举例说明换算过程 数据点内容: 取值范围:-30(Ymin) ~ 50(Ymax),分辨率:0.1根据公式:y=kx+m,m默认等于Ymin -30Xmin = (-30+30) / 0.1 = 0Xmax = (50+30) / 0.1 = 800
4-管理应用
根据不同的平台类型,APP开发者首先需要在开发者中心创建应用,并將产品与应用关联起来。创建应用步骤如下:1、进入应用管理页面点击【应用管理】链接,成功跳转到应用管理页面,显示应用列表详情,如图1-1;当前无应用,提示“您还没有添加任何应用”,点击右边的“添加新应用”按钮进行添加。https://gizwits.kf5.com/attachments/download/524979/00156e91baa20092db81325ea92781e/图1-12、创建新应用2.1页面显示点击【创建新应用】按钮,弹出创建应用窗口,如图1-2。https://gizwits.kf5.com/attachments/download/524987/00156e91bee9fee6f4d229f4a3aa0be/图1-22.2平台类型分iOS、Android、微信Web应用等类型。2.3用户系统同一款应用,Andriod、iOS已经微信的Web应用需要在创建时就进行绑定才能共用一个用户系统。独立用户系统:一个应用独立一个用户系统。绑定已有用户系统:指几个应用相互绑定共用一个用户系统,只有新创建的应用可以进行绑定旧应用。2.4输入应用名称输入应用名称,默认选择平台为iOS,首个应用只能选择独立用户系统(绑定已有用户系统置灰),如图1-3。https://gizwits.kf5.com/attachments/download/524990/00156e91c1f6cf26e34e92b4fe03980/图1-32.5成功创建应用,如:微信宠物屋点击【添加】按钮,成功创建应用,如图1-4,生成以“微信宠物屋”命名的应用。https://gizwits.kf5.com/attachments/download/524995/00156e91c54ec79dc9b4462eaf41879/图1-43、应用管理信息在应用的详情页面中,可以看到该应用的名称、所选的平台类型、用户系统等信息,其中,App ID:在SDK调用过程中唯一的一个应用标识(默认自动生成)。App Secret:调用API时的Token,用来验证请求的合法性,请注意保密(默认自动生成)。3.1应用无设备接入
无设备接入时提示“您还没有接入任何设备”,如图1-5。https://gizwits.kf5.com/attachments/download/525012/00156e91dc8550d20855c68b9349ff8/ 图1-53.2设备接入应用绑定应用就是將设备与应用进行关联,这样应用才可以对设备进行绑定控制等操作。如何绑定设备呢?首先进入设备列表,再进入(如产品“微信宠物屋”)产品详细信息页面。可以看到已绑定的应用模块信息(当前无绑定应用),如图1-6;https://gizwits.kf5.com/attachments/download/525015/00156e91dfe442b3a87bda569a21493/ 图1-6点击【绑定应用】按钮,弹出窗口,勾选需要绑定的应用再保存,此时在应用详情页面可以看到设备接入应用成功,当前设备存在于设备列表中,如图1-7。https://gizwits.kf5.com/attachments/download/525026/00156e91eb0d7dc17ba33e4cabe3782/
图1-73.3配置消息推送机智云Android/ios应用支持接入“百度云推送”和“极光推送”。在接入之前需配置消息推送,需將应用与百度推送或极光推送绑定。点击操作目录下的【配置消息推送】,可根据自身需求进行配置,在推送服务选择栏中,可选择“百度云推送”或“极光推送”(选择对应的选项后,有显示蓝色链接为“点击前往百度申请”或“点击前往极光申请”,点击链接可前往相应的网站申请所需的值,如百度的API Key和Secret Key或极光的App Key和Master Secret),输入申请到的key,点击【绑定】按钮即可。当成功绑定消息推送后,显示如图1-8,如“已绑定百度云推送服务”或“已绑定极光推送服务”。https://gizwits.kf5.com/attachments/download/525060/00156e920b2790a2a981f38c45fcd1d/图1-8消息推送绑定成功后,如想更换新值,先删除旧值,再输入新值,点击【确认修改】按钮即可更改为新值;或想更换推送方式,需先解除绑定再重新选择新的推送服务方式。 3.4修改应用信息可以对当前的应用名称进行修改。3.5删除应用对已经准备要丢弃的用户系统应用,可以直接点击【删除应用】,再点击【确定删除】按钮,便可直接删除。如果非准备丢弃的应用,请慎操作(警告:该操作是不可恢复的)。3.6第三方授权登录信息点击【关联第三方登录】链接,弹出关联窗口,按提示去腾讯开放平台申请APP ID,完成关联。完成后,会显示对应值的,此时【关联第三方登录】显示为【取消关联第三方登录】。注:目前仅支持QQ授权登录的关联,点击前往腾讯开放平台申请APPID关联再集成机智云SDK至您的APP进行登录校验。https://gizwits.kf5.com/attachments/download/525073/00156e921498d3d0a966c8b73f2b20e/ 图1-93.7取消关联第三方登录点击【取消关联第三方登录】链接,弹出窗口如图1-10,点击【确认取消】按钮,便可以取消关联第三方登录。https://gizwits.kf5.com/attachments/download/525075/00156e9218db7995e6a8f44e287845d/ 图1-10
楼主整理好详细!! 点赞点赞,谢谢楼主分享:) 谢谢楼主分享
页:
[1]