Reference   Language | Libraries | Comparison | Changes

Arduino_LSM9DS1 : LSM9DS1 class

readMagneticField()

Description

Query the magnetometer and returns the magnetic field measured in uT(micro Tesla)

Syntax

 IMU.readMagneticField(x, y, z)

Parameters

x,y,z - the float variables where the magnetic field values will be stored

Returns

1 on success, 0 on failure

Example


  float x, y, z;

  if (IMU.magneticFieldAvailable()) {
        IMU.readMagneticField(x, y, z);

        Serial.print(x);
        Serial.print('\t');
        Serial.print(y);
        Serial.print('\t');
        Serial.println(z);
  }

See Also



Reference Home

Corrections, suggestions, and new documentation should be posted to the Forum.

The text of the Arduino reference is licensed under a Creative Commons Attribution-ShareAlike 3.0 License. Code samples in the reference are released into the public domain.