Tinkerforge::BrickIMU - Full fledged AHRS with 9 degrees of freedom
This constant is used to identify a IMU Brick.
The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.
This constant represents the display name of a IMU Brick.
This constant is used with the register_callback() subroutine to specify the CALLBACK_ACCELERATION callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_MAGNETIC_FIELD callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_ANGULAR_VELOCITY callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_ALL_DATA callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_ORIENTATION callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_QUATERNION callback.
This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.
Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.
Returns the calibrated acceleration from the accelerometer for the x, y and z axis in g/1000 (1g = 9.80665m/s²).
If you want to get the acceleration periodically, it is recommended to use the :cb:`Acceleration` callback and set the period with :func:`Set Acceleration Period`.
Returns the calibrated magnetic field from the magnetometer for the x, y and z axis in mG (Milligauss or Nanotesla).
If you want to get the magnetic field periodically, it is recommended to use the :cb:`Magnetic Field` callback and set the period with :func:`Set Magnetic Field Period`.
Returns the calibrated angular velocity from the gyroscope for the x, y and z axis in °/14.375s (you have to divide by 14.375 to get the value in °/s).
If you want to get the angular velocity periodically, it is recommended to use the :cb:`Angular Velocity` callback and set the period with :func:`Set Angular Velocity Period`.
Returns the data from :func:`Get Acceleration`, :func:`Get Magnetic Field` and :func:`Get Angular Velocity` as well as the temperature of the IMU Brick.
The temperature is given in °C/100.
If you want to get the data periodically, it is recommended to use the :cb:`All Data` callback and set the period with :func:`Set All Data Period`.
Returns the current orientation (roll, pitch, yaw) of the IMU Brick as Euler angles in one-hundredth degree. Note that Euler angles always experience a `gimbal lock <https://en.wikipedia.org/wiki/Gimbal_lock>`__.
We recommend that you use quaternions instead.
The order to sequence in which the orientation values should be applied is roll, yaw, pitch.
If you want to get the orientation periodically, it is recommended to use the :cb:`Orientation` callback and set the period with :func:`Set Orientation Period`.
Returns the current orientation (x, y, z, w) of the IMU as `quaternions <https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation>`__.
You can go from quaternions to Euler angles with the following formula::
xAngle = atan2(2*y*w - 2*x*z, 1 - 2*y*y - 2*z*z) yAngle = atan2(2*x*w - 2*y*z, 1 - 2*x*x - 2*z*z) zAngle = asin(2*x*y + 2*z*w)
This process is not reversible, because of the `gimbal lock <https://en.wikipedia.org/wiki/Gimbal_lock>`__.
It is also possible to calculate independent angles. You can calculate yaw, pitch and roll in a right-handed vehicle coordinate system according to DIN70000 with::
yaw = atan2(2*x*y + 2*w*z, w*w + x*x - y*y - z*z) pitch = -asin(2*w*y - 2*x*z) roll = -atan2(2*y*z + 2*w*x, -w*w + x*x + y*y - z*z))
Converting the quaternions to an OpenGL transformation matrix is possible with the following formula::
matrix = [[1 - 2*(y*y + z*z), 2*(x*y - w*z), 2*(x*z + w*y), 0], [ 2*(x*y + w*z), 1 - 2*(x*x + z*z), 2*(y*z - w*x), 0], [ 2*(x*z - w*y), 2*(y*z + w*x), 1 - 2*(x*x + y*y), 0], [ 0, 0, 0, 1]]
If you want to get the quaternions periodically, it is recommended to use the :cb:`Quaternion` callback and set the period with :func:`Set Quaternion Period`.
Returns the temperature of the IMU Brick. The temperature is given in °C/100.
Turns the orientation and direction LEDs of the IMU Brick on.
Turns the orientation and direction LEDs of the IMU Brick off.
Returns *true* if the orientation and direction LEDs of the IMU Brick are on, *false* otherwise.
Not implemented yet.
Sets the convergence speed of the IMU Brick in °/s. The convergence speed determines how the different sensor measurements are fused.
If the orientation of the IMU Brick is off by 10° and the convergence speed is set to 20°/s, it will take 0.5s until the orientation is corrected. However, if the correct orientation is reached and the convergence speed is too high, the orientation will fluctuate with the fluctuations of the accelerometer and the magnetometer.
If you set the convergence speed to 0, practically only the gyroscope is used to calculate the orientation. This gives very smooth movements, but errors of the gyroscope will not be corrected. If you set the convergence speed to something above 500, practically only the magnetometer and the accelerometer are used to calculate the orientation. In this case the movements are abrupt and the values will fluctuate, but there won't be any errors that accumulate over time.
In an application with high angular velocities, we recommend a high convergence speed, so the errors of the gyroscope can be corrected fast. In applications with only slow movements we recommend a low convergence speed. You can change the convergence speed on the fly. So it is possible (and recommended) to increase the convergence speed before an abrupt movement and decrease it afterwards again.
You might want to play around with the convergence speed in the Brick Viewer to get a feeling for a good value for your application.
The default value is 30.
Returns the convergence speed as set by :func:`Set Convergence Speed`.
There are several different types that can be calibrated:
.. csv-table:: :header: "Type", "Description", "Values" :widths: 10, 30, 110
"0", "Accelerometer Gain", "``[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]``" "1", "Accelerometer Bias", "``[bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0]``" "2", "Magnetometer Gain", "``[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]``" "3", "Magnetometer Bias", "``[bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0]``" "4", "Gyroscope Gain", "``[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]``" "5", "Gyroscope Bias", "``[bias xl, bias yl, bias zl, temp l, bias xh, bias yh, bias zh, temp h, 0, 0]``"
The calibration via gain and bias is done with the following formula::
new_value = (bias + orig_value) * gain_mul / gain_div
If you really want to write your own calibration software, please keep in mind that you first have to undo the old calibration (set bias to 0 and gain to 1/1) and that you have to average over several thousand values to obtain a usable result in the end.
The gyroscope bias is highly dependent on the temperature, so you have to calibrate the bias two times with different temperatures. The values ``xl``, ``yl``, ``zl`` and ``temp l`` are the bias for ``x``, ``y``, ``z`` and the corresponding temperature for a low temperature. The values ``xh``, ``yh``, ``zh`` and ``temp h`` are the same for a high temperatures. The temperature difference should be at least 5°C. If you have a temperature where the IMU Brick is mostly used, you should use this temperature for one of the sampling points.
.. note:: We highly recommend that you use the Brick Viewer to calibrate your IMU Brick.
Returns the calibration for a given type as set by :func:`Set Calibration`.
Sets the period in ms with which the :cb:`Acceleration` callback is triggered periodically. A value of 0 turns the callback off.
The default value is 0.
Returns the period as set by :func:`Set Acceleration Period`.
Sets the period in ms with which the :cb:`Magnetic Field` callback is triggered periodically. A value of 0 turns the callback off.
Returns the period as set by :func:`Set Magnetic Field Period`.
Sets the period in ms with which the :cb:`Angular Velocity` callback is triggered periodically. A value of 0 turns the callback off.
Returns the period as set by :func:`Set Angular Velocity Period`.
Sets the period in ms with which the :cb:`All Data` callback is triggered periodically. A value of 0 turns the callback off.
Returns the period as set by :func:`Set All Data Period`.
Sets the period in ms with which the :cb:`Orientation` callback is triggered periodically. A value of 0 turns the callback off.
Returns the period as set by :func:`Set Orientation Period`.
Sets the period in ms with which the :cb:`Quaternion` callback is triggered periodically. A value of 0 turns the callback off.
Returns the period as set by :func:`Set Quaternion Period`.
Turns the orientation calculation of the IMU Brick on.
As default the calculation is on.
.. versionadded:: 2.0.2$nbsp;(Firmware)
Turns the orientation calculation of the IMU Brick off.
If the calculation is off, :func:`Get Orientation` will return the last calculated value until the calculation is turned on again.
The trigonometric functions that are needed to calculate the orientation are very expensive. We recommend to turn the orientation calculation off if the orientation is not needed, to free calculation time for the sensor fusion algorithm.
Returns *true* if the orientation calculation of the IMU Brick is on, *false* otherwise.
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 :func:`Set SPITFP Baudrate`. If the dynamic baudrate is disabled, the baudrate as set by :func:`Set SPITFP Baudrate` 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.
.. versionadded:: 2.3.5$nbsp;(Firmware)
Returns the baudrate config, see :func:`Set SPITFP Baudrate Config`.
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.
.. versionadded:: 2.3.3$nbsp;(Firmware)
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 :func:`Get SPITFP Error Count`) you can decrease the baudrate.
If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (see :func:`Set SPITFP Baudrate Config`).
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.
Returns the baudrate for a given Bricklet port, see :func:`Set SPITFP Baudrate`.
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.
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.
.. versionadded:: 2.3.1$nbsp;(Firmware)
Disables the status LED.
Returns *true* if the status LED is enabled, *false* otherwise.
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.
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.
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!
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 :ref:`here <device_identifier>`. |device_identifier_constant|
To install Tinkerforge, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tinkerforge
CPAN shell
perl -MCPAN -e shell install Tinkerforge
For more information on module installation, please visit the detailed CPAN module installation guide.