开发文档

平台公告

• 更新日志
  • 2016.01
    • 【规则引擎、消息推送Beta】
    • 【OPEN API】
    • 【开发者中心】
    • 【M2M】
    • 【企业api】
  • 2015.12
    • 【规则引擎、消息推送Beta】
    • 【API】
    • 【开发者中心】
    • 【M2M】
  • 2015.11
    • 【规则引擎、消息推送Beta】
    • 【API】
    • 【M2M】

常见问题

• 机智云功能与服务 Q&A
  • 机智云是做什么的？
  • 机智云跟其他平台有什么不同？
  • 机智云能帮我做什么？
  • 我该如何接入机智云？
  • 机智云可以帮我做app吗？
  • 机智云可以帮我接入微信吗？
  • 怎么使用机智云平台开发工具？
  • GoKit是什么？
  • GoKit能帮我做什么？
  • 怎么申请GoKit？
  • 机智云主要客户有哪些？
• 机智云怎么保证稳定和安全
  • 机智云系统和网络安全
    • 一、操作系统平台
    • 二、云盾防护系统
    • 三、操作系统的日志文件分析
    • 四、系统及软件升级更新
    • 五、系统软硬件状况监控平台
    • 六、系统备份策略
    • 七、 运维人员监控机制
  • 机智云 M2M 安全机制
    • 一、机智云安全机制描述
    • 二、各种攻击行为分析
  • 机智云Web应用程序安全
    • 一、用户登录和权限系统
    • 二、防XSS
    • 三、防CSRF
    • 四、防SQL 注入
    • 五、防文件上传攻击
• 名称解释
  • 机智云
  • GAgent
  • 小循环
  • 大循环
  • Productkey
  • did
  • passcode
  • AppID
  • Onboarding
  • AirLink
  • SoftAP
• OTA升级FAQ
  • OTA简介
    • 1．固件升级OTA是什么？
    • 2．什么样的用户才可以进行OTA操作？
    • 3．产品有什么版本？OTA又有哪些版本？
    • 4．一个完整的OTA升级流程包括哪些操作？
    • 5．wifi固件升级与mcu固件升级有什么区别？
  • 创建新固件
    • 6．添加固件时，我该如何选择用哪一个推送方式？
    • 7．v4与v4.1版本OTA有什么区别？
    • 8．添加固件时硬件版本号、软件版本号该如何输入？应注意哪些？
  • 验证固件
    • 9．为什么不能直接进行固件推送，而是要先验证固件？
    • 10．验证固件时，当被验证设备如果不在线，固件验证能否成功？
    • 11．如何定义固件验证成功？
    • 12．验证固件时，推送完成以后，有时候会显示“设备固件推送升级失败，你可以返回重新尝试”，但是实际上已经有设备推送成功了。为什么提示会这样？
    • 13．为什么验证固件的界面会等待很久？如果验证固件的弹出界面长时间没有反应，该如何处理？
    • 14．验证固件从发起验证开始，大概要等待多长时间？
  • 设备升级
    • 15．OTA是如何筛选目标设备的？
    • 16．为什么在设备运行状态里能看到某个设备在线， 但是在固件升级里添加规则的时候却没找到这个在线的设备？
    • 17．V4版本OTA时，为什么添加了很多固件，但添加规则时检测不到旧固件信息？
    • 18．V3版能升级到V4版吗？
    • 19．为什么V4版本升级的时候需要创建两个固件，但V41版本只需要创建一个固件？
    • 20．按地区的推送时，为什么只出现部分省市可选?
  • 推送完成
    • 21．为什么状态中会出现“已暂停”？
    • 22．固件已推送完成，为什么界面上还显示推送中
  • 查看明细
    • 23．批量推送所有设备，如果有一部分设备不在线，下面的设备全部是否即包含了在线设备，也包含了离线设备？离线设备什么时候才能升级？
    • 24．批量推送固件时，推送成功率如何计算才准确？

硬件接入

• 硬件接入服务简介
• 硬件接入快速开始指南
  • 一、成为机智云开发者
  • 二、创建第一个新设备
  • 三、使用向导完成设备配置
    • 第一步，编辑设备数据点。
    • 第二步：开发硬件功能：
    • 第三步：开始调试你的新设备。
    • 完成并退出向导
  • 四、修改、查看设备信息
    • 设备信息编辑：
    • 数据点编辑：
    • 虚拟设备
    • 运行记录
    • 开发资源下载
  • 五、申请发布
  • 寻求帮助
    • 电话：400 6525 488
    • 在线QQ：800099639
• 数据点编辑指南
  • 一、数据点详解
    • 1、基本描述
      • 显示名称（display_name）：
      • 标识名（name）：
      • 备注（desc）：
    • 2、读写操作类型
      • 只读（status_readonly）：
      • 可写（status_writable）：
      • 故障（fault）：
      • 报警（alert）：
    • 3、数据类型
      • 布尔（bool）：
      • 枚举（enum）：
      • 数值（num）：
      • 扩展（binary）：
  • 二、编辑数据点
    • 布尔型数据类型添加/编辑方法：
    • 枚举型数据类型添加/编辑方法：
    • 数值型数据类型添加/编辑方法：
    • 扩展型数据类型添加/编辑方法：
  • 三、数值型数据类型自动换算实现原理：
• 标准数据点协议文档
  • 数据点协议
  • 获取产品配置
  • SDK 操作数据点指南
  • 数据点样本
• GAgent 产品规格书
  • 1. 产品简介
    • 1.1. 产品名称
    • 1.2. 产品功能
    • 1.3. 系统结构图
    • 1.4. 支持协议
    • 1.5. 模式定义
      • 1.5.1. 生产模式
      • 1.5.2. 配置模式
      • 1.5.3. 工作模式
  • 2. 产品基础信息
    • 2.1. 产品形态
      • 2.1.1. 标准版本形态
      • 2.1.2. 二次开发版本形态
      • 2.1.3. 源码形态
    • 2.2. 产品版本号
      • 2.2.1. 硬件版本号
      • 2.2.2. 软件版本号
      • 2.2.3. Firmware 版本号(发布日期)
      • 2.2.4. 云端 OTA 原则
    • 2.3. 发布名称
  • 3. 硬件规格
  • 4. 模组状态规格
    • 4.1. 指示灯
    • 4.2. WiFi 工作状态
    • 4.3. WiFi 信号强度
    • 4.4. WiFi 信号上报原则
  • 5. 生产模式
  • 6. 配置模式
    • 6.1. 概述
    • 6.2. SoftAP
    • 6.3. WebConfig
    • 6.4. AirLink
    • 6.5. AirKiss
  • 7. 工作模式（小循环）
    • 7.1. 发现
    • 7.2. 获取 Passcode
    • 7.3. SDK（APP）登陆
    • 7.4. 控制与状态
    • 7.5. 模组和 SDK心跳
    • 7.6. 模组和 MCU心跳
    • 7.7. Reset 清空机制
    • 7.8. ProductKey更改机制
  • 8. 工作模式（大循环）
    • 8.1. 名字解释
    • 8.2. 模组注册
    • 8.3. 模组注销
    • 8.4. 模组 Provision
    • 8.5. 模组登陆
    • 8.6. 模组订阅
    • 8.7. 数据转发
    • 8.8. 与 M2M服务器心跳
    • 8.9. MQTT错误字处理
  • 9. OTA
  • 10. 安全性
  • 11. DNS解析原则
  • 12. 故障恢复
  • 13. 日志
• GAgent二次开发技术手册
  • 术语：
  • 一、怎么使用demo
    • 1.编译
    • 2.运行
    • 3.硬件连接
  • 二、结构框图
  • 三、GAgent参数
    • 重要数据结构：
  • 四、目录结构
  • 五、资源统计
  • 六、API列表说明
  • 七、GAgent验证与调试
    • 1.GAgent正常接入GService服务器
      • 获取到GService服务器分配的唯一DID
      • 获取到M2M服务器的域名和端口号信息
    • 2.GAgent正常连接M2M服务器
      • ◎连接M2M服务器，获取到M2M服务器响应
      • ◎成功订阅三个主题：
      • ◎同服务器心跳正常（55秒一次心跳）
      • 1） APP可发现GAgent
      • 2） APP正常绑定GAgent
      • 3. APP在局域网下可登录控制GAgent
      • 4. APP在广域网下可登录控制GAgent
• GAgent测试用例
  • 测试环境搭建
  • WiFi测试最小集
    • SoftAP
    • AirLink
    • 配置成功验证
    • 上电宣告验证
    • 小循环控制
    • 大小循环切换
    • 大循环控制
    • GAgent_OTA
    • 故障恢复
  • WiFi测试最大集
  • GPRS测试最小集
    • 云端注册
    • 大循环控制
    • GAgent_OTA
  • GPRS测试最大集

开放平台

• 开放平台服务介绍
• iOS SDK 集成指南
• Android SDK 集成指南
• 蓝牙接入iOS SDK集成指南
• 蓝牙接入Android SDK集成指南
• Websocket API 指南
• Open API
• 微信硬件接入指南
  • 1、前言
    • 1.1 版权说明
    • 1.2 目标读者
  • 2、微信硬件简介
    • 2.1 简介
    • 2.2 为什么要接入微信
  • 3、微信硬件整体框架
    • 3.1 框架示意图
    • 3.2 各部分功能
      • 3.2.1 设备
      • 3.2.2 机智云
      • 3.2.3 厂商服务器
      • 3.2.4 微信服务器
      • 3.2.5 微信客户端
  • 4、微信硬件用户使用场景
    • 4.1 扫描设备二维码
    • 4.2 配置设备连接网络
    • 4.3 设备连接并开始使用
  • 5、微信硬件接入完整开发流程
    • 5.1 设备开发
      • 5.1.1 通过机智云后台定义设备功能
      • 5.1.2 下载串口协议文档进行MCU开发
      • 5.1.3 设备上线并通过IOE Demo进行调试
    • 5.2 申请微信公众账号并开通设备功能
      • 5.2.1 微信公众账号介绍
      • 5.2.2 使用微信公众测试号
      • 5.2.3 申请微信公众服务号
      • 5.2.4 开通设备功能
    • 5.3 微信公众平台开发服务器配置
      • 5.3.1 概述
      • 5.3.2 第一步：填写服务器配置
      • 5.3.3 第二步：验证服务器地址的有效性
      • 5.3.4 依据接口文档实现业务逻辑
    • 5.4 使用微信公众平台接口与服务器通信
      • 5.4.1 第一步：获取AccessToken；
      • 5.4.2 第二步：根据获取到的AccessToken请求用户列表
    • 5.5 使用机智云Open API与设备通信
    • 5.6 微信公众平台界面开发
      • 1. click：点击推事件
      • 2. view：跳转URL
      • 3. scancode_push：扫码推事件
      • 4. scancode_waitmsg：扫码推事件且弹出“消息接收中”提示框
      • 5. pic_sysphoto：弹出系统拍照发图
      • 6. pic_photo_or_album：弹出拍照或者相册发图
      • 7. pic_weixin：弹出微信相册发图器
      • 8. location_select：弹出地理位置选择器
    • 5.7 注册设备与生成二维码
      • 5.7.1 获取设备二维码
      • 5.7.2 设备授权
    • 5.8 设备生产
• APICloud开发接入文档

统计分析

• 统计分析服务介绍
• BLE(蓝牙4.0)SDK iOS集成指南
  • 第一步：导入文件
  • 第二步：引入头文件并注册你的AppKey
  • 第三步：配置机智云平台的统计分析
    • 工程还未有蓝牙模块：
    • 方案一：使用单一的类来完成蓝牙所有的处理
    • 方案二：使用两个或两个以上的类完成蓝牙处理
    • 工程已有蓝牙模块：
    • 方案一：使用单一的类来完成蓝牙所有的处理
    • 方案二：使用两个或两个以上的类完成蓝牙处理
  • 温馨提醒：一般会实现的蓝牙回调方法
  • 另附：使用机智云IOTSDK蓝牙框架的集成
    • 1.注意事项
    • 2.Framework依赖
    • 3.基本流程
    • 4.方法调用
    • 5.常见问题
• BT(经典蓝牙)SDK iOS集成指南
  • 第一步：将 GizAnalyticsBT导入到你的工程中
  • 第二步：添加依赖框架
  • 第三步：方法调用
    • 一、在- (BOOL)application: didFinishLaunchingWithOptions:方法中调用initWithAppKey方法来初始化GizAnalytics：
    • 二、在负责蓝牙处理的类.h文件里添加EASession的属性
    • 三、在搜索到设备的类，将连接设备相应的EAAccessory,ProtocolString传入到负责蓝牙处理类.m文件自定义的初始化方法中：（初始化方法仅供参考，可视项目实际情况而定）
    • 四、当断开连接时调用
  • 经典蓝牙GizAnalytivsBT集成完毕。
• Android SDK集成
  • 使用机智云BLE SDK
    • 第一步：导入文件
    • 第二步：添加代码
    • 第三步：加入权限
  • 使用Android原生 BLE
    • 第一步：导入文件
    • 第二步：初始化
    • 第三步：加入设备广播统计
    • 第四步：加入封装
    • 第五步：加入权限
  • 使用Android BT
    • 第一步：导入文件
    • 第二步：初始化
    • 第二步：加入权限

Gokit开发套件

• GoKit介绍
  • GoKit的产品使命
  • GoKit 能给您带来什么
    • 如果您是一个产品经理
      • 第一件事情可以这样玩 GoKit:
      • 第二件事情可以这样玩 GoKit:
    • 如果您是一个APP开发者
    • 如果您是一个嵌入式开发者
    • 如果您就想讲一个故事
  • GoKit 是如何做到的
    • GoKit背后是一个完整的产品体系
    • GoKit在系统中的位置
• GoKit上手指南
  • GoKit 2 开箱
    • 打开包装后，你可以看到一个黄色纸皮盒包裹着一个透明亚克力盒。里面的板子就是GoKit2代。
    • GoKit 2代，我们把应用板与主控板分离，使用了Arduino标准接口，你现在可以有两个选择，使用标准的STM32主控板或者兼容Arduino的Atmel主控板。如下图：
    • 应用板依然板载了正反转可调速电机马达、温湿度传感器、红外感应器、RGB全彩LED灯，另外增加了OLED扩展接口，你可以为GoKit配上一块显示屏。
    • WiFi模块方面，目前已经有二十几家国内厂商为机智云做了兼容。而且，现在所有开发者都可以拿到开发库自行开发适配。
  • 第一步：下载 IoE Demo App
    • IoE Demo是机智云推出的智能硬件调试工具，通过IoE Demo App可以对GoKit进行绑定与远程控制等操作，也可以作为其他基于机智云开发的智能硬件项目的调试工具。
    • 你可以通过扫描说明书上的黄色二维码下载并安装IoE Demo，也可以进入机智云开发者中心进行下载，前往下载
    • 为了让开发者更好的掌握客户端开发的技巧，我们提供了IoE Demo的开源版本，前往下载
  • 第二步：将GoKit连接上网
    • GoKit通过WiFi通信模块以无线的方式连接路由器并接入互联网，这里我们需要做的就是把可用WiFi的路由器SSID和密码告诉GoKit（就像你新买的手机需要输入家里的WiFi密码一样）,但GoKit没有键盘和屏幕，如何做到呢？GoKit提供三种配置方式：AirLink 、WebConfig、 SoftAP。下面我们分别学习三种不同的配置方式，大家人选一种即可。
    • AirLink配置入网
      • AirLink配置就是说明书上介绍的方法，实现过程就是：通过按键触发开启设备“AirLink”模式，开启后设备会不断接收特定编码的WiFi广播包，手机连接可用的WiFi网络后，通过指定的App（如IoE Demo）发送编码后的WiFi网络的SSID和密码广播，设备接收到之后自动尝试连接此WiFi网络，连接成功即配置完成。下面一步步完成GoKit通过AirLink接入路由器连接网络吧。（注意：AirLink配置不支持5G的WiFi网络，请使用传统2.4G WiFi信号）
      • 1.智能手机进入“系统设置”连接您附件可用的WiFi网络。
      • 2.打开下载好的“IoE Demo” App，点击主屏幕右上角“菜单栏”中的“添加新设备”。如下图
      • 3.使用USB线为GoKit供电，开机后长按［KEY2］直到［RGB LED］亮绿灯（Arduino版本GoKit短按［KEY2］），表示设备AirLink模式已经开启。如下图
      • 4.IoE Demo APP上输入已连接WiFi的密码，点击配置按钮，等待30秒到一分钟，APP提示配置成功。在此期间，您可以看到GoKit的绿灯熄灭，WiFi模组两个指示灯瞬间熄灭，直到指示灯开始交叉闪烁，这表示GoKit已经连上路由器，配置完成。
    • SoftAP配置入网
      • 由于AirLink配置方式有一定的技术限制，GoKit支持另一种配置方式——SoftAP，实现过程就是将GoKit上的WiFi模组切换到AP模式，手机直接与GoKit连接，并将可用的WiFi网络SSID和密码发送给GoKit，GoKit接收到配置信息后自动尝试连接路由器。具体步骤如下：
      • 1.GoKit正常供电情况下，长按［KEY1］直到［RGB LED］亮红灯（Arduino底板［RGB LED］蓝色闪一下），表示GoKit已经初始化。而GoKit在初始状态下将自动进入“SoftAP”模式。
      • 2.手机进入“系统设置”中的“WiFi设置”，找到“XPG-GAgent-XXXX”（XXXX是你的GoKit MAC地址后4位）并连接此WiFi网络，如需密码请输入：123456789 。
      • 3.打开“IoE Demo” App，此时App会自动进入SoftAP配置模式，选择或手动输入你附近的可用WiFi网络SSIS及密码，点击“确定”。
      • 4.等待30秒到一分钟，当GoKit上WiFi模组的指示灯交叉闪烁时，表示配置完成。
    • Web Config配置模式
      • Web Config是SoftAP配置模式的一种升级，解决了智能硬件配置上网对独立专用App的依赖问题。实现原理与SoftAP类似，但直接使用手机自带的浏览器即可配置。具体步骤如下：
      • 1.GoKit正常供电情况下，长按［KEY1］直到［RGB LED］亮红灯（Arduino底板［RGB LED］蓝色闪一下），表示GoKit已经初始化，而GoKit在初始状态下将自动进入“SoftAP”模式。
      • 2.手机进入“系统设置”中的“WiFi设置”，找到“XPG-GAgent-XXXX”（XXXX是你的GoKit MAC地址后4位）并连接此WiFi网络，如需密码请输入：123456789 。
      • 3.打开手机浏览器，并在地址栏输入“10.10.100.254”即可访问GoKit配置页面，根据提示输入可用WiFi网络SSID及密码，点击配置。
      • 4.等待30秒到一分钟，当GoKit上WiFi模组的指示灯交叉闪烁时，表示配置完成。
  • 第三步：使用IoE Demo控制GoKit
    • 完成GoKit的网络配置后，GoKit已经通过路由器连接互联网，你可以使用“IoE Demo”对GoKit进行状态的查询以及控制（包括局域网和远程）。
    • 绑定设备
      • 确保手机与GoKit连接同一个WiFi网络，打开IoE Demo，刷新设备列表你将可以发现一台未绑定的新设备“微信宠物屋”，如图
      • 点击设备将自动进行绑定，如果你从未注册、登录IoE Demo，GoKit将绑定当前手机，在不更换手机的情况下，你可以对设备进行所有的状态查询与远程控制等功能，更换手机后需要重新在局域网下进行绑定。如果你希望在不同的手机下对GoKit进行控制，可以先注册账号并登录后进行绑定操作，绑定完成后只需使用账号登录，在不同手机都可以对GoKit进行远程控制。
    • 局域网控制设备
      • 绑定完成后，设备显示“局域网在线”，点击进入设备界面，即可查看GoKit最新状态以及进行控制操作。
    • 远程控制设备
      • 保持GoKit连接，手机关闭WiFi或切换到其他WiFi网络，此时”IoE Demo” App将自动识别网络环境并切换到远程连接模式。
  • 第四步：使用微信控制GoKit
    • 微信从5.x版本开始，支持服务号设备功能。通过微信扫描设备二维码关注设备公众号后即可以实现对设备的控制。机智云作为微信设备号首批技术合作伙伴，在GoKit上也加入微信控制的功能，而GoKit也是目前世界上唯一一款开通了服务好设备功能的智能硬件开发板。使用微信控制GoKit具体步骤如下：
    • 1.打开GoKit附带的说明书，找到一张白色二维码（此二维码每台设备唯一，请注意保管）。如图：
    • 2.打开微信扫描说明书上的二维码，点击“关注”并进入公众号。
    • 3.点击“窝窝”，公众号将返回你绑定的设备列表。点击进入设备主界面，如图
    • 4.在此界面上你可以看到宠物屋（GoKit）当前的状态，并可以通过点击“送风”或“抽湿”对GoKit上的电机进行控制。
  • 第五步：开始您的智能硬件开发之旅
    • 到这里，你已经基本上体验了一款基于GoKit开发的智能硬件原型“微信宠物屋”。这仅仅是机智云团队基于GoKit开发的一款Demo产品，而GoKit本身就是一块功能强大的智能硬件开发板，你可以完全根据自己的想法，利用GoKit做出更好玩的产品，这就是你智能硬件创业的第一步。
    • 机智云提供“微信宠物屋”整套Demo的开源代码：
      • “智能宠物屋”MCU源码 for GoKit（1代、2代STM、2代Arduino）
      • “智能宠物屋”Demo App （iOS、Android）
    • 为了让你更快掌握GoKit的开发，我们提供了一系列的教学视频：
      • 进入视频教学
    • 在你开发过程中，会使用到的一系列开发文档：
      • 进入文档中心
    • 如果你需要更多机智云的开发工具及其他资源，请前往下载中心：
      • 进入下载中心
    • 与全国各地智能硬件开发者交流，请前往机智云开发者社区：
      • 加入开发者社区
    • 有任何疑问或技术支持，请联系我们：
      • 机智云众创联盟QQ群：104975951
      • 机智云客服QQ：800099639
      • 机智云客服热线：400-6525-488