@@ -88,7 +88,30 @@ def is_valid(cls, value):
88
88
return value in cls .string
89
89
90
90
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
+ """
92
115
pass #pylint: disable=unnecessary-pass
93
116
94
117
Mode .add_values ((
@@ -101,7 +124,7 @@ class Mode(CV):
101
124
))
102
125
103
126
class Rate (CV ):
104
- """Options for data_rate """
127
+ """Options for `pressure_rate` and `temperature_rate` """
105
128
pass
106
129
107
130
Rate .add_values ((
@@ -116,7 +139,7 @@ class Rate(CV):
116
139
))
117
140
118
141
class SampleCount (CV ):
119
- """Options for oversample_count """
142
+ """Options for `temperature_oversample_count` and `pressure_oversample_count` """
120
143
pass
121
144
122
145
SampleCount .add_values ((
@@ -254,20 +277,19 @@ def pressure_ready(self):
254
277
255
278
@property
256
279
def mode (self ):
257
- """An example """
280
+ """The measurement mode. Must be a `Mode`. See the `Mode` documentation for details """
258
281
return self ._mode_bits
259
282
260
283
@mode .setter
261
284
def mode (self , value ):
262
- """Set the mode"""
263
285
if not Mode .is_valid (value ):
264
286
raise AttributeError ("mode must be an `Mode`" )
265
287
266
288
self ._mode_bits = value
267
289
268
290
@property
269
291
def pressure_rate (self ):
270
- """Configure the pressure measurement rate. Must be a Rate"""
292
+ """Configure the pressure measurement rate. Must be a ` Rate` """
271
293
return self ._pressure_ratebits
272
294
273
295
@pressure_rate .setter
@@ -278,7 +300,7 @@ def pressure_rate(self, value):
278
300
279
301
@property
280
302
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` """
282
304
return self ._pressure_osbits
283
305
284
306
@pressure_oversample_count .setter
@@ -292,7 +314,7 @@ def pressure_oversample_count(self, value):
292
314
293
315
@property
294
316
def temperature_rate (self ):
295
- """Configure the temperature measurement rate. Must be a Rate"""
317
+ """Configure the temperature measurement rate. Must be a ` Rate` """
296
318
return self ._temp_ratebits
297
319
298
320
@temperature_rate .setter
@@ -303,7 +325,7 @@ def temperature_rate(self, value):
303
325
304
326
@property
305
327
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` """
307
329
return self ._temp_osbits
308
330
309
331
@temperature_oversample_count .setter
0 commit comments