Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-fxos8700/badge/?version=latest
:target: https://docs.circuitpython.org/projects/fxos8700/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700/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
CircuitPython module for the NXP FXOS8700 accelerometer and magnetometer.
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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
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-fxos8700/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-fxos8700
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-fxos8700
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-fxos8700
Usage Example
=============
.. code-block:: python3
import time
import board
import adafruit_fxos8700
i2c = board.I2C() # uses board.SCL and board.SDA
sensor = adafruit_fxos8700.FXOS8700(i2c)
while True:
accel_x, accel_y, accel_z = sensor.accelerometer
mag_x, mag_y, mag_z = sensor.magnetometer
print('Acceleration (m/s^2): ({0:0.3f}, {1:0.3f}, {2:0.3f})'.format(accel_x, accel_y, accel_z))
print('Magnetometer (uTesla): ({0:0.3f}, {1:0.3f}, {2:0.3f})'.format(mag_x, mag_y, mag_z))
time.sleep(1.0)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/fxos8700/en/latest/>`_.
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/adafruit/Adafruit_CircuitPython_fxos8700/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-fxos8700",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, nxp, fxos8700, accelerometer, magnetometer, breakout, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/d8/b1/5d3cb9e4a7aa492b2ef68c877b353e26ce75ea0f63277149eb1ce923dd42/adafruit_circuitpython_fxos8700-3.0.3.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-fxos8700/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/fxos8700/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700/actions/\n :alt: Build Status\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\nCircuitPython module for the NXP FXOS8700 accelerometer and magnetometer.\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-fxos8700/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-fxos8700\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-fxos8700\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 .venv/bin/activate\n pip3 install adafruit-circuitpython-fxos8700\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import time\n import board\n import adafruit_fxos8700\n\n i2c = board.I2C() # uses board.SCL and board.SDA\n sensor = adafruit_fxos8700.FXOS8700(i2c)\n\n while True:\n accel_x, accel_y, accel_z = sensor.accelerometer\n mag_x, mag_y, mag_z = sensor.magnetometer\n print('Acceleration (m/s^2): ({0:0.3f}, {1:0.3f}, {2:0.3f})'.format(accel_x, accel_y, accel_z))\n print('Magnetometer (uTesla): ({0:0.3f}, {1:0.3f}, {2:0.3f})'.format(mag_x, mag_y, mag_z))\n time.sleep(1.0)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/fxos8700/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_fxos8700/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for NXP FXOS8700 accelerometer and magnetometer.",
"version": "3.0.3",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700"
},
"split_keywords": [
"adafruit",
" nxp",
" fxos8700",
" accelerometer",
" magnetometer",
" breakout",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "32892186d10c05ab968c730e7238708eaeb8ffa065543bf6e2822fd793836987",
"md5": "eea082f92387c7ab6c16e14ff9738be8",
"sha256": "3c525e544ef41458269cd866aea6887efa53c4f64d6ea245c69e5da843cee5dd"
},
"downloads": -1,
"filename": "adafruit_circuitpython_fxos8700-3.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eea082f92387c7ab6c16e14ff9738be8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6484,
"upload_time": "2024-10-10T16:00:07",
"upload_time_iso_8601": "2024-10-10T16:00:07.775171Z",
"url": "https://files.pythonhosted.org/packages/32/89/2186d10c05ab968c730e7238708eaeb8ffa065543bf6e2822fd793836987/adafruit_circuitpython_fxos8700-3.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8b15d3cb9e4a7aa492b2ef68c877b353e26ce75ea0f63277149eb1ce923dd42",
"md5": "30cdad0effc08358fcce3746bd0ba511",
"sha256": "0500244e51268541aefb5d344522f1da3e8b6d0c10e85882f6a02084c0b25f73"
},
"downloads": -1,
"filename": "adafruit_circuitpython_fxos8700-3.0.3.tar.gz",
"has_sig": false,
"md5_digest": "30cdad0effc08358fcce3746bd0ba511",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27726,
"upload_time": "2024-10-10T16:00:09",
"upload_time_iso_8601": "2024-10-10T16:00:09.538218Z",
"url": "https://files.pythonhosted.org/packages/d8/b1/5d3cb9e4a7aa492b2ef68c877b353e26ce75ea0f63277149eb1ce923dd42/adafruit_circuitpython_fxos8700-3.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 16:00:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_FXOS8700",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-fxos8700"
}
JSON
