Introduction
============
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/furbrain/CircuitPython_mag_cal/workflows/Build%20CI/badge.svg
:target: https://github.com/furbrain/CircuitPython_mag_cal/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
This library allows you to calibrate magnetometers when used with a 3 axis accelerometer.
It is designed for use with circuitpython and `ulab <https://github.com/v923z/micropython-ulab>`_,
but can be used in any python environment where `numpy <https://numpy.org/>`_ is present.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Numpy <https://numpy.org/>`_ *or* `ulab <https://github.com/v923z/micropython-ulab>`_
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-mag-cal/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-mag-cal
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-mag-cal
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-mag-cal
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 mag_cal
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
from mag_cal.calibration import Calibration
from mag_cal.utils import read_fixture
PATH = "../tests/fixtures/cal_data/hj2.json"
with open(PATH) as f:
aligned, grav, mag = read_fixture(f.read())
calib = Calibration()
calib.fit_ellipsoid(mag, grav)
calib.fit_to_axis(aligned)
calib.fit_non_linear_quick(aligned, param_count=5)
#calib.fit_non_linear(aligned, param_count=3)
for m, g in zip(mag,grav):
azimuth, inclination, roll = calib.get_angles(m, g)
print(f"{azimuth:05.1f}° {inclination:+05.1f}° {roll:+04.0f}°")
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-mag-cal.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_mag_cal/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-mag-cal",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,mag_cal,magnetometer,accelerometer,compass,calibrate,calibration,gravity,magnetism,magnetic",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/4b/04/534e28d3be9a68fdb6a5083ed0d14c8544b8465dc5627211da3b2af9bc3e/circuitpython-mag-cal-1.4.1.tar.gz",
"platform": null,
"description": "Introduction\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_mag_cal/workflows/Build%20CI/badge.svg\n :target: https://github.com/furbrain/CircuitPython_mag_cal/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\nThis library allows you to calibrate magnetometers when used with a 3 axis accelerometer.\nIt is designed for use with circuitpython and `ulab <https://github.com/v923z/micropython-ulab>`_,\nbut can be used in any python environment where `numpy <https://numpy.org/>`_ is present.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Numpy <https://numpy.org/>`_ *or* `ulab <https://github.com/v923z/micropython-ulab>`_\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-mag-cal/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-mag-cal\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-mag-cal\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-mag-cal\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 mag_cal\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n.. code-block:: python\n\n from mag_cal.calibration import Calibration\n from mag_cal.utils import read_fixture\n\n PATH = \"../tests/fixtures/cal_data/hj2.json\"\n\n with open(PATH) as f:\n aligned, grav, mag = read_fixture(f.read())\n\n calib = Calibration()\n calib.fit_ellipsoid(mag, grav)\n calib.fit_to_axis(aligned)\n calib.fit_non_linear_quick(aligned, param_count=5)\n\n #calib.fit_non_linear(aligned, param_count=3)\n for m, g in zip(mag,grav):\n azimuth, inclination, roll = calib.get_angles(m, g)\n print(f\"{azimuth:05.1f}\u00b0 {inclination:+05.1f}\u00b0 {roll:+04.0f}\u00b0\")\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-mag-cal.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_mag_cal/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Calibrate magnetometer and accelerometer readings",
"version": "1.4.1",
"project_urls": {
"Homepage": "https://github.com/furbrain/CircuitPython_mag_cal"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"mag_cal",
"magnetometer",
"accelerometer",
"compass",
"calibrate",
"calibration",
"gravity",
"magnetism",
"magnetic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "22b49ad940610822d28182d60ec1526e854003fa622e5495ae0824fb1fd3d7d5",
"md5": "139cd4f545038053abf92ce34c157e59",
"sha256": "3f9fddce833eaf138450ca94f4d24b073d708ec4604a815792ce7ceb42624c34"
},
"downloads": -1,
"filename": "circuitpython_mag_cal-1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "139cd4f545038053abf92ce34c157e59",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23554,
"upload_time": "2023-09-27T18:33:46",
"upload_time_iso_8601": "2023-09-27T18:33:46.119155Z",
"url": "https://files.pythonhosted.org/packages/22/b4/9ad940610822d28182d60ec1526e854003fa622e5495ae0824fb1fd3d7d5/circuitpython_mag_cal-1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4b04534e28d3be9a68fdb6a5083ed0d14c8544b8465dc5627211da3b2af9bc3e",
"md5": "1a1e4704b6787dbcc5dfc21d566d5167",
"sha256": "500fee7ea10b5f05ba7e7f11e94f7ca32bf66f41b94ebabb7113f93f0cd2119b"
},
"downloads": -1,
"filename": "circuitpython-mag-cal-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "1a1e4704b6787dbcc5dfc21d566d5167",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 65890,
"upload_time": "2023-09-27T18:33:47",
"upload_time_iso_8601": "2023-09-27T18:33:47.226997Z",
"url": "https://files.pythonhosted.org/packages/4b/04/534e28d3be9a68fdb6a5083ed0d14c8544b8465dc5627211da3b2af9bc3e/circuitpython-mag-cal-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-27 18:33:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "furbrain",
"github_project": "CircuitPython_mag_cal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-mag-cal"
}
JSON
