Adafruit_LIS2MDL (community library)
Unified Magnetometer sensor driver for Adafruit's LIS2MDL Breakout Unified Magnetometer sensor driver for Adafruit's LIS2MDL Breakout
Example Build Testing
Device OS Version:
This table is generated from an automated build. Success only indicates that the code compiled successfully.
Library Read Me
This content is provided by the library maintainer and has not been validated or approved.
Adafruit LIS2MDL Magnetometer Library
This library is for the Adafruit LIS2MDL and LSM303AGR Breakouts
Tested and works great with Adafruit's LIS2MDL and LSM303AGR Breakout Boards
This chip uses I2C to communicate, 2 pins are required to interface
Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!
About the LIS2MDL
The LIS2MDL is a 3-axis magnetometer made by ST. Additionally, the LIS2MDL is available packaged with an accelerometer in the ST LSM303AGR 6-dof IMUs. The magnetometer measures magnetic force, which is useful to detect magnetic north.
More information on the LIS2MDL can be found in the datasheet: https://www.st.com/resource/en/datasheet/lis2mdl.pdf
Information on the LSM303AGR can be found in the datasheet: http://www.adafruit.com/datasheets/LSM303AGRC.PDF
What is the Adafruit Unified Sensor Library?
The Adafruit Unified Sensor Library (Adafruit_Sensor) provides a common interface and data type for any supported sensor. It defines some basic information about the sensor (sensor limits, etc.), and returns standard SI units of a specific type and scale for each supported sensor type.
It provides a simple abstraction layer between your application and the actual sensor HW, allowing you to drop in any comparable sensor with only one or two lines of code to change in your project (essentially the constructor since the functions to read sensor data and get information about the sensor are defined in the base Adafruit_Sensor class).
This is imporant useful for two reasons:
1.) You can use the data right away because it's already converted to SI units that you understand and can compare, rather than meaningless values like 0..1023.
2.) Because SI units are standardised in the sensor library, you can also do quick sanity checks working with new sensors, or drop in any comparable sensor if you need better sensitivity or if a lower cost unit becomes available, etc.
Light sensors will always report units in lux, gyroscopes will always report units in rad/s, etc. ... freeing you up to focus on the data, rather than digging through the datasheet to understand what the sensor's raw numbers really mean.
About this Driver
Written by Bryan Siepert for Adafruit Industries. BSD license, check license.txt for more information All text above must be included in any redistribution
To install, use the Arduino Library Manager and search for "Adafruit LIS2MDL" and install the library.
Browse Library Files