Skip to content

Thermal

Thermal service implementation.

Thermal

Bases: ONVIFService

0.0.1 16.06

Thermal service client.

Property Details
First introduced ONVIF 16.06 (June 2016)
Binding name ThermalBinding (ver10/thermal/wsdl/thermal.wsdl)
Operations thermal.wsdl
Spec Thermal

GetServiceCapabilities 

GetServiceCapabilities()

Returns the capabilities of the thermal service.

The result is returned in a typed answer.

Output
  • Capabilities [Capabilities]
    The capabilities of the thermal service are returned in the Capabilities element.
    • Radiometry - optional; [boolean]
      Indicates whether or not radiometric thermal measurements are supported by the thermal device.

GetConfigurationOptions 

GetConfigurationOptions(VideoSourceToken)

Gets the valid ranges for the Thermal parameters that have device specific ranges.

This command is mandatory for all devices implementing the Thermal service. The command shall return all supported parameters and their ranges, such that these can be applied to the SetConfiguration command.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource for which the Thermal Configuration Options are requested.
    Maximum length: 64
Output
  • ConfigurationOptions [ConfigurationOptions]
    Valid ranges for the Thermal configuration parameters that are categorized as device specific.
    • ColorPalette - unbounded; [ColorPalette]
      List of Color Palettes available for the requested Thermal VideoSource.
      • token - required; [ReferenceToken]
        Unique identifier of this Color Palette.
      • Type - required; [string]
        Indicates Color Palette Type. Use tth:ColorPaletteType. Used for multi-language support and display.
      • Name [Name]
        User readable Color Palette name.
        Maximum length: 64
    • NUCTable - optional, unbounded; [NUCTable]
      List of Non-Uniformity Correction (NUC) Tables available for the requested Thermal VideoSource.
      • token - required; [ReferenceToken]
        Unique identifier of this NUC Table.
      • LowTemperature - optional; [float]
        Low Temperature limit for application of NUC Table, in Kelvin.
      • HighTemperature - optional; [float]
        High Temperature limit for application of NUC Table, in Kelvin.
      • Name [Name]
        User reabable name for the Non-Uniformity Correction (NUC) Table.
        Maximum length: 64
    • CoolerOptions - optional; [CoolerOptions]
      Specifies Cooler Options for cooled thermal devices.
      • Enabled - optional; [boolean]
        Indicates the Device allows cooler status to be changed from running (Enabled) to stopped (Disabled), and viceversa.

GetConfiguration 

GetConfiguration(VideoSourceToken)

Gets the Thermal Configuration for the requested VideoSource.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource for which the Thermal Settings are requested.
    Maximum length: 64
Output
  • Configuration [Configuration]
    Thermal Settings for the VideoSource that was requested.
    • ColorPalette [ColorPalette]
      Current Color Palette in use by the Thermal Device.
      • token - required; [ReferenceToken]
        Unique identifier of this Color Palette.
      • Type - required; [string]
        Indicates Color Palette Type. Use tth:ColorPaletteType. Used for multi-language support and display.
      • Name [Name]
        User readable Color Palette name.
        Maximum length: 64
    • Polarity [Polarity]
      Polarity configuration of the Thermal Device.
      Enum Value Enum Description
      WhiteHot —
      BlackHot —
    • NUCTable - optional; [NUCTable]
      Current Non-Uniformity Correction (NUC) Table in use by the Thermal Device.
      • token - required; [ReferenceToken]
        Unique identifier of this NUC Table.
      • LowTemperature - optional; [float]
        Low Temperature limit for application of NUC Table, in Kelvin.
      • HighTemperature - optional; [float]
        High Temperature limit for application of NUC Table, in Kelvin.
      • Name [Name]
        User reabable name for the Non-Uniformity Correction (NUC) Table.
        Maximum length: 64
    • Cooler - optional; [Cooler]
      Cooler settings of the Thermal Device.
      • Enabled [boolean]
        Indicates whether the Cooler is enabled (running) or not.
      • RunTime - optional; [float]
        Number of hours the Cooler has been running (unit: hours). Read-only.

GetConfigurations 

GetConfigurations()

Gets the Thermal Configuration for all thermal VideoSources of the Device.

Output
  • Configurations - optional, unbounded; [Configurations]
    This element contains a list of thermal VideoSource configurations.
    • token - required; [ReferenceToken]
      Reference token to the thermal VideoSource.
    • Configuration [Configuration]
      Current Thermal Settings for the VideoSource.
      • ColorPalette [ColorPalette]
        Current Color Palette in use by the Thermal Device.
        • token - required; [ReferenceToken]
          Unique identifier of this Color Palette.
        • Type - required; [string]
          Indicates Color Palette Type. Use tth:ColorPaletteType. Used for multi-language support and display.
        • Name [Name]
          User readable Color Palette name.
          Maximum length: 64
      • Polarity [Polarity]
        Polarity configuration of the Thermal Device.
        Enum Value Enum Description
        WhiteHot —
        BlackHot —
      • NUCTable - optional; [NUCTable]
        Current Non-Uniformity Correction (NUC) Table in use by the Thermal Device.
        • token - required; [ReferenceToken]
          Unique identifier of this NUC Table.
        • LowTemperature - optional; [float]
          Low Temperature limit for application of NUC Table, in Kelvin.
        • HighTemperature - optional; [float]
          High Temperature limit for application of NUC Table, in Kelvin.
        • Name [Name]
          User reabable name for the Non-Uniformity Correction (NUC) Table.
          Maximum length: 64
      • Cooler - optional; [Cooler]
        Cooler settings of the Thermal Device.
        • Enabled [boolean]
          Indicates whether the Cooler is enabled (running) or not.
        • RunTime - optional; [float]
          Number of hours the Cooler has been running (unit: hours). Read-only.

SetConfiguration 

SetConfiguration(VideoSourceToken, Configuration)

Sets the Thermal Configuration for the requested VideoSource.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource for which the Thermal Settings are configured.
    Maximum length: 64
  • Configuration [Configuration]
    Thermal Settings to be configured.
    • ColorPalette [ColorPalette]
      Current Color Palette in use by the Thermal Device.
      • token - required; [ReferenceToken]
        Unique identifier of this Color Palette.
      • Type - required; [string]
        Indicates Color Palette Type. Use tth:ColorPaletteType. Used for multi-language support and display.
      • Name [Name]
        User readable Color Palette name.
        Maximum length: 64
    • Polarity [Polarity]
      Polarity configuration of the Thermal Device.
      Enum Value Enum Description
      WhiteHot —
      BlackHot —
    • NUCTable - optional; [NUCTable]
      Current Non-Uniformity Correction (NUC) Table in use by the Thermal Device.
      • token - required; [ReferenceToken]
        Unique identifier of this NUC Table.
      • LowTemperature - optional; [float]
        Low Temperature limit for application of NUC Table, in Kelvin.
      • HighTemperature - optional; [float]
        High Temperature limit for application of NUC Table, in Kelvin.
      • Name [Name]
        User reabable name for the Non-Uniformity Correction (NUC) Table.
        Maximum length: 64
    • Cooler - optional; [Cooler]
      Cooler settings of the Thermal Device.
      • Enabled [boolean]
        Indicates whether the Cooler is enabled (running) or not.
      • RunTime - optional; [float]
        Number of hours the Cooler has been running (unit: hours). Read-only.

GetRadiometryConfigurationOptions 

GetRadiometryConfigurationOptions(VideoSourceToken)

Gets the valid ranges for the Radiometry parameters that have device specific ranges.

The command shall return all supported parameters and their ranges, such that these can be applied to the SetRadiometryConfiguration command.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource for which the Thermal Radiometry Options are requested.
    Maximum length: 64
Output
  • ConfigurationOptions [RadiometryConfigurationOptions]
    Valid ranges for the Thermal Radiometry parameters that are categorized as device specific.
    • RadiometryGlobalParameterOptions - optional; [RadiometryGlobalParameterOptions]
      Specifies valid ranges and options for the global radiometry parameters used as default parameter values for temperature measurement modules (spots and boxes).
      • ReflectedAmbientTemperature [FloatRange]
        Valid range of temperature values, in Kelvin.
        • Min [float]
        • Max [float]
      • Emissivity [FloatRange]
        Valid range of emissivity values for the objects to measure.
        • Min [float]
        • Max [float]
      • DistanceToObject [FloatRange]
        Valid range of distance between camera and object for a valid temperature reading, in meters.
        • Min [float]
        • Max [float]
      • RelativeHumidity - optional; [FloatRange]
        Valid range of relative humidity values, in percentage.
        • Min [float]
        • Max [float]
      • AtmosphericTemperature - optional; [FloatRange]
        Valid range of temperature values, in Kelvin.
        • Min [float]
        • Max [float]
      • AtmosphericTransmittance - optional; [FloatRange]
        Valid range of atmospheric transmittance values.
        • Min [float]
        • Max [float]
      • ExtOpticsTemperature - optional; [FloatRange]
        Valid range of temperature values, in Kelvin.
        • Min [float]
        • Max [float]
      • ExtOpticsTransmittance - optional; [FloatRange]
        Valid range of external optics transmittance.
        • Min [float]
        • Max [float]

GetRadiometryConfiguration 

GetRadiometryConfiguration(VideoSourceToken)

Gets the Radiometry Configuration for the requested VideoSource.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource for which the Radiometry Configuration is requested.
    Maximum length: 64
Output
  • Configuration [RadiometryConfiguration]
    Radiometry Configuration for the VideoSource that was requested.
    • RadiometryGlobalParameters - optional; [RadiometryGlobalParameters]
      Global Parameters for Radiometry Measurements. Shall exist if Radiometry Capability is reported, and Global Parameters are supported by the device.
      • ReflectedAmbientTemperature [float]
        Reflected Ambient Temperature for the environment in which the thermal device and the object being measured is located.
      • Emissivity [float]
        Emissivity of the surface of the object on which temperature is being measured.
      • DistanceToObject [float]
        Distance from the thermal device to the measured object.
      • RelativeHumidity - optional; [float]
        Relative Humidity in the environment in which the measurement is located.
      • AtmosphericTemperature - optional; [float]
        Temperature of the atmosphere between the thermal device and the object being measured.
      • AtmosphericTransmittance - optional; [float]
        Transmittance value for the atmosphere between the thermal device and the object being measured.
      • ExtOpticsTemperature - optional; [float]
        Temperature of the optics elements between the thermal device and the object being measured.
      • ExtOpticsTransmittance - optional; [float]
        Transmittance value for the optics elements between the thermal device and the object being measured.

SetRadiometryConfiguration 

SetRadiometryConfiguration(VideoSourceToken, Configuration)

Sets the Radiometry Configuration for the requested VideoSource.

Input
  • VideoSourceToken [ReferenceToken]
    Reference token to the VideoSource for which the Radiometry settings are configured.
    Maximum length: 64
  • Configuration [RadiometryConfiguration]
    Radiometry settings to be configured.
    • RadiometryGlobalParameters - optional; [RadiometryGlobalParameters]
      Global Parameters for Radiometry Measurements. Shall exist if Radiometry Capability is reported, and Global Parameters are supported by the device.
      • ReflectedAmbientTemperature [float]
        Reflected Ambient Temperature for the environment in which the thermal device and the object being measured is located.
      • Emissivity [float]
        Emissivity of the surface of the object on which temperature is being measured.
      • DistanceToObject [float]
        Distance from the thermal device to the measured object.
      • RelativeHumidity - optional; [float]
        Relative Humidity in the environment in which the measurement is located.
      • AtmosphericTemperature - optional; [float]
        Temperature of the atmosphere between the thermal device and the object being measured.
      • AtmosphericTransmittance - optional; [float]
        Transmittance value for the atmosphere between the thermal device and the object being measured.
      • ExtOpticsTemperature - optional; [float]
        Temperature of the optics elements between the thermal device and the object being measured.
      • ExtOpticsTransmittance - optional; [float]
        Transmittance value for the optics elements between the thermal device and the object being measured.