public class BrickletTemperatureIRV2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletTemperatureIRV2.AmbientTemperatureCallbackConfiguration |
static interface |
BrickletTemperatureIRV2.AmbientTemperatureListener
This listener is triggered periodically according to the configuration set by
setAmbientTemperatureCallbackConfiguration(long, boolean, char, int, int) . |
class |
BrickletTemperatureIRV2.ObjectTemperatureCallbackConfiguration |
static interface |
BrickletTemperatureIRV2.ObjectTemperatureListener
This listener is triggered periodically according to the configuration set by
setObjectTemperatureCallbackConfiguration(long, boolean, char, int, int) . |
class |
BrickletTemperatureIRV2.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletTemperatureIRV2(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addAmbientTemperatureListener(BrickletTemperatureIRV2.AmbientTemperatureListener listener)
Adds a AmbientTemperature listener.
|
void |
addObjectTemperatureListener(BrickletTemperatureIRV2.ObjectTemperatureListener listener)
Adds a ObjectTemperature listener.
|
int |
getAmbientTemperature()
Returns the ambient temperature of the sensor.
|
BrickletTemperatureIRV2.AmbientTemperatureCallbackConfiguration |
getAmbientTemperatureCallbackConfiguration()
Returns the listener configuration as set by
setAmbientTemperatureCallbackConfiguration(long, boolean, char, int, int) . |
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
int |
getEmissivity()
Returns the emissivity as set by
setEmissivity(int) . |
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 |
getObjectTemperature()
Returns the object temperature of the sensor, i.e.
|
BrickletTemperatureIRV2.ObjectTemperatureCallbackConfiguration |
getObjectTemperatureCallbackConfiguration()
Returns the listener configuration as set by
setObjectTemperatureCallbackConfiguration(long, boolean, char, int, int) . |
BrickletTemperatureIRV2.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
long |
readUID()
Returns the current UID as an integer.
|
void |
removeAmbientTemperatureListener(BrickletTemperatureIRV2.AmbientTemperatureListener listener)
Removes a AmbientTemperature listener.
|
void |
removeObjectTemperatureListener(BrickletTemperatureIRV2.ObjectTemperatureListener listener)
Removes a ObjectTemperature listener.
|
void |
reset()
Calling this function will reset the Bricklet.
|
void |
setAmbientTemperatureCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletTemperatureIRV2.AmbientTemperatureListener listener is triggered
periodically. |
int |
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested
mode change was instigated.
|
void |
setEmissivity(int emissivity)
Sets the `emissivity <https://en.wikipedia.org/wiki/Emissivity>`__ that is
used to calculate the surface temperature as returned by
getObjectTemperature() . |
void |
setObjectTemperatureCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletTemperatureIRV2.ObjectTemperatureListener listener is triggered
periodically. |
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 String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_AMBIENT_TEMPERATURE
public static final byte FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_AMBIENT_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_OBJECT_TEMPERATURE
public static final byte FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_EMISSIVITY
public static final byte FUNCTION_GET_EMISSIVITY
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 char THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_GREATER
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 BrickletTemperatureIRV2(String uid, IPConnection ipcon)
public int getAmbientTemperature() throws TinkerforgeException
BrickletTemperatureIRV2.AmbientTemperatureListener
listener. You can set the listener configuration
with setAmbientTemperatureCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setAmbientTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletTemperatureIRV2.AmbientTemperatureListener
listener is triggered
periodically. A value of 0 turns the listener off.
If the `value has to change`-parameter is set to true, the listener is only
triggered after the value has changed. If the value didn't change
within the period, the listener is triggered immediately on change.
If it is set to false, the listener is continuously triggered with the period,
independent of the value.
It is furthermore possible to constrain the listener with thresholds.
The `option`-parameter together with min/max sets a threshold for the BrickletTemperatureIRV2.AmbientTemperatureListener
listener.
The following options are possible:
\verbatim
"Option", "Description"
"'x'", "Threshold is turned off"
"'o'", "Threshold is triggered when the value is *outside* the min and max values"
"'i'", "Threshold is triggered when the value is *inside* or equal to the min and max values"
"'<'", "Threshold is triggered when the value is smaller than the min value (max is ignored)"
"'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)"
\endverbatim
If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.TinkerforgeException
public BrickletTemperatureIRV2.AmbientTemperatureCallbackConfiguration getAmbientTemperatureCallbackConfiguration() throws TinkerforgeException
setAmbientTemperatureCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public int getObjectTemperature() throws TinkerforgeException
setEmissivity(int)
.
If you want to get the value periodically, it is recommended to use the
BrickletTemperatureIRV2.ObjectTemperatureListener
listener. You can set the listener configuration
with setObjectTemperatureCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setObjectTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletTemperatureIRV2.ObjectTemperatureListener
listener is triggered
periodically. A value of 0 turns the listener off.
If the `value has to change`-parameter is set to true, the listener is only
triggered after the value has changed. If the value didn't change
within the period, the listener is triggered immediately on change.
If it is set to false, the listener is continuously triggered with the period,
independent of the value.
It is furthermore possible to constrain the listener with thresholds.
The `option`-parameter together with min/max sets a threshold for the BrickletTemperatureIRV2.ObjectTemperatureListener
listener.
The following options are possible:
\verbatim
"Option", "Description"
"'x'", "Threshold is turned off"
"'o'", "Threshold is triggered when the value is *outside* the min and max values"
"'i'", "Threshold is triggered when the value is *inside* or equal to the min and max values"
"'<'", "Threshold is triggered when the value is smaller than the min value (max is ignored)"
"'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)"
\endverbatim
If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.TinkerforgeException
public BrickletTemperatureIRV2.ObjectTemperatureCallbackConfiguration getObjectTemperatureCallbackConfiguration() throws TinkerforgeException
setObjectTemperatureCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setEmissivity(int emissivity) throws TinkerforgeException
getObjectTemperature()
.
The emissivity is usually given as a value between 0.0 and 1.0. A list of
emissivities of different materials can be found
`here <https://www.infrared-thermography.com/material.htm>`__.
The parameter of setEmissivity(int)
has to be given with a factor of
65535 (16-bit). For example: An emissivity of 0.1 can be set with the
value 6553, an emissivity of 0.5 with the value 32767 and so on.
\note
If you need a precise measurement for the object temperature, it is
absolutely crucial that you also provide a precise emissivity.
The emissivity is stored in non-volatile memory and will still be
used after a restart or power cycle of the Bricklet.TinkerforgeException
public int getEmissivity() throws TinkerforgeException
setEmissivity(int)
.TinkerforgeException
public BrickletTemperatureIRV2.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 void addAmbientTemperatureListener(BrickletTemperatureIRV2.AmbientTemperatureListener listener)
public void removeAmbientTemperatureListener(BrickletTemperatureIRV2.AmbientTemperatureListener listener)
public void addObjectTemperatureListener(BrickletTemperatureIRV2.ObjectTemperatureListener listener)
public void removeObjectTemperatureListener(BrickletTemperatureIRV2.ObjectTemperatureListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.