readMagneticField

Read the magnetic field measured by the Magnetometer along the x, y and z axis

Syntax

magField = readMagneticField(mysh)

[magField,Ts] = readMagneticField(mysh)

magFieldRaw = readMagneticField(mysh,raw)

[magFieldRaw,Ts]= readMagneticField(mysh,raw)

Description

magField = readMagneticField(mysh) returns the magnetic field measured by the Magnetometer along the x, y, and the z axes.

The unit of measurement for the Magnetometer raw data is microtesla (µT).

[magField,Ts] = readMagneticField(mysh) returns the magnetic field measured by the Magnetometer along the x, y, and the z axes with timestamp. The unit of measurement for the Magnetometer field is microtesla (µT).

magFieldRaw = readMagneticField(mysh,raw) returns the magnetic field measured by the Magnetometer along the x, y, and the z axes. The ‘raw’ argument is to specify that the output should be a uncalibrated raw data.

[magFieldRaw,Ts]= readMagneticField(mysh,raw) returns the magnetic field measured by the Magnetometer along the x, y, and the z axes with timestamp. The ‘raw’ argument is to specify that the output should be a uncalibrated raw data.

The full scale range for the Magnetometer is +/- 4 gauss.

Sense HAT IMU sensor axis information is shown below.

Examples

Read Magnetic Field

To read the magnetic field along the x, y, and the z axis.

magField = readMagneticField(mysh) 

magField =  

      -0.3045    0.2769   10.0417 

Read the magnetic field measured by the Magnetometer along the x, y, and the z axis .

Read Magnetic Field with Timestamp

To read the magnetic field along the x, y, and the z axes measured by the Magnetometer along with the time stamp at which the data was read.

[magField,ts] = readMagneticField(mysh)  

magField= 

 -0.1847    0.5511    0.1847 

ts =  

   09-Aug-2016 15:37:19  

Read the magnetic field measured by the Magnetometer along the x, y, and the z axis with timestamp.

Read Raw Uncalibrated Magnetic Field

To read raw uncalibrated magnetic field along the x, y, and the z axis.

magFieldRaw = readMagneticField(mysensehat,'raw')

magFieldRaw = 

         865       -1189        2002 

Read the raw uncalibrated magnetic field value measured by the Magnetometer along the x, y, and the z axis .

Read Raw Uncalibrated Magnetic Field with Timestamp

To read raw uncalibrated magnetic field along the x, y, and the z axis.

[magFieldRaw,ts] = readMagneticField(mysensehat,'raw') 

magFieldRaw= 

         865       -1189        2002 

ts = 

  09-Aug-2016 15:37:19 
 

Read the raw uncalibrated magnetic field value measured by the Magnetometer along the x, y, and the z axis with the timestamp.

Input Arguments

mysh — Connection to SenseHAT

sense HAT object

Connection to a SenseHAT board, specified as a sensehat object.

raw — Argument to specify the output type

scalar

Argument to specify that the output should be a uncalibrated raw data.

Output Arguments

magField — Magnetic field measured along the x,y, and z axes

scalar

The magnetic field measured by the Magnetometer along the x,y, and z axes. This is a 1x3 double data. The unit of measurement for the Magnetometer data is microtesla (µT).

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

• You can also deploy readMagneticField on the Raspberry Pi^® hardware in MATLAB^® Online™.

Version History

Introduced in R2016b