LIS2MDL Sensor

The ST LIS2MDL is a sensor for magnetometer.

Implementation file for the LIS2MDL driver class.

Assembly

LIS2MDLSensor.h

Summary

Types

DevI2C

Provides functions for multi-register I2C communication.

MAGNETO_StatusTypeDef

MAGNETO status enumerator definition

Constructors

LIS2MDL

LIS2MDL(DevI2C &i2c)

Parameters

Type	Name	Description
DevI2C &	i2c	The object of an helper class which handles the I2C peripheral.

Methods

init

int init()

Set LIS2MDL Initialization.

Parameters

None.

Return value

Type	Description
int	0 (MAGNETO_OK) in case of success, an error code otherwise.

readId

int readId(unsigned char *m_id)

Read ID of LIS2MDL Magnetic sensor.

Parameters

Type	Name	Description
unsigned char *	m_id	The pointer where the ID of the device is stored.

Return value

Type	Description
int	0 (MAGNETO_OK) in case of success, an error code otherwise.

getMAxes

int getMAxes(int *pData)

Read data from LIS2MDL Magnetic sensor and calculate Magnetic in mgauss.

Parameters

Type	Name	Description
int *	pData	The pointer where the magnetometer data are stored.

Return value

Type	Description
int	0 (MAGNETO_OK) in case of success, an error code otherwise.

Sample code

#include "lis2mdl_class.h"
DevI2C *i2c;
LIS2MDL *lis2mdl;
int32_t axes[3];
int16_t raw[3];
uint8_t id;
void setup(){
    i2c = new DevI2C(D14, D15);
    lis2mdl = new LIS2MDL(*i2c);
    // init
    lis2mdl->init(NULL);
}
void loop(){
    // read id
    lis2mdl->readId(&id);
    Serial.printf("Id: %d\n", id);
    // getMAxes
    lis2mdl->getMAxes(axes);
    Serial.printf("Axes: x - %d, y - %d, z - %d\n", axes[0], axes[1], axes[2]);
    delay(1000);
}