X-Git-Url: https://git.ayoreis.com/Adafruit_Blinka-hackapet.git/blobdiff_plain/c72b2913f8b11bc650b5a17f087a058cf7948fb9..03548b64a8d7b407b4ae6464c5ffc551be8fc0be:/src/adafruit_blinka/microcontroller/mcp2221/i2c.py

diff --git a/src/adafruit_blinka/microcontroller/mcp2221/i2c.py b/src/adafruit_blinka/microcontroller/mcp2221/i2c.py
index ef7f784..d8e40c2 100644
--- a/src/adafruit_blinka/microcontroller/mcp2221/i2c.py
+++ b/src/adafruit_blinka/microcontroller/mcp2221/i2c.py
@@ -1,24 +1,53 @@
-from adafruit_blinka.microcontroller.mcp2221.pin import Pin
+# SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+"""I2C Class for MCP2221"""
 from .mcp2221 import mcp2221
 
+
 class I2C:
+    """Custom I2C Class for MCP2221"""
 
-    def __init__(self, *, baudrate=100000):
-        mcp2221.i2c_configure(baudrate)
+    def __init__(self, *, frequency=100000):
+        self._mcp2221 = mcp2221
+        self._mcp2221._i2c_configure(frequency)
 
     def scan(self):
-        return mcp2221.i2c_scan()
+        """Perform an I2C Device Scan"""
+        return self._mcp2221.i2c_scan()
 
+    # pylint: disable=unused-argument
     def writeto(self, address, buffer, *, start=0, end=None, stop=True):
-        mcp2221.i2c_writeto(address, buffer, start=start, end=end)
+        """Write data from the buffer to an address"""
+        self._mcp2221.i2c_writeto(address, buffer, start=start, end=end)
 
     def readfrom_into(self, address, buffer, *, start=0, end=None, stop=True):
-        mcp2221.i2c_readfrom_into(address, buffer, start=start, end=end)
+        """Read data from an address and into the buffer"""
+        self._mcp2221.i2c_readfrom_into(address, buffer, start=start, end=end)
 
-    def writeto_then_readfrom(self, address, buffer_out, buffer_in, *,
-                              out_start=0, out_end=None,
-                              in_start=0, in_end=None, stop=False):
-        mcp2221.i2c_writeto_then_readfrom(address, buffer_out, buffer_in,
-                                          out_start=out_start, out_end=out_end,
-                                          in_start=in_start, in_end=in_end)
+    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
+        """
+        self._mcp2221.i2c_writeto_then_readfrom(
+            address,
+            buffer_out,
+            buffer_in,
+            out_start=out_start,
+            out_end=out_end,
+            in_start=in_start,
+            in_end=in_end,
+        )
 
+    # pylint: enable=unused-argument