PHP - Humidity Bricklet

This is the description of the PHP API bindings for the Humidity Bricklet. General information and technical specifications for the Humidity Bricklet are summarized in its hardware description.

An installation guide for the PHP API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.php)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletHumidity.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHumidity;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Humidity Bricklet

$ipcon = new IPConnection(); // Create IP connection
$h = new BrickletHumidity(UID, $ipcon); // Create device object

$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected

// Get current humidity
$humidity = $h->getHumidity();
echo "Humidity: " . $humidity/10.0 . " %RH\n";

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Callback

Download (ExampleCallback.php)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletHumidity.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHumidity;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Humidity Bricklet

// Callback function for humidity callback
function cb_humidity($humidity)
{
    echo "Humidity: " . $humidity/10.0 . " %RH\n";
}

$ipcon = new IPConnection(); // Create IP connection
$h = new BrickletHumidity(UID, $ipcon); // Create device object

$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected

// Register humidity callback to function cb_humidity
$h->registerCallback(BrickletHumidity::CALLBACK_HUMIDITY, 'cb_humidity');

// Set period for humidity callback to 1s (1000ms)
// Note: The humidity callback is only called every second
//       if the humidity has changed since the last call!
$h->setHumidityCallbackPeriod(1000);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

Threshold

Download (ExampleThreshold.php)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletHumidity.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHumidity;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Humidity Bricklet

// Callback function for humidity reached callback
function cb_humidityReached($humidity)
{
    echo "Humidity: " . $humidity/10.0 . " %RH\n";
    echo "Recommended humidity for human comfort is 30 to 60 %RH.\n";
}

$ipcon = new IPConnection(); // Create IP connection
$h = new BrickletHumidity(UID, $ipcon); // Create device object

$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected

// Get threshold callbacks with a debounce time of 10 seconds (10000ms)
$h->setDebouncePeriod(10000);

// Register humidity reached callback to function cb_humidityReached
$h->registerCallback(BrickletHumidity::CALLBACK_HUMIDITY_REACHED, 'cb_humidityReached');

// Configure threshold for humidity "outside of 30 to 60 %RH"
$h->setHumidityCallbackThreshold('o', 30*10, 60*10);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API

Functions that return multiple values return them in an associative array.

Basic Functions

class BrickletHumidity(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $humidity – Type: BrickletHumidity

Creates an object with the unique device ID $uid:

<?php   $humidity = new BrickletHumidity('YOUR_DEVICE_UID', $ipcon);   ?>

This object can then be used after the IP Connection is connected (see examples above).

int BrickletHumidity::getHumidity()
Returns:
  • $humidity – Type: int, Range: [0 to 216 - 1]

Returns the humidity of the sensor. The value has a range of 0 to 1000 and is given in %RH/10 (Relative Humidity), i.e. a value of 421 means that a humidity of 42.1 %RH is measured.

If you want to get the humidity periodically, it is recommended to use the CALLBACK_HUMIDITY callback and set the period with setHumidityCallbackPeriod().

Advanced Functions

int BrickletHumidity::getAnalogValue()
Returns:
  • $value – Type: int, Range: [0 to 216 - 1]

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by getHumidity() is averaged over several samples to yield less noise, while getAnalogValue() gives back raw unfiltered analog values. The returned humidity value is calibrated for room temperatures, if you use the sensor in extreme cold or extreme warm environments, you might want to calculate the humidity from the analog value yourself. See the HIH 5030 datasheet.

If you want the analog value periodically, it is recommended to use the CALLBACK_ANALOG_VALUE callback and set the period with setAnalogValueCallbackPeriod().

array BrickletHumidity::getAPIVersion()
Returns:
  • $api_version – Type: array(int, ...), Length: 3, Range: [0 to 255]

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.

bool BrickletHumidity::getResponseExpected(int $function_id)
Parameters:
  • $function_id – Type: int, Range: See constants
Returns:
  • $response_expected – Type: bool

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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

  • BrickletHumidity::FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD = 3
  • BrickletHumidity::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletHumidity::FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD = 7
  • BrickletHumidity::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletHumidity::FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletHumidity::setResponseExpected(int $function_id, bool $response_expected)
Parameters:
  • $function_id – Type: int, Range: See constants
  • $response_expected – Type: bool

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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

  • BrickletHumidity::FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD = 3
  • BrickletHumidity::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletHumidity::FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD = 7
  • BrickletHumidity::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletHumidity::FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletHumidity::setResponseExpectedAll(bool $response_expected)
Parameters:
  • $response_expected – Type: bool

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

array BrickletHumidity::getIdentity()
Return Array:
  • 'uid' – Type: string, Length: up to 8
  • 'connected_uid' – Type: string, Length: up to 8
  • 'position' – Type: string
  • 'hardware_version' – Type: array(int, ...), Length: 3, Range: [0 to 255]
  • 'firmware_version' – Type: array(int, ...), Length: 3, Range: [0 to 255]
  • 'device_identifier' – Type: int, Range: [0 to 216 - 1]

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. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

void BrickletHumidity::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)
Parameters:
  • $callback_id – Type: int
  • $callback – Type: callable
  • $user_data – Type: mixed

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

void BrickletHumidity::setHumidityCallbackPeriod(int $period)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The CALLBACK_HUMIDITY callback is only triggered if the humidity has changed since the last triggering.

int BrickletHumidity::getHumidityCallbackPeriod()
Returns:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setHumidityCallbackPeriod().

void BrickletHumidity::setAnalogValueCallbackPeriod(int $period)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the CALLBACK_ANALOG_VALUE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_ANALOG_VALUE callback is only triggered if the analog value has changed since the last triggering.

int BrickletHumidity::getAnalogValueCallbackPeriod()
Returns:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setAnalogValueCallbackPeriod().

void BrickletHumidity::setHumidityCallbackThreshold(string $option, int $min, int $max)
Parameters:
  • $option – Type: string, Range: See constants, Default: 'x'
  • $min – Type: int, Range: [0 to 216 - 1]
  • $max – Type: int, Range: [0 to 216 - 1]

Sets the thresholds for the CALLBACK_HUMIDITY_REACHED callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the humidity is outside the min and max values
'i' Callback is triggered when the humidity is inside the min and max values
'<' Callback is triggered when the humidity is smaller than the min value (max is ignored)
'>' Callback is triggered when the humidity is greater than the min value (max is ignored)

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

The following constants are available for this function:

For $option:

  • BrickletHumidity::THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidity::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidity::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidity::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidity::THRESHOLD_OPTION_GREATER = '>'
array BrickletHumidity::getHumidityCallbackThreshold()
Return Array:
  • 'option' – Type: string, Range: See constants, Default: 'x'
  • 'min' – Type: int, Range: [0 to 216 - 1]
  • 'max' – Type: int, Range: [0 to 216 - 1]

Returns the threshold as set by setHumidityCallbackThreshold().

The following constants are available for this function:

For $option:

  • BrickletHumidity::THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidity::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidity::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidity::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidity::THRESHOLD_OPTION_GREATER = '>'
void BrickletHumidity::setAnalogValueCallbackThreshold(string $option, int $min, int $max)
Parameters:
  • $option – Type: string, Range: See constants, Default: 'x'
  • $min – Type: int, Range: [0 to 216 - 1]
  • $max – Type: int, Range: [0 to 216 - 1]

Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the analog value is outside the min and max values
'i' Callback is triggered when the analog value is inside the min and max values
'<' Callback is triggered when the analog value is smaller than the min value (max is ignored)
'>' Callback is triggered when the analog value is greater than the min value (max is ignored)

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

The following constants are available for this function:

For $option:

  • BrickletHumidity::THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidity::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidity::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidity::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidity::THRESHOLD_OPTION_GREATER = '>'
array BrickletHumidity::getAnalogValueCallbackThreshold()
Return Array:
  • 'option' – Type: string, Range: See constants, Default: 'x'
  • 'min' – Type: int, Range: [0 to 216 - 1]
  • 'max' – Type: int, Range: [0 to 216 - 1]

Returns the threshold as set by setAnalogValueCallbackThreshold().

The following constants are available for this function:

For $option:

  • BrickletHumidity::THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidity::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidity::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidity::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidity::THRESHOLD_OPTION_GREATER = '>'
void BrickletHumidity::setDebouncePeriod(int $debounce)
Parameters:
  • $debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

int BrickletHumidity::getDebouncePeriod()
Returns:
  • $debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by setDebouncePeriod().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$humidity->registerCallback(BrickletHumidity::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

int BrickletHumidity::CALLBACK_HUMIDITY
<?php   void callback(int $humidity [, mixed $user_data])   ?>
Callback Parameters:
  • $humidity – Type: int, Range: [0 to 216 - 1]
  • $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setHumidityCallbackPeriod(). The parameter is the humidity of the sensor.

The CALLBACK_HUMIDITY callback is only triggered if the humidity has changed since the last triggering.

int BrickletHumidity::CALLBACK_ANALOG_VALUE
<?php   void callback(int $value [, mixed $user_data])   ?>
Callback Parameters:
  • $value – Type: int, Range: [0 to 216 - 1]
  • $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setAnalogValueCallbackPeriod(). The parameter is the analog value of the sensor.

The CALLBACK_ANALOG_VALUE callback is only triggered if the humidity has changed since the last triggering.

int BrickletHumidity::CALLBACK_HUMIDITY_REACHED
<?php   void callback(int $humidity [, mixed $user_data])   ?>
Callback Parameters:
  • $humidity – Type: int, Range: [0 to 216 - 1]
  • $user_data – Type: mixed

This callback is triggered when the threshold as set by setHumidityCallbackThreshold() is reached. The parameter is the humidity of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

int BrickletHumidity::CALLBACK_ANALOG_VALUE_REACHED
<?php   void callback(int $value [, mixed $user_data])   ?>
Callback Parameters:
  • $value – Type: int, Range: [0 to 216 - 1]
  • $user_data – Type: mixed

This callback is triggered when the threshold as set by setAnalogValueCallbackThreshold() is reached. The parameter is the analog value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

Constants

int BrickletHumidity::DEVICE_IDENTIFIER

This constant is used to identify a Humidity Bricklet.

The getIdentity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

string BrickletHumidity::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Humidity Bricklet.