all done?

Author: siddacious

.travis.yml

@@ -11,11 +11,8 @@ python:
 cache:
   pip: true
 
-# TODO: if deployment to PyPi is desired, change 'DEPLOY_PYPI' to "true",
-#       or remove the env block entirely and remove the condition in the
-#       deploy block.
 env:
-  - DEPLOY_PYPI="false"
+  - DEPLOY_PYPI="true"
 
 deploy:
   - provider: releases
@@ -26,12 +23,10 @@ deploy:
     overwrite: true
     on:
       tags: true
-  # TODO: Use 'travis encrypt --com -r adafruit/<repo slug>' to generate
-  #       the encrypted password for adafruit-travis. Paste result below.
   - provider: pypi
     user: adafruit-travis
     password:
-      secure: #-- PASTE ENCRYPTED PASSWORD HERE --#
+      secure: ihb28n7IEXjCri2SMDcLtZulWEJCef9+UziSK8qgBgZG33s/Zdt/1EMPpcxvV2SBSVhmJR0zXBOj5+qsJxbxEDURjSaapehL8Pp0zz0CnpZjyxjoKyaHK7Z+8ExiRjo2YR584wl8vRg9qB7hM1ZyS6BsBRwQ2EzMYFMj4UOkyU0djTPbZ/DXCwCiScZZXvpIRiG7D74QI0eKcCvesC2wkXV3cisqwJnqwDsT/ab0Jk5w3nsswuUF+vatLz0d3n27ggkmPy/OlgaIrVQTeV55QbBmh/Cr8815LKT1C1ucindyxT+lKNH1aaEeKoySVOg8wCtpWgnhgqVwzJAF5I+NT+zaqAueVkIOmbqaJibA9H8Jh9iGFyP2HBXlUCjp8SVfamKx/ya0FZZoIJrK+R/IL6Dkf2mweTOYR5E3qxdeF3SSE/FtpktqqefV/XSBiAHxmKfcB1KR/Nu6M8aqLAcA5wzowpJvNeL6usxFQpNqRoKHYSI5TtscGFPk+40ViAsgltABD85RR+AP+Q7gNAHwMx706+0eSUoLlGwDcSIe/DLfwKIvcjEUqbrNLcLwcGwcirk5/X8LJPoMU8i/IpL0SJI452eUqnwmQgEtJvS2dwaM+RPAxQpbFuxoqUb1UZvoKruiXj5eE0cH0CM5gjiKZXgmRqwiUF4lyKJblKC95so=
     on:
       tags: true
       condition: $DEPLOY_PYPI = "true"

README.rst

@@ -30,12 +30,6 @@ This is easily achieved by downloading
 
 Installing from PyPI
 =====================
-.. note:: This library is not available on PyPI yet. Install documentation is included
-   as a standard element. Stay tuned for PyPI availability!
-
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
-   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
-
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 PyPI <https://pypi.org/project/adafruit-circuitpython-pct2075/>`_. To install for current user:
 
@@ -61,7 +55,20 @@ To install in a virtual environment in your current project:
 Usage Example
 =============
 
-.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
+.. code-block:: python
+
+    import time
+    import board
+    import busio
+    import adafruit_pct2075
+    i2c = busio.I2C(board.SCL, board.SDA)
+
+    pct = adafruit_pct2075.PCT2075(i2c)
+
+    while True:
+        print("Temperature: %.2f C"%pct.temperature)
+        time.sleep(0.5)
+
 
 Contributing
 ============

adafruit_pct2075.py

@@ -33,8 +33,7 @@
 
 **Hardware:**
 
-.. todo:: Add links to any specific hardware product page(s), or category page(s). Use unordered list & hyperlink rST
-   inline format: "* `Link Text <url>`_"
+* Adafruit PCT2075 Breakout: https://www.adafruit.com/products/4369
 
 **Software and Dependencies:**
 
@@ -48,53 +47,72 @@
 """
 
 from adafruit_register.i2c_struct import ROUnaryStruct, UnaryStruct
-from adafruit_register.i2c_bits import ROBits, RWBits
-from adafruit_register.i2c_bit import RWBit, ROBit
+from adafruit_register.i2c_bits import RWBits
+from adafruit_register.i2c_bit import RWBit
 import adafruit_bus_device.i2c_device as i2cdevice
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PCT2075.git"
+# pylint: disable=bad-whitespace, too-few-public-methods
+PCT2075_DEFAULT_ADDRESS		 = 0x37		# Address is configured with pins A0-A2
 
-#PCT2075_DEFAULT_ADDRESS		 = 0x37		# Address is configured with pins A0-A2
-PCT2075_DEFAULT_ADDRESS		 = 0x48		# Address is configured with pins A0-A2
 PCT2075_REGISTER_TEMP		 = 0		# Temperature register (read-only)
 PCT2075_REGISTER_CONFIG		 = 1		# Configuration register
 PCT2075_REGISTER_THYST		 = 2		# Hysterisis register
 PCT2075_REGISTER_TOS		 = 3		# OS register
 PCT2075_REGISTER_TIDLE       = 4        # Measurement idle time register
 
 class Mode:
+    """Options for `mode`"""
     INTERRUPT = 1
     COMPARITOR = 0
 
 class FaultCount:
+    """Options for `faults_to_alert`"""
     FAULT_1 = 0
     FAULT_2 = 1
     FAULT_4 = 3
     FAULT_6 = 4
 
+# pylint: enable=bad-whitespace, too-few-public-methods
 
 class PCT2075:
-
+    """Driver for the PCT2075 Digital Temperature Sensor and Thermal Watchdog.
+        :param ~busio.I2C i2c_bus: The I2C bus the INA260 is connected to.
+        :param address: The I2C device address for the sensor. Default is ``0x37``.
+    """
     def __init__(self, i2c_bus, address=PCT2075_DEFAULT_ADDRESS):
         self.i2c_device = i2cdevice.I2CDevice(i2c_bus, address)
 
     _temperature = ROUnaryStruct(PCT2075_REGISTER_TEMP, ">h")
     mode = RWBit(PCT2075_REGISTER_CONFIG, 1, register_width=1)
+    """Sets the alert mode. In comparitor mode, the sensor acts like a thermostat and will activate
+    the INT pin according to `high_temp_active_high` when an alert is triggered. The INT pin will be
+    deactiveated when the temperature falls below `temperature_hysteresis`. In interrupt mode the
+    INT pin is activated once when a temperature fault is detected, and once more when the
+    temperature falls below `temperature_hysteresis`. In interrupt mode, the alert is cleared by
+    reading a property"""
 
     shutdown = RWBit(PCT2075_REGISTER_CONFIG, 0, 1)
+    """Set to True to turn off the temperature measurement circuitry in the sensor. While shut down
+    the configurations properties can still be read or written but the temperature will not be
+    measured"""
     _fault_queue_length = RWBits(2, PCT2075_REGISTER_CONFIG, 5, register_width=1)
     _high_temperature_threshold = UnaryStruct(PCT2075_REGISTER_TOS, ">h")
     _temp_hysteresis = UnaryStruct(PCT2075_REGISTER_THYST, ">h")
     _idle_time = RWBits(5, PCT2075_REGISTER_TIDLE, 0, register_width=1)
-    high_temp_active_low = RWBit(PCT2075_REGISTER_CONFIG, 2, register_width=1)
+    high_temp_active_high = RWBit(PCT2075_REGISTER_CONFIG, 2, register_width=1)
+    """Sets the alert polarity. When False the INT pin will be tied to ground when an alert is
+    triggered. If set to True it will be disconnected from ground when an alert is triggered."""
 
     @property
     def temperature(self):
-        """WHAT DO YOU THINK THIS RETURNS?"""
+        """Returns the current temperature in degress celsius. Resolution is 0.125 degrees C"""
         return (self._temperature>>5) *  0.125
 
     @property
     def high_temperature_threshold(self):
+        """The temperature in degrees celsius that will trigger an alert on the INT pin if it is
+        exceeded. Resolution is 0.5 degrees C."""
         return (self._high_temperature_threshold >> 7) * 0.5
 
     @high_temperature_threshold.setter
@@ -103,19 +121,43 @@ def high_temperature_threshold(self, value):
 
     @property
     def temperature_hysteresis(self):
+        """The temperature hysteresis value defines the bottom of the temperature range in degrees
+        C in which the temperature is still considered high". `temperature_hysteresis` must be
+        lower than `high_temperature_threshold`. Resolution is 0.5 degrees C.
+        """
         return (self._temp_hysteresis  >> 7) * 0.5
 
     @temperature_hysteresis.setter
     def temperature_hysteresis(self, value):
-        # TODO: check that hyst is < threshold
+        if value >= self.high_temperature_threshold:
+            raise ValueError("temperature_hysteresis must be less than high_temperature_threshold")
         self._temp_hysteresis = (int(value * 2) << 7)
 
     @property
     def faults_to_alert(self):
+        """The number of consecutive high temperature faults required to raise an alert. An fault
+        is tripped each time the sensor measures the temperature to be greater than
+        `high_temperature_threshold`. The rate at which the sensor measures the temperature
+        is defined by `delay_between_measurements`.
+        """
+
         return self._fault_queue_length
 
     @faults_to_alert.setter
     def faults_to_alert(self, value):
         if value > 4 or value < 1:
             raise ValueError("faults_to_alert must be an adafruit_pct2075.FaultCount")
         self._fault_queue_length = value
+
+    @property
+    def delay_between_measurements(self):
+        """The amount of time between measurements made by the sensor in milliseconds. The value
+        must be between 100 and 3100 and a multiple of 100"""
+        return self._idle_time * 100
+
+    @delay_between_measurements.setter
+    def delay_between_measurements(self, value):
+        if value > 3100 or value < 100 or value % 100 > 0:
+            raise AttributeError(""""delay_between_measurements must be >= 100 or <= 3100\
+            and a multiple of 100""")
+        self._idle_time = int(value/100)

docs/conf.py

@@ -16,11 +16,11 @@
     'sphinx.ext.todo',
 ]
 
-# TODO: Please Read!
+
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-# autodoc_mock_imports = ["digitalio", "busio"]
+autodoc_mock_imports = ["adafruit_register", "adafruit_bus_device"]
 
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'Register': ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}

docs/index.rst

@@ -23,14 +23,10 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
+.. Adafruit PCT2075 Breakout <https://www.adafruit.com/products/4369>
 
 .. toctree::
     :caption: Other Links

examples/high_temp_alert_example.py

@@ -2,16 +2,17 @@
 import board
 import busio
 import adafruit_pct2075
-i2c = busio.I2C(board.SCL, board.SDA)
 
+i2c = busio.I2C(board.SCL, board.SDA)
 pct = adafruit_pct2075.PCT2075(i2c)
+
 pct.high_temperature_threshold = 35.5
 pct.temperature_hysteresis = 30.0
-pct.high_temp_active_low = False
-print("High temp alert active low? %s"%pct.high_temp_active_low)
+pct.high_temp_active_high = False
+print("High temp alert active high? %s"%pct.high_temp_active_high)
 
 # Attach an LED with the Cathode to the INT pin and Anode to 3.3V with a current limiting resistor
 
 while True:
     print("Temperature: %.2f C"%pct.temperature)
-    time.sleep(0.5)
+    time.sleep(0.5)

examples/pct2075_simpletest.py

@@ -1,11 +1,11 @@
-import time
-import board
-import busio
-import adafruit_pct2075
-i2c = busio.I2C(board.SCL, board.SDA)
-
-pct = adafruit_pct2075.PCT2075(i2c)
-
-while True:
-    print(pct.temperature)
-    time.sleep(0.5)
+import time
+import board
+import busio
+import adafruit_pct2075
+i2c = busio.I2C(board.SCL, board.SDA)
+
+pct = adafruit_pct2075.PCT2075(i2c)
+
+while True:
+    print("Temperature: %.2f C"%pct.temperature)
+    time.sleep(0.5)