设备网络SDK开发使用手册


<?xml version="1.0" encoding="utf-8"?>
<!--req, 设备PTZ能力集描述 -->
<!--req, PTZAbility:花样扫描、云台守望等PTZ能力 -->
<PTZAbility version="2.0">
  <channelNO>
    1<!--req,通道号-->
  </channelNO>
  <PTZControl>
    <!--req,云台控制-->
    <controlType opt="light,wiper,fan,heater,aux1,aux2,zoomIn,zoomOut,focusNear,focusFar,irisOpen,irisClose,
                 ttiltUp,tiltDown,panLeft,panRight,upLeft,upRight,downLeft,downRight,panAuto,panCircle,
                 linearScan,cleanAllPreset, cleanAllSeq, cleanAllCruise, tiltUpZoomIn, tiltUpZoomOut, 
                 tiltDownZoomIn, tiltDownZoomOut, panLeftZoomIn, panLeftZoomOut, panRightZoomIn, panRightZoomOut, 
                 upLeftZoomIn, upLeftZoomOut, upRightZoomIn, upRightZoomOut, downLeftZoomIn, downLeftZoomOut, 
                 downRightZoomIn, downRightZoomOut"/>
    <!--req,支持的云台控制类型,分别为接通灯光电源、接通雨刷开关、接通风扇开关、接通加热器开关、接通辅助设备开关、
    接通辅助设备开关、焦距以速度SS变大、焦距以速度SS变小、焦点以速度SS前调、焦点以速度SS后调、光圈以速度SS扩大、
    光圈以速度SS缩小、云台以SS的速度上仰、云台以SS的速度下俯、云台以SS的速度左转、云台以SS的速度右转、
    云台以SS的速度上仰和左转、云台以SS的速度上仰和右转、云台以SS的速度下俯和左转、云台以SS的速度下俯和右转、
    云台以SS的速度左右自动扫描、云台以SS的速度自动圆周扫描、区域扫描、预置点全部清除、巡航全部清除、轨迹全部清除、
    云台以SS的速度上仰&&焦距以速度SS变大、云台以SS的速度上仰&&焦距以速度SS变小、云台以SS的速度下俯&&焦距以速度SS变大、
    云台以SS的速度下俯&&焦距以速度SS变小、云台以SS的速度左转&&焦距以速度SS变大、云台以SS的速度左转&&焦距以速度SS变小、
    云台以SS的速度右转&&焦距以速度SS变大、云台以SS的速度右转&&焦距以速度SS变小、云台以SS的速度上仰和左转&&焦距以速度SS变大、
    云台以SS的速度上仰和左转&&焦距以速度SS变小、云台以SS的速度上仰和右转&&焦距以速度SS变大、云台以SS的速度上仰和右转&&焦距以速度SS变小、
    云台以SS的速度下俯和左转&&焦距以速度SS变大、云台以SS的速度下俯和左转&&焦距以速度SS变小、云台以SS的速度下俯和右转&&焦距以速度SS变大、
    云台以SS的速度下俯和右转&&焦距以速度SS变小-->
  </PTZControl>
  <Patrol><!--巡航-->
    <patrolNum min="1" max="16"/>
    <!--req,巡航扫描的个数-->
    <presetNum min="1" max="256"/>
    <!--req,单条巡航扫描的预置点个数-->
    <dwellTime min="1" max="255" default="10"/>
    <!--req,巡航点停顿时间-->
    <speed min="1" max="255" default=""/>
    <!--req,巡航速度-->
  </Patrol>
  <Preset>
    <!--req,预置点-->
    <presetNum min="1" max="256"/>
      <!--req,预置点个数-->
    <nameLen max="32"/><!--req, 无此节点认为不支持设置名称-->
    <specialNo opt ="1,2,3,4,5"/>
    <!--req, 此列表里的预置点只能用于调用,不能有其他操作,比如修改、删除-->
    <maxThermometryPresetNum>100</maxThermometryPresetNum>
    <!--opt,支持的测温预置点个数,最大100个-->
  </Preset>
  <PTZZoomIn><!--支持云台缩放(3D定位)功能-->
    <enabled>true</enabled>
    <!--req,支持云台缩放-->
  </PTZZoomIn>
  <Pattern>
    <!--req,花样扫描-->
    <operateType opt="recordStart,recordStop,run,stop,delete,deleteAll"/>
      <!--req,支持的花样扫描的操作类型-->
    <patternID min="1" max="4"/>
      <!--req,花样扫描的ID号-->
  </Pattern>
  <ParkAction><!--云台守望-->
    <parkTime min="5" max="720"/>
    <!--req,守望等待时间,单位s-->
    <actionType opt="atuoScan,frameScan,patrol,verticalScan,preset,randomScan,pattern,panoramaScan,areaScan"/>
    <!--req,守望动作类型,支持patrol(巡航扫描)、preset(预置点)、pattern(花样扫描)、areaScan(区域扫描)还需要填写下面支持的编号能力-->
    <patrolID min="1" max="8"/>
    <!--req,巡航扫描的ID号-->
    <presetID min="1" max="8"/><!--req,预置点的ID号-->
    <patternID min="1" max="4"/><!--req,花样扫描的ID号-->
    <oneTouchSwitch opt="true,false"/><!--req,一键功能使能-->
  </ParkAction>
  <SchduleTask><!--云台定时任务-->
    <enable opt="true,false"/>
    <!--req, 是否支持使能-->
    <maxTimeNum>10</maxTimeNum>
    <!--req, 每天支持设置的时间段-->
    <parkTime min="5" max="720"/>
    <!--req,任务等待时间,单位:s-->
    <actionType opt="autoscan,framescan,randomscan,patrol,pattern,preset,panoramascan,tiltscan,periodreboot,periodadjust,auxoutput,areaScan"/>
    <!--req,动作类型,支持autoscan(自动扫描)、framescan(帧扫描)、patrol(巡航扫描)、preset(预置点)、pattern(花样扫描)、
    panoramascan(全景扫描)、tiltscan(垂直扫描)、periodreboot(定时重启)、periodadjust(定时校正)、auxoutput(辅助输出)、areaScan(区域扫描)还需要填写下面支持的编号能力-->
    <patrolID min="1" max="8"/>
    <!--req,巡航扫描的ID号-->
    <presetID min="1" max="8"/>
    <!--req,预置点的ID号-->
    <patternID min="1" max="4"/>
    <!--req,花样扫描的ID号-->
    <auxoutput min="1" max="2"/>
    <!--req,辅助输出-->
  </SchduleTask>
  <LinearScanCfg>
    <type opt="leftLimit,rightLimit"/>
    <!--req,left左边界设置,right右边界设置-->
  </LinearScanCfg>

  <WiperCfg><!--req, 雨刷控制配置NET_DVR_WIPERINFO_CFG-->
<wiperWorkMode opt="single, repeat"/><!--req, 雨刷工作模式0-single(单次操作) 1-continue(持续操作)-->
<WiperContinueWorkParam>
    <!--req, 持续操作模式-->
   <workTimeIntervalUnit opt="sec"/>
      <!--req, 间隔时间单位: sec-秒-->
   <workTimeInterval min="" max=""/><!--req, 间隔时间-->
   <continueWorkTimeUnit opt="minute"/>
       <!--req, 持续时间单位,minute-分钟-->
   <continueWorkTime min="" max=""/><!--req,持续时间-->
</WiperContinueWorkParam>
</WiperCfg>
<WiperStatus opt="false"/>
  <!--req,true表示支持雨刷状态, false表示支持不支持雨刷-->
  <PtzBasicCfg>
    <BasicParamCfg>
      <proportionalPan opt="false,true"/>
      <!--req,启用比例变倍配置, 0-否,1-是-->
      <presetFreezing opt="false,true"/>
      <!--req,启用预置点视频冻结, 0-否,1-是-->
      <presetSpeed min="" max=""/>
      <!--req,预置点速度等级, 1~8,默认4-->
      <keyboardCtrlSpeed opt="low,normal,high"/>
      <!--req,手控速度等级, 0-低,1-中,2-高-->
      <autoScanSpeed min="" max=""/>
      <!--req,扫描速度等级:1~40,默认28-->
      <zoomingSpeed min="" max=""/>
      <!--req,变倍速度:1~3,默认3-->
      <manualControlSpeed  opt="compatibility,human,nonMotorVehicle, motorVehicle, adaptive"/>
      <!--req,0-兼容,1-行人,2-非机动车,3-机动车,4-自适应 -->
      <PTZMotionTrack opt="true,false"/>
      <!--opt,0-默认(开启),1-关闭 -->
    </BasicParamCfg>
    <OSDCfg>
      <zoomStatus opt="2s,5s,10s,normallyOpen,normallyClose"/><!--req,镜头倍数显示:1-2秒、2-5秒、3-10秒、0xff-常关、0-常开,默认2秒-->
      <ptStatus opt="2s,5s,10s,normallyOpen,normallyClose"/><!--req,方位角显示:1-2秒、2-5秒、3-10秒、0xff-常关、0-常开,默认2秒-->
      <presetStatus opt="2s,5s,10s,normallyOpen,normallyClose"/><!--req,预置点标题显示:1-2秒、2-5秒、3-10秒、0xff-常关、0-常开,默认2秒-->
    </OSDCfg>
    <PowerOffMemCfg>
      <resumeTimePoint opt="forbidden,30s,60s,300s,600s"/><!--req,掉电记忆模式:Oxff-禁用、1-30秒、2-60秒、3-300秒、4-600秒,默认30秒-->
    </PowerOffMemCfg>
  </PtzBasicCfg>

  <LimitCfg>
    <enable opt="false,true"/>
    <!--req,启用使能,0-否,1-是-->
    <limitMode opt="mamualStops,scanStops"/>
    <!--req,限位模式 1-键控限位,2-扫描限位-->
    <limitStatus attri="readonly" opt="noLimited,limited"/>
    <!--req,限位状态 0-未限位,1-已限位(不可编辑-->
  </LimitCfg>

  <LimitCtrl>
    <workMode opt="set,clear"/>
    <!--req,工作模式 :0-设置,1-清除-->
  </LimitCtrl>

  <ClearCfg>
    <allPreset opt="false,true"/>
    <!--req,清除所有的预置点,0-否,1-是-->
    <allPatrols opt="false,true"/>
    <!--req,清除所有的巡航路径,0-否,1-是-->
    <allPatterms opt="false,true"/>
    <!--req,清除所有的花样扫描,0-否,1-是-->
    <allPrivacyMasks opt="false,true"/>
    <!--req,清除所有的隐私块,0-否,1-是-->
    <allPTZLimited opt="false,true"/>
    <!--req,清除所有的限位设置,0-否,1-是-->
    <allScheduledTasks opt="false,true"/>
    <!--req,清除所有的定时任务,0-否,1-是-->
    <allParkAction opt="false,true"/>
    <!--req,清除所有的守望,0-否,1-是-->
  </ClearCfg>

  <PtzPrioritizeCfg>
    <PtzPrioritize opt="net,Rs485"/>
    <!--req,云台优先:0-RS485,1-网络,默认网络-->
    <delay min="" max=""/>
    <!--req,延时:2~200秒-->
  </PtzPrioritizeCfg>

  <InitalPostionCtrl>
    <workMode opt="set,goto,clear"/>
    <!--req,工作模式 : 0-设置,1-调用,  2-清除-->
  </InitalPostionCtrl>

  <PrivacyMaskCfg>
    <globalEnable opt="false,true"/>
    <!--req,启用全局使能,0-否,1-是-->
    <RegionalID min="" max=""/>
    <!--req,区域ID号 1~24-->
    <enable opt="false,true"/>
    <!--req,启用使能,0-否,1-是-->
    <colorType opt="gray,red,green,blue,orange,yellow,mosaic"/>
    <!--req,颜色 1-灰、2-红、3-绿、4-蓝、5-橙、6-黄、0xff-马赛克-->
    <delPrivacyMaskCfg attri="writeonly" opt="delete"/>
    <!--req,字段索引含义 1-删除(WriteOnly)-->
    <privacyMaskCfgEnable attri="readonly" opt="false,true"/>
    <!--req, 隐私遮蔽区域配置参数是否显示  0-否,1-是(ReadOnly)-->
    <currentRegionEnable opt="false,true"/>
    <!--req, 当前区域坐标是否有效 0-否,1-是-->
    <activeZoomRatio min="" max=""/>
    <!--req, 屏蔽倍率:1~100-->
    <PrivacyMaskNameLen min="" max=""/>
    <!--req, 遮挡区域名称长度-->
    <PrivacyMaskArea>
      <Region>
        <regionType opt="rectangle,convexPolygon,concavePolygon"/>
        <!--req,矩形,凸多边形,凹多边形-->
        <vertexNum min="3" max="10"/>
        <!--req,区域顶点数量-->
      </Region>
    </PrivacyMaskArea>
  </PrivacyMaskCfg>

  <SmartTrackCfg>
    <enable opt="false,true"/>
    <!--req,启用使能,0-否,1-是-->
    <duration min="" max=""/>
    <!--req,持续时间:0~300秒,默认300秒-->
  </SmartTrackCfg>

  <ZoomRatioCtrl>
    <enable opt="true"/>
    <!--req,支持设置跟踪倍率-->
  </ZoomRatioCtrl>

  <PTZLOCK>
    <ptzLockCtrl opt="unlock,lock"/>
    <!--req,云台锁定控制 0-解锁,1-锁定-->
    <supportFunction opt="fieldDetection,traversingVirtualPlane,regionEntrance,regionExiting,loitering,peopleGathering,
                     fastMoving,parking,unattendedBaggage,objectRemoval,vehicleDetection,hvtVehicleDetection"/>
    <!--req,支持 区域入侵侦测,越界侦测界面,进入区域侦测,离开区域侦测,徘徊侦测,人员聚集侦测,快速运动侦测,
    停车侦测,物品遗留侦测,物品拿取侦测,车辆侦测,HVT混行卡口侦测-->
  </PTZLOCK>

  <PositionLimitAngle>
    <!--场景限位操作-->
    <positionIndex min="" max=""/>
    <!--场景索引-->
    <LimitAngle>
      <able opt="enable,disable"/>
      <!--场景是否启用-->
        <Up>
          <action opt="ptz,p,t,z,pt"/>
          <panpos>true</panpos>
          <tiltpos>true</tiltpos>
          <zoompos>true</zoompos>
        </Up>
        <Down>
          <action opt="ptz,p,t,z,pt"/>
          <panpos>true</panpos>
          <tiltpos>true</tiltpos>
          <zoompos>true</zoompos>
        </Down>
        <Left>
          <action opt="ptz,p,t,z,pt"/>
          <panpos>true</panpos>
          <tiltpos>true</tiltpos>
          <zoompos>true</zoompos>
        </Left>
        <Right>
          <action opt="ptz,p,t,z,pt"/>
          <panpos>true</panpos>
          <tiltpos>true</tiltpos>
          <zoompos>true</zoompos>
        </Right>
      </LimitAngle>
  </PositionLimitAngle>

</PTZAbility>