public class BrickletThermalImaging extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletThermalImaging.FluxLinearParameters |
class |
BrickletThermalImaging.HighContrastConfig |
static interface |
BrickletThermalImaging.HighContrastImageListener
This listener is triggered with every new high contrast image if the transfer image
config is configured for high contrast listener (see
setImageTransferConfig(int) ). |
class |
BrickletThermalImaging.HighContrastImageLowLevel |
static interface |
BrickletThermalImaging.HighContrastImageLowLevelListener |
class |
BrickletThermalImaging.SPITFPErrorCount |
class |
BrickletThermalImaging.Statistics |
static interface |
BrickletThermalImaging.TemperatureImageListener
This listener is triggered with every new temperature image if the transfer image
config is configured for temperature listener (see
setImageTransferConfig(int) ). |
class |
BrickletThermalImaging.TemperatureImageLowLevel |
static interface |
BrickletThermalImaging.TemperatureImageLowLevelListener |
Device.Identity
Constructor and Description |
---|
BrickletThermalImaging(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addHighContrastImageListener(BrickletThermalImaging.HighContrastImageListener listener)
Adds a HighContrastImage listener.
|
void |
addHighContrastImageLowLevelListener(BrickletThermalImaging.HighContrastImageLowLevelListener listener)
Adds a HighContrastImageLowLevel listener.
|
void |
addTemperatureImageListener(BrickletThermalImaging.TemperatureImageListener listener)
Adds a TemperatureImage listener.
|
void |
addTemperatureImageLowLevelListener(BrickletThermalImaging.TemperatureImageLowLevelListener listener)
Adds a TemperatureImageLowLevel listener.
|
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
BrickletThermalImaging.FluxLinearParameters |
getFluxLinearParameters()
Returns the flux linear parameters, as set by
setFluxLinearParameters(int, int, int, int, int, int, int, int) . |
BrickletThermalImaging.HighContrastConfig |
getHighContrastConfig()
Returns the high contrast config as set by
setHighContrastConfig(int[], int, int[], int) . |
int[] |
getHighContrastImage()
Returns the current high contrast image.
|
BrickletThermalImaging.HighContrastImageLowLevel |
getHighContrastImageLowLevel()
Returns the current high contrast image.
|
Device.Identity |
getIdentity()
Returns the UID, the UID where the Bricklet is connected to,
the position, the hardware and firmware version as well as the
device identifier.
|
int |
getImageTransferConfig()
Returns the image transfer config, as set by
setImageTransferConfig(int) . |
int |
getResolution()
Returns the resolution as set by
setResolution(int) . |
BrickletThermalImaging.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int[] |
getSpotmeterConfig()
Returns the spotmeter config as set by
setSpotmeterConfig(int[]) . |
BrickletThermalImaging.Statistics |
getStatistics()
Returns the spotmeter statistics, various temperatures, current resolution and status bits.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
int[] |
getTemperatureImage()
Returns the current temperature image.
|
BrickletThermalImaging.TemperatureImageLowLevel |
getTemperatureImageLowLevel()
Returns the current temperature image.
|
long |
readUID()
Returns the current UID as an integer.
|
void |
removeHighContrastImageListener(BrickletThermalImaging.HighContrastImageListener listener)
Removes a HighContrastImage listener.
|
void |
removeHighContrastImageLowLevelListener(BrickletThermalImaging.HighContrastImageLowLevelListener listener)
Removes a HighContrastImageLowLevel listener.
|
void |
removeTemperatureImageListener(BrickletThermalImaging.TemperatureImageListener listener)
Removes a TemperatureImage listener.
|
void |
removeTemperatureImageLowLevelListener(BrickletThermalImaging.TemperatureImageLowLevelListener listener)
Removes a TemperatureImageLowLevel listener.
|
void |
reset()
Calling this function will reset the Bricklet.
|
int |
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested
mode change was instigated.
|
void |
setFluxLinearParameters(int sceneEmissivity,
int temperatureBackground,
int tauWindow,
int temperaturWindow,
int tauAtmosphere,
int temperatureAtmosphere,
int reflectionWindow,
int temperatureReflection)
Sets the flux linear parameters that can be used for radiometry calibration.
|
void |
setHighContrastConfig(int[] regionOfInterest,
int dampeningFactor,
int[] clipLimit,
int emptyCounts)
Sets the high contrast region of interest, dampening factor, clip limit and empty counts.
|
void |
setImageTransferConfig(int config)
The necessary bandwidth of this Bricklet is too high to use getter/listener or
high contrast/temperature image at the same time.
|
void |
setResolution(int resolution)
Sets the resolution.
|
void |
setSpotmeterConfig(int[] regionOfInterest)
Sets the spotmeter region of interest.
|
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(int[]) . |
int |
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written by
setWriteFirmwarePointer(long) before. |
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final java.lang.String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_HIGH_CONTRAST_IMAGE_LOW_LEVEL
public static final byte FUNCTION_GET_TEMPERATURE_IMAGE_LOW_LEVEL
public static final byte FUNCTION_GET_STATISTICS
public static final byte FUNCTION_SET_RESOLUTION
public static final byte FUNCTION_GET_RESOLUTION
public static final byte FUNCTION_SET_SPOTMETER_CONFIG
public static final byte FUNCTION_GET_SPOTMETER_CONFIG
public static final byte FUNCTION_SET_HIGH_CONTRAST_CONFIG
public static final byte FUNCTION_GET_HIGH_CONTRAST_CONFIG
public static final byte FUNCTION_SET_IMAGE_TRANSFER_CONFIG
public static final byte FUNCTION_GET_IMAGE_TRANSFER_CONFIG
public static final byte FUNCTION_SET_FLUX_LINEAR_PARAMETERS
public static final byte FUNCTION_GET_FLUX_LINEAR_PARAMETERS
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final int RESOLUTION_0_TO_6553_KELVIN
public static final int RESOLUTION_0_TO_655_KELVIN
public static final int FFC_STATUS_NEVER_COMMANDED
public static final int FFC_STATUS_IMMINENT
public static final int FFC_STATUS_IN_PROGRESS
public static final int FFC_STATUS_COMPLETE
public static final int IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE
public static final int IMAGE_TRANSFER_MANUAL_TEMPERATURE_IMAGE
public static final int IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE
public static final int IMAGE_TRANSFER_CALLBACK_TEMPERATURE_IMAGE
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletThermalImaging(java.lang.String uid, IPConnection ipcon)
public BrickletThermalImaging.HighContrastImageLowLevel getHighContrastImageLowLevel() throws TinkerforgeException
setImageTransferConfig(int)
.TinkerforgeException
public BrickletThermalImaging.TemperatureImageLowLevel getTemperatureImageLowLevel() throws TinkerforgeException
setResolution(int)
).
Before you can use this function you have to enable it with
setImageTransferConfig(int)
.TinkerforgeException
public BrickletThermalImaging.Statistics getStatistics() throws TinkerforgeException
TinkerforgeException
public void setResolution(int resolution) throws TinkerforgeException
TinkerforgeException
public int getResolution() throws TinkerforgeException
setResolution(int)
.TinkerforgeException
public void setSpotmeterConfig(int[] regionOfInterest) throws TinkerforgeException
getStatistics()
.TinkerforgeException
public int[] getSpotmeterConfig() throws TinkerforgeException
setSpotmeterConfig(int[])
.TinkerforgeException
public void setHighContrastConfig(int[] regionOfInterest, int dampeningFactor, int[] clipLimit, int emptyCounts) throws TinkerforgeException
setImageTransferConfig(int)
).
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.TinkerforgeException
public BrickletThermalImaging.HighContrastConfig getHighContrastConfig() throws TinkerforgeException
setHighContrastConfig(int[], int, int[], int)
.TinkerforgeException
public void setImageTransferConfig(int config) throws TinkerforgeException
getHighContrastImage()
.
* Manual Temperature Image: getTemperatureImage()
.
* Listener High Contrast Image: BrickletThermalImaging.HighContrastImageListener
listener.
* Listener Temperature Image: BrickletThermalImaging.TemperatureImageListener
listener.TinkerforgeException
public int getImageTransferConfig() throws TinkerforgeException
setImageTransferConfig(int)
.TinkerforgeException
public void setFluxLinearParameters(int sceneEmissivity, int temperatureBackground, int tauWindow, int temperaturWindow, int tauAtmosphere, int temperatureAtmosphere, int reflectionWindow, int temperatureReflection) throws TinkerforgeException
TinkerforgeException
public BrickletThermalImaging.FluxLinearParameters getFluxLinearParameters() throws TinkerforgeException
setFluxLinearParameters(int, int, int, int, int, int, int, int)
.
.. versionadded:: 2.0.5$nbsp;(Plugin)TinkerforgeException
public BrickletThermalImaging.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
writeFirmware(int[])
. 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.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
setWriteFirmwarePointer(long)
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.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public int[] getHighContrastImage() throws TinkerforgeException
setImageTransferConfig(int)
.TinkerforgeException
public int[] getTemperatureImage() throws TinkerforgeException
setResolution(int)
).
Before you can use this function you have to enable it with
setImageTransferConfig(int)
.TinkerforgeException
public void addHighContrastImageLowLevelListener(BrickletThermalImaging.HighContrastImageLowLevelListener listener)
public void removeHighContrastImageLowLevelListener(BrickletThermalImaging.HighContrastImageLowLevelListener listener)
public void addTemperatureImageLowLevelListener(BrickletThermalImaging.TemperatureImageLowLevelListener listener)
public void removeTemperatureImageLowLevelListener(BrickletThermalImaging.TemperatureImageLowLevelListener listener)
public void addHighContrastImageListener(BrickletThermalImaging.HighContrastImageListener listener)
public void removeHighContrastImageListener(BrickletThermalImaging.HighContrastImageListener listener)
public void addTemperatureImageListener(BrickletThermalImaging.TemperatureImageListener listener)
public void removeTemperatureImageListener(BrickletThermalImaging.TemperatureImageListener listener)
Copyright © 2020 Tinkerforge GmbH. All rights reserved.