Skip to content

Add documentation for Gain settings #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 15, 2022
Merged

Add documentation for Gain settings #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0eec363
Add table for Gain CV, remove unnecessary pass statements
tekktrik Feb 15, 2022
da9e65c
Reformatted per pre-commit
tekktrik Feb 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 28 additions & 6 deletions adafruit_as7341.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,9 +145,35 @@ def is_valid(cls, value):


class Gain(CV):
"""Options for ``accelerometer_range``"""
"""Options for ``accelerometer_range``

+-------------------------------+-------------------------+
| Setting | Gain Value |
+===============================+=========================+
| :py:const:`Gain.GAIN_0_5X` | 0.5 |
+-------------------------------+-------------------------+
| :py:const:`Gain.GAIN_1X` | 1 |
+-------------------------------+-------------------------+
| :py:const:`Gain.GAIN_2X` | 2 |
+-------------------------------+-------------------------+
| :py:const:`Gain.GAIN_4X` | 4 |
+-------------------------------+-------------------------+
| :py:const:`Gain.GAIN_8X` | 8 |
+-------------------------------+-------------------------+
| :py:const:`Gain.GAIN_16X` | 16 |
+-------------------------------+-------------------------+
| :py:const:`Gain.GAIN_32X` | 32 |
+-------------------------------+-------------------------+
| :py:const:`Gain.GAIN_64X` | 64 |
+-------------------------------+-------------------------+
| :py:const:`Gain.GAIN_128X` | 128 |
+-------------------------------+-------------------------+
| :py:const:`Gain.GAIN_256X` | 256 |
+-------------------------------+-------------------------+
| :py:const:`Gain.GAIN_512X` | 512 |
+-------------------------------+-------------------------+

pass # pylint: disable=unnecessary-pass
"""


Gain.add_values(
Expand All @@ -170,8 +196,6 @@ class Gain(CV):
class SMUX_OUT(CV):
"""Options for ``smux_out``"""

pass # pylint: disable=unnecessary-pass


SMUX_OUT.add_values(
(
Expand All @@ -189,8 +213,6 @@ class SMUX_OUT(CV):
class SMUX_IN(CV):
"""Options for ``smux_in``"""

pass # pylint: disable=unnecessary-pass


SMUX_IN.add_values(
(
Expand Down