Massive pylinting session and added Github Actions

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

diff --git a/src/adafruit_blinka/microcontroller/ft232h/i2c.py b/src/adafruit_blinka/microcontroller/ft232h/i2c.py
index fd2d30c810b7b2116c16be2002d42937c22579b4..2d21f15408a9512d86ff5207543434fe5790cbeb 100644 (file)
--- a/src/adafruit_blinka/microcontroller/ft232h/i2c.py
+++ b/src/adafruit_blinka/microcontroller/ft232h/i2c.py
@@ -1,37 +1,62 @@
+"""I2C Class for FT232H"""
 from adafruit_blinka.microcontroller.ft232h.pin import Pin
 
+
 class I2C:
+    """Custom I2C Class for FT232H"""
 
-    def __init__(self):
+    def __init__(self, *, frequency=400000):
         # change GPIO controller to I2C
+        # pylint: disable=import-outside-toplevel
         from pyftdi.i2c import I2cController
+
+        # pylint: enable=import-outside-toplevel
+
         self._i2c = I2cController()
-        self._i2c.configure('ftdi:///1')
+        self._i2c.configure("ftdi://ftdi:ft232h/1", frequency=frequency)
         Pin.ft232h_gpio = self._i2c.get_gpio()
 
     def scan(self):
+        """Perform an I2C Device Scan"""
         return [addr for addr in range(0x79) if self._i2c.poll(addr)]
 
     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)
         port = self._i2c.get_port(address)
         port.write(buffer[start:end], relax=stop)
 
     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)
         port = self._i2c.get_port(address)
         result = port.read(len(buffer[start:end]), relax=stop)
         for i, b in enumerate(result):
-            buffer[start+i] = b
+            buffer[start + i] = b
 
-    def writeto_then_readfrom(self, address, buffer_out, buffer_in, *,
-                              out_start=0, out_end=None,
-                              in_start=0, in_end=None, stop=False):
+    # 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)
         port = self._i2c.get_port(address)
-        result = port.exchange(buffer_out[out_start:out_end],
-                               in_end-in_start,
-                               relax=True).tobytes()
+        result = port.exchange(
+            buffer_out[out_start:out_end], in_end - in_start, relax=True
+        )
         for i, b in enumerate(result):
-            buffer_in[in_start+i] = b
+            buffer_in[in_start + i] = b
+
+    # pylint: enable=unused-argument