TCP/IP - Humidity Bricklet 2.0

This is the description of the TCP/IP protocol for the Humidity Bricklet 2.0. General information and technical specifications for the Humidity Bricklet 2.0 are summarized in its hardware description.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletHumidityV2.get_humidity
Function ID:

1

Request:

empty payload

Response:
  • humidity -- uint16

Returns the humidity measured by the sensor. The value has a range of 0 to 10000 and is given in %RH/100 (Relative Humidity), i.e. a value of 4223 means that a humidity of 42.23 %RH is measured.

If you want to get the value periodically, it is recommended to use the CALLBACK_HUMIDITY callback. You can set the callback configuration with set_humidity_callback_configuration.

BrickletHumidityV2.get_temperature
Function ID:

5

Request:

empty payload

Response:
  • temperature -- int16

Returns the temperature measured by the sensor. The value has a range of -4000 to 16500 and is given in °C/100, i.e. a value of 3200 means that a temperature of 32.00 °C is measured.

If you want to get the value periodically, it is recommended to use the CALLBACK_TEMPERATURE callback. You can set the callback configuration with set_temperature_callback_configuration.

BrickletHumidityV2.set_heater_configuration
Function ID:

9

Request:
  • heater_config -- uint8
Response:

no response

Enables/disables the heater. The heater can be used to dry the sensor in extremely wet conditions.

By default the heater is disabled.

The following meanings are defined for the parameters of this function:

  • 0: disabled, for heater_config
  • 1: enabled, for heater_config
BrickletHumidityV2.get_heater_configuration
Function ID:

10

Request:

empty payload

Response:
  • heater_config -- uint8

Returns the heater configuration as set by set_heater_configuration.

The following meanings are defined for the parameters of this function:

  • 0: disabled, for heater_config
  • 1: enabled, for heater_config
BrickletHumidityV2.set_moving_average_configuration
Function ID:

11

Request:
  • moving_average_length_humidity -- uint16
  • moving_average_length_temperature -- uint16
Response:

no response

Sets the length of a moving averaging 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.

The range for the averaging is 1-1000.

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.

The default value is 5.

* In firmware version 2.0.3 we added the set_samples_per_second 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!

BrickletHumidityV2.get_moving_average_configuration
Function ID:

12

Request:

empty payload

Response:
  • moving_average_length_humidity -- uint16
  • moving_average_length_temperature -- uint16

Returns the moving average configuration as set by set_moving_average_configuration.

BrickletHumidityV2.set_samples_per_second
Function ID:

13

Request:
  • sps -- uint8
Response:

no response

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.

The following meanings are defined for the parameters of this function:

  • 0: 20, for sps
  • 1: 10, for sps
  • 2: 5, for sps
  • 3: 1, for sps
  • 4: 02, for sps
  • 5: 01, for sps

New in version 2.0.3 (Plugin).

BrickletHumidityV2.get_samples_per_second
Function ID:

14

Request:

empty payload

Response:
  • sps -- uint8

Returnes the samples per second, as set by set_samples_per_second.

The following meanings are defined for the parameters of this function:

  • 0: 20, for sps
  • 1: 10, for sps
  • 2: 5, for sps
  • 3: 1, for sps
  • 4: 02, for sps
  • 5: 01, for sps

New in version 2.0.3 (Plugin).

Advanced Functions

BrickletHumidityV2.get_spitfp_error_count
Function ID:

234

Request:

empty payload

Response:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.

BrickletHumidityV2.set_bootloader_mode
Function ID:

235

Request:
  • mode -- uint8
Response:
  • status -- uint8

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.

The following meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
  • 0: ok, for status
  • 1: invalid mode, for status
  • 2: no change, for status
  • 3: entry function not present, for status
  • 4: device identifier incorrect, for status
  • 5: crc mismatch, for status
BrickletHumidityV2.get_bootloader_mode
Function ID:

236

Request:

empty payload

Response:
  • mode -- uint8

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
BrickletHumidityV2.set_write_firmware_pointer
Function ID:

237

Request:
  • pointer -- uint32
Response:

no response

Sets the firmware pointer for write_firmware. 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.

BrickletHumidityV2.write_firmware
Function ID:

238

Request:
  • data -- uint8[64]
Response:
  • status -- uint8

Writes 64 Bytes of firmware at the position as written by set_write_firmware_pointer 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.

BrickletHumidityV2.set_status_led_config
Function ID:

239

Request:
  • config -- uint8
Response:

no response

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.

The following meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletHumidityV2.get_status_led_config
Function ID:

240

Request:

empty payload

Response:
  • config -- uint8

Returns the configuration as set by set_status_led_config

The following meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletHumidityV2.get_chip_temperature
Function ID:

242

Request:

empty payload

Response:
  • temperature -- int16

Returns the temperature in °C 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.

BrickletHumidityV2.reset
Function ID:243
Request:empty payload
Response:no response

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!

BrickletHumidityV2.write_uid
Function ID:

248

Request:
  • uid -- uint32
Response:

no response

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.

BrickletHumidityV2.read_uid
Function ID:

249

Request:

empty payload

Response:
  • uid -- uint32

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

BrickletHumidityV2.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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' or 'd'.

The device identifier numbers can be found here

Callback Configuration Functions

BrickletHumidityV2.set_humidity_callback_configuration
Function ID:

2

Request:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- uint16
  • max -- uint16
Response:

no response

The period in ms is the period with which the CALLBACK_HUMIDITY callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_HUMIDITY callback.

The following options are possible:

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)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletHumidityV2.get_humidity_callback_configuration
Function ID:

3

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- uint16
  • max -- uint16

Returns the callback configuration as set by set_humidity_callback_configuration.

The following meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletHumidityV2.set_temperature_callback_configuration
Function ID:

6

Request:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int16
  • max -- int16
Response:

no response

The period in ms is the period with which the CALLBACK_TEMPERATURE callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_TEMPERATURE callback.

The following options are possible:

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)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletHumidityV2.get_temperature_callback_configuration
Function ID:

7

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int16
  • max -- int16

Returns the callback configuration as set by set_temperature_callback_configuration.

The following meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option

Callbacks

BrickletHumidityV2.CALLBACK_HUMIDITY
Function ID:

4

Response:
  • humidity -- uint16

This callback is triggered periodically according to the configuration set by set_humidity_callback_configuration.

The response value is the same as get_humidity.

BrickletHumidityV2.CALLBACK_TEMPERATURE
Function ID:

8

Response:
  • temperature -- int16

This callback is triggered periodically according to the configuration set by set_temperature_callback_configuration.

The response value is the same as get_temperature.