Skip to content

Commit 1b3997e

Browse files
committed
updated info docstring; removed 'get/set/etc'
1 parent 724b4c6 commit 1b3997e

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

adafruit_max31865.py

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,26 @@
2727
examples/simpletest.py for an example of the usage.
2828
2929
* Author(s): Tony DiCola
30+
31+
Implementation Notes
32+
--------------------
33+
34+
**Hardware:**
35+
36+
* Adafruit `Universal Thermocouple Amplifier MAX31856 Breakout
37+
<https://www.adafruit.com/product/3263>`_ (Product ID: 3263)
38+
39+
* Adafruit `PT100 RTD Temperature Sensor Amplifier - MAX31865
40+
<https://www.adafruit.com/product/3328>`_ (Product ID: 3328)
41+
42+
* Adafruit `PT1000 RTD Temperature Sensor Amplifier - MAX31865
43+
<https://www.adafruit.com/product/3648>`_ (Product ID: 3648)
44+
45+
**Software and Dependencies:**
46+
47+
* Adafruit CircuitPython firmware for the ESP8622 and M0-based boards:
48+
https://github.com/adafruit/circuitpython/releases
49+
* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
3050
"""
3151
import math
3252
import time
@@ -118,7 +138,7 @@ def _write_u8(self, address, val):
118138

119139
@property
120140
def bias(self):
121-
"""Get and set the boolean state of the sensor's bias (True/False)."""
141+
"""The state of the sensor's bias (True/False)."""
122142
return bool(self._read_u8(_MAX31865_CONFIG_REG) & _MAX31865_CONFIG_BIAS)
123143

124144
@bias.setter
@@ -132,7 +152,7 @@ def bias(self, val):
132152

133153
@property
134154
def auto_convert(self):
135-
"""Get and set the boolean state of the sensor's automatic conversion
155+
"""The state of the sensor's automatic conversion
136156
mode (True/False).
137157
"""
138158
return bool(self._read_u8(_MAX31865_CONFIG_REG) & _MAX31865_CONFIG_MODEAUTO)
@@ -148,7 +168,7 @@ def auto_convert(self, val):
148168

149169
@property
150170
def fault(self):
151-
"""Get the fault state of the sensor. Use `clear_faults` to clear the
171+
"""The fault state of the sensor. Use ``clear_faults()`` to clear the
152172
fault state. Returns a 6-tuple of boolean values which indicate if any
153173
faults are present:
154174
- HIGHTHRESH

0 commit comments

Comments
 (0)