Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-rm3100/badge/?version=latest
:target: https://circuitpython-rm3100.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/furbrain/CircuitPython_RM3100/workflows/Build%20CI/badge.svg
:target: https://github.com/furbrain/CircuitPython_RM3100/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
Driver for the RM3100 magnetometer by PNI Sensor Corporation
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-rm3100/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-rm3100
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-rm3100
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-rm3100
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install rm3100
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Examples
==============
.. code-block:: python
# Example using I2C and single measurement readings, no DRDY pin
import time
import board
import rm3100
i2c = board.I2C()
rm = rm3100.RM3100_I2C(i2c, i2c_address=0x23)
while True:
rm.start_single_reading()
time.sleep(rm.get_measurement_time())
print(rm.get_next_reading())
.. code-block:: python
# Example using SPI and a DRDY pin, using continuous readings
import board
import digitalio
import rm3100
spi = board.SPI()
drdy_pin = digitalio.DigitalInOut(board.D3)
drdy_pin.direction = digitalio.Direction.INPUT
cs_pin = digitalio.DigitalInOut(board.D4)
cs_pin.direction = digitalio.Direction.OUTPUT
cs_pin.value = True
rm = rm3100.RM3100_SPI(spi, chip_select=cs_pin, drdy_pin=drdy_pin)
rm.start_continuous_reading(1.2) # start continuous reading at 1.2Hz
for i in range(20):
print(rm.get_next_reading())
rm.stop()
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-rm3100.readthedocs.io/>`_.
For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/furbrain/CircuitPython_RM3100/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-rm3100",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,rm3100,RM3100,magnetometer,geomagnetic,compass,sensor",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/6f/74/2d176401dc47e3c7a5ce01fe8fd7f4ea19f02d18d83fc5ee9aa1c728e3b9/circuitpython-rm3100-1.0.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-rm3100/badge/?version=latest\n :target: https://circuitpython-rm3100.readthedocs.io/\n :alt: Documentation Status\n\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/furbrain/CircuitPython_RM3100/workflows/Build%20CI/badge.svg\n :target: https://github.com/furbrain/CircuitPython_RM3100/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nDriver for the RM3100 magnetometer by PNI Sensor Corporation\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-rm3100/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-rm3100\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-rm3100\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install circuitpython-rm3100\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install rm3100\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Examples\n==============\n\n.. code-block:: python\n\n # Example using I2C and single measurement readings, no DRDY pin\n\n import time\n import board\n import rm3100\n\n i2c = board.I2C()\n rm = rm3100.RM3100_I2C(i2c, i2c_address=0x23)\n\n while True:\n rm.start_single_reading()\n time.sleep(rm.get_measurement_time())\n print(rm.get_next_reading())\n\n.. code-block:: python\n\n # Example using SPI and a DRDY pin, using continuous readings\n\n import board\n import digitalio\n import rm3100\n\n spi = board.SPI()\n drdy_pin = digitalio.DigitalInOut(board.D3)\n drdy_pin.direction = digitalio.Direction.INPUT\n\n cs_pin = digitalio.DigitalInOut(board.D4)\n cs_pin.direction = digitalio.Direction.OUTPUT\n cs_pin.value = True\n rm = rm3100.RM3100_SPI(spi, chip_select=cs_pin, drdy_pin=drdy_pin)\n\n\n rm.start_continuous_reading(1.2) # start continuous reading at 1.2Hz\n for i in range(20):\n print(rm.get_next_reading())\n rm.stop()\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-rm3100.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/furbrain/CircuitPython_RM3100/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Driver for the RM3100 megnetometer by PNI Corp",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/furbrain/CircuitPython_RM3100"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"rm3100",
"rm3100",
"magnetometer",
"geomagnetic",
"compass",
"sensor"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c10ba26d64cde745a259400eb70efda41d47a40185b671b0adc4f589f1e7435c",
"md5": "a5e7ea2ef8b80b4a293e65b2b4cefc0b",
"sha256": "ea5dfa9ab3a32ac3c7296c677f024b1240eb2eec472a256b6a360a5ce98c8454"
},
"downloads": -1,
"filename": "circuitpython_rm3100-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a5e7ea2ef8b80b4a293e65b2b4cefc0b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6738,
"upload_time": "2023-09-01T17:22:41",
"upload_time_iso_8601": "2023-09-01T17:22:41.817083Z",
"url": "https://files.pythonhosted.org/packages/c1/0b/a26d64cde745a259400eb70efda41d47a40185b671b0adc4f589f1e7435c/circuitpython_rm3100-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6f742d176401dc47e3c7a5ce01fe8fd7f4ea19f02d18d83fc5ee9aa1c728e3b9",
"md5": "e162969bafe935c299efb352f8d863c8",
"sha256": "b1a74c9ce52575f7ec49c9f5a033986eba2f11acf3891da51dc15913d544650c"
},
"downloads": -1,
"filename": "circuitpython-rm3100-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "e162969bafe935c299efb352f8d863c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30240,
"upload_time": "2023-09-01T17:22:43",
"upload_time_iso_8601": "2023-09-01T17:22:43.306131Z",
"url": "https://files.pythonhosted.org/packages/6f/74/2d176401dc47e3c7a5ce01fe8fd7f4ea19f02d18d83fc5ee9aa1c728e3b9/circuitpython-rm3100-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-01 17:22:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "furbrain",
"github_project": "CircuitPython_RM3100",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-rm3100"
}
JSON
