門禁物模型
本文檔說明門禁設(shè)備對接的物模型和功能分類，目的是指導(dǎo)廠商如何根據(jù)設(shè)備能力選擇產(chǎn)品品類和能力集。
廠商對接時參考文檔中第1節(jié)物模型選擇需要的能力，再到第2節(jié)的品類支持能力中選擇可以滿足需求的品類。
1. 物模型
門禁設(shè)備的能力各不相同，很多設(shè)備會是幾個能力的組合。IoT針對不同的品類也定義了不同的能力。廠商要根據(jù)設(shè)備的能力需求，確定要對接的品類是否能滿足需求。
下面梳理了各種能力的組合，選定后再根據(jù)第2節(jié)的品類的能力列表選擇適配對接的品類。
物模型中包含了服務(wù)、屬性和事件定義。為了描述方案，下面用前綴標(biāo)識出需要的物模型成員類型：
[P] - 屬性，[E] - 事件，[S] - 服務(wù)
對于物模型中服務(wù)、屬性和事件更詳細的描述，在對接品類時可以查看。
能力 | 需要的物模型 [P] - 屬性，[E] - 事件，[S] - 服務(wù) | 說明 |
二維碼直發(fā) | [S] 新增二維碼 addQrCode [S] 刪除二維碼 delQrCode [E] 通行事件 passEvent [E] 報警事件 alarmEvent | 早期直接通過物模型下發(fā)的二維碼，目前不再使用，只維護存量設(shè)備。 |
密碼直發(fā) | [S] 設(shè)置密碼 setPassword [E] 通行事件 passEvent [E] 報警事件 alarmEvent | 早期直接通過物模型下發(fā)的密碼門禁，目前不再使用，只維護存量設(shè)備。 |
卡同步 | [S] 同步權(quán)限 syncPermissions [E] 異常刷卡 abnormalCreditCard [E] 通行事件 passEvent [E] 報警事件 alarmEvent | 用權(quán)限文件下發(fā)的同步門禁，有獨立事件上報異常刷卡； |
藍牙同步 | [S] 同步權(quán)限 syncPermissions [E] 異常刷卡 abnormalBleCard [E] 通行事件 passEvent [E] 報警事件 alarmEvent | 用權(quán)限文件下發(fā)的同步門禁，有獨立事件上報異常刷卡； |
二維碼同步 | [S] 同步權(quán)限 syncPermissions [E] 通行事件 passEvent [E] 報警事件 alarmEvent | 用權(quán)限文件下發(fā)的同步門禁 |
加密二維碼 | [P] RSA公鑰（加密二維碼）RSAPublicKey | 在二維碼同步門禁基礎(chǔ)上，增加加密功能 |
人臉 1.0 | [S] 同步人臉庫圖片 SyncFacePictures [S] 查詢?nèi)四槻伎剡M度 QuerySyncPicSchedule [S] 查詢布控成功的人臉圖 QueryAddedUserInfo [S] 查詢權(quán)限數(shù) QueryFacePermTotal [E] 人臉比對事件上報 OnMatched [E] 人臉檢測事件上報 OnDetect | 門禁設(shè)備對接推薦的接入版本 通過“部署”、“查詢部署進度”和“查詢?nèi)繖?quán)限”完成整個部署流程。 支持人臉識別和陌生人事件上報； 支持設(shè)備權(quán)限數(shù)查詢； |
人臉 2.0 | [S] 查詢設(shè)備數(shù)據(jù)校驗碼 QueryDataCheckCode [S] 查詢用戶是否存在 QueryUserData [S] 同步人臉數(shù)據(jù) SyncFaceData [S] 同步人臉圖片失敗 OnFacePicError [E] 人臉庫同步確認(rèn) OnSync [E] 上報設(shè)備數(shù)據(jù)校驗碼 PublishDataCheckCode [E] 智能告警 IntelligentAlarm | 門禁設(shè)備2.0版本對接，無特殊需求不推薦對接。 |
人臉特征下發(fā)[1] | [P] 算法版本 FaceAlgorithmVersion [P] 固件版本 FirmwareVersion [P] 支持人臉特征開關(guān) SupportFaceFeature [S] 部署人臉特征 SyncFaceFeatures | 在人臉1.0基礎(chǔ)上，增加人臉特征下發(fā)功能 |
可視對講 | [S] 下發(fā)手機號校驗結(jié)果 NotifyPhoneNumberCheckResult [S] 頒發(fā) SyncSipNumber [S] 同步組號和房間號 SyncGroupIdAndRoomId [S] 查詢 querySipNumber [E] 開門事件 doorOpenEvent [S] 校驗手機號 checkPhoneNumber | 在人臉1.0基礎(chǔ)上，增加可視對講功能。可與室內(nèi)天貓精靈對接。 |
遠程開門-參數(shù)版 | [S] 遠程開門 RemoteControl | 在健康碼對接的基礎(chǔ)上，支持提示消息的開門操作 |
遠程開門-無參版 | [S] 遠程開門 remoteControl | 無參數(shù)版本，只完成開門動作。 |
注：
[1] 人臉特征下發(fā)只適用于人臉1.0物模型。
[2] 物的能力不一定只適用唯一的能力，有些服務(wù)或事件是通用的，可以支持多種能力。
2. 支持的品類
下面列出門禁服務(wù)支持的品類和對應(yīng)的能力集合
分類 | 品類 | 功能 |
智能生活 -> 家居安防 | 人臉識別能力模型/ FaceRecognitionCapabilityModel | 人臉下發(fā) 1.0（不推薦） |
攝像頭/Camera | ||
智能城市 -> 公共服務(wù) | 人臉識別門禁/FaceRecognition | 人臉下發(fā) 1.0 人臉特征下發(fā) |
智能園區(qū) | 刷卡門禁/CardAccess | 卡同步門禁 同步門禁 |
密碼門禁/PasswordAccess | 密碼直發(fā) 遠程開門（無參版） | |
二維碼門禁/QrCodeAccess | 二維碼直發(fā) 遠程開門（無參版） | |
二維碼門禁機/QrCodeAccessControl | 同步門禁 遠程開門 | |
藍牙門禁/BluetoothAccess | 藍牙同步門禁 同步門禁 | |
多功能門禁/MultiAccessControl | 人臉下發(fā) 1.0 人臉特征下發(fā) 人臉下發(fā) 2.0-不推薦 SIP可視對講 同步門禁 加密二維碼 遠程開門 | |
可視對講機門口機/VideoIntercomDoor | 可視對講 | |
邊緣計算 | 人臉識別機/FaceRecognizeDevice | 人臉下發(fā) 2.0 |
攝像頭邊緣節(jié)點/VisionAccessNode | AIBox，支持人臉下發(fā) 2.0 | |
自定義品類 | 自定義品類/CustomCategory | 無預(yù)定義功能，在SI中選擇能力創(chuàng)建 |
注：上面的能力列表只面向門禁領(lǐng)域?qū)Ｓ媚芰Γ瑢嶋H品類物模型可能包含其它能力，不在上表中列出。
權(quán)限計數(shù)服務(wù)
以服務(wù)形式從云端調(diào)用設(shè)備端執(zhí)行實時統(tǒng)計。此統(tǒng)計直接查詢設(shè)備存儲，不受SDK影響。
{
"services":[
{
"identifier":"QueryFacePermTotal",
"method":"thing.service.QueryFacePermTotal",
"name":"查詢設(shè)備上人臉權(quán)限總數(shù)",
"required":true,
"callType":"sync",
"inputData":[
],
"outputData":[
{
"name":"當(dāng)前人臉庫權(quán)限總數(shù)",
"identifier":"FacePermTotal",
"dataType":{
"specs":{
"min":"0",
"unitName":"無",
"max":"1000000",
"step":"1"
},
"type":"int"
}
}
]
}
]
}人臉特征物模型
屬性：
特征下發(fā)開關(guān)屬性 SupportFaceFeature
人臉?biāo)惴ò姹?FaceAlgorithmVersion
設(shè)備固件版本 FirmwareVersion
{
"properties":[
{
"identifier":"SupportFaceFeature",
"dataType":{
"specs":{
"0":"支持",
"1":"不支持"
},
"type":"bool"
},
"name":"設(shè)備是否支持人臉特征下發(fā)"
},
{
"identifier":"FaceAlgorithmVersion",
"dataType":{
"specs":{
"length":"65"
},
"type":"text"
},
"name":"人臉庫算法版本",
"accessMode":"rw",
"required":true
},
{
"identifier":"FirmwareVersion",
"dataType":{
"specs":{
"length":"65"
},
"type":"text"
},
"name":"設(shè)備固件版本",
"accessMode":"rw",
"required":true
}
]
}服務(wù)
人臉特征下發(fā) SyncFaceFeatures
{
"services":[
{
"name":"同步人臉庫特征",
"identifier":"SyncFaceFeatures",
"method":"thing.service.SyncFaceFeatures",
"required":false,
"callType":"sync",
"inputData":[
{
"identifier":"FacePicFeaturesURL",
"dataType":{
"specs":{
"length":"1024"
},
"type":"text"
},
"name":"同步特征文件URL地址"
}
],
"outputData":[
{
"identifier":"SyncPicStatus",
"dataType":{
"specs":{
"0":"成功",
"1":"布控中",
"2":"下載文件失敗",
"3":"解析文件失敗"
},
"type":"enum"
},
"name":"設(shè)備同步圖片狀態(tài)值"
}
]
}
]
}參數(shù)示例：
{"FacePicFeaturesURL":"http://xxxxxx"}特征文件
新增人臉特信息，增加人臉特征字段，類型為字符串?dāng)?shù)組。
features: ["xxxxxxxxxxxxxxxxxx"]完整示例：
{
"groupId": "egqQkuFBPgh8pltWiw1S000100",
"addFaceInfos": [
{
"faceId": "552f3570-4717-4a39-910b-d72542552d89",
"faceMd5": "36c36fa96920e45ca5f00334675484bc",
"faceUrl": "http://xxx",
"userInfo": "{\"userName\": \"Xiao Wang\", \"expire\": \"2020-12-31 23:59:59\", \"policy\": \"DENY\", \"userExtInfo\": \"BLACKLIST\"}",
"features": [ "xxxxxxxxxxxxxxxxxx" ],
"index": 0,
"clientTag": ""
}
],
"deleteFaceInfos": [
{
"faceId": "xxxx"
},
{
"faceId": "yyyy"
}
],
"isCleanAll": false,
"isCleanAllGroup": false
}SIP可視對講物模型
頒發(fā)SipNumber（SyncSipNumber）： SaaS應(yīng)用從SIP server為門禁機申請到SIP number, 通過該服務(wù)將SIP number通過阿里L(fēng)P平臺下發(fā)到門禁機。
同步組號和房間號 (SyncGroupIdAndRoomId) ：當(dāng)SaaS應(yīng)用完成SIP Group創(chuàng)建并錄入房間息后，通過該服務(wù)將GroupID與RoomID的映射關(guān)系表格下發(fā)到門禁機。門禁機在有人發(fā)起可視對講呼叫時，可以根據(jù)房間號查找到對應(yīng)的GroupID，然后發(fā)給SIP server呼叫GroupID里的所有SIP number。
查詢SipNumber（querySipNumber）：當(dāng)SaaS應(yīng)用想查詢某個單元門禁機的SipNumber時，可以使用該服務(wù)
下發(fā)手機號校驗結(jié)果該服務(wù)用在支持通過IPPBX直接呼叫手機的方案使用。