Skip to content

Commit 1b26033

Browse files
committed
updated info docstring; removed 'get/set' from docstrings
1 parent ab70b9e commit 1b26033

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

adafruit_tcs34725.py

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,26 @@
2727
micropython-adafruit-tcs34725 module by Radomir Dopieralski:
2828
https://github.com/adafruit/micropython-adafruit-tcs34725
2929
30-
See examples/simpletest.py for an example of the usage.
30+
See examples/tcs34725_simpletest.py for an example of the usage.
3131
3232
* Author(s): Tony DiCola
33+
34+
Implementation Notes
35+
--------------------
36+
37+
**Hardware:**
38+
39+
* Adafruit `RGB Color Sensor with IR filter and White LED - TCS34725
40+
<https://www.adafruit.com/product/1334>`_ (Product ID: 1334)
41+
42+
* Flora `Color Sensor with White Illumination LED - TCS34725
43+
<https://www.adafruit.com/product/1356>`_ (Product ID: 1356)
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
3350
"""
3451
import time
3552

@@ -127,7 +144,7 @@ def _write_u16(self, address, val):
127144

128145
@property
129146
def active(self):
130-
"""Get and set the active state of the sensor. Boolean value that will
147+
"""The active state of the sensor. Boolean value that will
131148
enable/activate the sensor with a value of True and disable with a
132149
value of False.
133150
"""
@@ -150,7 +167,7 @@ def active(self, val):
150167

151168
@property
152169
def integration_time(self):
153-
"""Get and set the integration time of the sensor in milliseconds."""
170+
"""The integration time of the sensor in milliseconds."""
154171
return self._integration_time
155172

156173
@integration_time.setter
@@ -162,7 +179,7 @@ def integration_time(self, val):
162179

163180
@property
164181
def gain(self):
165-
"""Get and set the gain of the sensor. Should be a value of 1, 4, 16,
182+
"""The gain of the sensor. Should be a value of 1, 4, 16,
166183
or 60.
167184
"""
168185
return _GAINS[self._read_u8(_REGISTER_CONTROL)]
@@ -174,7 +191,7 @@ def gain(self, val):
174191

175192
@property
176193
def interrupt(self):
177-
"""Get and clear the interrupt of the sensor. Returns a bool that's
194+
"""Return and clear the interrupt of the sensor. Returns a bool that's
178195
True if the interrupt is set. Can be set to False (and only False)
179196
to clear the interrupt.
180197
"""
@@ -235,7 +252,7 @@ def lux(self):
235252

236253
@property
237254
def cycles(self):
238-
"""Get and set the persistence cycles of the sensor."""
255+
"""The persistence cycles of the sensor."""
239256
if self._read_u8(_REGISTER_ENABLE) & _ENABLE_AIEN:
240257
return _CYCLES[self._read_u8(_REGISTER_APERS) & 0x0f]
241258
return -1
@@ -252,7 +269,7 @@ def cycles(self, val):
252269

253270
@property
254271
def min_value(self):
255-
"""Get and set the minimum threshold value (AILT register) of the
272+
"""The minimum threshold value (AILT register) of the
256273
sensor as a 16-bit unsigned value.
257274
"""
258275
return self._read_u16(_REGISTER_AILT)
@@ -263,7 +280,7 @@ def min_value(self, val):
263280

264281
@property
265282
def max_value(self):
266-
"""Get and set the minimum threshold value (AIHT register) of the
283+
"""The minimum threshold value (AIHT register) of the
267284
sensor as a 16-bit unsigned value.
268285
"""
269286
return self._read_u16(_REGISTER_AIHT)

0 commit comments

Comments
 (0)