Rename to use the name of the actual sensor

Author: siddacious

README.rst

@@ -2,19 +2,19 @@
 Introduction
 ============
 
-.. image:: https://readthedocs.org/projects/adafruit-circuitpython-lsm303agr-mag/badge/?version=latest
-    :target: https://circuitpython.readthedocs.io/projects/lsm303agr-mag/en/latest/
+.. image:: https://readthedocs.org/projects/adafruit-circuitpython-lis2mdl-mag/badge/?version=latest
+    :target: https://circuitpython.readthedocs.io/projects/lis2mdl-mag/en/latest/
     :alt: Documentation Status
 
 .. image :: https://img.shields.io/discord/327254708534116352.svg
     :target: https://discord.gg/nBQh6qu
     :alt: Discord
 
-.. image:: https://github.com/adafruit/Adafruit_CircuitPython_LSM303AGR_Mag/workflows/Build%20CI/badge.svg
-    :target: https://github.com/adafruit/Adafruit_CircuitPython_LSM303AGR_Mag/actions/
+.. image:: https://github.com/adafruit/Adafruit_CircuitPython_LIS2MDL/workflows/Build%20CI/badge.svg
+    :target: https://github.com/adafruit/Adafruit_CircuitPython_LIS2MDL/actions/
     :alt: Build Status
 
-Adafruit CircuitPython module for the LSM303AGR's 3-axis magnetometer
+Adafruit CircuitPython module for the LIS2MDL 3-axis magnetometer
 
 Dependencies
 =============
@@ -32,17 +32,17 @@ Installing from PyPI
 ====================
 
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
-PyPI <https://pypi.org/project/adafruit-circuitpython-lsm303agr_mag/>`_. To install for current user:
+PyPI <https://pypi.org/project/adafruit-circuitpython-lis2mdl/>`_. To install for current user:
 
 .. code-block:: shell
 
-    pip3 install adafruit-circuitpython-lsm303agr_mag
+    pip3 install adafruit-circuitpython-lis2mdl
 
 To install system-wide (this may be required in some cases):
 
 .. code-block:: shell
 
-    sudo pip3 install adafruit-circuitpython-lsm303agr_mag
+    sudo pip3 install adafruit-circuitpython-lis2mdl
 
 To install in a virtual environment in your current project:
 
@@ -51,7 +51,7 @@ To install in a virtual environment in your current project:
     mkdir project-name && cd project-name
     python3 -m venv .env
     source .env/bin/activate
-    pip3 install adafruit-circuitpython-lsm303agr_mag
+    pip3 install adafruit-circuitpython-lis2mdl
 
 Usage Example
 =============
@@ -61,10 +61,10 @@ Usage Example
     import time
     import board
     import busio
-    import adafruit_lsm303agr_mag
+    import adafruit_lis2mdl
 
     i2c = busio.I2C(board.SCL, board.SDA)
-    sensor = adafruit_lsm303agr_mag.LSM303AGR_Mag(i2c)
+    sensor = adafruit_lis2mdl.LIS2MDL(i2c)
 
     while True:
         mag_x, mag_y, mag_z = sensor.magnetic
@@ -78,7 +78,7 @@ Contributing
 ============
 
 Contributions are welcome! Please read our `Code of Conduct
-<https://github.com/adafruit/Adafruit_CircuitPython_LSM303AGR_Mag/blob/master/CODE_OF_CONDUCT.md>`_
+<https://github.com/adafruit/Adafruit_CircuitPython_LIS2MDL/blob/master/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
 
 Documentation

adafruit_lsm303agr_mag.py renamed to adafruit_lis2mdl.py

@@ -20,11 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`adafruit_lsm303agr_mag`
+`adafruit_lis2mdl`
 ====================================================
 
 
-CircuitPython driver for the LSM303AGR's magnetometer.
+CircuitPython driver for the LIS2MDL 3-axis magnetometer.
 
 * Author(s): Bryan Siepert
 
@@ -57,7 +57,7 @@
 
 
 __version__ = "0.0.0-auto.0"
-__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LSM303DHL_Mag.git"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LIS2MDL.git"
 
 # pylint: disable=bad-whitespace
 _ADDRESS_MAG               = const(0x1E)  # (0x3C >> 1)       // 0011110x
@@ -103,11 +103,11 @@ class DataRate: # pylint: disable=too-few-public-methods
 
 _MAG_SCALE = 0.15 # 1.5 milligauss/LSB * 0.1 microtesla/milligauss
 
-class LSM303AGR_Mag:# pylint: disable=too-many-instance-attributes
+class LIS2MDL:# pylint: disable=too-many-instance-attributes
     """
-    Driver for the Driver for the LSM303AGR's 'magnetometer.
+    Driver for the LIS2MDL 3-axis magnetometer.
 
-    :param busio.I2C i2c_bus: The I2C bus the LSM303AGR is connected to.
+    :param busio.I2C i2c_bus: The I2C bus the LIS2MDL is connected to.
 
     """
     _BUFFER = bytearray(6)
@@ -156,7 +156,7 @@ def __init__(self, i2c):
         self.i2c_device = I2CDevice(i2c, _ADDRESS_MAG)
 
         if self._device_id != 0x40:
-            raise AttributeError("Cannot find an LSM303AGR")
+            raise AttributeError("Cannot find an LIS2MDL")
 
         self.reset()
 

docs/api.rst

@@ -1,5 +1,5 @@
 
 .. If you created a package, create one automodule per module in the package.
 
-.. automodule:: adafruit_lsm303agr_mag
+.. automodule:: adafruit_lis2mdl
    :members:

docs/conf.py

@@ -31,7 +31,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Adafruit LSM303AGR Magnetometer Library'
+project = u'Adafruit LIS2MDL 3-axis Magnetometer Library'
 copyright = u'2019 Bryan Siepert'
 author = u'Bryan Siepert'
 
@@ -105,7 +105,7 @@
 html_favicon = '_static/favicon.ico'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'AdafruitLsm303AgrMagLibrarydoc'
+htmlhelp_basename = 'AdafruitLIS2MDLLibrarydoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -131,7 +131,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'AdafruitLSM303AGRMagLibrary.tex', u'Adafruit LSM303AGR Magnetometer Library Documentation',
+    (master_doc, 'AdafruitLIS2MDLLibrary.tex', u'Adafruit LIS2MDL 3-axis Magnetometer Library Documentation',
      author, 'manual'),
 ]
 
@@ -140,7 +140,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'AdafruitLSM303AGRMaglibrary', u'Adafruit LSM303AGR Magnetometer Library Documentation',
+    (master_doc, 'AdafruitLIS2MDLlibrary', u'Adafruit LIS2MDL 3-axis Magnetometer Library Documentation',
      [author], 1)
 ]
 
@@ -150,7 +150,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitLSM303AGRMagLibrary', u'Adafruit LSM303AGR Magnetometer Library Documentation',
-     author, 'AdafruitLSM303AGRMAgLibrary', 'One line description of project.',
+    (master_doc, 'AdafruitLIS2MDLLibrary', u'Adafruit LIS2MDL 3-axis Magnetometer Library Documentation',
+     author, 'AdafruitLIS2MDLLibrary', 'One line description of project.',
      'Miscellaneous'),
 ]

docs/examples.rst

@@ -3,12 +3,12 @@ Simple tests
 
 Ensure your device works with these simple tests.
 
-.. literalinclude:: ../examples/lsm303agr_mag_simpletest.py
-    :caption: examples/lsm303agr_mag_simpletest.py
+.. literalinclude:: ../examples/lis2mdl_simpletest.py
+    :caption: examples/lis2mdl_simpletest.py
     :linenos:
 
-.. literalinclude:: ../examples/lsm303agr_mag_interrupt.py
-    :caption: examples/lsm303agr_mag_interrupt.py
+.. literalinclude:: ../examples/lis2mdl_interrupt.py
+    :caption: examples/lis2mdl_interrupt.py
     :linenos:
 
-examples/lsm303agr_mag_interrupt.py
+examples/lis2mdl_interrupt.py

docs/index.rst

@@ -32,7 +32,7 @@ Table of Contents
 .. toctree::
     :caption: Other Links
 
-    Download <https://github.com/adafruit/Adafruit_CircuitPython_LSM303AGR_Mag/releases/latest>
+    Download <https://github.com/adafruit/Adafruit_CircuitPython_LIS2MDL/releases/latest>
     CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
     CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
     Discord Chat <https://adafru.it/discord>

examples/lsm303agr_mag_interrupt.py renamed to examples/lis2mdl_interrupt.py

@@ -1,17 +1,17 @@
 import time
 import board
 import busio
-import adafruit_lsm303agr_mag
+import adafruit_lis2mdl
 
 i2c = busio.I2C(board.SCL, board.SDA)
-lsm_mag = adafruit_lsm303agr_mag.LSM303AGR_Mag(i2c)
-lsm_mag.interrupt_threshold = 80
-lsm_mag.interrupt_enabled = True
+lis = adafruit_lis2mdl.LIS2MDL(i2c)
+lis.interrupt_threshold = 80
+lis.interrupt_enabled = True
 
 while True:
-    x_hi, y_hi, z_hi, x_lo, y_lo, z_lo, int_triggered = lsm_mag.faults
+    x_hi, y_hi, z_hi, x_lo, y_lo, z_lo, int_triggered = lis.faults
 
-    print(lsm_mag.magnetic)
+    print(lis.magnetic)
     print("Xhi:%s\tYhi:%s\tZhi:%s"%(x_hi, y_hi, z_hi))
     print("Xlo:%s\tYlo:%s\tZlo:%s"%(x_lo, y_lo, z_lo))
     print("Int triggered: %s"%int_triggered)

examples/lsm303agr_mag_simpletest.py renamed to examples/lis2mdl_simpletest.py

@@ -3,10 +3,10 @@
 import time
 import board
 import busio
-import adafruit_lsm303agr_mag
+import adafruit_lis2mdl
 
 i2c = busio.I2C(board.SCL, board.SDA)
-sensor = adafruit_lsm303agr_mag.LSM303AGR_Mag(i2c)
+sensor = adafruit_lis2mdl.LIS2MDL(i2c)
 
 while True:
     mag_x, mag_y, mag_z = sensor.magnetic

setup.py

@@ -18,17 +18,17 @@
     long_description = f.read()
 
 setup(
-    name='adafruit-circuitpython-lsm303agr-mag',
+    name='adafruit-circuitpython-lis2mdl',
 
     use_scm_version=True,
     setup_requires=['setuptools_scm'],
 
-    description='CircuitPython library for LSM303AGR\'s 3-axis magnetometer.',
+    description='CircuitPython library for LIS2MDL 3-axis magnetometer.',
     long_description=long_description,
     long_description_content_type='text/x-rst',
 
     # The project's main homepage.
-    url='https://github.com/adafruit/Adafruit_CircuitPython_LSM303AGR_Mag',
+    url='https://github.com/adafruit/Adafruit_CircuitPython_LIS2MDL',
 
     # Author details
     author='Adafruit Industries',
@@ -52,10 +52,10 @@
     ],
 
     # What does your project relate to?
-    keywords='adafruit lsm303 6dof 6-dof magnetometer axis'
+    keywords='adafruit lsm303 lis2mdl 3-dof 3-axis 6dof 6-dof magnetometer axis'
              'breakout hardware micropython circuitpython',
 
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
-    py_modules=['adafruit_lsm303agr_mag'],
+    py_modules=['adafruit_lis2mdl'],
 )