The keyfob is an electronic key fob that ate used for controlling access.
To check whether the device supports configuring keyfob, you can call NET_DVR_GetDeviceAbility, set the capability type dwAbilityType to "DEVICE_ABILITY_INFO" (macro definition value: 0x011), and set the input buffer (pInBuf) to XML_Desc_AlarmHostAbility for getting the network security control panel capability.
The capability is returned in the message XML_AlarmHostAbility by pOutBuf. If the node <RemoteController> is returned, it indicates that configuring keyfob is supported.
Function |
Description |
---|---|
Get Keyfob Configuration Capability |
Call NET_DVR_STDXMLConfig to transmit the request URI: GET /ISAPI/SecurityCP/Configuration/remoteCtrl/capabilities?format=json. And the configuration capability is returned in the message of JSON_RemoteCtrlCap by the output parameter (lpOutputParam). |
Get Currently Added Keyfob's Parameters |
Call NET_DVR_STDXMLConfig to transmit the request URI: GET /ISAPI/SecurityCP/Configuration/remoteCtrl/currentAdd?format=json. And the parameters of the currently added keyfob are returned in the message of JSON_RemoteCtrl. |
Get One Keyfob's Parameters |
Call NET_DVR_STDXMLConfig to transmit the request URI: GET /ISAPI/SecurityCP/Configuration/remoteCtrl/<ID>?format=json. And the parameters of a keyfob are returned in the message of JSON_RemoteCtrl. |
Get All Keyfobs' Parameters |
Call NET_DVR_STDXMLConfig to transmit the request URI: GET /ISAPI/SecurityCP/Configuration/remoteCtrl?format=json. And the parameters of all keyfobs are returned in the message JSON_List_RemoteCtrl by the output buffer (lpOutBuffer) of the output parameter (lpOutputParam). |
Set One Keyfob's Parameters |
Call NET_DVR_STDXMLConfig to transmit the request URI: PUT /ISAPI/SecurityCP/Configuration/remoteCtrl/<ID>?format=json, and set the input buffer (lpInBuffer) of the input parameter (lpInputParam) to the message JSON_RemoteCtrl. |
Delete One Keyfob |
Call NET_DVR_STDXMLConfig to transmit the request URI: DELETE /ISAPI/SecurityCP/Configuration/remoteCtrl/<ID>?format=json. |
Funciton |
Description |
---|---|
Get Keyfob User Parameters |
Call NET_DVR_GetDVRConfig with "NET_DVR_GET_REMOTECONTROLLER_PERMISION_CFG" (command No.: 2200). And the obtained keyfob user parameters are returned in the structure NET_DVR_REMOTECONTROLLER_PERMISSION_CFG by the output buffer (lpOutBuffer). |
Set Keyfob User Parameters |
Call NET_DVR_SetDVRConfig with "NET_DVR_SET_REMOTECONTROLLER_PERMISION_CFG" (command No.: 2201) and set the input buffer (lpInBuffer) to the structure NET_DVR_REMOTECONTROLLER_PERMISSION_CFG. |
Get All Keyfob Users |
|
Function |
Description |
---|---|
Get Capability of Controlling Asynchronous Keyfob Adding Mode |
Call NET_DVR_STDXMLConfig to transmit the request URI: GET /ISAPI/SecurityCP/Configuration/remoteCtrl/mode/capabilities?format=json. And the capability is returned in the message JSON_RemoteCtrlModeCap by the output parameter (lpOutputParam). |
Control Asynchronous Keyfob Adding Mode |
Call NET_DVR_STDXMLConfig to transmit the request URI: PUT /ISAPI/SecurityCP/Configuration/remoteCtrl/mode?format=json and set the input buffer (lpInBuffer) of the input parameter (lpInputParam) to the message JSON_RemoteCtrlMode. |
Get Asynchronously Added Kefob's Parameters |
Call NET_DVR_STDXMLConfig to transmit the request URI: GET /ISAPI/SecurityCP/Configuration/remoteCtrl/currentAddAsyn?format=json. And the parameters are returned in the message JSON_RemoteCtrl by the output buffer (lpOutBuffer) of the output parameter (lpOutputParam). |