Skip to content

Commit 0bffd1b

Browse files
committed
updating docs
1 parent 47a0100 commit 0bffd1b

File tree

1 file changed

+31
-9
lines changed

1 file changed

+31
-9
lines changed

adafruit_dps310.py

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,30 @@ def is_valid(cls, value):
8888
return value in cls.string
8989

9090
class Mode(CV):
91-
"""Options for ``mode``"""
91+
"""Options for ``mode``
92+
93+
+--------------------------+------------------------------------------------------------------+
94+
| Mode | Description |
95+
+--------------------------+------------------------------------------------------------------+
96+
| ``Mode.IDLE`` | Puts the sensor into a shutdown state |
97+
+--------------------------+------------------------------------------------------------------+
98+
| ``Mode.ONE_PRESSURE`` | Setting `mode` to ``Mode.ONE_PRESSURE`` takes a single pressure |
99+
| | measurement then switches to ``Mode.IDLE`` |
100+
+--------------------------+------------------------------------------------------------------+
101+
| ``Mode.ONE_TEMPERATURE`` | Setting `mode` to ``Mode.ONE_TEMPERATURE`` takes a single |
102+
| | temperature measurement then switches to ``Mode.IDLE`` |
103+
+--------------------------+------------------------------------------------------------------+
104+
| ``Mode.CONT_PRESSURE`` | Take pressure measurements at the current `pressure_rate`. |
105+
| | `temperature` will not be updated |
106+
+--------------------------+------------------------------------------------------------------+
107+
| ``Mode.CONT_TEMP`` | Take temperature measurements at the current `temperature_rate`. |
108+
| | `pressure` will not be updated |
109+
+--------------------------+------------------------------------------------------------------+
110+
| ``Mode.CONT_PRESTEMP`` | Take temperature and pressure measurements at the current |
111+
| | `pressure_rate` and `temperature_rate` |
112+
+--------------------------+------------------------------------------------------------------+
113+
114+
"""
92115
pass #pylint: disable=unnecessary-pass
93116

94117
Mode.add_values((
@@ -101,7 +124,7 @@ class Mode(CV):
101124
))
102125

103126
class Rate(CV):
104-
"""Options for data_rate"""
127+
"""Options for `pressure_rate` and `temperature_rate`"""
105128
pass
106129

107130
Rate.add_values((
@@ -116,7 +139,7 @@ class Rate(CV):
116139
))
117140

118141
class SampleCount(CV):
119-
"""Options for oversample_count"""
142+
"""Options for `temperature_oversample_count` and `pressure_oversample_count`"""
120143
pass
121144

122145
SampleCount.add_values((
@@ -254,20 +277,19 @@ def pressure_ready(self):
254277

255278
@property
256279
def mode(self):
257-
"""An example"""
280+
"""The measurement mode. Must be a `Mode`. See the `Mode` documentation for details"""
258281
return self._mode_bits
259282

260283
@mode.setter
261284
def mode(self, value):
262-
"""Set the mode"""
263285
if not Mode.is_valid(value):
264286
raise AttributeError("mode must be an `Mode`")
265287

266288
self._mode_bits = value
267289

268290
@property
269291
def pressure_rate(self):
270-
"""Configure the pressure measurement rate. Must be a Rate"""
292+
"""Configure the pressure measurement rate. Must be a `Rate`"""
271293
return self._pressure_ratebits
272294

273295
@pressure_rate.setter
@@ -278,7 +300,7 @@ def pressure_rate(self, value):
278300

279301
@property
280302
def pressure_oversample_count(self):
281-
"""The number of samples taken per pressure measurement. Must be a SampleCount"""
303+
"""The number of samples taken per pressure measurement. Must be a `SampleCount`"""
282304
return self._pressure_osbits
283305

284306
@pressure_oversample_count.setter
@@ -292,7 +314,7 @@ def pressure_oversample_count(self, value):
292314

293315
@property
294316
def temperature_rate(self):
295-
"""Configure the temperature measurement rate. Must be a Rate"""
317+
"""Configure the temperature measurement rate. Must be a `Rate`"""
296318
return self._temp_ratebits
297319

298320
@temperature_rate.setter
@@ -303,7 +325,7 @@ def temperature_rate(self, value):
303325

304326
@property
305327
def temperature_oversample_count(self):
306-
"""The number of samples taken per temperature measurement. Must be a SampleCount"""
328+
"""The number of samples taken per temperature measurement. Must be a `SampleCount`"""
307329
return self._temp_osbits
308330

309331
@temperature_oversample_count.setter

0 commit comments

Comments
 (0)