Skip to main content

Intrusion & Perimeter Detection Configuration

Application Guide

For a complete walkthrough with code examples, see the Human Detection & Intrusion Detection application guide.

GetSmartPerimeterConfig

Retrieves intrusion/perimeter detection configuration. Returns the detection zone polygons, object filter settings, and alarm hold time for each configured intrusion region.

FieldValue
Endpoint/GetSmartPerimeterConfig[/channelId]
MethodPOST or GET
ProductsIPC
Channel IDOptional (default 1)

Response Example

<?xml version="1.0" encoding="utf-8"?>
<config xmlns="http://www.ipc.com/ver10" version="2.0.0">
<perimeter>
<switch type="boolean">true</switch>
<alarmHoldTime type="uint32">20</alarmHoldTime>
<objectFilter>
<car>
<switch type="boolean">true</switch>
<sensitivity type="uint32" max="100" min="1" default="50">50</sensitivity>
</car>
<person>
<switch type="boolean">true</switch>
<sensitivity type="uint32" max="100" min="1" default="50">50</sensitivity>
</person>
<motor>
<switch type="boolean">true</switch>
<sensitivity type="uint32" max="100" min="1" default="50">50</sensitivity>
</motor>
</objectFilter>
<saveTargetPicture type="boolean">false</saveTargetPicture>
<saveSourcePicture type="boolean">false</saveSourcePicture>
<regionInfo type="list" maxCount="4" count="1">
<item>
<pointGroup type="list" maxCount="8" count="4">
<item>
<X type="uint32">4075</X>
<Y type="uint32">2466</Y>
</item>
<!-- Additional points... -->
</pointGroup>
</item>
</regionInfo>
</perimeter>
</config>

Parameters

ParameterTypeRangeDescription
switchbooleantrue / falseEnable or disable perimeter detection
alarmHoldTimeuint32Duration (seconds) to hold the alarm state after detection
objectFilter.car.switchbooleantrue / falseEnable car/vehicle detection
objectFilter.car.sensitivityuint321–100 (default 50)Car detection sensitivity
objectFilter.person.switchbooleantrue / falseEnable person detection
objectFilter.person.sensitivityuint321–100 (default 50)Person detection sensitivity
objectFilter.motor.switchbooleantrue / falseEnable motorcycle/bicycle detection
objectFilter.motor.sensitivityuint321–100 (default 50)Motorcycle detection sensitivity
saveTargetPicturebooleantrue / falseSave cropped target image on detection
saveSourcePicturebooleantrue / falseSave full-frame source image on detection
regionInfolistmaxCount: 4Intrusion detection zones (up to 4 regions)
regionInfo.item.pointGrouplistmaxCount: 8Polygon vertices defining the zone boundary (up to 8 points per region)
regionInfo.item.pointGroup.item.Xuint32X coordinate of polygon vertex
regionInfo.item.pointGroup.item.Yuint32Y coordinate of polygon vertex

Notes

  • Coordinates use the camera's internal coordinate system (typically 0–10000 range).
  • Up to 4 independent intrusion zones can be configured, each with up to 8 polygon points.
  • Each object filter (car, person, motor) can be independently enabled/disabled with its own sensitivity.
  • The corresponding Set command is SetSmartPerimeterConfig using the same XML structure.
EndpointPurpose
SetHttpPostConfigConfigure webhook destination for intrusion alerts
GetAlarmStatusPoll current alarm state