XML_ThermometryBasicParam

XML message about temperature measurement basic parameters

<ThermometryBasicParam version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
  <id><!--required, xs:integer, channel number--></id>
  <enabled><!--required, xs:boolean, enable or not: false-no, true-yes--></enabled> 
  <streamOverlay><!--required, xs:boolean, whether displays temperature information on the stream: false-no, true-yes--></streamOverlay>
  <pictureOverlay><!--required, xs:boolean, whether displays temperature information on the captured picture: false-no, true-yes--></pictureOverlay>
  <temperatureRange>
    <!--required, xs:string, temperature range: "-20-150", "0-550", "0-650", "-4-302", "32-1022", "32-1200", "20-650", "-20-1500", "automatic", "-20-120", "20-350", "20-45", "20-350", "30-45", "100-550"-->
  </temperatureRange>
  <temperatureUnit>
    <!--required, xs:string, temperature unit: degreeCentigrade-Celsius (°C), degreeFahrenheit-Fahrenheit (°F), degreeKelvin-Kelvin(K)-->
  </temperatureUnit>
  <temperatureCurve>
    <!--optional, xs:string, temperature curve modes: close-closed, transverseTemperatureTrend-transverse temperature mode, longitudinalTemperatureTrend-longitudinal temperature mode-->
  </temperatureCurve>
  <fireImageMode>
    <!--optional, xs:string, fire detection modes: blackWhite-black and white mode, thermalProbe-thermal detection mode, fireGroud-fire scene mode-->
  </fireImageMode>	
  <emissivity>
    <!--optional, xs:float, the emissivity is between 0.01 and 1.00, which corrects to two decimal places. This parameter is used by the device (i.e., DS-2TF03-260V/GLT, DS-2TF03-167V/GLT) that does not support regular frame and preset-->
  </emissivity>
  <distanceUnit> 
    <!--required, xs:string, opt="meter,feet,centimeter"--></distanceUnit>
  <TemperatureColor>
    <!--optional, set the alarm information color for the temperature measurement-->
    <type>
      <!-- required, xs:string,"highTemperature, lowTemperature, rangeTemperature, heatPreservation", set temperature alarm types: highTemperature field-high temperature alarm, when the measured temperature is higher than the configured value of highTemperature field, the measured temperature will be marked by color; lowTemperature-low temperature alarm, when the measured temperature is lower than the configured value of lowTemperature field, the measured temperature will be marked by color; rangeTemperature-range temperature alarm, when the measured temperature is between the configured values of highTemperature field and lowTemperature field, the measured temperature will be marked by color; heatPreservation-insulation alarm, when the measured temperature is not between the configured values of highTemperature field and lowTemperature field, the measured temperature will be marked by color-->
    </type>
    <highTemperature><!--dep, xs:integer--></highTemperature>
    <lowTemperature><!--dep, xs:integer--></lowTemperature>
  </TemperatureColor>
  <enviroTemperature><!--optional, xs:integer, environment temperature, unit: °C--></enviroTemperature>
  <enviroHumidity><!--optional, xs:integer, environment humidity, unit:%--></enviroHumidity>
  <correctionVolume><!--optional, xs:integer, temperature correction--></correctionVolume>
  <specialPointThermType>
    <!--required, xs:string,"centerPoint, highestPoint, lowestPoint", display the special point temperature, central point temperature, highest temperature, lowest temperature. Supports multiple selections-->
  </specialPointThermType>
  <distance><!--required, xs:integer; unit:m, the distance range is [0, 10000]--></distance>
  <reflectiveEnable><!--required, xs:boolean, whether enables temperature reflection--></reflectiveEnable>
  <reflectiveTemperature><!--optional, xs:float, reflective temperature, which corrects to one decimal place--></reflectiveTemperature>
  <alert><!--optional, xs: float, pre-alarm threshold--></alert>
  <alarm><!--optional, xs: float, alarm threshold--></alarm>
  <showTempStripEnable><!--optional, xs:boolean, whether enables displaying temperature bar--></showTempStripEnable>
  <thermalOpticalTransmittance><!--optional, xs: float, optical transmissivity is between 0.001 and 1.000, which corrects to three decimal places. The default value is 1.000--></thermalOpticalTransmittance>
  <externalOpticsWindowCorrection><!--optional, xs: float, external optical temperature is between -40.0 °C and 80.0 °C. The default value is 20 °C--></externalOpticsWindowCorrection>
  <AlertOutputIOPortList><!--optional, list of temperature pre-alarm output ports-->
    <OutputIOPort>
      <portID><!--required, xs:string --></portID>
      <enabled><!--required, xs:boolean, "true,false"--></enabled>
    </OutputIOPort>
  </AlertOutputIOPortList>
  <AlarmOutputIOPortList><!--optional, list of temperature alarm output ports-->
    <OutputIOPort>
      <portID><!--required, xs:string--></portID>
      <enabled><!--required, xs:boolean, "true,false"--></enabled>
    </OutputIOPort>
  </AlarmOutputIOPortList>
  <alertFilteringTime><!--optional, xs:integer, temperature pre-alarm dwell time, unit:s--></alertFilteringTime>
  <alarmFilteringTime><!--optional, xs:integer, temperature alarm dwell time, unit:s--></alarmFilteringTime>
  <displayMaxTemperatureEnabled><!--optional, xs:boolean, whether displays the maximum temperature--></displayMaxTemperatureEnabled>
  <displayMinTemperatureEnabled><!--optional, xs:boolean, whether displays the minimum temperature--></displayMinTemperatureEnabled>
  <displayAverageTemperatureEnabled><!--optional, xs:boolean, whether displays the average temperature--></displayAverageTemperatureEnabled>
  <thermometryInfoDisplayposition><!--optional, xs:string, position of temperature measurement information overlay, "rules_around,top_left_of_screen"--></thermometryInfoDisplayposition>
  <calibrationCoefficientEnabled><!--optional, xs:boolean, whether enables calibration coefficient--></calibrationCoefficientEnabled>
  <calibrationCoefficient><!--dep, xs:float, calibration coefficient, ranges from 0 to 30, corrects to two decimal places--></calibrationCoefficient>
  <emissivityMode>
    <!--optional, xs:string, emissivity type: "rougher"-rougher 0.95, "rough"-rough 0.80, "smooth"-smooth 0.60, "smoother"-smoother 0.30, "customsettings"-customized setting, values from 0.01 to 1.00, the larger the value, the higher the roughness-->
  </emissivityMode>
  <displayTemperatureInOpticalChannelEnabled>
    <!--optional, xs:boolean, display the temperature information of optical channel-->
  </displayTemperatureInOpticalChannelEnabled>
  <distanceMode><!--optional, xs:string, distance mode: "selfAdapt"-self-adaption, "fixed"-fixed distance--></distanceMode>
  <faceTemperatureInfoUploadEnabled>
    <!--optional, xs:boolean, whether to enable uploading face temperature information: true-enable, false-disable-->
  </faceTemperatureInfoUploadEnabled>
  <calibrationFileVersion><!--optional, xs:string, read-only, calibration file version information--></calibrationFileVersion>
  <alarmInterval><!--optional, xs:integer, temperature measurement interval, unit: second--></alarmInterval>
  <rulesOverlayMode><!--optional, xs:string, rule overlay mode: all (all rules), alarm (triggered alarm rule)--></rulesOverlayMode>
  <toleranceTemperature><!--optional, xs:float, tolerance temperature, value range: [1,5], unit: Celsius--></toleranceTemperature>
  <alarmMode><!--optional, xs:string, alarm mode: "temperatureIntervalMeasurement" (temperature range measurement), "alarm_alert" (pre-alarm/alarm)--></alarmMode>
  <NormalRulesColor><!--optional, normal rule color; this node is valid when the value of alarmMode is "temperatureIntervalMeasurement"-->
    <R><!--required, xs:integer--></R>
    <G><!--required, xs:integer--></G>
    <B><!--required, xs:integer--></B>
  </NormalRulesColor>
  <NormalTemperatureIntervalMeasurement><!--optional, normal temperature range measurement-->
    <alarmType><!--optional, xs:string, alarm type: "highestTemp" (the highest temperature), "lowestTemp" (the lowest temperature)--></alarmType>
    <TemperatureIntervalList><!--optional, temperature range list; up to 4 temperature ranges are allowed-->
      <TemperatureInterval>
        <id><!--optional, xs:integer, No.--></id>
        <enabled><!--optional, xs:boolean, whether to enable--></enabled>
        <name><!--optional, xs:string, range name--></name>
        <minTemperature><!--optional, xs:float, the lowest temperature; value range: [-20,550], unit: Celsius; the value should be accurate to one decimal place--></minTemperature>
        <maxTemperature><!--optional, xs:float, the highest temperature; value range: [-20,550], unit: Celsius; the value should be accurate to one decimal place--></maxTemperature>
        <AlarmColor><!--optional, alarm color of temperature range-->
          <R><!--required, xs:integer--></R>
          <G><!--required, xs:integer--></G>
          <B><!--required, xs:integer--></B>
        </AlarmColor>
        <AlarmOutputIOPortList><!--optional, alarm output port list-->
          <OutputIOPort><!--list-->
            <portID><!--required, xs:string, port No.--></portID>
            <enabled><!--required, xs:boolean, whether to enable--></enabled>
          </OutputIOPort>
        </AlarmOutputIOPortList>
      </TemperatureInterval>
    </TemperatureIntervalList>
  </NormalTemperatureIntervalMeasurement>
  <SunReflectionBlur>
    <!--optional, object, reflect light filter-->
    <enabled>
      <!--required, boolean, whether to enable reflect light filter-->true
    </enabled>
    <sensitivity>
      <!--optional, int, sensitivity of reflect light filter; value range: [1,100]-->50
    </sensitivity>
  </SunReflectionBlur>
  <VehicleBlur>
    <!--optional, object, forklift filter-->
    <enabled>
      <!--required, boolean, whether to enable forklift filter-->true
    </enabled>
    <sensitiveLevel>
      <!--optional, int, sensitivity of forklift filter; value range: [0,4]-->4
    </sensitiveLevel>
  </VehicleBlur>
  <TemperatureSuddenChange>
    <!--optional, object, configurations of temperature sudden change alarm  under normal thermometry mode-->
    <mode>
      <!--required, string, temperature sudden change mode: "close" (disabled), "temperatureSuddenIncrease" (temperature sudden increase), "temperatureSuddenDecrease" (temperature sudden decrease)-->temperatureSuddenIncrease
    </mode>
    <alarm>
      <!--optional, float, alarm threshold, value range: [0,570]; the value is accurate to one decimal place-->0.0
    </alarm>
    <cycleCfg>
      <!--optional, int, recording cycle, value range: [5,3600]-->60
    </cycleCfg>
  </TemperatureSuddenChange>
</ThermometryBasicParam>

Remarks

  • The reflect light filter, forklift filter and VCA function are mutually exclusive.

  • The following nodes are not supported by the thermographic automation thermal camera (DS-2TA03-15SVI, DS2TA06-25SVI): <TemperatureColor>, <specialPointThermType>, and <reflectiveEnable>.