thermal_imaging_bricklet

func (*ThermalImagingBricklet) DeregisterHighContrastImageCallback ¶

func (device *ThermalImagingBricklet) DeregisterHighContrastImageCallback(registrationId uint64)

Remove a registered High Contrast Image Low Level callback.

func (*ThermalImagingBricklet) DeregisterHighContrastImageLowLevelCallback ¶

func (device *ThermalImagingBricklet) DeregisterHighContrastImageLowLevelCallback(registrationId uint64)

Remove a registered High Contrast Image Low Level callback.

func (*ThermalImagingBricklet) DeregisterTemperatureImageCallback ¶

func (device *ThermalImagingBricklet) DeregisterTemperatureImageCallback(registrationId uint64)

Remove a registered Temperature Image Low Level callback.

func (*ThermalImagingBricklet) DeregisterTemperatureImageLowLevelCallback ¶

func (device *ThermalImagingBricklet) DeregisterTemperatureImageLowLevelCallback(registrationId uint64)

Remove a registered Temperature Image Low Level callback.

func (*ThermalImagingBricklet) GetAPIVersion ¶

func (device *ThermalImagingBricklet) GetAPIVersion() [3]uint8

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

func (*ThermalImagingBricklet) GetBootloaderMode ¶

func (device *ThermalImagingBricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

• BootloaderModeBootloader
• BootloaderModeFirmware
• BootloaderModeBootloaderWaitForReboot
• BootloaderModeFirmwareWaitForReboot
• BootloaderModeFirmwareWaitForEraseAndReboot

func (*ThermalImagingBricklet) GetChipTemperature ¶

func (device *ThermalImagingBricklet) GetChipTemperature() (temperature int16, err error)

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

func (*ThermalImagingBricklet) GetFFCShutterMode ¶

func (device *ThermalImagingBricklet) GetFFCShutterMode() (shutterMode ShutterMode, tempLockoutState ShutterLockout, videoFreezeDuringFFC bool, ffcDesired bool, elapsedTimeSinceLastFFC uint32, desiredFFCPeriod uint32, explicitCmdToOpen bool, desiredFFCTempDelta uint16, imminentDelay uint16, err error)

Sets the FFC shutter mode parameters.

See FLIR document 110-0144-03 4.5.15 for more details.

.. versionadded:: 2.0.6$nbsp;(Plugin)

Associated constants:

• ShutterModeManual
• ShutterModeAuto
• ShutterModeExternal
• ShutterLockoutInactive
• ShutterLockoutHigh
• ShutterLockoutLow

func (*ThermalImagingBricklet) GetFluxLinearParameters ¶

func (device *ThermalImagingBricklet) GetFluxLinearParameters() (sceneEmissivity uint16, temperatureBackground uint16, tauWindow uint16, temperaturWindow uint16, tauAtmosphere uint16, temperatureAtmosphere uint16, reflectionWindow uint16, temperatureReflection uint16, err error)

Returns the flux linear parameters, as set by SetFluxLinearParameters.

.. versionadded:: 2.0.5$nbsp;(Plugin)

func (*ThermalImagingBricklet) GetHighContrastConfig ¶

func (device *ThermalImagingBricklet) GetHighContrastConfig() (regionOfInterest [4]uint8, dampeningFactor uint16, clipLimit [2]uint16, emptyCounts uint16, err error)

Returns the high contrast config as set by SetHighContrastConfig.

func (*ThermalImagingBricklet) GetHighContrastImage ¶

func (device *ThermalImagingBricklet) GetHighContrastImage() (image []uint8, err error)

Returns the current high contrast image. See https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Thermal_Imaging.html#high-contrast-image-vs-temperature-image for the difference between High Contrast and Temperature Image. If you don't know what to use the High Contrast Image is probably right for you.

The data is organized as a 8-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.

Each 8-bit value represents one gray-scale image pixel that can directly be shown to a user on a display.

Before you can use this function you have to enable it with SetImageTransferConfig.

func (*ThermalImagingBricklet) GetHighContrastImageLowLevel ¶

func (device *ThermalImagingBricklet) GetHighContrastImageLowLevel() (imageChunkOffset uint16, imageChunkData [62]uint8, err error)

Returns the current high contrast image. See https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Thermal_Imaging.html#high-contrast-image-vs-temperature-image for the difference between High Contrast and Temperature Image. If you don't know what to use the High Contrast Image is probably right for you.

The data is organized as a 8-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.

Each 8-bit value represents one gray-scale image pixel that can directly be shown to a user on a display.

Before you can use this function you have to enable it with SetImageTransferConfig.

func (*ThermalImagingBricklet) GetIdentity ¶

func (device *ThermalImagingBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*ThermalImagingBricklet) GetImageTransferConfig ¶

func (device *ThermalImagingBricklet) GetImageTransferConfig() (config ImageTransfer, err error)

Returns the image transfer config, as set by SetImageTransferConfig.

Associated constants:

• ImageTransferManualHighContrastImage
• ImageTransferManualTemperatureImage
• ImageTransferCallbackHighContrastImage
• ImageTransferCallbackTemperatureImage

func (*ThermalImagingBricklet) GetResolution ¶

func (device *ThermalImagingBricklet) GetResolution() (resolution Resolution, err error)

Returns the resolution as set by SetResolution.

Associated constants:

• Resolution0To6553Kelvin
• Resolution0To655Kelvin

func (*ThermalImagingBricklet) GetResponseExpected ¶

func (device *ThermalImagingBricklet) GetResponseExpected(functionID Function) (bool, error)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

func (*ThermalImagingBricklet) GetSPITFPErrorCount ¶

func (device *ThermalImagingBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into ¶

* ACK checksum errors, * message checksum errors, * framing errors and * overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

func (*ThermalImagingBricklet) GetSpotmeterConfig ¶

func (device *ThermalImagingBricklet) GetSpotmeterConfig() (regionOfInterest [4]uint8, err error)

Returns the spotmeter config as set by SetSpotmeterConfig.

func (*ThermalImagingBricklet) GetStatistics ¶

func (device *ThermalImagingBricklet) GetStatistics() (spotmeterStatistics [4]uint16, temperatures [4]uint16, resolution Resolution, ffcStatus FFCStatus, temperatureWarning [2]bool, err error)

Returns the spotmeter statistics, various temperatures, current resolution and status bits.

The spotmeter statistics are:

* Index 0: Mean Temperature. * Index 1: Maximum Temperature. * Index 2: Minimum Temperature. * Index 3: Pixel Count of spotmeter region of interest.

The temperatures are:

* Index 0: Focal Plain Array temperature. * Index 1: Focal Plain Array temperature at last FFC (Flat Field Correction). * Index 2: Housing temperature. * Index 3: Housing temperature at last FFC.

The resolution is either `0 to 6553 Kelvin` or `0 to 655 Kelvin`. If the resolution is the former, the temperatures are in Kelvin/10, if it is the latter the temperatures are in Kelvin/100.

FFC (Flat Field Correction) Status:

* FFC Never Commanded: Only seen on startup before first FFC. * FFC Imminent: This state is entered 2 seconds prior to initiating FFC. * FFC In Progress: Flat field correction is started (shutter moves in front of lens and back). Takes about 1 second. * FFC Complete: Shutter is in waiting position again, FFC done.

Temperature warning bits:

* Index 0: Shutter lockout (if true shutter is locked out because temperature is outside -10°C to +65°C) * Index 1: Overtemperature shut down imminent (goes true 10 seconds before shutdown)

Associated constants:

• Resolution0To6553Kelvin
• Resolution0To655Kelvin
• FFCStatusNeverCommanded
• FFCStatusImminent
• FFCStatusInProgress
• FFCStatusComplete

func (*ThermalImagingBricklet) GetStatusLEDConfig ¶

func (device *ThermalImagingBricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

• StatusLEDConfigOff
• StatusLEDConfigOn
• StatusLEDConfigShowHeartbeat
• StatusLEDConfigShowStatus

func (*ThermalImagingBricklet) GetTemperatureImage ¶

func (device *ThermalImagingBricklet) GetTemperatureImage() (image []uint16, err error)

Returns the current temperature image. See https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Thermal_Imaging.html#high-contrast-image-vs-temperature-image for the difference between High Contrast and Temperature Image. If you don't know what to use the High Contrast Image is probably right for you.

The data is organized as a 16-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.

Each 16-bit value represents one temperature measurement in either Kelvin/10 or Kelvin/100 (depending on the resolution set with SetResolution).

Before you can use this function you have to enable it with SetImageTransferConfig.

func (*ThermalImagingBricklet) GetTemperatureImageLowLevel ¶

func (device *ThermalImagingBricklet) GetTemperatureImageLowLevel() (imageChunkOffset uint16, imageChunkData [31]uint16, err error)

Returns the current temperature image. See https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Thermal_Imaging.html#high-contrast-image-vs-temperature-image for the difference between High Contrast and Temperature Image. If you don't know what to use the High Contrast Image is probably right for you.

The data is organized as a 16-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.

Each 16-bit value represents one temperature measurement in either Kelvin/10 or Kelvin/100 (depending on the resolution set with SetResolution).

Before you can use this function you have to enable it with SetImageTransferConfig.

func (*ThermalImagingBricklet) ReadUID ¶

func (device *ThermalImagingBricklet) ReadUID() (uid uint32, err error)

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

func (*ThermalImagingBricklet) RegisterHighContrastImageCallback ¶

func (device *ThermalImagingBricklet) RegisterHighContrastImageCallback(fn func([]uint8)) uint64

This callback is triggered with every new high contrast image if the transfer image config is configured for high contrast callback (see SetImageTransferConfig).

The data is organized as a 8-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.

Each 8-bit value represents one gray-scale image pixel that can directly be shown to a user on a display.

Note

If reconstructing the value fails, the callback is triggered with nil for image.

func (*ThermalImagingBricklet) RegisterHighContrastImageLowLevelCallback ¶

func (device *ThermalImagingBricklet) RegisterHighContrastImageLowLevelCallback(fn func(uint16, [62]uint8)) uint64

See RegisterHighContrastImageCallback

func (*ThermalImagingBricklet) RegisterTemperatureImageCallback ¶

func (device *ThermalImagingBricklet) RegisterTemperatureImageCallback(fn func([]uint16)) uint64

This callback is triggered with every new temperature image if the transfer image config is configured for temperature callback (see SetImageTransferConfig).

The data is organized as a 16-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.

Each 16-bit value represents one temperature measurement in either Kelvin/10 or Kelvin/100 (depending on the resolution set with SetResolution).

Note

If reconstructing the value fails, the callback is triggered with nil for image.

func (*ThermalImagingBricklet) RegisterTemperatureImageLowLevelCallback ¶

func (device *ThermalImagingBricklet) RegisterTemperatureImageLowLevelCallback(fn func(uint16, [31]uint16)) uint64

See RegisterTemperatureImageCallback

func (*ThermalImagingBricklet) Reset ¶

func (device *ThermalImagingBricklet) Reset() (err error)

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

func (*ThermalImagingBricklet) RunFFCNormalization ¶

func (device *ThermalImagingBricklet) RunFFCNormalization() (err error)

Starts the Flat-Field Correction (FFC) normalization.

See FLIR document 110-0144-03 4.5.16 for more details.

.. versionadded:: 2.0.6$nbsp;(Plugin)

func (*ThermalImagingBricklet) SetBootloaderMode ¶

func (device *ThermalImagingBricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Associated constants:

• BootloaderModeBootloader
• BootloaderModeFirmware
• BootloaderModeBootloaderWaitForReboot
• BootloaderModeFirmwareWaitForReboot
• BootloaderModeFirmwareWaitForEraseAndReboot
• BootloaderStatusOK
• BootloaderStatusInvalidMode
• BootloaderStatusNoChange
• BootloaderStatusEntryFunctionNotPresent
• BootloaderStatusDeviceIdentifierIncorrect
• BootloaderStatusCRCMismatch

func (*ThermalImagingBricklet) SetFFCShutterMode ¶

func (device *ThermalImagingBricklet) SetFFCShutterMode(shutterMode ShutterMode, tempLockoutState ShutterLockout, videoFreezeDuringFFC bool, ffcDesired bool, elapsedTimeSinceLastFFC uint32, desiredFFCPeriod uint32, explicitCmdToOpen bool, desiredFFCTempDelta uint16, imminentDelay uint16) (err error)

Sets the FFC shutter mode parameters.

See FLIR document 110-0144-03 4.5.15 for more details.

.. versionadded:: 2.0.6$nbsp;(Plugin)

Associated constants:

• ShutterModeManual
• ShutterModeAuto
• ShutterModeExternal
• ShutterLockoutInactive
• ShutterLockoutHigh
• ShutterLockoutLow

func (*ThermalImagingBricklet) SetFluxLinearParameters ¶

func (device *ThermalImagingBricklet) SetFluxLinearParameters(sceneEmissivity uint16, temperatureBackground uint16, tauWindow uint16, temperaturWindow uint16, tauAtmosphere uint16, temperatureAtmosphere uint16, reflectionWindow uint16, temperatureReflection uint16) (err error)

Sets the flux linear parameters that can be used for radiometry calibration.

See FLIR document 102-PS245-100-01 for more details.

.. versionadded:: 2.0.5$nbsp;(Plugin)

func (*ThermalImagingBricklet) SetHighContrastConfig ¶

func (device *ThermalImagingBricklet) SetHighContrastConfig(regionOfInterest [4]uint8, dampeningFactor uint16, clipLimit [2]uint16, emptyCounts uint16) (err error)

Sets the high contrast region of interest, dampening factor, clip limit and empty counts. This config is only used in high contrast mode (see SetImageTransferConfig).

The high contrast region of interest consists of four values:

* Index 0: Column start (has to be smaller or equal then Column end). * Index 1: Row start (has to be smaller then Row end). * Index 2: Column end (has to be smaller then 80). * Index 3: Row end (has to be smaller then 60).

The algorithm to generate the high contrast image is applied to this region.

Dampening Factor: This parameter is the amount of temporal dampening applied to the HEQ (history equalization) transformation function. An IIR filter of the form::

(N / 256) * previous + ((256 - N) / 256) * current

is applied, and the HEQ dampening factor represents the value N in the equation, i.e., a value that applies to the amount of influence the previous HEQ transformation function has on the current function. The lower the value of N the higher the influence of the current video frame whereas the higher the value of N the more influence the previous damped transfer function has.

Clip Limit Index 0 (AGC HEQ Clip Limit High): This parameter defines the maximum number of pixels allowed to accumulate in any given histogram bin. Any additional pixels in a given bin are clipped. The effect of this parameter is to limit the influence of highly-populated bins on the resulting HEQ transformation function.

Clip Limit Index 1 (AGC HEQ Clip Limit Low): This parameter defines an artificial population that is added to every non-empty histogram bin. In other words, if the Clip Limit Low is set to L, a bin with an actual population of X will have an effective population of L + X. Any empty bin that is nearby a populated bin will be given an artificial population of L. The effect of higher values is to provide a more linear transfer function; lower values provide a more non-linear (equalized) transfer function.

Empty Counts: This parameter specifies the maximum number of pixels in a bin that will be interpreted as an empty bin. Histogram bins with this number of pixels or less will be processed as an empty bin.

func (*ThermalImagingBricklet) SetImageTransferConfig ¶

func (device *ThermalImagingBricklet) SetImageTransferConfig(config ImageTransfer) (err error)

The necessary bandwidth of this Bricklet is too high to use getter/callback or high contrast/temperature image at the same time. You have to configure the one you want to use, the Bricklet will optimize the internal configuration accordingly.

Corresponding functions:

* Manual High Contrast Image: GetHighContrastImage. * Manual Temperature Image: GetTemperatureImage. * Callback High Contrast Image: RegisterHighContrastImageCallback callback. * Callback Temperature Image: RegisterTemperatureImageCallback callback.

Associated constants:

• ImageTransferManualHighContrastImage
• ImageTransferManualTemperatureImage
• ImageTransferCallbackHighContrastImage
• ImageTransferCallbackTemperatureImage

func (*ThermalImagingBricklet) SetResolution ¶

func (device *ThermalImagingBricklet) SetResolution(resolution Resolution) (err error)

Sets the resolution. The Thermal Imaging Bricklet can either measure

* from 0 to 6553 Kelvin (-273.15°C to +6279.85°C) with 0.1°C resolution or * from 0 to 655 Kelvin (-273.15°C to +381.85°C) with 0.01°C resolution.

The accuracy is specified for -10°C to 450°C in the first range and -10°C and 140°C in the second range.

Associated constants:

• Resolution0To6553Kelvin
• Resolution0To655Kelvin

func (*ThermalImagingBricklet) SetResponseExpected ¶

func (device *ThermalImagingBricklet) SetResponseExpected(functionID Function, responseExpected bool) error

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

func (*ThermalImagingBricklet) SetResponseExpectedAll ¶

func (device *ThermalImagingBricklet) SetResponseExpectedAll(responseExpected bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

func (*ThermalImagingBricklet) SetSpotmeterConfig ¶

func (device *ThermalImagingBricklet) SetSpotmeterConfig(regionOfInterest [4]uint8) (err error)

Sets the spotmeter region of interest. The 4 values are

* Index 0: Column start (has to be smaller then Column end). * Index 1: Row start (has to be smaller then Row end). * Index 2: Column end (has to be smaller then 80). * Index 3: Row end (has to be smaller then 60).

The spotmeter statistics can be read out with GetStatistics.

func (*ThermalImagingBricklet) SetStatusLEDConfig ¶

func (device *ThermalImagingBricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

Associated constants:

• StatusLEDConfigOff
• StatusLEDConfigOn
• StatusLEDConfigShowHeartbeat
• StatusLEDConfigShowStatus

func (*ThermalImagingBricklet) SetWriteFirmwarePointer ¶

func (device *ThermalImagingBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*ThermalImagingBricklet) WriteFirmware ¶

func (device *ThermalImagingBricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*ThermalImagingBricklet) WriteUID ¶

func (device *ThermalImagingBricklet) WriteUID(uid uint32) (err error)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.