开发文档

平台公告

• 更新日志
  • 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
• 数据点编辑指南
  • 一、数据点详解
  • 二、编辑数据点
  • 三、数值型数据类型自动换算实现原理：
• 标准数据点协议文档
  • 数据点协议
  • 获取产品配置
  • 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
  • 二、结构框图
  • 三、GAgent参数
  • 四、目录结构
  • 五、资源统计
  • 六、API列表说明
  • 七、GAgent验证与调试
• GAgent测试用例
  • 测试环境搭建
  • WiFi测试最小集
  • WiFi测试最大集
  • GPRS测试最小集
  • GPRS测试最大集

开放平台

• 开放平台服务介绍
• iOS SDK 集成指南
• Android SDK 集成指南
  • 第一步：将 SDK 导入到你的工程中
  • 第二步：引入头文件和注册 SDK 的 AppID
  • 第三步：设置 XPGWifiSDK Listener
  • 第四步：创建和登录用户账号
  • 第五步：配置设备上线
    • Soft AP 设备配置
    • Air Link 一键配置
  • 第六步：搜索和绑定设备
  • 第七步：设备登录
  • 第八步：控制和接收设备信息
  • Error codes
• 蓝牙接入iOS SDK接入指南
  • 第一步：将 SDK 导入到你的工程中
  • 第二步：引入头文件和注册 SDK 的 AppID
  • 第三步：用户登录
  • 第四步：数据接入
    • 数据上传
    • 获取数据
    • Error codes
• 蓝牙接入Android SDK集成指南
  • 第一步：将 SDK 导入到你的工程中
  • 第二步：引入头文件和注册 SDK 的 AppID
  • 第三步：用户登录
  • 第四步：数据接入
    • 数据上传
    • 获取数据
    • Error codes
• Websocket API 指南
• Open API
  • Gizwits Open API
    • 简介
    • 访问地址
    • SDK
    • 用户信息 [/app/users]
      • 创建匿名用户 [POST]
      • 使用用户名和密码创建用户 [POST]
      • 使用手机号创建用户 [POST]
      • 使用第三方账号（百度/新浪）创建用户 [POST]
      • 匿名用户设置用户名和密码 [PUT]
      • 匿名用户设置手机号和密码 [PUT]
      • 修改密码 [PUT]
      • 修改 email [PUT]
      • 修改手机号 [PUT]
    • 用户登录 [/app/login]
      • 用户登录 [POST]
    • 验证码 [/app/codes]
      • 获取验证码 [POST]
      • 校验验证码 [POST]
    • 重置密码 [/app/reset_password]
      • 使用邮箱重置密码 [POST]
      • 使用手机号重置密码 [POST]
    • 获取设备历史数据 [/app/devdata]
      • 获取设备历史数据 [GET]
    • 绑定关系 [/app/bindings]
      • 获取绑定列表 [GET]
      • 绑定设备 [POST]
      • 解除绑定 [DELETE]
    • 设备信息 [/app/devices/{did}]
      • 获取设备详细信息 [GET]
    • 查询设备 [/app/devices]
      • 根据 product_key 和 mac 查询设备 [GET]
    • 远程控制设备 [/app/control/{did}]
      • 设置数据点 [POST]
      • 发送原始控制指令 [POST]
• 微信硬件接入指南
  • 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上手指南
  • 开箱
  • 关于说明书
  • 下载APP
  • 将您的GoKit连接到您的路由器
    • AirLink配置入网
    • Web Config配置模式
    • SoftAP配置入网
  • 让GoKit亮起来
  • 即使GoKit不在身边依然近在咫尺