JSON message about the parameters of all logical relays
{ "List":[{ "Output":{ "id": , /*required, int, relay No., which starts from 0*/ "name":"", /*optional, string type, relay name*/ "related": , /*read-only, boolean type, whether the relay is linked to the output module, for PUT method, this node is optional; for GET method, this node is required*/ "outputModuleNo": , /*read-only, int, linked output module No., this node is required only when the related is "true"*/ "channelNo": , /*read-only, int, channel No. of output module, this node is required only when the related is "true"*/ "linkage":"", /*optional, string type, linked event types: "alarm", "arming", "disarming", "manualCtrl"-manual control, "system"-system event, "zone"*/ "minorType": , /*optional, array, minor event type: "zoneAlarmTamper"-zone alarm and tampered event, "exDevTamper"-peripheral device tampered, "hostTamper"-control panel tampered, "emergency"-panic alarm, "medical"-medical alarm, "fire"-fire alarm, "gas"-gas event. When linkage is "alarm", one or all minor event types can be selected. The data type of elements in the array is string*/ "subSystem": , /*optional, array, linked partitions. When linkage is "alarm", "arming", or "disarming", one or more partitions can be configured to link. For example, [1,2,3] indicates that partition 1, partition 2, and partition 3 are linked*/ "LinkageList":[{ /*optional, linked event list. If the device supports multiple linkage event types linking to multiple minor event types and multiple partitions, this node can be used. For compatibility, one linkage event types linking to multiple minor event types and multiple partitions should also be supported*/ "linkage": "", /*optional, string, event types that can be linked to the relay: "alarm", "arming", "disarming", "manualCtrl"-manual control, "zone"*/ "alarmMinorType": , /*optional, array, minor event type: "zoneAlarmTamper"-zone alarm and tampered event, "exDevTamper"-peripheral device tampered, "hostTamper"-control panel tampered, "emergency"-panic alarm, "medical"-medical alarm, "fire"-fire alarm, "gas"-gas event. When linkage is "alarm", one or all minor event types can be selected. The data type of elements in the array is string*/ "zoneEvent": , /*optional, string, zone event type, this node is valid when linkage contains "zone". [1,3] indicates that zone 1 and zone 3 are enabled. If this node is not configured when linkage contains "zone", it indicates enabling all zones*/ "subSystem": /*optional, array, linked partitions. When linkage is "alarm", "arming", or "disarming", one or more partitions can be configured to link. For example, [1,2,3] indicates that partition 1, partition 2, and partition 3 are linked*/ }], "durationConstOutputEnable": , /*optional, boolean, whether it supports configuring relay output duration: "true"-not support (the duration cannot be configured and the relay will output continuously), "false"-support (the duration can be configured and it can be between 5s and 600s)*/ "alarmEvent":"", /*optional, string type, alarm event types, this node is valid only when the node linkage is "alarm", e.g., "1,3" indicates that the zone 1 and zone 3 is enabled; if this node is not configured, it indicates that all zones are enabled*/ "zoneEvent": , /*optional, string, zone event type, this node is valid when linkage contains "zone". [1,3] indicates that zone 1 and zone 3 are enabled. If this node is not configured when linkage contains "zone", it indicates enabling all zones*/ "systemEvent":"", /*optional, string type, system event types: "ACOff"-AC power off, "networkAbnormal"-network fault, "dismantleAlarm"-tampering alarm, "hidAlarm"-device blocking alarm, "preventMoveEvent"-motion event, "radarAbnormal"-radar fault. This node is valid only when the node linkage is "system"; if this node is not configured, it indicates that all system event types are selected*/ "duration": , /*optional, int, output duration*/ "alarmLine": , /*optional, int, trigger line No., it starts from 1*/ "followModeEnabled": , /*optional, boolean type, whether to enable following mode. If this node is set to "true": 1) duration is invalid for zone alarms, and after the zone or trigger line is triggered, the relay can remain open until the zone or trigger line is restored; 2) only zone or trigger line events can be linked, system events and arming and disarming events cannot be linked*/ "moduleType":"", /*optional, read-only, string type, module type: "localWired"-local wired module, "extendWired"-extended wired module, "localWireless"-local wireless module, "extendWireless"-extended wireless module*/ "scenarioType": ["alarm", "schedule", "arm", "disarm", "clearAlarm", "fault", "manual"], /*optional, object, scenario type, you can select one or multiple types*/ "alarmCfg": { /*optional, object, alarm configuration*/ "alarmType": ["zoneAlarmAndTamper", "exDevTamper", "panicAlarm", "medicalAlarm", "hostTamper", "fireAlarm"], /*optional, object, alarm type, you can set one or multiple types*/ "relayMode": "pulse", /*optional, enum, relay mode: "pulse", "latch", subType:string*/ "pulseDuration": 0, /*optional, int, pulse interval, this node is valid when relayMode is "pulse"*/ "contactStatus": "normalOpen", /*optional, enum, relay status after events occurred: "normalOpen", "normalClose", subType:string*/ "supportAssociatedZone": [1, 2, 3], /*optional, array, zones that can be linked, this node is valid when alarmType is "zoneAlarmAndTamper", subType:int*/ "associateZoneCfg": [1, 2, 3], /*optional, array, zones that have been linked with this relay, this node is valid when alarmType is "zoneAlarmAndTamper", subType:int*/ "alarmLogic": "and", /*optional, enum, alarm logic: "and", "or", this node is valid when alarmType is "zoneAlarmAndTamper", subType:string*/ "supportLinkageChannelID": [1, 2, 3], /*optional, array, No.s of the channels that can be linked with network cameras, this node is valid when alarmType is "zoneAlarmAndTamper", subType:int*/ "linkageChannelID": [1, 2] /*optional, array, No.s of the channels to be linked with network cameras, this node is valid when alarmType is "zoneAlarmAndTamper", subType:int, range:[1,4]*/ }, "address": , /*optional, read-only, int, module address, this node is only returned by wired modules*/ "linkageAddress": , /*optional, read-only, int, linked module address, this node is only returned by wireless modules*/ "moduleChannel": , /*optional, int, module channel No.*/ "alarmLine": [1, 2, 3], /*optional, array, No. of the trigger lines, which starts from 1*/ "followModeEnabled": true, /*optional, boolean, whether to enable following mode. If this node is set to "true": 1) duration is invalid for zone alarms, and after the zone or trigger line is triggered, the relay can remain open until the zone or trigger line is restored; 2) only zone or trigger line events can be linked, system events and arming and disarming events cannot be linked*/ "modifiedOutputNo": 1, /*optional, int, relay No. that has been modified*/ "accessModuleType": "transmitter" , /*optional, string, access module type: "transmitter", "multiTransmitter", "localTransmitter", "localRelay", "keypad"*/ "relatedAccessModuleID": 1, /*optional, int, No. of the linked access module*/ "relayAttrib": "wired" /*optional, string, relay attribute: "wired", "wireless" (default)*/ } }] }
Zone parameters configured by alarmEvent and zoneEvent should be the same and they both start from 0.