Merge pull request #8 from WindFishDiety/UVReadRaw

Fixes issue #7 whereby the read method should be renamed to raw_uv

Author: caternuson

README.rst

@@ -45,7 +45,7 @@ Usage Example
 
         # take 10 readings
         for j in range(10):
-            uv_raw = uv.read
+            uv_raw = uv.uv_raw
             risk_level = uv.get_index(uv_raw)
             print('Reading: {0} | Risk Level: {1}'.format(uv_raw, risk_level))
             time.sleep(1)

adafruit_veml6070.py

@@ -105,7 +105,7 @@ class VEML6070:
 
             # take 10 readings
             for j in range(10):
-                uv_raw = uv.read
+                uv_raw = uv.uv_raw
                 risk_level = uv.get_index(uv_raw)
                 print('Reading: ', uv_raw, ' | Risk Level: ', risk_level)
                 time.sleep(1)
@@ -145,20 +145,18 @@ def __init__(self, i2c_bus, _veml6070_it="VEML6070_1_T", ack=False):
 
 
     @property
-    def read(self):
+    def uv_raw(self):
         """
         Reads and returns the value of the UV intensity.
         """
-        read_buf = bytearray(2)
+        buffer = bytearray(2)
         with self.i2c_low as i2c_low:
-            i2c_low.readinto(read_buf, end=1)
+            i2c_low.readinto(buffer, end=1)
 
         with self.i2c_high as i2c_high:
-            i2c_high.readinto(read_buf, start=1)
+            i2c_high.readinto(buffer, start=1)
 
-        uvi = read_buf[1] << 8 | read_buf[0]
-
-        return uvi
+        return buffer[1] << 8 | buffer[0]
 
     @property
     def ack(self):
@@ -231,7 +229,7 @@ def sleep(self):
 
     def wake(self):
         """
-        Wakes the VEML6070 from sleep. ``[veml6070].read`` will also wake from sleep.
+        Wakes the VEML6070 from sleep. ``[veml6070].uv_raw`` will also wake from sleep.
         """
         self.buf[0] = (self._ack << 5 | self._ack_thd << 4 |
                        _VEML6070_INTEGRATION_TIME[self._it][0] << 2 | 0x02)
@@ -241,7 +239,7 @@ def wake(self):
     def get_index(self, _raw):
         """
         Calculates the UV Risk Level based on the captured UV reading. Requres the ``_raw``
-        argument (from ``veml6070.read``). Risk level is available for Integration Times (IT)
+        argument (from ``veml6070.uv_raw``). Risk level is available for Integration Times (IT)
         1, 2, & 4. The result is automatically scaled to the current IT setting.
 
             LEVEL*        UV Index

examples/veml6070_simpletest.py

@@ -13,7 +13,7 @@
 
     # take 10 readings
     for j in range(10):
-        uv_raw = uv.read
+        uv_raw = uv.uv_raw
         risk_level = uv.get_index(uv_raw)
         print('Reading: {0} | Risk Level: {1}'.format(uv_raw, risk_level))
         time.sleep(1)