Software / API Bindings / PHP / API Referenz und Beispiele / Bricks / IMU Brick 2.0

PHP - IMU Brick 2.0¶

Dies ist die Beschreibung der PHP API Bindings für den IMU Brick 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IMU Brick 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die PHP API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (ExampleSimple.php)

<?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)

<?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)

<?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 [Heading]: " . $euler_angle[0]/16.0 . " °\n";
    echo "Euler Angle [Roll]: " . $euler_angle[1]/16.0 . " °\n";
    echo "Euler Angle [Pitch]: " . $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¶

Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.

Grundfunktionen¶

class BrickIMUV2(string $uid, IPConnection $ipcon)¶

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$imu_v2 – Typ: BrickIMUV2

Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid:

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

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

array BrickIMUV2::getOrientation()¶

Rückgabe-Array:	'heading' – Typ: int, Einheit: 1/16 °, Wertebereich: [0 bis 5760] 'roll' – Typ: int, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] 'pitch' – Typ: int, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]

Gibt die aktuelle Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in unabhängigen Eulerwinkeln zurück. Zu beachten ist, dass Eulerwinkel immer eine kardanische Blockade erfahren. Wir empfehlen daher stattdessen Quaternionen zu verwenden, wenn die absolute Lage im Raum bestimmt werden soll.

Wenn die Orientierung periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_ORIENTATION Callback zu nutzen und die Periode mit setOrientationPeriod() vorzugeben.

array BrickIMUV2::getLinearAcceleration()¶

Rückgabe-Array:	'x' – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 'y' – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 'z' – Typ: int, Einheit: 1 cm/s², Wertebereich: ?

Gibt die lineare Beschleunigungen des IMU Brick für die X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit setSensorConfiguration() konfiguriert wurde.

Die lineare Beschleunigung ist die Beschleunigung in jede der drei Achsen. Der Einfluss von Erdbeschleunigung ist entfernt.

Es ist auch möglich einen Vektor der Erdbeschleunigung zu bekommen, siehe getGravityVector()

Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen den CALLBACK_LINEAR_ACCELERATION Callback zu nutzen und die Periode mit setLinearAccelerationPeriod() vorzugeben.

array BrickIMUV2::getGravityVector()¶

Rückgabe-Array:	'x' – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 'y' – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 'z' – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981]

Gibt den Vektor der Erdbeschleunigung des IMU Brick für die X-, Y- und Z-Achse zurück.

Die Erdbeschleunigung ist die Beschleunigung die auf Grund von Schwerkraft entsteht. Einflüsse von linearen Beschleunigungen sind entfernt.

Es ist auch möglich die lineare Beschleunigung zu bekommen, siehe getLinearAcceleration()

Wenn die Erdbeschleunigungen periodisch abgefragt werden soll, wird empfohlen den CALLBACK_GRAVITY_VECTOR Callback zu nutzen und die Periode mit setGravityVectorPeriod() vorzugeben.

array BrickIMUV2::getQuaternion()¶

Rückgabe-Array:	'w' – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 'x' – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 'y' – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 'z' – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]

Gibt die aktuelle Orientierung (w, x, y, z) des IMU Brick als Quaterinonen zurück.

Die Rückgabewerte müssen mit 16383 (14 Bit) dividiert werden, um in den üblichen Wertebereich für Quaternionen (-1,0 bis +1,0) gebracht zu werden.

Wenn die Quaternionen periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_QUATERNION Callback zu nutzen und die Periode mit setQuaternionPeriod() vorzugeben.

array BrickIMUV2::getAllData()¶

Rückgabe-Array:

Rückgabe-Array:	'acceleration' – Typ: array(int, ...), Länge: 3 0: $x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 1: $y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 2: $z – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 'magnetic_field' – Typ: array(int, ...), Länge: 3 0: $x – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 1: $y – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 2: $z – Typ: int, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000] 'angular_velocity' – Typ: array(int, ...), Länge: 3 0: $x – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? 1: $y – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? 2: $z – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? 'euler_angle' – Typ: array(int, ...), Länge: 3 0: $heading – Typ: int, Einheit: 1/16 °, Wertebereich: [0 bis 5760] 1: $roll – Typ: int, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] 2: $pitch – Typ: int, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880] 'quaternion' – Typ: array(int, ...), Länge: 4 0: $w – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 1: $x – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 2: $y – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 3: $z – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] 'linear_acceleration' – Typ: array(int, ...), Länge: 3 0: $x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 1: $y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 2: $z – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 'gravity_vector' – Typ: array(int, ...), Länge: 3 0: $x – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 1: $y – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 2: $z – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] 'temperature' – Typ: int, Einheit: 1 °C, Wertebereich: [-128 bis 127] 'calibration_status' – Typ: int, Wertebereich: [0 bis 255]

'acceleration' – Typ: array(int, ...), Länge: 3

0: $x – Typ: int, Einheit: 1 cm/s², Wertebereich: ?
1: $y – Typ: int, Einheit: 1 cm/s², Wertebereich: ?
2: $z – Typ: int, Einheit: 1 cm/s², Wertebereich: ?

'magnetic_field' – Typ: array(int, ...), Länge: 3

0: $x – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
1: $y – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
2: $z – Typ: int, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]

'angular_velocity' – Typ: array(int, ...), Länge: 3

0: $x – Typ: int, Einheit: 1/16 °/s, Wertebereich: ?
1: $y – Typ: int, Einheit: 1/16 °/s, Wertebereich: ?
2: $z – Typ: int, Einheit: 1/16 °/s, Wertebereich: ?

'euler_angle' – Typ: array(int, ...), Länge: 3

0: $heading – Typ: int, Einheit: 1/16 °, Wertebereich: [0 bis 5760]
1: $roll – Typ: int, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440]
2: $pitch – Typ: int, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]

'quaternion' – Typ: array(int, ...), Länge: 4

0: $w – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]
1: $x – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]
2: $y – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]
3: $z – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]

'linear_acceleration' – Typ: array(int, ...), Länge: 3

0: $x – Typ: int, Einheit: 1 cm/s², Wertebereich: ?
1: $y – Typ: int, Einheit: 1 cm/s², Wertebereich: ?
2: $z – Typ: int, Einheit: 1 cm/s², Wertebereich: ?

'gravity_vector' – Typ: array(int, ...), Länge: 3

0: $x – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981]
1: $y – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981]
2: $z – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981]

'temperature' – Typ: int, Einheit: 1 °C, Wertebereich: [-128 bis 127]
'calibration_status' – Typ: int, Wertebereich: [0 bis 255]

Gibt alle Daten zurück die dem IMU Brick zur Verfügung stehen.

Beschleunigung (see getAcceleration())
Magnetfeld (see getMagneticField())
Winkelgeschwindigkeit (see getAngularVelocity())
Eulerwinkel (see getOrientation())
Quaternion (see getQuaternion())
Lineare Beschleunigung (see getLinearAcceleration())
Erdbeschleunigungsvektor (see getGravityVector())
Temperatur (see getTemperature())
Kalibrierungsstatus (siehe unten)

Der Kalibrierungsstatus besteht aus vier Paaren von je zwei Bits. Jedes Paar von Bits repräsentiert den Status der aktuellen Kalibrierung.

Bit 0-1: Magnetometer
Bit 2-3: Beschleunigungsmesser
Bit 4-5: Gyroskop
Bit 6-7: System

Ein Wert von 0 bedeutet "nicht kalibriert" und ein Wert von 3 bedeutet "vollständig kalibriert". Normalerweise kann der Kalibrierungsstatus vollständig ignoriert werden. Er wird vom Brick Viewer im Kalibrierungsfenster benutzt und nur für die initiale Kalibrierung benötigt. Mehr Information zur Kalibrierung des IMU Bricks gibt es im Kalibrierungsfenster.

Wenn die Daten periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_ALL_DATA Callback zu nutzen und die Periode mit setAllDataPeriod() vorzugeben.

void BrickIMUV2::ledsOn()¶: Aktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.

void BrickIMUV2::ledsOff()¶: Deaktiviert die Orientierungs- und Richtungs-LEDs des IMU Brick.

bool BrickIMUV2::areLedsOn()¶

Rückgabe:	$leds – Typ: bool, Standardwert: TRUE

Gibt zurück ob die Orientierungs- und Richtungs-LEDs des IMU Brick aktiv sind.

Fortgeschrittene Funktionen¶

array BrickIMUV2::getAcceleration()¶

Rückgabe-Array:	'x' – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 'y' – Typ: int, Einheit: 1 cm/s², Wertebereich: ? 'z' – Typ: int, Einheit: 1 cm/s², Wertebereich: ?

Gibt die kalibrierten Beschleunigungen des Beschleunigungsmessers für die X-, Y- und Z-Achse zurück. Die Beschleunigungen liegen im Wertebereich, der mit setSensorConfiguration() konfiguriert wurde.

Wenn die Beschleunigungen periodisch abgefragt werden soll, wird empfohlen den CALLBACK_ACCELERATION Callback zu nutzen und die Periode mit setAccelerationPeriod() vorzugeben.

array BrickIMUV2::getMagneticField()¶

Rückgabe-Array:	'x' – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 'y' – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] 'z' – Typ: int, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]

Gibt das kalibrierte Magnetfeld des Magnetometers für die X-, Y- und Z-Komponenten zurück.

Wenn das Magnetfeld periodisch abgefragt werden soll, wird empfohlen den CALLBACK_MAGNETIC_FIELD Callback zu nutzen und die Periode mit setMagneticFieldPeriod() vorzugeben.

array BrickIMUV2::getAngularVelocity()¶

Rückgabe-Array:	'x' – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? 'y' – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? 'z' – Typ: int, Einheit: 1/16 °/s, Wertebereich: ?

Gibt die kalibrierte Winkelgeschwindigkeiten des Gyroskops für die X-, Y- und Z-Achse zurück. Die Winkelgeschwindigkeiten liegen im Wertebereich, der mit setSensorConfiguration() konfiguriert wurde.

Wenn die Winkelgeschwindigkeiten periodisch abgefragt werden sollen, wird empfohlen den CALLBACK_ANGULAR_VELOCITY Callback zu nutzen und die Periode mit setAngularVelocityPeriod() vorzugeben.

int BrickIMUV2::getTemperature()¶

Rückgabe:	$temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-128 bis 127]

Gibt die Temperatur des IMU Brick zurück. Die Temperatur wird im Kern des BNO055 ICs gemessen, es handelt sich nicht um die Umgebungstemperatur.

bool BrickIMUV2::saveCalibration()¶

Rückgabe:	$calibration_done – Typ: bool

Ein Aufruf dieser Funktion speichert die aktuelle Kalibrierung damit sie beim nächsten Neustart des IMU Brick als Startpunkt für die kontinuierliche Kalibrierung genutzt werden kann.

Ein Rückgabewert von true bedeutet das die Kalibrierung genutzt werden konnte und false bedeutet das die Kalibrierung nicht genutzt werden konnte (dies passiert wenn der Kalibrierungsstatus nicht "fully calibrated" ist).

Diese Funktion wird vom Kalibrierungsfenster des Brick Viewer benutzt. Sie sollte in einem normalen Benutzerprogramm nicht aufgerufen werden müssen.

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

Parameter:

Parameter:	$magnetometer_rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 5 $gyroscope_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 $gyroscope_bandwidth – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 7 $accelerometer_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 $accelerometer_bandwidth – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

$magnetometer_rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 5
$gyroscope_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
$gyroscope_bandwidth – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 7
$accelerometer_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
$accelerometer_bandwidth – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die verfügbaren Sensor-Konfigurationen für Magnetometer, Gyroskop und Beschleunigungssensor. Der Beschleunigungssensor-Wertebereich ist in allen Fusion-Modi wählbar, während alle anderen Konfigurationen im Fusion-Modus automatisch kontrolliert werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $magnetometer_rate:

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

Für $gyroscope_range:

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

Für $gyroscope_bandwidth:

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

Für $accelerometer_range:

BrickIMUV2::ACCELEROMETER_RANGE_2G = 0
BrickIMUV2::ACCELEROMETER_RANGE_4G = 1
BrickIMUV2::ACCELEROMETER_RANGE_8G = 2
BrickIMUV2::ACCELEROMETER_RANGE_16G = 3

Für $accelerometer_bandwidth:

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

Neu in Version 2.0.5 (Firmware).

array BrickIMUV2::getSensorConfiguration()¶

Rückgabe-Array:

Rückgabe-Array:	'magnetometer_rate' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 5 'gyroscope_range' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 'gyroscope_bandwidth' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 7 'accelerometer_range' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 'accelerometer_bandwidth' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

'magnetometer_rate' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 5
'gyroscope_range' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
'gyroscope_bandwidth' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 7
'accelerometer_range' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
'accelerometer_bandwidth' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Sensor-Konfiguration zurück, wie von setSensorConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $magnetometer_rate:

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

Für $gyroscope_range:

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

Für $gyroscope_bandwidth:

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

Für $accelerometer_range:

BrickIMUV2::ACCELEROMETER_RANGE_2G = 0
BrickIMUV2::ACCELEROMETER_RANGE_4G = 1
BrickIMUV2::ACCELEROMETER_RANGE_8G = 2
BrickIMUV2::ACCELEROMETER_RANGE_16G = 3

Für $accelerometer_bandwidth:

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

Neu in Version 2.0.5 (Firmware).

void BrickIMUV2::setSensorFusionMode(int $mode)¶

Parameter:	$mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Wenn der Fusion-Modus deaktiviert wird, geben die Funktionen getAcceleration(), getMagneticField() und getAngularVelocity() unkalibrierte und umkompensierte Sensorwerte zurück. Alle anderen Sensordaten-Getter geben keine Daten zurück.

Seit Firmware Version 2.0.6 kann auch ein Fusion-Modus ohne Magnetometer ausgewählt werden. In diesem Modus wird die Orientierung relativ berechnet (mit Magnetometer ist sie absolut in Bezug auf die Erde). Allerdings kann die Berechnung in diesem Fall nicht von störenden Magnetfeldern beeinflusst werden.

Seit Firmware Version 2.0.13 kann auch ein Fusion-Modus ohne schnelle Magnetometer-Kalibrierung ausgewählt werden. Dieser Modus ist der gleiche wie der "normale" Fusion-Modus, aber die schnelle Magnetometer-Kalibrierung ist aus. D.h. die Orientierung zu finden mag beim ersten start länger dauern, allerdings mag es sein das kleine magnetische einflüsse die automatische Kalibrierung nicht so stark stören.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $mode:

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

Neu in Version 2.0.5 (Firmware).

int BrickIMUV2::getSensorFusionMode()¶

Rückgabe:	$mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt den aktuellen Sensor-Fusion-Modus zurück, wie von setSensorFusionMode() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $mode:

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

Neu in Version 2.0.5 (Firmware).

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

Parameter:	$enable_dynamic_baudrate – Typ: bool, Standardwert: TRUE $minimum_dynamic_baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion setSPITFPBaudrate(). gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von setSPITFPBaudrate() gesetzt statisch verwendet.

Neu in Version 2.0.10 (Firmware).

array BrickIMUV2::getSPITFPBaudrateConfig()¶

Rückgabe-Array:	'enable_dynamic_baudrate' – Typ: bool, Standardwert: TRUE 'minimum_dynamic_baudrate' – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe setSPITFPBaudrateConfig().

Neu in Version 2.0.10 (Firmware).

int BrickIMUV2::getSendTimeoutCount(int $communication_method)¶

Parameter:	$communication_method – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	$timeout_count – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $communication_method:

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

Neu in Version 2.0.7 (Firmware).

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

Parameter:	$bricklet_port – Typ: string, Wertebereich: ['a' bis 'b'] $baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Setzt die Baudrate eines spezifischen Bricklet Ports .

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe getSPITFPErrorCount()) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe setSPITFPBaudrateConfig()).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Neu in Version 2.0.5 (Firmware).

int BrickIMUV2::getSPITFPBaudrate(string $bricklet_port)¶

Parameter:	$bricklet_port – Typ: string, Wertebereich: ['a' bis 'b']
Rückgabe:	$baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Gibt die Baudrate für einen Bricklet Port zurück, siehe setSPITFPBaudrate().

Neu in Version 2.0.5 (Firmware).

array BrickIMUV2::getSPITFPErrorCount(string $bricklet_port)¶

Parameter:	$bricklet_port – Typ: string, Wertebereich: ['a' bis 'b']
Rückgabe-Array:	'error_count_ack_checksum' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'error_count_message_checksum' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'error_count_frame' – Typ: int, Wertebereich: [0 bis 2³² - 1] 'error_count_overflow' – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.0.5 (Firmware).

void BrickIMUV2::enableStatusLED()¶

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

void BrickIMUV2::disableStatusLED()¶

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

bool BrickIMUV2::isStatusLEDEnabled()¶

Rückgabe:	$enabled – Typ: bool, Standardwert: TRUE

Gibt true zurück wenn die Status LED aktiviert ist, false sonst.

int BrickIMUV2::getChipTemperature()¶

Rückgabe:	$temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

void BrickIMUV2::reset()¶

Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.

Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

array BrickIMUV2::getIdentity()¶

Rückgabe-Array:

Rückgabe-Array:	'uid' – Typ: string, Länge: bis zu 8 'connected_uid' – Typ: string, Länge: bis zu 8 'position' – Typ: string, Wertebereich: ['0' bis '8'] 'hardware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'firmware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'device_identifier' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

'uid' – Typ: string, Länge: bis zu 8
'connected_uid' – Typ: string, Länge: bis zu 8
'position' – Typ: string, Wertebereich: ['0' bis '8']
'hardware_version' – Typ: array(int, ...), Länge: 3

0: $major – Typ: int, Wertebereich: [0 bis 255]
1: $minor – Typ: int, Wertebereich: [0 bis 255]
2: $revision – Typ: int, Wertebereich: [0 bis 255]

'firmware_version' – Typ: array(int, ...), Länge: 3

0: $major – Typ: int, Wertebereich: [0 bis 255]
1: $minor – Typ: int, Wertebereich: [0 bis 255]
2: $revision – Typ: int, Wertebereich: [0 bis 255]

'device_identifier' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die UID, die UID zu der der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.

Konfigurationsfunktionen für Callbacks¶

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

Parameter:	$callback_id – Typ: int $callback – Typ: callable $user_data – Typ: mixed

Registriert die $function für die gegebene $callback_id. Die optionalen $user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

void BrickIMUV2::setAccelerationPeriod(int $period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der CALLBACK_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int BrickIMUV2::getAccelerationPeriod()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von setAccelerationPeriod() gesetzt.

void BrickIMUV2::setMagneticFieldPeriod(int $period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der CALLBACK_MAGNETIC_FIELD Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int BrickIMUV2::getMagneticFieldPeriod()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von setMagneticFieldPeriod() gesetzt.

void BrickIMUV2::setAngularVelocityPeriod(int $period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der CALLBACK_ANGULAR_VELOCITY Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int BrickIMUV2::getAngularVelocityPeriod()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von setAngularVelocityPeriod() gesetzt.

void BrickIMUV2::setTemperaturePeriod(int $period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der CALLBACK_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int BrickIMUV2::getTemperaturePeriod()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von setTemperaturePeriod() gesetzt.

void BrickIMUV2::setOrientationPeriod(int $period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der CALLBACK_ORIENTATION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int BrickIMUV2::getOrientationPeriod()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von setOrientationPeriod() gesetzt.

void BrickIMUV2::setLinearAccelerationPeriod(int $period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der CALLBACK_LINEAR_ACCELERATION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int BrickIMUV2::getLinearAccelerationPeriod()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von setLinearAccelerationPeriod() gesetzt.

void BrickIMUV2::setGravityVectorPeriod(int $period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der CALLBACK_GRAVITY_VECTOR Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int BrickIMUV2::getGravityVectorPeriod()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von setGravityVectorPeriod() gesetzt.

void BrickIMUV2::setQuaternionPeriod(int $period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der CALLBACK_QUATERNION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int BrickIMUV2::getQuaternionPeriod()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von setQuaternionPeriod() gesetzt.

void BrickIMUV2::setAllDataPeriod(int $period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der CALLBACK_ALL_DATA Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int BrickIMUV2::getAllDataPeriod()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von setAllDataPeriod() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion registerCallback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite die Callback-Funktion:

<?php

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

$imu_v2->registerCallback(BrickIMUV2::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

int BrickIMUV2::CALLBACK_ACCELERATION¶

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

Callback-Parameter:	$x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? $y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? $z – Typ: int, Einheit: 1 cm/s², Wertebereich: ? $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setAccelerationPeriod(), ausgelöst. Die Parameter sind die Beschleunigungen der X, Y und Z-Achse.

int BrickIMUV2::CALLBACK_MAGNETIC_FIELD¶

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

Callback-Parameter:	$x – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] $y – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800] $z – Typ: int, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000] $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setMagneticFieldPeriod(), ausgelöst. Die Parameter sind die Magnetfeldkomponenten der X, Y und Z-Achse.

int BrickIMUV2::CALLBACK_ANGULAR_VELOCITY¶

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

Callback-Parameter:	$x – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? $y – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? $z – Typ: int, Einheit: 1/16 °/s, Wertebereich: ? $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setAngularVelocityPeriod(), ausgelöst. Die Parameter sind die Winkelgeschwindigkeiten der X, Y und Z-Achse.

int BrickIMUV2::CALLBACK_TEMPERATURE¶

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

Callback-Parameter:	$temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-128 bis 127] $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setTemperaturePeriod(), ausgelöst. Der Parameter ist die Temperatur.

int BrickIMUV2::CALLBACK_LINEAR_ACCELERATION¶

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

Callback-Parameter:	$x – Typ: int, Einheit: 1 cm/s², Wertebereich: ? $y – Typ: int, Einheit: 1 cm/s², Wertebereich: ? $z – Typ: int, Einheit: 1 cm/s², Wertebereich: ? $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setLinearAccelerationPeriod(), ausgelöst. Die Parameter sind die linearen Beschleunigungen der X, Y und Z-Achse.

int BrickIMUV2::CALLBACK_GRAVITY_VECTOR¶

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

Callback-Parameter:	$x – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] $y – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] $z – Typ: int, Einheit: 1 cm/s², Wertebereich: [-981 bis 981] $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setGravityVectorPeriod(), ausgelöst. Die Parameter sind die Erdbeschleunigungsvektor-Werte der X, Y und Z-Achse.

int BrickIMUV2::CALLBACK_ORIENTATION¶

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

Callback-Parameter:	$heading – Typ: int, Einheit: 1/16 °, Wertebereich: [0 bis 5760] $roll – Typ: int, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440] $pitch – Typ: int, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880] $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setOrientationPeriod(), ausgelöst. Die Parameter sind die Orientierung (Gier-, Roll-, Nickwinkel) des IMU Brick in Eulerwinkeln. Siehe getOrientation() für Details.

int BrickIMUV2::CALLBACK_QUATERNION¶

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

Callback-Parameter:	$w – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] $x – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] $y – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] $z – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1] $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setQuaternionPeriod(), ausgelöst. Die Parameter sind die Orientierung (w, x, y, z) des IMU Brick in Quaternionen. Siehe getQuaternion() für 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])   ?>

Callback-Parameter:

$acceleration – Typ: array(int, ...), Länge: 3

0: $x – Typ: int, Einheit: 1 cm/s², Wertebereich: ?
1: $y – Typ: int, Einheit: 1 cm/s², Wertebereich: ?
2: $z – Typ: int, Einheit: 1 cm/s², Wertebereich: ?

$magnetic_field – Typ: array(int, ...), Länge: 3

0: $x – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
1: $y – Typ: int, Einheit: 1/16 µT, Wertebereich: [-20800 bis 20800]
2: $z – Typ: int, Einheit: 1/16 µT, Wertebereich: [-40000 bis 40000]

$angular_velocity – Typ: array(int, ...), Länge: 3

0: $x – Typ: int, Einheit: 1/16 °/s, Wertebereich: ?
1: $y – Typ: int, Einheit: 1/16 °/s, Wertebereich: ?
2: $z – Typ: int, Einheit: 1/16 °/s, Wertebereich: ?

$euler_angle – Typ: array(int, ...), Länge: 3

0: $heading – Typ: int, Einheit: 1/16 °, Wertebereich: [0 bis 5760]
1: $roll – Typ: int, Einheit: 1/16 °, Wertebereich: [-1440 bis 1440]
2: $pitch – Typ: int, Einheit: 1/16 °, Wertebereich: [-2880 bis 2880]

$quaternion – Typ: array(int, ...), Länge: 4

0: $w – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]
1: $x – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]
2: $y – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]
3: $z – Typ: int, Einheit: 1/16383, Wertebereich: [-2¹⁴ + 1 bis 2¹⁴ - 1]

$linear_acceleration – Typ: array(int, ...), Länge: 3

0: $x – Typ: int, Einheit: 1 cm/s², Wertebereich: ?
1: $y – Typ: int, Einheit: 1 cm/s², Wertebereich: ?
2: $z – Typ: int, Einheit: 1 cm/s², Wertebereich: ?

$gravity_vector – Typ: array(int, ...), Länge: 3

0: $x – Typ: int, Einheit: 1 cm/s², Wertebereich: ?
1: $y – Typ: int, Einheit: 1 cm/s², Wertebereich: ?
2: $z – Typ: int, Einheit: 1 cm/s², Wertebereich: ?

$temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-128 bis 127]
$calibration_status – Typ: int, Wertebereich: [0 bis 255]
$user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setAllDataPeriod(), ausgelöst. Die Parameter sind die gleichen wie bei getAllData().

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

array BrickIMUV2::getAPIVersion()¶

Rückgabe-Array:	$api_version – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

bool BrickIMUV2::getResponseExpected(int $function_id)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	$response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels setResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $function_id:

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
BrickIMUV2::FUNCTION_WRITE_BRICKLET_PLUGIN = 246

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

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten $response_expected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $function_id:

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
BrickIMUV2::FUNCTION_WRITE_BRICKLET_PLUGIN = 246

void BrickIMUV2::setResponseExpectedAll(bool $response_expected)¶

Parameter:	$response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

array BrickIMUV2::getProtocol1BrickletName(string $port)¶

Parameter:	$port – Typ: string, Wertebereich: ['a' bis 'b']
Rückgabe-Array:	'protocol_version' – Typ: int, Wertebereich: [0 bis 255] 'firmware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'name' – Typ: string, Länge: bis zu 40

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

void BrickIMUV2::writeBrickletPlugin(string $port, int $offset, array $chunk)¶

Parameter:	$port – Typ: string, Wertebereich: ['a' bis 'b'] $offset – Typ: int, Wertebereich: [0 bis 255] $chunk – Typ: array(int, ...), Länge: 32, Wertebereich: [0 bis 255]

Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

array BrickIMUV2::readBrickletPlugin(string $port, int $offset)¶

Parameter:	$port – Typ: string, Wertebereich: ['a' bis 'b'] $offset – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	$chunk – Typ: array(int, ...), Länge: 32, Wertebereich: [0 bis 255]

Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Konstanten¶

int BrickIMUV2::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um einen IMU Brick 2.0 zu identifizieren.

Die getIdentity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickIMUV2::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines IMU Brick 2.0 dar.