This commit is contained in:
dherrada 2020-06-30 15:28:31 -04:00
parent dd263710b8
commit 57aaba408f
2 changed files with 25 additions and 27 deletions

View file

@ -184,8 +184,8 @@ class BNO055:
.. data:: CONFIG_MODE .. data:: CONFIG_MODE
This mode is used to configure BNO, wherein all output data is reset to zero and sensor fusion This mode is used to configure BNO, wherein all output data is reset to zero and sensor
is halted. fusion is halted.
.. data:: ACCONLY_MODE .. data:: ACCONLY_MODE
@ -194,28 +194,28 @@ class BNO055:
.. data:: MAGONLY_MODE .. data:: MAGONLY_MODE
In MAGONLY mode, the BNO055 behaves like a stand-alone magnetometer, with acceleration sensor In MAGONLY mode, the BNO055 behaves like a stand-alone magnetometer, with acceleration
and gyroscope being suspended. sensor and gyroscope being suspended.
.. data:: GYRONLY_MODE .. data:: GYRONLY_MODE
In GYROONLY mode, the BNO055 behaves like a stand-alone gyroscope, with acceleration sensor and In GYROONLY mode, the BNO055 behaves like a stand-alone gyroscope, with acceleration
magnetometer being suspended. sensor and magnetometer being suspended.
.. data:: ACCMAG_MODE .. data:: ACCMAG_MODE
Both accelerometer and magnetometer are switched on, the user can read the data from these two Both accelerometer and magnetometer are switched on, the user can read the data from
sensors. these two sensors.
.. data:: ACCGYRO_MODE .. data:: ACCGYRO_MODE
Both accelerometer and gyroscope are switched on; the user can read the data from these two Both accelerometer and gyroscope are switched on; the user can read the data from these
sensors. two sensors.
.. data:: MAGGYRO_MODE .. data:: MAGGYRO_MODE
Both magnetometer and gyroscope are switched on, the user can read the data from these two Both magnetometer and gyroscope are switched on, the user can read the data from these
sensors. two sensors.
.. data:: AMG_MODE .. data:: AMG_MODE
@ -228,22 +228,24 @@ class BNO055:
.. data:: COMPASS_MODE .. data:: COMPASS_MODE
The COMPASS mode is intended to measure the magnetic earth field and calculate the geographic The COMPASS mode is intended to measure the magnetic earth field and calculate the
direction. geographic direction.
.. data:: M4G_MODE .. data:: M4G_MODE
The M4G mode is similar to the IMU mode, but instead of using the gyroscope signal to detect The M4G mode is similar to the IMU mode, but instead of using the gyroscope signal to
rotation, the changing orientation of the magnetometer in the magnetic field is used. detect rotation, the changing orientation of the magnetometer in the magnetic field is
used.
.. data:: NDOF_FMC_OFF_MODE .. data:: NDOF_FMC_OFF_MODE
This fusion mode is same as NDOF mode, but with the Fast Magnetometer Calibration turned OFF. This fusion mode is same as NDOF mode, but with the Fast Magnetometer Calibration turned
OFF.
.. data:: NDOF_MODE .. data:: NDOF_MODE
This is a fusion mode with 9 degrees of freedom where the fused absolute orientation data is This is a fusion mode with 9 degrees of freedom where the fused absolute orientation data
calculated from accelerometer, gyroscope and the magnetometer. is calculated from accelerometer, gyroscope and the magnetometer.
""" """
return self._read_register(_MODE_REGISTER) return self._read_register(_MODE_REGISTER)

View file

@ -10,16 +10,12 @@ sys.path.insert(0, os.path.abspath(".."))
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ 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 # Uncomment the below if you use native CircuitPython modules such as
# digitalio, micropython and busio. List the modules you use. Without it, the # digitalio, micropython and busio. List the modules you use. Without it, the
# autodoc module docs will fail to generate with a warning. # autodoc module docs will fail to generate with a warning.
# autodoc_mock_imports = ["adafruit_bus_device", "micropython", "adafruit_register"] autodoc_mock_imports = ["adafruit_bus_device", "micropython", "adafruit_register"]
intersphinx_mapping = { intersphinx_mapping = {
"python": ("https://docs.python.org/3.4", None), "python": ("https://docs.python.org/3.4", None),
@ -144,7 +140,7 @@ latex_documents = [
"Adafruit BNO055 Library Documentation", "Adafruit BNO055 Library Documentation",
"Radomir Dopieralski", "Radomir Dopieralski",
"manual", "manual",
), )
] ]
# -- Options for manual page output --------------------------------------- # -- Options for manual page output ---------------------------------------
@ -175,5 +171,5 @@ texinfo_documents = [
"AdafruitBNO055Library", "AdafruitBNO055Library",
"One line description of project.", "One line description of project.",
"Miscellaneous", "Miscellaneous",
), )
] ]