mirrors
/
micropython
mirror of https://github.com/micropython/micropython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
micropython/docs/library/pyb.Accel.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

58 lines
1.3 KiB
ReStructuredText
Raw Normal View History

docs/pyb.*: Add "currentmodule:: pyb" directive. Makes sure that classes described in these separate files are properly designated as belonging to "pyb" module in indexes.
2016-06-07 22:57:41 +01:00
.. currentmodule:: pyb
docs/library: Add missing cross-ref links for classes in pyb module.
2017-10-10 15:24:44 +01:00
.. _pyb.Accel:
docs/pyb.*: Add "currentmodule:: pyb" directive. Makes sure that classes described in these separate files are properly designated as belonging to "pyb" module in indexes.
2016-06-07 22:57:41 +01:00
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
class Accel -- accelerometer control
====================================
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Accel is an object that controls the accelerometer. Example usage::
accel = pyb.Accel()
for i in range(10):
print(accel.x(), accel.y(), accel.z())
Raw values are between -32 and 31.
Constructors
------------
docs/library: Remove unnecessary "pyb." prefix on class names. Otherwise these classes are refered to with a double prefix, like pyb.pyb.ADC. Signed-off-by: Damien George <damien@micropython.org>
2022-06-21 05:33:23 +01:00
.. class:: Accel()
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Create and return an accelerometer object.
docs: Remove spaces on lines that are empty.
2019-12-04 04:02:54 +00:00
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Methods
-------
docs/pyb.*: Use proper class case in method headers. Class designator will be used as is in indexes, so must match actual class name.
2016-06-08 14:21:28 +01:00
.. method:: Accel.filtered_xyz()
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Get a 3-tuple of filtered x, y and z values.
docs: Update pyb.Accel doc to reflect changes and explain filtered_xyz.
2015-07-08 11:10:51 +01:00
Implementation note: this method is currently implemented as taking the
sum of 4 samples, sampled from the 3 previous calls to this function along
with the sample from the current call. Returned values are therefore 4
times the size of what they would be from the raw x(), y() and z() calls.
docs/pyb.*: Use proper class case in method headers. Class designator will be used as is in indexes, so must match actual class name.
2016-06-08 14:21:28 +01:00
.. method:: Accel.tilt()
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Get the tilt register.
docs/pyb.*: Use proper class case in method headers. Class designator will be used as is in indexes, so must match actual class name.
2016-06-08 14:21:28 +01:00
.. method:: Accel.x()
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Get the x-axis value.
docs/pyb.*: Use proper class case in method headers. Class designator will be used as is in indexes, so must match actual class name.
2016-06-08 14:21:28 +01:00
.. method:: Accel.y()
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Get the y-axis value.
docs/pyb.*: Use proper class case in method headers. Class designator will be used as is in indexes, so must match actual class name.
2016-06-08 14:21:28 +01:00
.. method:: Accel.z()
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Get the z-axis value.
docs/library/pyb.Accel: Add hardware note about pins used by accel.
2016-11-08 07:14:56 +00:00
Hardware Note
-------------
The accelerometer uses I2C bus 1 to communicate with the processor. Consequently
when readings are being taken pins X9 and X10 should be unused (other than for
I2C). Other devices using those pins, and which therefore cannot be used
concurrently, are UART 1 and Timer 4 channels 1 and 2.