基于GoKit的产品开发指导

GizWits文档技术指导说明书-1-基于GoKit的产品开发杰升.北京2014/9/30编制人Sean审核人批准人产品名称产品型号文档编号会签日期版本0.9.0GizWitsGizWits文档技术指导说明书-2-修订记录修改时间修改内容版本修改人备注2014-09-30创建0.9.0SeanGizWits文档技术指导说明书-1-目录1.开发GOKIT........................................................................................................................................................11.1.开发过程（思路）............................................................................................................................................11.2.了解GOKIT..........................................................................................................................................................11.3.定义新产品........................................................................................................................................................11.4.选择产品模板....................................................................................................................................................11.5.调整产品参数....................................................................................................................................................21.6.生成MCU协议..................................................................................................................................................31.7.生成虚拟设备....................................................................................................................................................31.8.GOKIT工程与调试..............................................................................................................................................41.9.协议细节............................................................................................................................................................41.9.1.WIFI模块获取MCU基本信息..................................................................................................................41.9.2.WIFI读取MCU属性..................................................................................................................................51.9.3.设定LED的R值........................................................................................................................................51.9.4.设定LED的G值........................................................................................................................................61.9.5.设定电机转速............................................................................................................................................71.9.6.MCU主动上报状态...................................................................................................................................72.以GOKIT为例，开发新产品............................................................................................................................8GizWits文档技术指导说明书-1-1.开发GoKit1.1.开发过程（思路）1)了解GoKit－了解GoKit能够支持的硬件功能2)定义新产品－基于这些硬件功能设计一个简单产品3)选择产品模板－选择一个已有的类似产品作为模板快速定义产品4)调整产品参数－根据自己产品的需要对模板中的各属性字段（数据点）进行添加、删除或修改5)生成MCU协议与示例代码－产品数据点保存后，立即生成完成的MCU开发协议以及对应的示例代码6)生成虚拟设备－如果您没有GoKit开发板，不需要再做任何的MCU开发，生成的虚拟设备已经具备你所设计的产品功能7)GoKit工程与调试－在您创建的GoKit工程中，添加示例代码，即可完成MCU协议数据的解析和组包，您只需完成对IO口的操作即可8)协议细节－当然，如果您想详细了解MCU协议，我们会给您一一介绍1.2.了解GoKitGoKit能够提供的硬件功能为：1)一颗STM32F103C8T6芯片，LPFQ封装，提供JTAG编程接口；2)一个红外探测器，可以探测是否有阻挡；3)一个R、G、B可编程全彩LED灯；4)一个可编程电机；5)一个温湿度传感器；6)一个复位按键和四个自定义按键，可以根据需要自行设定，比如按键改变电机转速、按键改变LED颜色等；此外，GoKit提供USB串口，可以更方便的对MCU进行调试或者升级。1.3.定义新产品基于GoKit提供的以上功能，我们可以设计一些简单且实用的产品，比如小狗宠物屋，我们设计这款产品功能如下：1)当小狗在屋里的时候，LED亮绿色，当小狗不在屋的时候，LED亮红色，当小狗连续一个小时不在屋的时候，上报一条报警给主人；2)当温度达到或者超过28度的时候，打开宠物屋的排风扇（电机），当温度降到28以下的时候，关闭宠物屋的排风扇（电机）；以上两个功能就可以很好的完成一个智能产品，当然，你也可以定义很多有趣的产品，比如儿童玩具之类的。接下来我们可以以一个已有的产品模型为基础进行快速开发；1.4.选择产品模板我们选择GoKit开发模板，会自动出现已经定义好的数据点，如下图所示：GizWits文档技术指导说明书-2-1.5.调整产品参数小狗宠物屋这个产品中，我们需要关心的属性有：1)LED的颜色R值（红色）2)LED的颜色G值（绿色）3)环境温度4)电机转速5)红外探测这五个属性值保留，并使用默认的配置，其余的属性可以删除；如下图所示：GizWits文档技术指导说明书-3-五个属性分别可以进行更详细的编辑：1)LED的R值（红色），用RGB表示发，一共有0-254种红色（数据范围为0-254），所以，我们用一个字节就可以描述（数据类型为uint8），这个属性是可以设定也可以读取的（读写类型为可写），由于没有负数，也没有浮点，MCU可以直接用一个字节描述这个属性，所以不需要做修正，所以分辨率为1，增量为0；2)LED的G值定义同上；3)环境属性，我们定义温度范围为0-50度，用一个字节可以表示（数据类型是数据，uint8），这个属性仅能读取，不能设置（读写属性是只读），同样不需要修正（k＝1，m＝0）；4)红外探测属性，可以探测是否有阻挡（是一个布尔类型），仅能读取（读写类型为只读）；5)电机转速我们定义范围0-1000，0表示停止，用两个字节描述，不用修正；1.6.生成MCU协议数据点保存后，会生成如下的MCU协议，协议在下文有详细解释：FFFF00050101000007FFFF00470201000030303030303030343030303030303032303030303030303130303030303030316436396166353965333863373131653461323964353235343030353238373664012CCAFFFF000603020000020dFFFF0010040200000355aabbcc80008023000042FFFF000d03040000010200CC00000000e3FFFF0005040400000dFFFF000d0305000001040000BB000000d5FFFF0005040500000eFFFF000d03070000011000000000e00008FFFF00050407000010FFFF0010050100000455aabbcc800080230103c7FFFF0005060100000c1.7.生成虚拟设备产品属性（数据点）定义好以后，就会自动生成虚拟设备，即使没有GoKit开发板，您也可以使用虚拟设备进行调试，虚拟设备的使用，可以参考文档中心的快速开始；虚拟设备操作页面如下图所示：GizWits文档技术指导说明书-4-1.8.GoKit工程与调试到此，可以进行代码开发了，在后期，我们会提供根据产品定义自动生成的代码片段，您可以创建一个标准的MCU工程，在您的工程中添加我们为您的产品生成的代码片段，这部分代码片段，完成了协议的解析，命令的组包，校验和的计算等各种问题，您只需要传入属性值就可以输出完成的状态包，您收到命令后，可以方便的进行命令拆分；具体的试用方法，参见代码片段中的注释说明。通过这些协议，可以方便的管理GoKit上的各个硬件，只需要在MCU中对响应I