Skip to content

Commit 206cd78

Browse files
authored
Merge pull request #24 from tekktrik/doc/add-CV-classes
Add documentation for Gain settings
2 parents e552ba1 + da9e65c commit 206cd78

File tree

1 file changed

+28
-6
lines changed

1 file changed

+28
-6
lines changed

adafruit_as7341.py

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -168,9 +168,35 @@ def is_valid(cls, value: str) -> bool:
168168

169169

170170
class Gain(CV):
171-
"""Options for ``accelerometer_range``"""
171+
"""Options for ``accelerometer_range``
172+
173+
+-------------------------------+-------------------------+
174+
| Setting | Gain Value |
175+
+===============================+=========================+
176+
| :py:const:`Gain.GAIN_0_5X` | 0.5 |
177+
+-------------------------------+-------------------------+
178+
| :py:const:`Gain.GAIN_1X` | 1 |
179+
+-------------------------------+-------------------------+
180+
| :py:const:`Gain.GAIN_2X` | 2 |
181+
+-------------------------------+-------------------------+
182+
| :py:const:`Gain.GAIN_4X` | 4 |
183+
+-------------------------------+-------------------------+
184+
| :py:const:`Gain.GAIN_8X` | 8 |
185+
+-------------------------------+-------------------------+
186+
| :py:const:`Gain.GAIN_16X` | 16 |
187+
+-------------------------------+-------------------------+
188+
| :py:const:`Gain.GAIN_32X` | 32 |
189+
+-------------------------------+-------------------------+
190+
| :py:const:`Gain.GAIN_64X` | 64 |
191+
+-------------------------------+-------------------------+
192+
| :py:const:`Gain.GAIN_128X` | 128 |
193+
+-------------------------------+-------------------------+
194+
| :py:const:`Gain.GAIN_256X` | 256 |
195+
+-------------------------------+-------------------------+
196+
| :py:const:`Gain.GAIN_512X` | 512 |
197+
+-------------------------------+-------------------------+
172198
173-
pass # pylint: disable=unnecessary-pass
199+
"""
174200

175201

176202
Gain.add_values(
@@ -193,8 +219,6 @@ class Gain(CV):
193219
class SMUX_OUT(CV):
194220
"""Options for ``smux_out``"""
195221

196-
pass # pylint: disable=unnecessary-pass
197-
198222

199223
SMUX_OUT.add_values(
200224
(
@@ -212,8 +236,6 @@ class SMUX_OUT(CV):
212236
class SMUX_IN(CV):
213237
"""Options for ``smux_in``"""
214238

215-
pass # pylint: disable=unnecessary-pass
216-
217239

218240
SMUX_IN.add_values(
219241
(

0 commit comments

Comments
 (0)