传统门禁边缘解决方案使用手册
更新时间:2020-07-02 18:15:20
传统门禁边缘解决方案使用手册
服务介绍
边缘网关门禁服务通过边缘方案集成本地门禁系统,把本地系统、老旧存量系统接入阿里云IoT云,实现设备、系统上云。
方案支持传统的卡式门禁、密码门禁、二维码门禁等,为不同类型的门禁提供了标准数据模型和服务模型。这些标准模型可以由其它平台集成,实现系统控制(下行)和业务感知(数据上行)的业务闭环。
系统用户
门禁服务的用户根据角色不同分为两个:
门禁开发商
- 集成门禁服务的系统能力,为门禁系统集成开发商提供门禁系统的应用能力
集成开发商
- 使用门禁SaaS平台应用和配置系统,实现业务能力。
下面的操作说明也分别为这两种用户说明各自业务领域的实现操作。
门禁开发商
门禁开发商通过门禁SaaS平台为集成开发商提供完整的门禁应用能力。
打造完整的业务闭环需要:
- 创建并部署边缘网关设备
- 通过云端接口把本地设备添加到云端
- 设备授权
- 集成云端门禁服务能力,开放给集成开发商
a. 管理设备
b. 配置门禁卡
c. 应用二维码门禁
d. 应用密码门禁
e. 远程开门 - 为集成开发商授权设备
传统门禁边缘解决方案架构
图1. 传统门禁边缘解决方案整体架构
图2. 传统门禁边缘解决方案功能
传统门禁边缘解决方案API
云端对接API
边缘网关对接API
应用开发说明
创建应用环境
步骤1:创建应用组
进入阿里云“智能人居开放平台”,网址:https://homelink.iot.aliyun.com。
打开左侧菜单中“应用组管理”页面,点击右上角的“新建应用组”:
项目名称:自定义,示例中是“门禁边缘网关项目”
账号体系:参考账号服务
点击“保存”完成。
步骤2:创建开发应用
打开左侧菜单中“项目管理”页面,在列表中找到上一步创建的项目,点击进入详情页。
选择“自有Web应用”标签,点击“立即创建”新建自有Web应用。
- 应用名称:自定义,示例中为“门禁边缘网关应用”
点击“确定”完成,可以在列表中看到刚创建的应用:
点击刚创建的应用,妥善保管AppKey和AppSecret。开发门禁应用时,AppKey和AppSecret将作为访问阿里云IoT的重要身份凭证,不要将AppSecret泄漏给他人。
步骤3:导入账号
如果使用了“自有账号体系”,可以点击“WebOA Java SDK下载”按钮,下载三方账号接入的SDK。使用上一步分配的AppKey/AppSecret使用SDK中的API批量导入账号,API说明见文档。
步骤4:服务授权
在“智能人居开放平台”创建项目后,需要开通一系列服务授权,才能使用服务API。请联系对接的商务同学申请线下的服务开通。
步骤5:绑定设备
使用“智能人居开放平台”API接入(绑定)设备到当前租户下。绑定设备后,可以使用“智能人居开放平台”的业务能力实现更丰富的功能。
(此功能暂时未开通)
开发门禁应用
开发门禁应用参考
云端对接API>>
系统授权
步骤1:申请设备授权开通
门禁服务需要门禁开发商把设备授权给集成开发商,授权功能需要线下开通。
请联系商务同学申请开通设备授权功能。
步骤2:进入控制台
同上。
步骤3:授权设备
打开左侧菜单中“开发服务”=>“资源划归”页面,点击进入“授权”页,再选择“设备”页:
点击“授权设备”按钮
产品:选择上面创建的边缘网关产品,示例中是“门禁边缘网关设备A”
- 注意,如果产品未发布,会提示“该产品尚未发布,请先到产品详情发布产品”,参考“配置边缘网关”的步骤2。
设备:选择“门禁边缘网关设备A”的设备实例,示例中是“edgeEntranceGuardDeviceA-001”
对方阿里云账号ID:根据要授权的租户填写。
点击“确定”完成。
如果阿里云账号ID不存在,会提示“输入的阿里云账号不存在。”。这时需要您联系对方确认账号ID的有效性。
完成授权设备后,对方(如集成开发商)可以在“物联网平台”的控制台上看到被授权的设备。
集成开发商
集成开发商根据门禁开发商提供的设备信息,可以订阅到相关设备的数据。
以下流程指导集成开发商如何实现设备数据订阅。
订阅门禁设备
集成开发商可以订阅门禁设备的数据。
步骤1:查询网关设备
打开左侧菜单中“设备管理”=>“设备”页面,查找网关设备。
点击“查看”打开设备详情页面,保存设备的ProductKey和DeviceName
步骤2:订阅设备数据
使用设备消息订阅接口(/entrance/paas/device/subscription/modify)订阅需要的设备数据。
接口见《门禁服务API手册》,请联系商务同学索要。
如果要:
查询已有订阅,使用“查询订阅消息推送设备列表”接口,/entrance/paas/device/subscription/query
删除设备订阅,使用“删除设备消息推送订阅”,/entrance/paas/device/subscription/delete
创建数据通道
用IoT平台提供的数据推送能力,通过H2通道可以实时接收设备数据和数据模型的变更通知。
步骤1:确认身份参数
找开阿里云控制台,点击“账号”进入详情页:
鼠标移动到详情页右上解的个人信息,在菜单中选择“accesskeys”
在弹出页,根据已有AccessKey选择:
- 继续使用AccessKey
如果没有可用的AccessKey,则“创建AccessKey”,或者把已有accessKey保存起来准备下一步使用。
步骤2:配置数据模型
参考:“阿里云物联网平台”的“数据总线”配置数据模型。
选择“iot_entrance_event_model 门禁通行事件模型”
步骤3:订阅数据模型
参考:“阿里云物联网平台”的“服务端订阅设备消息”建立订阅通道。
数据模型
门禁通行事件
模型ID:iot_entrance_event_model
模型版本:1.2
属性列表:
属性名称 | 属性标识符 | 数据类型 | 数据描述 | 必须 |
---|---|---|---|---|
租户 | tenantId | String | 租户 | 是 |
IoT体系用户标示 | identityId | String | IoT体系用户标示 | 是 |
用户姓名 | name | String | 用户姓名 | 是 |
事件时间 | time | Date | 事件时间 | 是 |
IoT设备标示 | iotId | String | IoT设备标示 | 是 |
通行类型 | type | String | 通行类型 - CARD门禁卡 - PASSWORD密码 - QRCODE二维码 |
是 |
密码号码 | number | String | 密码号码 | 否 |
门禁卡号 | cardId | String | 门禁卡号,只有type是CARD的时候有效 | 否 |
通行方向 | direction | String | 通行方向,ENTRANCE 进, EXIT 出 | 否 |
用户扩展信息 | userExtInfo | String | 用户扩展信息 | 否 |
设备扩展信息 | devExtInfo | String | 设备扩展信息 | 否 |