JSON_RemoteCtrlCap

RemoteCtrlCap capability message in JSON format

{
  "RemoteCtrlCap":{  
    "id":{  
/*required, keyfob No.*/
      "@min": ,
      "@max":
    }, 
    "enabled":{  
/*required, whether to enable the keyfob*/
      "@opt":"true,false"
    }, 
    "seq":{  
/*required, length of the keyfob serial No.*/
      "@min": ,
      "@max":
    },  
    "name":{  
/*optional, keyfob name length*/
      "@min": ,
      "@max":
    }, 
    "factory":{  
/*optional, keyfob manufacturer: "pyronix"-Pyronix, "hik"-Hikvision*/
      "@opt":"pyronix,hik"
    },  
    "right":{  
/*optional, permissions supported by the keyfob: "awayArming"-away arming, "stayArming"-stay arming, "disarming"-disarm, "panic"-panic alarm, "clearAlarm"-clear alarms, "operateOutputs"-operate relays*/
      "@opt":"awayArming,stayArming,disarming,panic,operateOutputs"
    }, 
    "selKey":{   
/*optional, custom keys*/
      "@opt":"3,4,..."
    }, 
    "combKey":{  
/*optional, combined keys*/
      "@opt":"12,..."
    }, 
    "func":{  
/*optional, functions supported by the keyfob's key: "awayArming"-away arming, "stayArming"-stay arming, "disarming"-disarm, "panic"-panic alarm, "clearAlarm"-clear alarms, "operateOutputs"-operate relays, "queryFault"-search for faults (it is used to report existing faults of the security control panel), "queryArmState"-search for arming status (it is used to prompt the arming and disarming status of the security control panel)*/
      "@opt":"awayArming,stayArming,disarming,panic,clearAlarm,operateOutputs,queryFault,queryArmState,mutePA,muteMedicalTreatment,medicalTreatment"
    }, 
    "combKeyFunc":{
/*optional, string, combination key function. If this field is returned, this field indicates the capability set of the combination key and the field func indicates that of a single key; if this field is not returned, the field func indicates the capability set of both a single key and the combination key*/
      "@opt":"awayArming,stayArming,disarming,panic,clearAlarm,operateOutputs,queryFault,queryArmState,mutePA,muteMedicalTreatment,medicalTreatment"
    },
    "outputNo":{  
/*optional, output channel No., this node is required only when the fun contains "operateOutputs"*/
      "@min": ,
      "@max":
    }, 
    "subSystem":{
/*optional, supported number of partitions that can be linked*/
      "@min": ,
      "@max":
    },
    "subSystemNo":{
/*optional, range of partition No.*/
      "@min": ,
      "@max":
    },
    "method":{  
/*required, methods supported by the function: "currentAdd"-add, "del"-delete, "put"-edit, "get"-get one, "getAll"-get all, "currentAddAsyn"-asynchronously add*/
      "@opt":"currentAdd,del,put,get,getAll,currentAddAsyn"
    },
    "relatedNetUserName":{
/*optional, int, length of the linked network user name*/
      "@min": ,
      "@max": 
    },
    "alarmVoicePromptEnabled":{
/*optional, boolean, whether to enable voice prompt for panic alarm: true-yes (the panic alarm of the keyfob will have linked voice prompt), false-no (the panic alarm of the keyfob will not have linked voice prompt)*/
      "@opt":[true,false]   
    }
  }
}

Remarks

  • There are four keys on the keyfob: Lock, Unlock, I, and II, which corresponds to key No.1, 2, 3, and 4.

  • The combined key is represented by the strings that consists of key No., e.g., if keys is "12", it indicates that the key is combined by key No.1 (Lock) and key No.2 (Unlock).

  • The Lock and Unlock keys are predefined, so only the I and II can be customized.

  • Customizing the key is not supported by the Hikvision keyfob.