轻应用平台操作手册v1 3 1

第 1 页 共 20 页 轻应用平台操作手册 内部资料 禁止外传 2018.09.06 第 2 页 共 20 页 目录 1 前言 . 3 2 阅读对象 . 3 3 操作流程图 . 3 4 特殊说明 . 4 5 轻应用入口 . 4 5.1 登录 . 4 5.2 创建产品. 5 5.3 设置产品. 6 5.4 调试产品. 8 6 【H5 研发-使用模板】操作流程 . 10 6.1 设置配网页. 10 6.2 选择模板. 12 6.3 设置功能参数 . 13 6.4 设置显示顺序 . 14 6.5 下载 APP . 15 7 【H5 研发-自主研发】操作流程 . 16 7.1 设置配网页. 16 7.2 上传应用文件 . 18 7.3 下载 APP . 19 8 【NATIVE 开发】操作流程 . 20 第 3 页 共 20 页 1 前言 本手册面向设备厂商，通过功能说明、操作步骤、界面展示等多种形式进行介绍， 让用户更快掌握使用。 2 阅读对象 本手册操作说明面向设备厂商及个人开发者。 3 操作流程图 选择 【使用模板】 开始 跳转至轻应用设置配网页 用户是否属于zigbee或 者andlink配网方式 提示：无法使用模板， 请选择其他方式 判断是否完成配网页 物料信息填写 选择模板 选择自定义模板选择标准模板 设置功能参数显示功能参数 设置显示顺序 下载APP 结束 是 是 否 否 在合作伙伴门户创建产品并调试通过 选择 【自主研发】 选择 【本地研发】 跳转至自主研发设置配网页 上传配网页zip包 下载APP 结束 联系和家亲APP进行本地开 发 结束 在合作伙伴门户选择配置APP后 跳转至轻应用 第 4 页 共 20 页 以上是轻应用三种方式的操作流程图，用户可根据实际情况进行选择。 4 特殊说明 1、使用测试 APP 进行设备配网页调试 2、使用调试 APP 进行设备管控页调试 3、配网页和管控页调试可并行，无需使用测试 app 先进行配网才能进行管控页调试 4、支持杭研网关或者杭研网关+云网关的设备，调试管控页前，需要先绑定模拟网关后，下 载调试 APP 进行调试。调试 APP 下载路径如下： Android：05:1080/jssdk/cmccUniversalApp-debug-prod.apk 测试 APP 下载路径如下： Android：05:1080/jssdk/cmccUniversalApp.apk iOS：05:1080/jssdk/cmccUniversalApp.ipa 5、 仅支持云网关的设备， 调试管控页前， 无需绑定模拟网关和调试 APP， 直接下载测试 APP 进行调试即可。测试 APP 下载路径如下： Android：05:1080/jssdk/cmccUniversalApp-AP.apk iOS：05:1080/jssdk/cmccUniversalApp-AP.ipa 6、支持更换配置方式，改选时，已配置的内容将清空。 5 轻应用入口 5.1 登录登录 功能描述 登录合作伙伴门户。 操作说明 1、打开合作伙伴门户，点击“登录”按钮进入登录页面。 2、输入账号及密码，即可登录。 界面展示 第 5 页 共 20 页 5.2 创建产品创建产品 功能描述 为设备创建新产品。创建产品后即可填写产品资料，也可以在自服务调试过程中随 时填写，产品资料已提交且通过审核后方可申请入库。 功能描述 1、点击“产品列表-创建新产品” ，进入创建新产品页面 2、填写产品分类、产品名称、产品品牌（可添加） 、连接类型、产品描述（非必填） 等信息 3、选择“保存产品并去填写资料”跳转至填写资料页面；选择“只保存产品”跳 转至产品列表页，此产品出现在“开发中的产品”列表中；选择“取消”跳转至产品列 表中，无此产品信息。 第 6 页 共 20 页 界面展示 5.3 设置产品设置产品 功能描述 设置产品功能、APP 模板以及硬件模组。 操作说明 1、设置产品功能。包括推荐功能及自定义功能。推荐功能是根据设备类型提供的； 自定义功能是根据产品特点用户自行添加的。 2、APP 模板。首先需要确认选择研发方式，包括 H5 研发-使用模板、H5 研发- 自主开发和 Native 开发。 然后确认设备已调试完成， 此时方可编辑 APP 界面。 点击 “编 辑 APP 界面”跳转至新标签 APP 设置界面。 3、硬件模组。可进行模组开发和定制。 界面展示 第 7 页 共 20 页 第 8 页 共 20 页 5.4 调试产品调试产品 功能描述 下载模拟网关，连接设备并调试。调试成功后方可进行 APP 界面配置。 第 9 页 共 20 页 操作说明 1、下载管控模拟网关，绑定模拟网关至平台。 2、将设备绑定至模拟网关。 3、进行设备功能参数调试。无实体设备时，需借助 MQTT 等工具模拟设备命令上 报。设备命令下发在门户上可操作。 界面展示 第 10 页 共 20 页 6 【H5 研发-使用模板】操作流程 6.1 设置配网页设置配网页 功能描述 添加配网所需物料信息。 操作说明 1、添加设备： 1.1 示意图，提供与操作相符的示意图。仅支持 png 格式，推荐尺寸 975*633。 1.2 步骤描述，提供与示意图相符的操作步骤描述。例如：1. 连接电源 2. 等待指 示灯闪烁。 1.3 正确状态描述，提供操作正确时设备的状态描述。例如：绿色指示灯亮起 1.4 错误状态描述【非必填】 ，提供设备连接不上的状态描述。例如：绿色指示灯未 亮起？或者连接不上怎么办？此项不填写页面上不显示。 1.5 错误状态具体内容，包括图片和文字，均为【非必填】 。此项不填写页面上不显 第 11 页 共 20 页 示。图片仅支持 png 格式，推荐尺寸 1054*498 1.6 输入框最多输入 100 字，超过部分限制输入。 1.7 接入方式为 andlink 时，显示“添加设备-AP 模式（云网关） ” 、 “添加设备-快 联模式（杭研网关） ” ；接入方式为 zigbee 时，显示“添加设备” 2、连接设备： 2.1 示意图， 提供与连接操作相符的示意图。 仅支持 png 格式， 推荐尺寸 975*633 2.2 连接设备描述，提供与示意图相符的操作步骤描述。例如：指示灯慢闪，语音 提示“连接中，请稍后” 。 2.3 若连接设备有多步，需要提供每个步骤的图片和相应的操作描述。提供时请做 好标注。如：步骤 1 图片+文字；步骤 2 图片+文字等 2.4 错误状态描述【非必填】 ，提供设备连接不上的状态描述。例如：绿色指示灯未 亮起？或者连接不上怎么办？此项不填写页面上不显示。 2.5 错误状态具体内容，包括图片和文字，均为非【必填】 。此项不填写页面上不显 示。图片仅支持 png 格式，推荐尺寸 1054*498 2.6 输入框最多输入 100 字，超过部分限制输入。 2.7 接入方式为 andlink 时，无此模块；接入方式为 zigbee 时，显示有此模块 3、添加设备失败： 3.1 提供设备连接失败的操作提示，非必填。 3.2 提供与连接失败时的操作提示相符的图片，非必填。图片仅支持 png 格式， 推荐尺寸 1054*498 3.3 输入框最多输入 100 字，超过部分限制输入。 4、当接入方式为 zigbee 时，设备配网页填写包括添加设备、连接设备、添加失败 第 12 页 共 20 页 3 个部分；当接入方式为 andlink 时，设备配网页填写包括添加设备-AP 模式（云 网关） 、添加设备-快联模式（杭研网关） 、添加失败 3 个部分。 界面展示 6.2 选择模板选择模板 功能描述 第 13 页 共 20 页 选择模板，支持自定义模板、标准模板。 操作说明 1.、将鼠标放置在模板上，点击模板，即可选中，选中后出现选中标记 界面展示 6.3 设置功能参数设置功能参数 功能描述 设置功能参数。选择标准模板时，不需要设置功能参数，可以直接进行下一步。 操作说明 1、点击“显示”按钮，设置此功能是否在调试 APP 中显示。最多显示 10 个功能， 固件版本和软件版本不能显示。 2、点击“编辑”按钮，设置此功能的模块名称、数据类型、数据值、模块图标。 3、点击“查看”按钮，查看此功能的参数详情。 界面展示 第 14 页 共 20 页 6.4 设置显示顺序设置显示顺序 功能描述 设置已显示功能在调试 APP 中的显示顺序。 操作说明 1.、使用鼠标拖拽模块调整显示顺序 界面展示 第 15 页 共 20 页 6.5 下载下载 APP 功能描述 为用户提供调试 APP，下载后进行调试。点击“虚拟调试工具”下载 mqtt，通过 此工具模拟设备进行管控页调测。 操作说明 1、手机扫一扫，下载调试 APP。 2、点击完成按钮，关闭当前页签，返回合作伙伴门户 3、点击上一步按钮，返回至上传应用文件页面 4、安装后通过手机号和验证码登录，即可查看设备列表。 5、点击某个设备跳转至设备管控页。 6、打开管控页，选择某个功能进行操作，此时，mqtt 收到设备上报的数据，说明 设备与管控页是联通的，调试成功。 界面展示 第 16 页 共 20 页 7 【H5 研发-自主研发】操作流程 7.1 设置配网页设置配网页 功能描述 添加配网所需物料信息。 操作说明 1、添加设备： 1.1 示意图，提供与操作相符的示意图。仅支持 png 格式，推荐尺寸 975*633。 1.2 步骤描述，提供与示意图相符的操作步骤描述。例如：1. 连接电源 2. 等待指 示灯闪烁。 1.3 正确状态描述，提供操作正确时设备的状态描述。例如：绿色指示灯亮起 1.4 错误状态描述【非必填】 ，提供设备连接不上的状态描述。例如：绿色指示灯未 亮起？或者连接不上怎么办？此项不填写页面上不显示。 1.5 错误状态具体内容，包括图片和文字，均为【非必填】 。此项不填写页面上不显 示。图片仅支持 png 格式，推荐尺寸 1054*498 1.6 输入框最多输入 100 字，超过部分限制输入。 1.7 接入方式为 andlink 时，显示“添加设备-AP 模式（云网关） ” 、 “添加设备-快 联模式（杭研网关） ” ；接入方式为 zigbee 时，显示“添加设备” 2、连接设备： 第 17 页 共 20 页 2.1 示意图， 提供与连接操作相符的示意图。 仅支持 png 格式， 推荐尺寸 975*633 2.2 连接设备描述，提供与示意图相符的操作步骤描述。例如：指示灯慢闪，语音 提示“连接中，请稍后” 。 2.3 若连接设备有多步，需要提供每个步骤的图片和相应的操作描述。提供时请做 好标注。如：步骤 1 图片+文字；步骤 2 图片+文字等 2.4 错误状态描述【非必填】 ，提供设备连接不上的状态描述。例如：绿色指示灯未 亮起？或者连接不上怎么办？此项不填写页面上不显示。 2.5 错误状态具体内容，包括图片和文字，均为非【必填】 。此项不填写页面上不显 示。图片仅支持 png 格式，推荐尺寸 1054*498 2.6 输入框最多输入 100 字，超过部分限制输入。 2.7 接入方式为 andlink 时，无此模块；接入方式为 zigbee 时，显示有此模块 3、添加设备失败： 3.1 提供设备连接失败的操作提示，非必填。 3.2 提供与连接失败时的操作提示相符的图片，非必填。图片仅支持 png 格式， 推荐尺寸 1054*498 3.3 输入框最多输入 100 字，超过部分限制输入。 4、当接入方式为 zigbee 时，设备配网页填写包括添加设备、连接设备、添加失败 3 个部分； 当接入方式为 andlink 时， 设备配网页填写包括添加设备-AP 模式 （云网关） 、 添加设备-快联模式（杭研网关） 、添加失败 3 个部分。 界面展示 第 18 页 共 20 页 7.2 上传应用文件上传应用文件 功能描述 为用户提供 JS-SDK 及接口说明，用户自主开发管控页并进行代码托管。 操作说明 1、上传附件。说明支持 zip 格式的文件。 第 19 页 共 20 页 1.1 上传后显示 zip 包名称和上传完成图标 1.2 可重新上传，上传后将覆盖之前的文件 1.3 可删除，鼠标悬停显示删除按钮，点击删除按钮删除已上传文件。 2、显示文件格式说明。1、选中本地 css、html、JavaScript、image 等文件后直 接压缩为 zip 文件 2、压缩包中主页面名称必须为 index.html 3、下载应用能力 SDK。鼠标悬停帮助说明按钮，显示说明：提供智能家居设备管 理能力及 APP 通用基础能力。点击下载应用 SDK 至本地。 4、JS-SDK 接口详情。鼠标悬停帮助说明按钮，显示说明：查看接口详情。点击打 开新标签页，展示接口文档，与原来相同 5、未上传 zip 包，点击“下一步”提示“请上传管控页文件” 6、点击“上一步”跳转至设置配网页；点击“下一步”跳转至设置管控页。 界面展示 7.3 下载下载 APP 功能描述 为用户提供调试 APP，下载后