PHP - IMU Brick 2.0

This is the description of the PHP API bindings for the IMU Brick 2.0. General information and technical specifications for the IMU Brick 2.0 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
28
29
30
31
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickIMUV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XXYYZZ'; // Change XXYYZZ to the UID of your IMU Brick 2.0

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

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

// Get current quaternion
$quaternion = $imu->getQuaternion();

echo "Quaternion [W]: " . $quaternion['w']/16383.0 . "\n";
echo "Quaternion [X]: " . $quaternion['x']/16383.0 . "\n";
echo "Quaternion [Y]: " . $quaternion['y']/16383.0 . "\n";
echo "Quaternion [Z]: " . $quaternion['z']/16383.0 . "\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
37
38
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickIMUV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XXYYZZ'; // Change XXYYZZ to the UID of your IMU Brick 2.0

// Callback function for quaternion callback
function cb_quaternion($w, $x, $y, $z)
{
    echo "Quaternion [W]: " . $w/16383.0 . "\n";
    echo "Quaternion [X]: " . $x/16383.0 . "\n";
    echo "Quaternion [Y]: " . $y/16383.0 . "\n";
    echo "Quaternion [Z]: " . $z/16383.0 . "\n";
    echo "\n";
}

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

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

// Register quaternion callback to function cb_quaternion
$imu->registerCallback(BrickIMUV2::CALLBACK_QUATERNION, 'cb_quaternion');

// Set period for quaternion callback to 0.1s (100ms)
$imu->setQuaternionPeriod(100);

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

?>

All Data

Download (ExampleAllData.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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickIMUV2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XXYYZZ'; // Change XXYYZZ to the UID of your IMU Brick 2.0

// Callback function for all data callback
function cb_allData($acceleration, $magnetic_field, $angular_velocity, $euler_angle,
                    $quaternion, $linear_acceleration, $gravity_vector, $temperature,
                    $calibration_status)
{
    echo "Acceleration [X]: " . $acceleration[0]/100.0 . " m/s²\n";
    echo "Acceleration [Y]: " . $acceleration[1]/100.0 . " m/s²\n";
    echo "Acceleration [Z]: " . $acceleration[2]/100.0 . " m/s²\n";
    echo "Magnetic Field [X]: " . $magnetic_field[0]/16.0 . " µT\n";
    echo "Magnetic Field [Y]: " . $magnetic_field[1]/16.0 . " µT\n";
    echo "Magnetic Field [Z]: " . $magnetic_field[2]/16.0 . " µT\n";
    echo "Angular Velocity [X]: " . $angular_velocity[0]/16.0 . " °/s\n";
    echo "Angular Velocity [Y]: " . $angular_velocity[1]/16.0 . " °/s\n";
    echo "Angular Velocity [Z]: " . $angular_velocity[2]/16.0 . " °/s\n";
    echo "Euler Angle [X]: " . $euler_angle[0]/16.0 . " °\n";
    echo "Euler Angle [Y]: " . $euler_angle[1]/16.0 . " °\n";
    echo "Euler Angle [Z]: " . $euler_angle[2]/16.0 . " °\n";
    echo "Quaternion [W]: " . $quaternion[0]/16383.0 . "\n";
    echo "Quaternion [X]: " . $quaternion[1]/16383.0 . "\n";
    echo "Quaternion [Y]: " . $quaternion[2]/16383.0 . "\n";
    echo "Quaternion [Z]: " . $quaternion[3]/16383.0 . "\n";
    echo "Linear Acceleration [X]: " . $linear_acceleration[0]/100.0 . " m/s²\n";
    echo "Linear Acceleration [Y]: " . $linear_acceleration[1]/100.0 . " m/s²\n";
    echo "Linear Acceleration [Z]: " . $linear_acceleration[2]/100.0 . " m/s²\n";
    echo "Gravity Vector [X]: " . $gravity_vector[0]/100.0 . " m/s²\n";
    echo "Gravity Vector [Y]: " . $gravity_vector[1]/100.0 . " m/s²\n";
    echo "Gravity Vector [Z]: " . $gravity_vector[2]/100.0 . " m/s²\n";
    echo "Temperature: $temperature °C\n";
    echo "Calibration Status: " . sprintf("%08b", $calibration_status) . "\n";
    echo "\n";
}

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

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

// Register all data callback to function cb_allData
$imu->registerCallback(BrickIMUV2::CALLBACK_ALL_DATA, 'cb_allData');

// Set period for all data callback to 0.1s (100ms)
$imu->setAllDataPeriod(100);

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 BrickIMUV2(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $imu_v2 = new BrickIMUV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

array BrickIMUV2::getOrientation()

Returns the current orientation (heading, roll, pitch) of the IMU Brick as independent Euler angles in 1/16 degree. Note that Euler angles always experience a gimbal lock. We recommend that you use quaternions instead, if you need the absolute orientation.

The rotation angle has the following ranges:

  • heading: 0° to 360°
  • roll: -90° to +90°
  • pitch: -180° to +180°

If you want to get the orientation periodically, it is recommended to use the CALLBACK_ORIENTATION callback and set the period with setOrientationPeriod().

The returned array has the keys heading, roll and pitch.

array BrickIMUV2::getLinearAcceleration()

Returns the linear acceleration of the IMU Brick for the x, y and z axis in 1/100 m/s².

The linear acceleration is the acceleration in each of the three axis of the IMU Brick with the influences of gravity removed.

It is also possible to get the gravity vector with the influence of linear acceleration removed, see getGravityVector().

If you want to get the linear acceleration periodically, it is recommended to use the CALLBACK_LINEAR_ACCELERATION callback and set the period with setLinearAccelerationPeriod().

The returned array has the keys x, y and z.

array BrickIMUV2::getGravityVector()

Returns the current gravity vector of the IMU Brick for the x, y and z axis in 1/100 m/s².

The gravity vector is the acceleration that occurs due to gravity. Influences of additional linear acceleration are removed.

It is also possible to get the linear acceleration with the influence of gravity removed, see getLinearAcceleration().

If you want to get the gravity vector periodically, it is recommended to use the CALLBACK_GRAVITY_VECTOR callback and set the period with setGravityVectorPeriod().

The returned array has the keys x, y and z.

array BrickIMUV2::getQuaternion()

Returns the current orientation (w, x, y, z) of the IMU Brick as quaternions.

You have to divide the returns values by 16383 (14 bit) to get the usual range of -1.0 to +1.0 for quaternions.

If you want to get the quaternions periodically, it is recommended to use the CALLBACK_QUATERNION callback and set the period with setQuaternionPeriod().

The returned array has the keys w, x, y and z.

array BrickIMUV2::getAllData()

Return all of the available data of the IMU Brick.

The calibration status consists of four pairs of two bits. Each pair of bits represents the status of the current calibration.

  • bit 0-1: Magnetometer
  • bit 2-3: Accelerometer
  • bit 4-5: Gyroscope
  • bit 6-7: System

A value of 0 means for "not calibrated" and a value of 3 means "fully calibrated". In your program you should always be able to ignore the calibration status, it is used by the calibration window of the Brick Viewer and it can be ignored after the first calibration. See the documentation in the calibration window for more information regarding the calibration of the IMU Brick.

If you want to get the data periodically, it is recommended to use the CALLBACK_ALL_DATA callback and set the period with setAllDataPeriod().

The returned array has the keys acceleration, magnetic_field, angular_velocity, euler_angle, quaternion, linear_acceleration, gravity_vector, temperature and calibration_status.

void BrickIMUV2::ledsOn()

Turns the orientation and direction LEDs of the IMU Brick on.

void BrickIMUV2::ledsOff()

Turns the orientation and direction LEDs of the IMU Brick off.

bool BrickIMUV2::areLedsOn()

Returns true if the orientation and direction LEDs of the IMU Brick are on, false otherwise.

Advanced Functions

array BrickIMUV2::getAcceleration()

Returns the calibrated acceleration from the accelerometer for the x, y and z axis in 1/100 m/s².

If you want to get the acceleration periodically, it is recommended to use the CALLBACK_ACCELERATION callback and set the period with setAccelerationPeriod().

The returned array has the keys x, y and z.

array BrickIMUV2::getMagneticField()

Returns the calibrated magnetic field from the magnetometer for the x, y and z axis in 1/16 µT (Microtesla).

If you want to get the magnetic field periodically, it is recommended to use the CALLBACK_MAGNETIC_FIELD callback and set the period with setMagneticFieldPeriod().

The returned array has the keys x, y and z.

array BrickIMUV2::getAngularVelocity()

Returns the calibrated angular velocity from the gyroscope for the x, y and z axis in 1/16 °/s.

If you want to get the angular velocity periodically, it is recommended to use the CALLBACK_ANGULAR_VELOCITY acallback nd set the period with setAngularVelocityPeriod().

The returned array has the keys x, y and z.

int BrickIMUV2::getTemperature()

Returns the temperature of the IMU Brick. The temperature is given in °C. The temperature is measured in the core of the BNO055 IC, it is not the ambient temperature

bool BrickIMUV2::saveCalibration()

A call of this function saves the current calibration to be used as a starting point for the next restart of continuous calibration of the IMU Brick.

A return value of true means that the calibration could be used and false means that it could not be used (this happens if the calibration status is not "fully calibrated").

This function is used by the calibration window of the Brick Viewer, you should not need to call it in your program.

void BrickIMUV2::setSensorConfiguration(int $magnetometer_rate, int $gyroscope_range, int $gyroscope_bandwidth, int $accelerometer_range, int $accelerometer_bandwidth)

Sets the available sensor configuration for the Magnetometer, Gyroscope and Accelerometer. The Accelerometer Range is user selectable in all fusion modes, all other configurations are auto-controlled in fusion mode.

The default values are:

  • Magnetometer Rate 20Hz
  • Gyroscope Range 2000°/s
  • Gyroscope Bandwidth 32Hz
  • Accelerometer Range +/-4G
  • Accelerometer Bandwidth 62.5Hz

The following constants are available for this function:

  • BrickIMUV2::MAGNETOMETER_RATE_2HZ = 0
  • BrickIMUV2::MAGNETOMETER_RATE_6HZ = 1
  • BrickIMUV2::MAGNETOMETER_RATE_8HZ = 2
  • BrickIMUV2::MAGNETOMETER_RATE_10HZ = 3
  • BrickIMUV2::MAGNETOMETER_RATE_15HZ = 4
  • BrickIMUV2::MAGNETOMETER_RATE_20HZ = 5
  • BrickIMUV2::MAGNETOMETER_RATE_25HZ = 6
  • BrickIMUV2::MAGNETOMETER_RATE_30HZ = 7
  • BrickIMUV2::GYROSCOPE_RANGE_2000DPS = 0
  • BrickIMUV2::GYROSCOPE_RANGE_1000DPS = 1
  • BrickIMUV2::GYROSCOPE_RANGE_500DPS = 2
  • BrickIMUV2::GYROSCOPE_RANGE_250DPS = 3
  • BrickIMUV2::GYROSCOPE_RANGE_125DPS = 4
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_523HZ = 0
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_230HZ = 1
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_116HZ = 2
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_47HZ = 3
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_23HZ = 4
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_12HZ = 5
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_64HZ = 6
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_32HZ = 7
  • BrickIMUV2::ACCELEROMETER_RANGE_2G = 0
  • BrickIMUV2::ACCELEROMETER_RANGE_4G = 1
  • BrickIMUV2::ACCELEROMETER_RANGE_8G = 2
  • BrickIMUV2::ACCELEROMETER_RANGE_16G = 3
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_7_81HZ = 0
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_15_63HZ = 1
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_31_25HZ = 2
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_62_5HZ = 3
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_125HZ = 4
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_250HZ = 5
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_500HZ = 6
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_1000HZ = 7

New in version 2.0.5 (Firmware).

array BrickIMUV2::getSensorConfiguration()

Returns the sensor configuration as set by setSensorConfiguration().

The following constants are available for this function:

  • BrickIMUV2::MAGNETOMETER_RATE_2HZ = 0
  • BrickIMUV2::MAGNETOMETER_RATE_6HZ = 1
  • BrickIMUV2::MAGNETOMETER_RATE_8HZ = 2
  • BrickIMUV2::MAGNETOMETER_RATE_10HZ = 3
  • BrickIMUV2::MAGNETOMETER_RATE_15HZ = 4
  • BrickIMUV2::MAGNETOMETER_RATE_20HZ = 5
  • BrickIMUV2::MAGNETOMETER_RATE_25HZ = 6
  • BrickIMUV2::MAGNETOMETER_RATE_30HZ = 7
  • BrickIMUV2::GYROSCOPE_RANGE_2000DPS = 0
  • BrickIMUV2::GYROSCOPE_RANGE_1000DPS = 1
  • BrickIMUV2::GYROSCOPE_RANGE_500DPS = 2
  • BrickIMUV2::GYROSCOPE_RANGE_250DPS = 3
  • BrickIMUV2::GYROSCOPE_RANGE_125DPS = 4
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_523HZ = 0
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_230HZ = 1
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_116HZ = 2
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_47HZ = 3
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_23HZ = 4
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_12HZ = 5
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_64HZ = 6
  • BrickIMUV2::GYROSCOPE_BANDWIDTH_32HZ = 7
  • BrickIMUV2::ACCELEROMETER_RANGE_2G = 0
  • BrickIMUV2::ACCELEROMETER_RANGE_4G = 1
  • BrickIMUV2::ACCELEROMETER_RANGE_8G = 2
  • BrickIMUV2::ACCELEROMETER_RANGE_16G = 3
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_7_81HZ = 0
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_15_63HZ = 1
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_31_25HZ = 2
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_62_5HZ = 3
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_125HZ = 4
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_250HZ = 5
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_500HZ = 6
  • BrickIMUV2::ACCELEROMETER_BANDWIDTH_1000HZ = 7

New in version 2.0.5 (Firmware).

The returned array has the keys magnetometer_rate, gyroscope_range, gyroscope_bandwidth, accelerometer_range and accelerometer_bandwidth.

void BrickIMUV2::setSensorFusionMode(int $mode)

If the fusion mode is turned off, the functions getAcceleration(), getMagneticField() and getAngularVelocity() return uncalibrated and uncompensated sensor data. All other sensor data getters return no data.

Since firmware version 2.0.6 you can also use a fusion mode without magnetometer. In this mode the calculated orientation is relative (with magnetometer it is absolute with respect to the earth). However, the calculation can't be influenced by spurious magnetic fields.

Since firmware version 2.0.13 you can also use a fusion mode without fast magnetometer calibration. This mode is the same as the normal fusion mode, but the fast magnetometer calibration is turned off. So to find the orientation the first time will likely take longer, but small magnetic influences might not affect the automatic calibration as much.

By default sensor fusion is on.

The following constants are available for this function:

  • BrickIMUV2::SENSOR_FUSION_OFF = 0
  • BrickIMUV2::SENSOR_FUSION_ON = 1
  • BrickIMUV2::SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
  • BrickIMUV2::SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

New in version 2.0.5 (Firmware).

int BrickIMUV2::getSensorFusionMode()

Returns the sensor fusion mode as set by setSensorFusionMode().

The following constants are available for this function:

  • BrickIMUV2::SENSOR_FUSION_OFF = 0
  • BrickIMUV2::SENSOR_FUSION_ON = 1
  • BrickIMUV2::SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER = 2
  • BrickIMUV2::SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION = 3

New in version 2.0.5 (Firmware).

array BrickIMUV2::getAPIVersion()

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 BrickIMUV2::getResponseExpected(int $function_id)

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.

See setResponseExpected() for the list of function ID constants available for this function.

void BrickIMUV2::setResponseExpected(int $function_id, bool $response_expected)

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 function ID constants are available for this function:

  • BrickIMUV2::FUNCTION_LEDS_ON = 10
  • BrickIMUV2::FUNCTION_LEDS_OFF = 11
  • BrickIMUV2::FUNCTION_SET_ACCELERATION_PERIOD = 14
  • BrickIMUV2::FUNCTION_SET_MAGNETIC_FIELD_PERIOD = 16
  • BrickIMUV2::FUNCTION_SET_ANGULAR_VELOCITY_PERIOD = 18
  • BrickIMUV2::FUNCTION_SET_TEMPERATURE_PERIOD = 20
  • BrickIMUV2::FUNCTION_SET_ORIENTATION_PERIOD = 22
  • BrickIMUV2::FUNCTION_SET_LINEAR_ACCELERATION_PERIOD = 24
  • BrickIMUV2::FUNCTION_SET_GRAVITY_VECTOR_PERIOD = 26
  • BrickIMUV2::FUNCTION_SET_QUATERNION_PERIOD = 28
  • BrickIMUV2::FUNCTION_SET_ALL_DATA_PERIOD = 30
  • BrickIMUV2::FUNCTION_SET_SENSOR_CONFIGURATION = 41
  • BrickIMUV2::FUNCTION_SET_SENSOR_FUSION_MODE = 43
  • BrickIMUV2::FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickIMUV2::FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickIMUV2::FUNCTION_ENABLE_STATUS_LED = 238
  • BrickIMUV2::FUNCTION_DISABLE_STATUS_LED = 239
  • BrickIMUV2::FUNCTION_RESET = 243
void BrickIMUV2::setResponseExpectedAll(bool $response_expected)

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

void BrickIMUV2::setSPITFPBaudrateConfig(bool $enable_dynamic_baudrate, int $minimum_dynamic_baudrate)

The SPITF protocol can be used with a dynamic baudrate. If the dynamic baudrate is enabled, the Brick will try to adapt the baudrate for the communication between Bricks and Bricklets according to the amount of data that is transferred.

The baudrate will be increased exponentially if lots of data is send/received and decreased linearly if little data is send/received.

This lowers the baudrate in applications where little data is transferred (e.g. a weather station) and increases the robustness. If there is lots of data to transfer (e.g. Thermal Imaging Bricklet) it automatically increases the baudrate as needed.

In cases where some data has to transferred as fast as possible every few seconds (e.g. RS485 Bricklet with a high baudrate but small payload) you may want to turn the dynamic baudrate off to get the highest possible performance.

The maximum value of the baudrate can be set per port with the function setSPITFPBaudrate(). If the dynamic baudrate is disabled, the baudrate as set by setSPITFPBaudrate() will be used statically.

The minimum dynamic baudrate has a value range of 400000 to 2000000 baud.

By default dynamic baudrate is enabled and the minimum dynamic baudrate is 400000.

New in version 2.0.10 (Firmware).

array BrickIMUV2::getSPITFPBaudrateConfig()

Returns the baudrate config, see setSPITFPBaudrateConfig().

New in version 2.0.10 (Firmware).

The returned array has the keys enable_dynamic_baudrate and minimum_dynamic_baudrate.

int BrickIMUV2::getSendTimeoutCount(int $communication_method)

Returns the timeout count for the different communication methods.

The methods 0-2 are available for all Bricks, 3-7 only for Master Bricks.

This function is mostly used for debugging during development, in normal operation the counters should nearly always stay at 0.

The following constants are available for this function:

  • BrickIMUV2::COMMUNICATION_METHOD_NONE = 0
  • BrickIMUV2::COMMUNICATION_METHOD_USB = 1
  • BrickIMUV2::COMMUNICATION_METHOD_SPI_STACK = 2
  • BrickIMUV2::COMMUNICATION_METHOD_CHIBI = 3
  • BrickIMUV2::COMMUNICATION_METHOD_RS485 = 4
  • BrickIMUV2::COMMUNICATION_METHOD_WIFI = 5
  • BrickIMUV2::COMMUNICATION_METHOD_ETHERNET = 6
  • BrickIMUV2::COMMUNICATION_METHOD_WIFI_V2 = 7

New in version 2.0.7 (Firmware).

void BrickIMUV2::setSPITFPBaudrate(string $bricklet_port, int $baudrate)

Sets the baudrate for a specific Bricklet port ('a' - 'd'). The baudrate can be in the range 400000 to 2000000.

If you want to increase the throughput of Bricklets you can increase the baudrate. If you get a high error count because of high interference (see getSPITFPErrorCount()) you can decrease the baudrate.

If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (see setSPITFPBaudrateConfig()).

Regulatory testing is done with the default baudrate. If CE compatibility or similar is necessary in you applications we recommend to not change the baudrate.

The default baudrate for all ports is 1400000.

New in version 2.0.5 (Firmware).

int BrickIMUV2::getSPITFPBaudrate(string $bricklet_port)

Returns the baudrate for a given Bricklet port, see setSPITFPBaudrate().

New in version 2.0.5 (Firmware).

array BrickIMUV2::getSPITFPErrorCount(string $bricklet_port)

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 Brick side. All Bricklets have a similar function that returns the errors on the Bricklet side.

New in version 2.0.5 (Firmware).

The returned array has the keys error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

void BrickIMUV2::enableStatusLED()

Enables the status LED.

The status LED is the blue LED next to the USB connector. If enabled is is on and it flickers if data is transfered. If disabled it is always off.

The default state is enabled.

void BrickIMUV2::disableStatusLED()

Disables the status LED.

The status LED is the blue LED next to the USB connector. If enabled is is on and it flickers if data is transfered. If disabled it is always off.

The default state is enabled.

bool BrickIMUV2::isStatusLEDEnabled()

Returns true if the status LED is enabled, false otherwise.

array BrickIMUV2::getProtocol1BrickletName(string $port)

Returns the firmware and protocol version and the name of the Bricklet for a given port.

This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet plugins.

The returned array has the keys protocol_version, firmware_version and name.

int BrickIMUV2::getChipTemperature()

Returns the temperature in °C/10 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 an accuracy of +-15%. Practically it is only useful as an indicator for temperature changes.

void BrickIMUV2::reset()

Calling this function will reset the Brick. Calling this function on a Brick inside of a stack will reset the whole stack.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

array BrickIMUV2::getIdentity()

Returns the UID, the UID where the Brick is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be '0'-'8' (stack position).

The device identifier numbers can be found here. There is also a constant for the device identifier of this Brick.

The returned array has the keys uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

void BrickIMUV2::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)

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 BrickIMUV2::setAccelerationPeriod(int $period)

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

The default value is 0.

int BrickIMUV2::getAccelerationPeriod()

Returns the period as set by setAccelerationPeriod().

void BrickIMUV2::setMagneticFieldPeriod(int $period)

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

int BrickIMUV2::getMagneticFieldPeriod()

Returns the period as set by setMagneticFieldPeriod().

void BrickIMUV2::setAngularVelocityPeriod(int $period)

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

int BrickIMUV2::getAngularVelocityPeriod()

Returns the period as set by setAngularVelocityPeriod().

void BrickIMUV2::setTemperaturePeriod(int $period)

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

int BrickIMUV2::getTemperaturePeriod()

Returns the period as set by setTemperaturePeriod().

void BrickIMUV2::setOrientationPeriod(int $period)

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

int BrickIMUV2::getOrientationPeriod()

Returns the period as set by setOrientationPeriod().

void BrickIMUV2::setLinearAccelerationPeriod(int $period)

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

int BrickIMUV2::getLinearAccelerationPeriod()

Returns the period as set by setLinearAccelerationPeriod().

void BrickIMUV2::setGravityVectorPeriod(int $period)

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

int BrickIMUV2::getGravityVectorPeriod()

Returns the period as set by setGravityVectorPeriod().

void BrickIMUV2::setQuaternionPeriod(int $period)

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

int BrickIMUV2::getQuaternionPeriod()

Returns the period as set by setQuaternionPeriod().

void BrickIMUV2::setAllDataPeriod(int $period)

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

int BrickIMUV2::getAllDataPeriod()

Returns the period as set by setAllDataPeriod().

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";
}

$imu_v2->registerCallback(BrickIMUV2::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 BrickIMUV2::CALLBACK_ACCELERATION
<?php   void callback(int $x, int $y, int $z [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setAccelerationPeriod(). The parameters are the acceleration for the x, y and z axis.

int BrickIMUV2::CALLBACK_MAGNETIC_FIELD
<?php   void callback(int $x, int $y, int $z [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setMagneticFieldPeriod(). The parameters are the magnetic field for the x, y and z axis.

int BrickIMUV2::CALLBACK_ANGULAR_VELOCITY
<?php   void callback(int $x, int $y, int $z [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setAngularVelocityPeriod(). The parameters are the angular velocity for the x, y and z axis.

int BrickIMUV2::CALLBACK_TEMPERATURE
<?php   void callback(int $temperature [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setTemperaturePeriod(). The parameter is the temperature.

int BrickIMUV2::CALLBACK_LINEAR_ACCELERATION
<?php   void callback(int $x, int $y, int $z [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setLinearAccelerationPeriod(). The parameters are the linear acceleration for the x, y and z axis.

int BrickIMUV2::CALLBACK_GRAVITY_VECTOR
<?php   void callback(int $x, int $y, int $z [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setGravityVectorPeriod(). The parameters gravity vector for the x, y and z axis.

int BrickIMUV2::CALLBACK_ORIENTATION
<?php   void callback(int $heading, int $roll, int $pitch [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setOrientationPeriod(). The parameters are the orientation (heading (yaw), roll, pitch) of the IMU Brick in Euler angles. See getOrientation() for details.

int BrickIMUV2::CALLBACK_QUATERNION
<?php   void callback(int $w, int $x, int $y, int $z [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setQuaternionPeriod(). The parameters are the orientation (x, y, z, w) of the IMU Brick in quaternions. See getQuaternion() for details.

int BrickIMUV2::CALLBACK_ALL_DATA
<?php   void callback(array $acceleration, array $magnetic_field, array $angular_velocity, array $euler_angle, array $quaternion, array $linear_acceleration, array $gravity_vector, int $temperature, int $calibration_status [, mixed $user_data])   ?>

This callback is triggered periodically with the period that is set by setAllDataPeriod(). The parameters are as for getAllData().

Constants

int BrickIMUV2::DEVICE_IDENTIFIER

This constant is used to identify a IMU Brick 2.0.

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

string BrickIMUV2::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a IMU Brick 2.0.