Package com.tinkerforge
Class BrickletHumidityV2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletHumidityV2
-
public class BrickletHumidityV2 extends Device
Measures relative humidity
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletHumidityV2.HumidityCallbackConfiguration
static interface
BrickletHumidityV2.HumidityListener
This listener is triggered periodically according to the configuration set bysetHumidityCallbackConfiguration(long, boolean, char, int, int)
.class
BrickletHumidityV2.MovingAverageConfiguration
class
BrickletHumidityV2.SPITFPErrorCount
class
BrickletHumidityV2.TemperatureCallbackConfiguration
static interface
BrickletHumidityV2.TemperatureListener
This listener is triggered periodically according to the configuration set bysetTemperatureCallbackConfiguration(long, boolean, char, int, int)
.-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletHumidityV2(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addHumidityListener(BrickletHumidityV2.HumidityListener listener)
Adds a Humidity listener.void
addTemperatureListener(BrickletHumidityV2.TemperatureListener listener)
Adds a Temperature listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.int
getHeaterConfiguration()
Returns the heater configuration as set bysetHeaterConfiguration(int)
.int
getHumidity()
Returns the humidity measured by the sensor.BrickletHumidityV2.HumidityCallbackConfiguration
getHumidityCallbackConfiguration()
Returns the listener configuration as set bysetHumidityCallbackConfiguration(long, boolean, char, int, 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.BrickletHumidityV2.MovingAverageConfiguration
getMovingAverageConfiguration()
Returns the moving average configuration as set bysetMovingAverageConfiguration(int, int)
.int
getSamplesPerSecond()
Returnes the samples per second, as set bysetSamplesPerSecond(int)
.BrickletHumidityV2.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
int
getTemperature()
Returns the temperature measured by the sensor.BrickletHumidityV2.TemperatureCallbackConfiguration
getTemperatureCallbackConfiguration()
Returns the listener configuration as set bysetTemperatureCallbackConfiguration(long, boolean, char, int, int)
.long
readUID()
Returns the current UID as an integer.void
removeHumidityListener(BrickletHumidityV2.HumidityListener listener)
Removes a Humidity listener.void
removeTemperatureListener(BrickletHumidityV2.TemperatureListener listener)
Removes a Temperature 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
setHeaterConfiguration(int heaterConfig)
Enables/disables the heater.void
setHumidityCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)
The period is the period with which theBrickletHumidityV2.HumidityListener
listener is triggered periodically.void
setMovingAverageConfiguration(int movingAverageLengthHumidity, int movingAverageLengthTemperature)
Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__ for the humidity and temperature.void
setSamplesPerSecond(int sps)
Sets the samples per second that are gathered by the humidity/temperature sensor HDC1080.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)
The period is the period with which theBrickletHumidityV2.TemperatureListener
listener is triggered periodically.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.int
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before.void
writeUID(long uid)
Writes a new UID into flash.-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_HUMIDITY
public static final byte FUNCTION_GET_HUMIDITY
- See Also:
- Constant Field Values
-
FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_TEMPERATURE
public static final byte FUNCTION_GET_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_HEATER_CONFIGURATION
public static final byte FUNCTION_SET_HEATER_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_HEATER_CONFIGURATION
public static final byte FUNCTION_GET_HEATER_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION
public static final byte FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION
public static final byte FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_SAMPLES_PER_SECOND
public static final byte FUNCTION_SET_SAMPLES_PER_SECOND
- See Also:
- Constant Field Values
-
FUNCTION_GET_SAMPLES_PER_SECOND
public static final byte FUNCTION_GET_SAMPLES_PER_SECOND
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_WRITE_FIRMWARE
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_UID
public static final byte FUNCTION_WRITE_UID
- See Also:
- Constant Field Values
-
FUNCTION_READ_UID
public static final byte FUNCTION_READ_UID
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OFF
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_OUTSIDE
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_INSIDE
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_SMALLER
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_GREATER
public static final char THRESHOLD_OPTION_GREATER
- See Also:
- Constant Field Values
-
HEATER_CONFIG_DISABLED
public static final int HEATER_CONFIG_DISABLED
- See Also:
- Constant Field Values
-
HEATER_CONFIG_ENABLED
public static final int HEATER_CONFIG_ENABLED
- See Also:
- Constant Field Values
-
SPS_20
public static final int SPS_20
- See Also:
- Constant Field Values
-
SPS_10
public static final int SPS_10
- See Also:
- Constant Field Values
-
SPS_5
public static final int SPS_5
- See Also:
- Constant Field Values
-
SPS_1
public static final int SPS_1
- See Also:
- Constant Field Values
-
SPS_02
public static final int SPS_02
- See Also:
- Constant Field Values
-
SPS_01
public static final int SPS_01
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_BOOTLOADER
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_FIRMWARE
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_OK
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_INVALID_MODE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_NO_CHANGE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_CRC_MISMATCH
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_STATUS
public static final int STATUS_LED_CONFIG_SHOW_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletHumidityV2
public BrickletHumidityV2(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
getHumidity
public int getHumidity() throws TinkerforgeException
Returns the humidity measured by the sensor. If you want to get the value periodically, it is recommended to use theBrickletHumidityV2.HumidityListener
listener. You can set the listener configuration withsetHumidityCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setHumidityCallbackConfiguration
public void setHumidityCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
The period is the period with which theBrickletHumidityV2.HumidityListener
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 theBrickletHumidityV2.HumidityListener
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.- Throws:
TinkerforgeException
-
getHumidityCallbackConfiguration
public BrickletHumidityV2.HumidityCallbackConfiguration getHumidityCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetHumidityCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
getTemperature
public int getTemperature() throws TinkerforgeException
Returns the temperature measured by the sensor. If you want to get the value periodically, it is recommended to use theBrickletHumidityV2.TemperatureListener
listener. You can set the listener configuration withsetTemperatureCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setTemperatureCallbackConfiguration
public void setTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
The period is the period with which theBrickletHumidityV2.TemperatureListener
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 theBrickletHumidityV2.TemperatureListener
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.- Throws:
TinkerforgeException
-
getTemperatureCallbackConfiguration
public BrickletHumidityV2.TemperatureCallbackConfiguration getTemperatureCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetTemperatureCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setHeaterConfiguration
public void setHeaterConfiguration(int heaterConfig) throws TinkerforgeException
Enables/disables the heater. The heater can be used to dry the sensor in extremely wet conditions.- Throws:
TinkerforgeException
-
getHeaterConfiguration
public int getHeaterConfiguration() throws TinkerforgeException
Returns the heater configuration as set bysetHeaterConfiguration(int)
.- Throws:
TinkerforgeException
-
setMovingAverageConfiguration
public void setMovingAverageConfiguration(int movingAverageLengthHumidity, int movingAverageLengthTemperature) throws TinkerforgeException
Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__ for the humidity and temperature. Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data. New data is gathered every 50ms*. With a moving average of length 1000 the resulting averaging window has a length of 50s. If you want to do long term measurements the longest moving average will give the cleanest results. \* In firmware version 2.0.3 we added thesetSamplesPerSecond(int)
function. It configures the measurement frequency. Since high frequencies can result in self-heating of th IC, changed the default value from 20 samples per second to 1. With 1 sample per second a moving average length of 1000 would result in an averaging window of 1000 seconds!- Throws:
TinkerforgeException
-
getMovingAverageConfiguration
public BrickletHumidityV2.MovingAverageConfiguration getMovingAverageConfiguration() throws TinkerforgeException
Returns the moving average configuration as set bysetMovingAverageConfiguration(int, int)
.- Throws:
TinkerforgeException
-
setSamplesPerSecond
public void setSamplesPerSecond(int sps) throws TinkerforgeException
Sets the samples per second that are gathered by the humidity/temperature sensor HDC1080. We added this function since we found out that a high measurement frequency can lead to self-heating of the sensor. Which can distort the temperature measurement. If you don't need a lot of measurements, you can use the lowest available measurement frequency of 0.1 samples per second for the least amount of self-heating. Before version 2.0.3 the default was 20 samples per second. The new default is 1 sample per second. .. versionadded:: 2.0.3$nbsp;(Plugin)- Throws:
TinkerforgeException
-
getSamplesPerSecond
public int getSamplesPerSecond() throws TinkerforgeException
Returnes the samples per second, as set bysetSamplesPerSecond(int)
. .. versionadded:: 2.0.3$nbsp;(Plugin)- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletHumidityV2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
setBootloaderMode
public int setBootloaderMode(int mode) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getBootloaderMode
public int getBootloaderMode() throws TinkerforgeException
Returns the current bootloader mode, seesetBootloaderMode(int)
.- Throws:
TinkerforgeException
-
setWriteFirmwarePointer
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
Sets the firmware pointer forwriteFirmware(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.- Throws:
TinkerforgeException
-
writeFirmware
public int writeFirmware(int[] data) throws TinkerforgeException
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(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.- Throws:
TinkerforgeException
-
setStatusLEDConfig
public void setStatusLEDConfig(int config) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getStatusLEDConfig
public int getStatusLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetStatusLEDConfig(int)
- Throws:
TinkerforgeException
-
getChipTemperature
public int getChipTemperature() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
reset
public void reset() throws TinkerforgeException
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!- Throws:
TinkerforgeException
-
writeUID
public void writeUID(long uid) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
readUID
public long readUID() throws TinkerforgeException
Returns the current UID as an integer. Encode as Base58 to get the usual string version.- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
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 :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
addHumidityListener
public void addHumidityListener(BrickletHumidityV2.HumidityListener listener)
Adds a Humidity listener.
-
removeHumidityListener
public void removeHumidityListener(BrickletHumidityV2.HumidityListener listener)
Removes a Humidity listener.
-
addTemperatureListener
public void addTemperatureListener(BrickletHumidityV2.TemperatureListener listener)
Adds a Temperature listener.
-
removeTemperatureListener
public void removeTemperatureListener(BrickletHumidityV2.TemperatureListener listener)
Removes a Temperature listener.
-
-