Merge pull request #276 from makermelissa/master

[Adafruit_Blinka-hackapet.git] / src / adafruit_blinka / microcontroller / nova / i2c.py

diff --git a/src/adafruit_blinka/microcontroller/nova/i2c.py b/src/adafruit_blinka/microcontroller/nova/i2c.py
index 3c9325c377c644060721c7856fad6713006baa58..e5f0beb747044b854e9add67efb8d38ee928ff25 100644 (file)
--- a/src/adafruit_blinka/microcontroller/nova/i2c.py
+++ b/src/adafruit_blinka/microcontroller/nova/i2c.py
@@ -1,34 +1,39 @@
+"""I2C Class for Binho Nova"""
+
+from adafruit_blinka.microcontroller.nova import Connection
+
+
 class I2C:
+    """Custom I2C Class for Binho Nova"""
 
-    def __init__(self):
-        from adafruit_blinka.microcontroller.nova import Connection
+    def __init__(self, *, frequency=400000):
         self._nova = Connection.getInstance()
         self._nova.setNumericalBase(10)
         self._nova.setOperationMode(0, "I2C")
         self._nova.setPullUpStateI2C(0, "EN")
-        self._nova.setClockI2C(0, 400000)
+        self._nova.setClockI2C(0, frequency)
 
     def scan(self):
-
+        """Perform an I2C Device Scan"""
         scanResults = []
 
         for i in range(8, 121):
-            result = self._nova.scanAddrI2C(0, i<<1)
+            result = self._nova.scanAddrI2C(0, i << 1)
 
             resp = result.split(" ")
 
-            if resp[3] == 'OK':
+            if resp[3] == "OK":
                 scanResults.append(i)
 
         return scanResults
 
     def writeto(self, address, buffer, *, start=0, end=None, stop=True):
-
+        """Write data from the buffer to an address"""
         end = end if end else len(buffer)
 
-        self._nova.startI2C(0, address<<1)
+        self._nova.startI2C(0, address << 1)
 
-        for i in range(start, end): 
+        for i in range(start, end):
             self._nova.writeByteI2C(0, buffer[i])
 
         if stop:
@@ -37,39 +42,60 @@ class I2C:
             self._nova.endI2C(0, True)
 
     def readfrom_into(self, address, buffer, *, start=0, end=None, stop=True):
-
+        """Read data from an address and into the buffer"""
         end = end if end else len(buffer)
 
-        result = self._nova.readBytesI2C(0, address<<1, len(buffer[start:end]))
+        result = self._nova.readBytesI2C(0, address << 1, len(buffer[start:end]))
 
         if result != "-NG":
             resp = result.split(" ")
 
             for i in range(len(buffer[start:end])):
-                buffer[start+i] = int(resp[2+i])
+                buffer[start + i] = int(resp[2 + i])
         else:
-            raise RuntimeError("Received error response from Binho Nova, result = " + result)
-
-    def writeto_then_readfrom(self, address, buffer_out, buffer_in, *,
-                              out_start=0, out_end=None,
-                              in_start=0, in_end=None, stop=False):
-    
+            raise RuntimeError(
+                "Received error response from Binho Nova, result = " + result
+            )
+
+    # pylint: disable=unused-argument
+    def writeto_then_readfrom(
+        self,
+        address,
+        buffer_out,
+        buffer_in,
+        *,
+        out_start=0,
+        out_end=None,
+        in_start=0,
+        in_end=None,
+        stop=False
+    ):
+        """Write data from buffer_out to an address and then
+        read data from an address and into buffer_in
+        """
         out_end = out_end if out_end else len(buffer_out)
         in_end = in_end if in_end else len(buffer_in)
 
-        self._nova.startI2C(0, address<<1)
+        self._nova.startI2C(0, address << 1)
 
-        for i in range(out_start, out_end): 
+        for i in range(out_start, out_end):
             self._nova.writeByteI2C(0, buffer_out[i])
 
         self._nova.endI2C(0, True)
 
-        result = self._nova.readBytesI2C(0, address<<1, len(buffer_in[in_start:in_end]))
+        result = self._nova.readBytesI2C(
+            0, address << 1, len(buffer_in[in_start:in_end])
+        )
 
         if result != "-NG":
             resp = result.split(" ")
 
             for i in range(len(buffer_in[in_start:in_end])):
-                buffer_in[in_start+i] = int(resp[2+i])
+                buffer_in[in_start + i] = int(resp[2 + i])
         else:
-            raise RuntimeError("Received error response from Binho Nova, result = " + result)
\ No newline at end of file
+            raise RuntimeError(
+                "Received error response from Binho Nova, result = " + result
+            )
+
+
+# pylint: enable=unused-argument