summaryrefslogtreecommitdiff
path: root/docs/library/pyb.Accel.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/pyb.Accel.rst')
-rw-r--r--docs/library/pyb.Accel.rst57
1 files changed, 0 insertions, 57 deletions
diff --git a/docs/library/pyb.Accel.rst b/docs/library/pyb.Accel.rst
deleted file mode 100644
index 9ade5c5c8..000000000
--- a/docs/library/pyb.Accel.rst
+++ /dev/null
@@ -1,57 +0,0 @@
-.. currentmodule:: pyb
-.. _pyb.Accel:
-
-class Accel -- accelerometer control
-====================================
-
-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
-------------
-
-.. class:: pyb.Accel()
-
- Create and return an accelerometer object.
-
-Methods
--------
-
-.. method:: Accel.filtered_xyz()
-
- Get a 3-tuple of filtered x, y and z values.
-
- 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.
-
-.. method:: Accel.tilt()
-
- Get the tilt register.
-
-.. method:: Accel.x()
-
- Get the x-axis value.
-
-.. method:: Accel.y()
-
- Get the y-axis value.
-
-.. method:: Accel.z()
-
- Get the z-axis value.
-
-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.