Struct tinkerforge::imu_v2_brick::ImuV2Brick
source · pub struct ImuV2Brick { /* private fields */ }
Expand description
Full fledged AHRS with 9 degrees of freedom
Implementations
sourceimpl ImuV2Brick
impl ImuV2Brick
pub const DEVICE_IDENTIFIER: u16 = 18u16
pub const DEVICE_DISPLAY_NAME: &'static str = "IMU Brick 2.0"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> ImuV2Brick
pub fn new(uid: &str, ip_connection: &IpConnection) -> ImuV2Brick
Creates an object with the unique device ID uid
. This object can then be used after the IP Connection ip_connection
is connected.
sourcepub fn get_response_expected(
&mut self,
fun: ImuV2BrickFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: ImuV2BrickFunction
) -> Result<bool, GetResponseExpectedError>
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 set_response_expected
.
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 set_response_expected
for the list of function ID constants available for this function.
sourcepub fn set_response_expected(
&mut self,
fun: ImuV2BrickFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: ImuV2BrickFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
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.
sourcepub fn set_response_expected_all(&mut self, response_expected: bool)
pub fn set_response_expected_all(&mut self, response_expected: bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
sourcepub fn get_acceleration_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AccelerationEvent>
pub fn get_acceleration_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AccelerationEvent>
This receiver is triggered periodically with the period that is set by
Set Acceleration Period
. The parameters are the acceleration
for the x, y and z axis.
sourcepub fn get_magnetic_field_callback_receiver(
&self
) -> ConvertingCallbackReceiver<MagneticFieldEvent>
pub fn get_magnetic_field_callback_receiver(
&self
) -> ConvertingCallbackReceiver<MagneticFieldEvent>
This receiver is triggered periodically with the period that is set by
Set Magnetic Field Period
. The parameters are the magnetic
field for the x, y and z axis.
sourcepub fn get_angular_velocity_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AngularVelocityEvent>
pub fn get_angular_velocity_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AngularVelocityEvent>
This receiver is triggered periodically with the period that is set by
Set Angular Velocity Period
. The parameters are the angular
velocity for the x, y and z axis.
sourcepub fn get_temperature_callback_receiver(
&self
) -> ConvertingCallbackReceiver<i8>
pub fn get_temperature_callback_receiver(
&self
) -> ConvertingCallbackReceiver<i8>
This receiver is triggered periodically with the period that is set by
Set Temperature Period
. The parameter is the temperature.
sourcepub fn get_linear_acceleration_callback_receiver(
&self
) -> ConvertingCallbackReceiver<LinearAccelerationEvent>
pub fn get_linear_acceleration_callback_receiver(
&self
) -> ConvertingCallbackReceiver<LinearAccelerationEvent>
This receiver is triggered periodically with the period that is set by
Set Linear Acceleration Period
. The parameters are the
linear acceleration for the x, y and z axis.
sourcepub fn get_gravity_vector_callback_receiver(
&self
) -> ConvertingCallbackReceiver<GravityVectorEvent>
pub fn get_gravity_vector_callback_receiver(
&self
) -> ConvertingCallbackReceiver<GravityVectorEvent>
This receiver is triggered periodically with the period that is set by
Set Gravity Vector Period
. The parameters gravity vector
for the x, y and z axis.
sourcepub fn get_orientation_callback_receiver(
&self
) -> ConvertingCallbackReceiver<OrientationEvent>
pub fn get_orientation_callback_receiver(
&self
) -> ConvertingCallbackReceiver<OrientationEvent>
This receiver is triggered periodically with the period that is set by
Set Orientation Period
. The parameters are the orientation
(heading (yaw), roll, pitch) of the IMU Brick in Euler angles. See
Get Orientation
for details.
sourcepub fn get_quaternion_callback_receiver(
&self
) -> ConvertingCallbackReceiver<QuaternionEvent>
pub fn get_quaternion_callback_receiver(
&self
) -> ConvertingCallbackReceiver<QuaternionEvent>
This receiver is triggered periodically with the period that is set by
Set Quaternion Period
. The parameters are the orientation
(x, y, z, w) of the IMU Brick in quaternions. See Get Quaternion
for details.
sourcepub fn get_all_data_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AllDataEvent>
pub fn get_all_data_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AllDataEvent>
This receiver is triggered periodically with the period that is set by
Set All Data Period
. The parameters are as for
Get All Data
.
sourcepub fn get_acceleration(&self) -> ConvertingReceiver<Acceleration>
pub fn get_acceleration(&self) -> ConvertingReceiver<Acceleration>
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 get_acceleration_callback_receiver
receiver and set the period with
Set Acceleration Period
.
sourcepub fn get_magnetic_field(&self) -> ConvertingReceiver<MagneticField>
pub fn get_magnetic_field(&self) -> ConvertingReceiver<MagneticField>
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 get_magnetic_field_callback_receiver
receiver and set the period with
Set Magnetic Field Period
.
sourcepub fn get_angular_velocity(&self) -> ConvertingReceiver<AngularVelocity>
pub fn get_angular_velocity(&self) -> ConvertingReceiver<AngularVelocity>
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 get_angular_velocity_callback_receiver
areceiver nd set the period with
Set Angular Velocity Period
.
sourcepub fn get_temperature(&self) -> ConvertingReceiver<i8>
pub fn get_temperature(&self) -> ConvertingReceiver<i8>
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
sourcepub fn get_orientation(&self) -> ConvertingReceiver<Orientation>
pub fn get_orientation(&self) -> ConvertingReceiver<Orientation>
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 get_orientation_callback_receiver
receiver and set the period with
Set Orientation Period
.
sourcepub fn get_linear_acceleration(&self) -> ConvertingReceiver<LinearAcceleration>
pub fn get_linear_acceleration(&self) -> ConvertingReceiver<LinearAcceleration>
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 Get Gravity Vector
.
If you want to get the linear acceleration periodically, it is recommended
to use the get_linear_acceleration_callback_receiver
receiver and set the period with
Set Linear Acceleration Period
.
sourcepub fn get_gravity_vector(&self) -> ConvertingReceiver<GravityVector>
pub fn get_gravity_vector(&self) -> ConvertingReceiver<GravityVector>
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 Get Linear Acceleration
.
If you want to get the gravity vector periodically, it is recommended
to use the get_gravity_vector_callback_receiver
receiver and set the period with
Set Gravity Vector Period
.
sourcepub fn get_quaternion(&self) -> ConvertingReceiver<Quaternion>
pub fn get_quaternion(&self) -> ConvertingReceiver<Quaternion>
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 get_quaternion_callback_receiver
receiver and set the period with
Set Quaternion Period
.
sourcepub fn get_all_data(&self) -> ConvertingReceiver<AllData>
pub fn get_all_data(&self) -> ConvertingReceiver<AllData>
Return all of the available data of the IMU Brick.
- acceleration in 1/100 m/s² (see
Get Acceleration
) - magnetic field in 1/16 µT (see
Get Magnetic Field
) - angular velocity in 1/16 °/s (see
Get Angular Velocity
) - Euler angles in 1/16 ° (see
Get Orientation
) - quaternion 1/16383 (see
Get Quaternion
) - linear acceleration 1/100 m/s² (see
Get Linear Acceleration
) - gravity vector 1/100 m/s² (see
Get Gravity Vector
) - temperature in 1 °C (see
Get Temperature
) - calibration status (see below)
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 get_all_data_callback_receiver
receiver and set the period with
Set All Data Period
.
sourcepub fn leds_on(&self) -> ConvertingReceiver<()>
pub fn leds_on(&self) -> ConvertingReceiver<()>
Turns the orientation and direction LEDs of the IMU Brick on.
sourcepub fn leds_off(&self) -> ConvertingReceiver<()>
pub fn leds_off(&self) -> ConvertingReceiver<()>
Turns the orientation and direction LEDs of the IMU Brick off.
sourcepub fn are_leds_on(&self) -> ConvertingReceiver<bool>
pub fn are_leds_on(&self) -> ConvertingReceiver<bool>
Returns true if the orientation and direction LEDs of the IMU Brick are on, false otherwise.
sourcepub fn save_calibration(&self) -> ConvertingReceiver<bool>
pub fn save_calibration(&self) -> ConvertingReceiver<bool>
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.
sourcepub fn set_acceleration_period(&self, period: u32) -> ConvertingReceiver<()>
pub fn set_acceleration_period(&self, period: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the get_acceleration_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
The default value is 0.
sourcepub fn get_acceleration_period(&self) -> ConvertingReceiver<u32>
pub fn get_acceleration_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Acceleration Period
.
sourcepub fn set_magnetic_field_period(&self, period: u32) -> ConvertingReceiver<()>
pub fn set_magnetic_field_period(&self, period: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the get_magnetic_field_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
sourcepub fn get_magnetic_field_period(&self) -> ConvertingReceiver<u32>
pub fn get_magnetic_field_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Magnetic Field Period
.
sourcepub fn set_angular_velocity_period(&self, period: u32) -> ConvertingReceiver<()>
pub fn set_angular_velocity_period(&self, period: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the get_angular_velocity_callback_receiver
receiver is
triggered periodically. A value of 0 turns the receiver off.
sourcepub fn get_angular_velocity_period(&self) -> ConvertingReceiver<u32>
pub fn get_angular_velocity_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Angular Velocity Period
.
sourcepub fn set_temperature_period(&self, period: u32) -> ConvertingReceiver<()>
pub fn set_temperature_period(&self, period: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the get_temperature_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
sourcepub fn get_temperature_period(&self) -> ConvertingReceiver<u32>
pub fn get_temperature_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Temperature Period
.
sourcepub fn set_orientation_period(&self, period: u32) -> ConvertingReceiver<()>
pub fn set_orientation_period(&self, period: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the get_orientation_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
sourcepub fn get_orientation_period(&self) -> ConvertingReceiver<u32>
pub fn get_orientation_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Orientation Period
.
sourcepub fn set_linear_acceleration_period(
&self,
period: u32
) -> ConvertingReceiver<()>
pub fn set_linear_acceleration_period(
&self,
period: u32
) -> ConvertingReceiver<()>
Sets the period in ms with which the get_linear_acceleration_callback_receiver
receiver is
triggered periodically. A value of 0 turns the receiver off.
sourcepub fn get_linear_acceleration_period(&self) -> ConvertingReceiver<u32>
pub fn get_linear_acceleration_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Linear Acceleration Period
.
sourcepub fn set_gravity_vector_period(&self, period: u32) -> ConvertingReceiver<()>
pub fn set_gravity_vector_period(&self, period: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the get_gravity_vector_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
sourcepub fn get_gravity_vector_period(&self) -> ConvertingReceiver<u32>
pub fn get_gravity_vector_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Gravity Vector Period
.
sourcepub fn set_quaternion_period(&self, period: u32) -> ConvertingReceiver<()>
pub fn set_quaternion_period(&self, period: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the get_quaternion_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
sourcepub fn get_quaternion_period(&self) -> ConvertingReceiver<u32>
pub fn get_quaternion_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Quaternion Period
.
sourcepub fn set_all_data_period(&self, period: u32) -> ConvertingReceiver<()>
pub fn set_all_data_period(&self, period: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the get_all_data_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
sourcepub fn get_all_data_period(&self) -> ConvertingReceiver<u32>
pub fn get_all_data_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set All Data Period
.
sourcepub fn set_sensor_configuration(
&self,
magnetometer_rate: u8,
gyroscope_range: u8,
gyroscope_bandwidth: u8,
accelerometer_range: u8,
accelerometer_bandwidth: u8
) -> ConvertingReceiver<()>
pub fn set_sensor_configuration(
&self,
magnetometer_rate: u8,
gyroscope_range: u8,
gyroscope_bandwidth: u8,
accelerometer_range: u8,
accelerometer_bandwidth: u8
) -> ConvertingReceiver<()>
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
.. versionadded:: 2.0.5$nbsp;(Firmware)
Associated constants:
- IMU_V2BRICK_MAGNETOMETER_RATE_2HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_6HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_8HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_10HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_15HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_20HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_25HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_30HZ
- IMU_V2BRICK_GYROSCOPE_RANGE_2000DPS
- IMU_V2BRICK_GYROSCOPE_RANGE_1000DPS
- IMU_V2BRICK_GYROSCOPE_RANGE_500DPS
- IMU_V2BRICK_GYROSCOPE_RANGE_250DPS
- IMU_V2BRICK_GYROSCOPE_RANGE_125DPS
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_523HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_230HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_116HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_47HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_23HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_12HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_64HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_32HZ
- IMU_V2BRICK_ACCELEROMETER_RANGE_2G
- IMU_V2BRICK_ACCELEROMETER_RANGE_4G
- IMU_V2BRICK_ACCELEROMETER_RANGE_8G
- IMU_V2BRICK_ACCELEROMETER_RANGE_16G
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_7_81HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_15_63HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_31_25HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_62_5HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_125HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_250HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_500HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_1000HZ
sourcepub fn get_sensor_configuration(
&self
) -> ConvertingReceiver<SensorConfiguration>
pub fn get_sensor_configuration(
&self
) -> ConvertingReceiver<SensorConfiguration>
Returns the sensor configuration as set by Set Sensor Configuration
.
.. versionadded:: 2.0.5$nbsp;(Firmware)
Associated constants:
- IMU_V2BRICK_MAGNETOMETER_RATE_2HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_6HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_8HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_10HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_15HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_20HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_25HZ
- IMU_V2BRICK_MAGNETOMETER_RATE_30HZ
- IMU_V2BRICK_GYROSCOPE_RANGE_2000DPS
- IMU_V2BRICK_GYROSCOPE_RANGE_1000DPS
- IMU_V2BRICK_GYROSCOPE_RANGE_500DPS
- IMU_V2BRICK_GYROSCOPE_RANGE_250DPS
- IMU_V2BRICK_GYROSCOPE_RANGE_125DPS
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_523HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_230HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_116HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_47HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_23HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_12HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_64HZ
- IMU_V2BRICK_GYROSCOPE_BANDWIDTH_32HZ
- IMU_V2BRICK_ACCELEROMETER_RANGE_2G
- IMU_V2BRICK_ACCELEROMETER_RANGE_4G
- IMU_V2BRICK_ACCELEROMETER_RANGE_8G
- IMU_V2BRICK_ACCELEROMETER_RANGE_16G
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_7_81HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_15_63HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_31_25HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_62_5HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_125HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_250HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_500HZ
- IMU_V2BRICK_ACCELEROMETER_BANDWIDTH_1000HZ
sourcepub fn set_sensor_fusion_mode(&self, mode: u8) -> ConvertingReceiver<()>
pub fn set_sensor_fusion_mode(&self, mode: u8) -> ConvertingReceiver<()>
If the fusion mode is turned off, the functions Get Acceleration
,
Get Magnetic Field
and Get Angular Velocity
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.
.. versionadded:: 2.0.5$nbsp;(Firmware)
Associated constants:
- IMU_V2BRICK_SENSOR_FUSION_OFF
- IMU_V2BRICK_SENSOR_FUSION_ON
- IMU_V2BRICK_SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER
- IMU_V2BRICK_SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION
sourcepub fn get_sensor_fusion_mode(&self) -> ConvertingReceiver<u8>
pub fn get_sensor_fusion_mode(&self) -> ConvertingReceiver<u8>
Returns the sensor fusion mode as set by Set Sensor Fusion Mode
.
.. versionadded:: 2.0.5$nbsp;(Firmware)
Associated constants:
- IMU_V2BRICK_SENSOR_FUSION_OFF
- IMU_V2BRICK_SENSOR_FUSION_ON
- IMU_V2BRICK_SENSOR_FUSION_ON_WITHOUT_MAGNETOMETER
- IMU_V2BRICK_SENSOR_FUSION_ON_WITHOUT_FAST_MAGNETOMETER_CALIBRATION
sourcepub fn set_spitfp_baudrate_config(
&self,
enable_dynamic_baudrate: bool,
minimum_dynamic_baudrate: u32
) -> ConvertingReceiver<()>
pub fn set_spitfp_baudrate_config(
&self,
enable_dynamic_baudrate: bool,
minimum_dynamic_baudrate: u32
) -> ConvertingReceiver<()>
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
Set SPITFP Baudrate
. If the dynamic baudrate is disabled, the baudrate
as set by 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.0.10$nbsp;(Firmware)
sourcepub fn get_spitfp_baudrate_config(
&self
) -> ConvertingReceiver<SpitfpBaudrateConfig>
pub fn get_spitfp_baudrate_config(
&self
) -> ConvertingReceiver<SpitfpBaudrateConfig>
Returns the baudrate config, see Set SPITFP Baudrate Config
.
.. versionadded:: 2.0.10$nbsp;(Firmware)
sourcepub fn get_send_timeout_count(
&self,
communication_method: u8
) -> ConvertingReceiver<u32>
pub fn get_send_timeout_count(
&self,
communication_method: u8
) -> ConvertingReceiver<u32>
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.0.7$nbsp;(Firmware)
Associated constants:
- IMU_V2BRICK_COMMUNICATION_METHOD_NONE
- IMU_V2BRICK_COMMUNICATION_METHOD_USB
- IMU_V2BRICK_COMMUNICATION_METHOD_SPI_STACK
- IMU_V2BRICK_COMMUNICATION_METHOD_CHIBI
- IMU_V2BRICK_COMMUNICATION_METHOD_RS485
- IMU_V2BRICK_COMMUNICATION_METHOD_WIFI
- IMU_V2BRICK_COMMUNICATION_METHOD_ETHERNET
- IMU_V2BRICK_COMMUNICATION_METHOD_WIFI_V2
sourcepub fn set_spitfp_baudrate(
&self,
bricklet_port: char,
baudrate: u32
) -> ConvertingReceiver<()>
pub fn set_spitfp_baudrate(
&self,
bricklet_port: char,
baudrate: u32
) -> ConvertingReceiver<()>
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 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 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.
.. versionadded:: 2.0.5$nbsp;(Firmware)
sourcepub fn get_spitfp_baudrate(&self, bricklet_port: char) -> ConvertingReceiver<u32>
pub fn get_spitfp_baudrate(&self, bricklet_port: char) -> ConvertingReceiver<u32>
Returns the baudrate for a given Bricklet port, see Set SPITFP Baudrate
.
.. versionadded:: 2.0.5$nbsp;(Firmware)
sourcepub fn get_spitfp_error_count(
&self,
bricklet_port: char
) -> ConvertingReceiver<SpitfpErrorCount>
pub fn get_spitfp_error_count(
&self,
bricklet_port: char
) -> ConvertingReceiver<SpitfpErrorCount>
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.
.. versionadded:: 2.0.5$nbsp;(Firmware)
sourcepub fn enable_status_led(&self) -> ConvertingReceiver<()>
pub fn enable_status_led(&self) -> ConvertingReceiver<()>
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.
sourcepub fn disable_status_led(&self) -> ConvertingReceiver<()>
pub fn disable_status_led(&self) -> ConvertingReceiver<()>
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.
sourcepub fn is_status_led_enabled(&self) -> ConvertingReceiver<bool>
pub fn is_status_led_enabled(&self) -> ConvertingReceiver<bool>
Returns true if the status LED is enabled, false otherwise.
sourcepub fn get_protocol1_bricklet_name(
&self,
port: char
) -> ConvertingReceiver<Protocol1BrickletName>
pub fn get_protocol1_bricklet_name(
&self,
port: char
) -> ConvertingReceiver<Protocol1BrickletName>
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.
sourcepub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>
pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>
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.
sourcepub fn reset(&self) -> ConvertingReceiver<()>
pub fn reset(&self) -> ConvertingReceiver<()>
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!
sourcepub fn get_identity(&self) -> ConvertingReceiver<Identity>
pub fn get_identity(&self) -> ConvertingReceiver<Identity>
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. |device_identifier_constant|
Trait Implementations
sourceimpl Clone for ImuV2Brick
impl Clone for ImuV2Brick
sourcefn clone(&self) -> ImuV2Brick
fn clone(&self) -> ImuV2Brick
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more