Merge pull request #19 from tekktrik/dev/note-pn

Note that the driver is for the LSM303DLHC
adafruit · Jan 25, 2023 · b946cfa · b946cfa
2 parents 4c24170 + 5a5a728
commit b946cfa
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -20,6 +20,9 @@ Introduction
 
 Adafruit CircuitPython module for the LSM303DLH's 3-axis magnetometer
 
+Note that this is specifically intended for the LSM303DLHC, as opposed to the
+LSM303DLH proper, which has the magnetic Y and Z orientations swapped.
+
 Dependencies
 =============
 This driver depends on:

diff --git a/adafruit_lsm303dlh_mag.py b/adafruit_lsm303dlh_mag.py
@@ -9,6 +9,9 @@
 
 CircuitPython driver for the LSM303DLH's magnetometer.
 
+Note that this is specifically intended for the LSM303DLHC, as opposed to the
+LSM303DLH proper, which has the magnetic Y and Z orientations swapped.
+
 * Author(s): Dave Astels, Bryan Siepert
 
 Implementation Notes