Compare commits
11 commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d1b17ae5fb | ||
|
|
eef60cad46 | ||
|
|
1f6df6aa1e | ||
|
|
d30da2d5c9 | ||
|
|
0e8e12d2e2 | ||
|
|
f0d19333b5 | ||
|
|
bfc2c06e82 | ||
|
|
778094d04d | ||
|
|
932eeed186 | ||
|
|
946a3cf9e6 | ||
|
|
743be21a26 |
8 changed files with 169 additions and 139 deletions
9
.github/workflows/build.yml
vendored
9
.github/workflows/build.yml
vendored
|
|
@ -34,11 +34,18 @@ jobs:
|
|||
with:
|
||||
repository: adafruit/actions-ci-circuitpython-libs
|
||||
path: actions-ci
|
||||
- name: Install deps
|
||||
- name: Install dependencies
|
||||
# (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.)
|
||||
run: |
|
||||
source actions-ci/install.sh
|
||||
- name: Pip install pylint, black, & Sphinx
|
||||
run: |
|
||||
pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme
|
||||
- name: Library version
|
||||
run: git describe --dirty --always --tags
|
||||
- name: Check formatting
|
||||
run: |
|
||||
black --check --target-version=py35 .
|
||||
- name: PyLint
|
||||
run: |
|
||||
pylint $( find . -path './adafruit*.py' )
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ confidence=
|
|||
# no Warning level messages displayed, use"--disable=all --enable=classes
|
||||
# --disable=W"
|
||||
# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
|
||||
disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error
|
||||
disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation
|
||||
|
||||
# Enable the message, report, category or checker with the given id(s). You can
|
||||
# either give multiple identifier separated by comma (,) or put this option
|
||||
|
|
@ -119,7 +119,7 @@ spelling-store-unknown-words=no
|
|||
[MISCELLANEOUS]
|
||||
|
||||
# List of note tags to take in consideration, separated by a comma.
|
||||
#notes=FIXME,XXX,TODO
|
||||
# notes=FIXME,XXX,TODO
|
||||
notes=FIXME,XXX
|
||||
|
||||
|
||||
|
|
@ -301,7 +301,7 @@ function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
|
|||
|
||||
# Good variable names which should always be accepted, separated by a comma
|
||||
# good-names=i,j,k,ex,Run,_
|
||||
good-names=r,g,b,i,j,k,n,ex,Run,_
|
||||
good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
|
||||
|
||||
# Include a hint for the correct naming format with invalid-name
|
||||
include-naming-hint=no
|
||||
|
|
@ -423,7 +423,7 @@ max-returns=6
|
|||
max-statements=50
|
||||
|
||||
# Minimum number of public methods for a class (see R0903).
|
||||
min-public-methods=2
|
||||
min-public-methods=1
|
||||
|
||||
|
||||
[EXCEPTIONS]
|
||||
|
|
|
|||
|
|
@ -34,13 +34,15 @@ Examples of unacceptable behavior by participants include:
|
|||
* Excessive or unwelcome helping; answering outside the scope of the question
|
||||
asked
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Promoting or spreading disinformation, lies, or conspiracy theories against
|
||||
a person, group, organisation, project, or community
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate
|
||||
|
||||
The goal of the standards and moderation guidelines outlined here is to build
|
||||
and maintain a respectful community. We ask that you don’t just aim to be
|
||||
and maintain a respectful community. We ask that you don’t just aim to be
|
||||
"technically unimpeachable", but rather try to be your best self.
|
||||
|
||||
We value many things beyond technical expertise, including collaboration and
|
||||
|
|
@ -72,10 +74,10 @@ You may report in the following ways:
|
|||
In any situation, you may send an email to <support@adafruit.com>.
|
||||
|
||||
On the Adafruit Discord, you may send an open message from any channel
|
||||
to all Community Helpers by tagging @community helpers. You may also send an
|
||||
open message from any channel, or a direct message to @kattni#1507,
|
||||
@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or
|
||||
@Andon#8175.
|
||||
to all Community Moderators by tagging @community moderators. You may
|
||||
also send an open message from any channel, or a direct message to
|
||||
@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442,
|
||||
@sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175.
|
||||
|
||||
Email and direct message reports will be kept confidential.
|
||||
|
||||
|
|
@ -83,7 +85,7 @@ In situations on Discord where the issue is particularly egregious, possibly
|
|||
illegal, requires immediate action, or violates the Discord terms of service,
|
||||
you should also report the message directly to Discord.
|
||||
|
||||
These are the steps for upholding our community’s standards of conduct.
|
||||
These are the steps for upholding our community’s standards of conduct.
|
||||
|
||||
1. Any member of the community may report any situation that violates the
|
||||
Adafruit Community Code of Conduct. All reports will be reviewed and
|
||||
|
|
@ -124,4 +126,4 @@ For other projects adopting the Adafruit Community Code of
|
|||
Conduct, please contact the maintainers of those projects for enforcement.
|
||||
If you wish to use this code of conduct for your own project, consider
|
||||
explicitly mentioning your moderation policy or making a copy with your
|
||||
own moderation policy so as to avoid confusion.
|
||||
own moderation policy so as to avoid confusion.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Introduction
|
|||
:alt: Documentation Status
|
||||
|
||||
.. image :: https://img.shields.io/discord/327254708534116352.svg
|
||||
:target: https://discord.gg/nBQh6qu
|
||||
:target: https://adafru.it/discord
|
||||
:alt: Discord
|
||||
|
||||
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700/workflows/Build%20CI/badge.svg
|
||||
|
|
|
|||
|
|
@ -58,37 +58,37 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700.git"
|
|||
|
||||
# Register addresses and other constants:
|
||||
# pylint: disable=bad-whitespace
|
||||
_FXOS8700_ADDRESS = const(0x1F) # 0011111
|
||||
_FXOS8700_ID = const(0xC7) # 1100 0111
|
||||
_FXOS8700_REGISTER_STATUS = const(0x00)
|
||||
_FXOS8700_REGISTER_OUT_X_MSB = const(0x01)
|
||||
_FXOS8700_REGISTER_OUT_X_LSB = const(0x02)
|
||||
_FXOS8700_REGISTER_OUT_Y_MSB = const(0x03)
|
||||
_FXOS8700_REGISTER_OUT_Y_LSB = const(0x04)
|
||||
_FXOS8700_REGISTER_OUT_Z_MSB = const(0x05)
|
||||
_FXOS8700_REGISTER_OUT_Z_LSB = const(0x06)
|
||||
_FXOS8700_REGISTER_WHO_AM_I = const(0x0D) # 11000111 r
|
||||
_FXOS8700_ADDRESS = const(0x1F) # 0011111
|
||||
_FXOS8700_ID = const(0xC7) # 1100 0111
|
||||
_FXOS8700_REGISTER_STATUS = const(0x00)
|
||||
_FXOS8700_REGISTER_OUT_X_MSB = const(0x01)
|
||||
_FXOS8700_REGISTER_OUT_X_LSB = const(0x02)
|
||||
_FXOS8700_REGISTER_OUT_Y_MSB = const(0x03)
|
||||
_FXOS8700_REGISTER_OUT_Y_LSB = const(0x04)
|
||||
_FXOS8700_REGISTER_OUT_Z_MSB = const(0x05)
|
||||
_FXOS8700_REGISTER_OUT_Z_LSB = const(0x06)
|
||||
_FXOS8700_REGISTER_WHO_AM_I = const(0x0D) # 11000111 r
|
||||
_FXOS8700_REGISTER_XYZ_DATA_CFG = const(0x0E)
|
||||
_FXOS8700_REGISTER_CTRL_REG1 = const(0x2A) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_CTRL_REG2 = const(0x2B) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_CTRL_REG3 = const(0x2C) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_CTRL_REG4 = const(0x2D) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_CTRL_REG5 = const(0x2E) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_MSTATUS = const(0x32)
|
||||
_FXOS8700_REGISTER_MOUT_X_MSB = const(0x33)
|
||||
_FXOS8700_REGISTER_MOUT_X_LSB = const(0x34)
|
||||
_FXOS8700_REGISTER_MOUT_Y_MSB = const(0x35)
|
||||
_FXOS8700_REGISTER_MOUT_Y_LSB = const(0x36)
|
||||
_FXOS8700_REGISTER_MOUT_Z_MSB = const(0x37)
|
||||
_FXOS8700_REGISTER_MOUT_Z_LSB = const(0x38)
|
||||
_FXOS8700_REGISTER_MCTRL_REG1 = const(0x5B) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_MCTRL_REG2 = const(0x5C) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_MCTRL_REG3 = const(0x5D) # 00000000 r/w
|
||||
_ACCEL_MG_LSB_2G = 0.000244
|
||||
_ACCEL_MG_LSB_4G = 0.000488
|
||||
_ACCEL_MG_LSB_8G = 0.000976
|
||||
_MAG_UT_LSB = 0.1
|
||||
_SENSORS_GRAVITY_STANDARD = 9.80665
|
||||
_FXOS8700_REGISTER_CTRL_REG1 = const(0x2A) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_CTRL_REG2 = const(0x2B) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_CTRL_REG3 = const(0x2C) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_CTRL_REG4 = const(0x2D) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_CTRL_REG5 = const(0x2E) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_MSTATUS = const(0x32)
|
||||
_FXOS8700_REGISTER_MOUT_X_MSB = const(0x33)
|
||||
_FXOS8700_REGISTER_MOUT_X_LSB = const(0x34)
|
||||
_FXOS8700_REGISTER_MOUT_Y_MSB = const(0x35)
|
||||
_FXOS8700_REGISTER_MOUT_Y_LSB = const(0x36)
|
||||
_FXOS8700_REGISTER_MOUT_Z_MSB = const(0x37)
|
||||
_FXOS8700_REGISTER_MOUT_Z_LSB = const(0x38)
|
||||
_FXOS8700_REGISTER_MCTRL_REG1 = const(0x5B) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_MCTRL_REG2 = const(0x5C) # 00000000 r/w
|
||||
_FXOS8700_REGISTER_MCTRL_REG3 = const(0x5D) # 00000000 r/w
|
||||
_ACCEL_MG_LSB_2G = 0.000244
|
||||
_ACCEL_MG_LSB_4G = 0.000488
|
||||
_ACCEL_MG_LSB_8G = 0.000976
|
||||
_MAG_UT_LSB = 0.1
|
||||
_SENSORS_GRAVITY_STANDARD = 9.80665
|
||||
# pylint: enable=bad-whitespace
|
||||
|
||||
# User-facing constants/module-level globals:
|
||||
|
|
@ -107,19 +107,19 @@ def _twos_comp(val, bits):
|
|||
|
||||
class FXOS8700:
|
||||
"""Driver for the NXP FXOS8700 accelerometer and magnetometer."""
|
||||
|
||||
# Class-level buffer for reading and writing data with the sensor.
|
||||
# This reduces memory allocations but means the code is not re-entrant or
|
||||
# thread safe!
|
||||
_BUFFER = bytearray(13)
|
||||
|
||||
def __init__(self, i2c, address=_FXOS8700_ADDRESS,
|
||||
accel_range=ACCEL_RANGE_2G):
|
||||
def __init__(self, i2c, address=_FXOS8700_ADDRESS, accel_range=ACCEL_RANGE_2G):
|
||||
assert accel_range in (ACCEL_RANGE_2G, ACCEL_RANGE_4G, ACCEL_RANGE_8G)
|
||||
self._accel_range = accel_range
|
||||
self._device = i2c_dev.I2CDevice(i2c, address)
|
||||
# Check for chip ID value.
|
||||
if self._read_u8(_FXOS8700_REGISTER_WHO_AM_I) != _FXOS8700_ID:
|
||||
raise RuntimeError('Failed to find FXOS8700, check wiring!')
|
||||
raise RuntimeError("Failed to find FXOS8700, check wiring!")
|
||||
# Set to standby mode (required to make changes to this register)
|
||||
self._write_u8(_FXOS8700_REGISTER_CTRL_REG1, 0)
|
||||
if accel_range == ACCEL_RANGE_2G:
|
||||
|
|
@ -142,8 +142,7 @@ class FXOS8700:
|
|||
# Read an 8-bit unsigned value from the specified 8-bit address.
|
||||
with self._device as i2c:
|
||||
self._BUFFER[0] = address & 0xFF
|
||||
i2c.write_then_readinto(self._BUFFER, self._BUFFER,
|
||||
out_end=1, in_end=1)
|
||||
i2c.write_then_readinto(self._BUFFER, self._BUFFER, out_end=1, in_end=1)
|
||||
return self._BUFFER[0]
|
||||
|
||||
def _write_u8(self, address, val):
|
||||
|
|
@ -166,11 +165,10 @@ class FXOS8700:
|
|||
# Read accelerometer data from sensor.
|
||||
with self._device as i2c:
|
||||
self._BUFFER[0] = _FXOS8700_REGISTER_OUT_X_MSB
|
||||
i2c.write_then_readinto(self._BUFFER, self._BUFFER,
|
||||
out_end=1, in_end=6)
|
||||
accel_raw_x = struct.unpack_from('>H', self._BUFFER[0:2])[0]
|
||||
accel_raw_y = struct.unpack_from('>H', self._BUFFER[2:4])[0]
|
||||
accel_raw_z = struct.unpack_from('>H', self._BUFFER[4:6])[0]
|
||||
i2c.write_then_readinto(self._BUFFER, self._BUFFER, out_end=1, in_end=6)
|
||||
accel_raw_x = struct.unpack_from(">H", self._BUFFER[0:2])[0]
|
||||
accel_raw_y = struct.unpack_from(">H", self._BUFFER[2:4])[0]
|
||||
accel_raw_z = struct.unpack_from(">H", self._BUFFER[4:6])[0]
|
||||
# Convert accelerometer data to signed 14-bit value from 16-bit
|
||||
# left aligned 2's compliment value.
|
||||
accel_raw_x = _twos_comp(accel_raw_x >> 2, 14)
|
||||
|
|
@ -180,13 +178,14 @@ class FXOS8700:
|
|||
# 16-bit signed data so struct parsing can handle it directly.
|
||||
with self._device as i2c:
|
||||
self._BUFFER[0] = _FXOS8700_REGISTER_MOUT_X_MSB
|
||||
i2c.write_then_readinto(self._BUFFER, self._BUFFER,
|
||||
out_end=1, in_end=6)
|
||||
mag_raw_x = struct.unpack_from('>h', self._BUFFER[0:2])[0]
|
||||
mag_raw_y = struct.unpack_from('>h', self._BUFFER[2:4])[0]
|
||||
mag_raw_z = struct.unpack_from('>h', self._BUFFER[4:6])[0]
|
||||
return ((accel_raw_x, accel_raw_y, accel_raw_z),
|
||||
(mag_raw_x, mag_raw_y, mag_raw_z))
|
||||
i2c.write_then_readinto(self._BUFFER, self._BUFFER, out_end=1, in_end=6)
|
||||
mag_raw_x = struct.unpack_from(">h", self._BUFFER[0:2])[0]
|
||||
mag_raw_y = struct.unpack_from(">h", self._BUFFER[2:4])[0]
|
||||
mag_raw_z = struct.unpack_from(">h", self._BUFFER[4:6])[0]
|
||||
return (
|
||||
(accel_raw_x, accel_raw_y, accel_raw_z),
|
||||
(mag_raw_x, mag_raw_y, mag_raw_z),
|
||||
)
|
||||
|
||||
@property
|
||||
def accelerometer(self):
|
||||
|
|
|
|||
114
docs/conf.py
114
docs/conf.py
|
|
@ -2,7 +2,8 @@
|
|||
|
||||
import os
|
||||
import sys
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
|
||||
sys.path.insert(0, os.path.abspath(".."))
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
|
|
@ -10,9 +11,9 @@ sys.path.insert(0, os.path.abspath('..'))
|
|||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.intersphinx',
|
||||
'sphinx.ext.viewcode',
|
||||
"sphinx.ext.autodoc",
|
||||
"sphinx.ext.intersphinx",
|
||||
"sphinx.ext.viewcode",
|
||||
]
|
||||
|
||||
# Uncomment the below if you use native CircuitPython modules such as
|
||||
|
|
@ -20,29 +21,36 @@ extensions = [
|
|||
# autodoc module docs will fail to generate with a warning.
|
||||
# autodoc_mock_imports = ["adafruit_bus_device", "micropython"]
|
||||
|
||||
intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
|
||||
intersphinx_mapping = {
|
||||
"python": ("https://docs.python.org/3.4", None),
|
||||
"BusDevice": (
|
||||
"https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
|
||||
None,
|
||||
),
|
||||
"CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
|
||||
}
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
templates_path = ["_templates"]
|
||||
|
||||
source_suffix = '.rst'
|
||||
source_suffix = ".rst"
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
master_doc = "index"
|
||||
|
||||
# General information about the project.
|
||||
project = u'Adafruit FXOS8700 Library'
|
||||
copyright = u'2017 Tony DiCola'
|
||||
author = u'Tony DiCola'
|
||||
project = "Adafruit FXOS8700 Library"
|
||||
copyright = "2017 Tony DiCola"
|
||||
author = "Tony DiCola"
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = u'1.0'
|
||||
version = "1.0"
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = u'1.0'
|
||||
release = "1.0"
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
|
@ -54,7 +62,7 @@ language = None
|
|||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This patterns also effect to html_static_path and html_extra_path
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
|
||||
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
|
|
@ -66,7 +74,7 @@ default_role = "any"
|
|||
add_function_parentheses = True
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
pygments_style = "sphinx"
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = False
|
||||
|
|
@ -80,59 +88,62 @@ todo_emit_warnings = True
|
|||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
||||
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
|
||||
|
||||
if not on_rtd: # only import and set the theme if we're building docs locally
|
||||
try:
|
||||
import sphinx_rtd_theme
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
|
||||
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
|
||||
except:
|
||||
html_theme = 'default'
|
||||
html_theme_path = ['.']
|
||||
html_theme = "default"
|
||||
html_theme_path = ["."]
|
||||
else:
|
||||
html_theme_path = ['.']
|
||||
html_theme_path = ["."]
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
html_static_path = ["_static"]
|
||||
|
||||
# The name of an image file (relative to this directory) to use as a favicon of
|
||||
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#
|
||||
html_favicon = '_static/favicon.ico'
|
||||
html_favicon = "_static/favicon.ico"
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'AdafruitFXOS8700Librarydoc'
|
||||
htmlhelp_basename = "AdafruitFXOS8700Librarydoc"
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'AdafruitFXOS8700Library.tex', u'Adafruit FXOS8700 Library Documentation',
|
||||
author, 'manual'),
|
||||
(
|
||||
master_doc,
|
||||
"AdafruitFXOS8700Library.tex",
|
||||
"Adafruit FXOS8700 Library Documentation",
|
||||
author,
|
||||
"manual",
|
||||
),
|
||||
]
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
|
@ -140,8 +151,13 @@ latex_documents = [
|
|||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'adafruitFXOS8700library', u'Adafruit FXOS8700 Library Documentation',
|
||||
[author], 1)
|
||||
(
|
||||
master_doc,
|
||||
"adafruitFXOS8700library",
|
||||
"Adafruit FXOS8700 Library Documentation",
|
||||
[author],
|
||||
1,
|
||||
)
|
||||
]
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
|
@ -150,7 +166,13 @@ man_pages = [
|
|||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'AdafruitFXOS8700Library', u'Adafruit FXOS8700 Library Documentation',
|
||||
author, 'AdafruitFXOS8700Library', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
(
|
||||
master_doc,
|
||||
"AdafruitFXOS8700Library",
|
||||
"Adafruit FXOS8700 Library Documentation",
|
||||
author,
|
||||
"AdafruitFXOS8700Library",
|
||||
"One line description of project.",
|
||||
"Miscellaneous",
|
||||
),
|
||||
]
|
||||
|
|
|
|||
|
|
@ -13,8 +13,8 @@ i2c = busio.I2C(board.SCL, board.SDA)
|
|||
sensor = adafruit_fxos8700.FXOS8700(i2c)
|
||||
# Optionally create the sensor with a different accelerometer range (the
|
||||
# default is 2G, but you can use 4G or 8G values):
|
||||
#sensor = adafruit_fxos8700.FXOS8700(i2c, accel_range=adafruit_fxos8700.ACCEL_RANGE_4G)
|
||||
#sensor = adafruit_fxos8700.FXOS8700(i2c, accel_range=adafruit_fxos8700.ACCEL_RANGE_8G)
|
||||
# sensor = adafruit_fxos8700.FXOS8700(i2c, accel_range=adafruit_fxos8700.ACCEL_RANGE_4G)
|
||||
# sensor = adafruit_fxos8700.FXOS8700(i2c, accel_range=adafruit_fxos8700.ACCEL_RANGE_8G)
|
||||
|
||||
# Main loop will read the acceleration and magnetometer values every second
|
||||
# and print them out.
|
||||
|
|
@ -23,7 +23,15 @@ while True:
|
|||
accel_x, accel_y, accel_z = sensor.accelerometer
|
||||
mag_x, mag_y, mag_z = sensor.magnetometer
|
||||
# Print values.
|
||||
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))
|
||||
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
|
||||
)
|
||||
)
|
||||
# Delay for a second.
|
||||
time.sleep(1.0)
|
||||
|
|
|
|||
50
setup.py
50
setup.py
|
|
@ -7,6 +7,7 @@ https://github.com/pypa/sampleproject
|
|||
|
||||
# Always prefer setuptools over distutils
|
||||
from setuptools import setup, find_packages
|
||||
|
||||
# To use a consistent encoding
|
||||
from codecs import open
|
||||
from os import path
|
||||
|
|
@ -14,47 +15,38 @@ from os import path
|
|||
here = path.abspath(path.dirname(__file__))
|
||||
|
||||
# Get the long description from the README file
|
||||
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
|
||||
with open(path.join(here, "README.rst"), encoding="utf-8") as f:
|
||||
long_description = f.read()
|
||||
|
||||
setup(
|
||||
name='adafruit-circuitpython-fxos8700',
|
||||
|
||||
name="adafruit-circuitpython-fxos8700",
|
||||
use_scm_version=True,
|
||||
setup_requires=['setuptools_scm'],
|
||||
|
||||
description='CircuitPython library for NXP FXOS8700 accelerometer and magnetometer.',
|
||||
setup_requires=["setuptools_scm"],
|
||||
description="CircuitPython library for NXP FXOS8700 accelerometer and magnetometer.",
|
||||
long_description=long_description,
|
||||
long_description_content_type='text/x-rst',
|
||||
|
||||
long_description_content_type="text/x-rst",
|
||||
# The project's main homepage.
|
||||
url='https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700',
|
||||
|
||||
url="https://github.com/adafruit/Adafruit_CircuitPython_FXOS8700",
|
||||
# Author details
|
||||
author='Adafruit Industries',
|
||||
author_email='circuitpython@adafruit.com',
|
||||
|
||||
install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice'],
|
||||
|
||||
author="Adafruit Industries",
|
||||
author_email="circuitpython@adafruit.com",
|
||||
install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"],
|
||||
# Choose your license
|
||||
license='MIT',
|
||||
|
||||
license="MIT",
|
||||
# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
|
||||
classifiers=[
|
||||
'Development Status :: 3 - Alpha',
|
||||
'Intended Audience :: Developers',
|
||||
'Topic :: Software Development :: Libraries',
|
||||
'Topic :: System :: Hardware',
|
||||
'License :: OSI Approved :: MIT License',
|
||||
'Programming Language :: Python :: 3',
|
||||
'Programming Language :: Python :: 3.4',
|
||||
'Programming Language :: Python :: 3.5',
|
||||
"Development Status :: 3 - Alpha",
|
||||
"Intended Audience :: Developers",
|
||||
"Topic :: Software Development :: Libraries",
|
||||
"Topic :: System :: Hardware",
|
||||
"License :: OSI Approved :: MIT License",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.4",
|
||||
"Programming Language :: Python :: 3.5",
|
||||
],
|
||||
|
||||
# What does your project relate to?
|
||||
keywords='adafruit nxp fxos8700 accelerometer magnetometer breakout hardware micropython circuitpython',
|
||||
|
||||
keywords="adafruit nxp fxos8700 accelerometer magnetometer 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_fxos8700'],
|
||||
py_modules=["adafruit_fxos8700"],
|
||||
)
|
||||
|
|
|
|||
Loading…
Reference in a new issue