reformatted by black.

[Adafruit_Blinka-hackapet.git] / src / adafruit_blinka / microcontroller / bcm283x / pin.py

diff --git a/src/adafruit_blinka/microcontroller/bcm283x/pin.py b/src/adafruit_blinka/microcontroller/bcm283x/pin.py
index 3db76dfec133425357f34ada784f2c8d0f2a676e..a24ed220dfc72e6cf21fac3752407b5f1e3b5767 100644 (file)
--- a/src/adafruit_blinka/microcontroller/bcm283x/pin.py
+++ b/src/adafruit_blinka/microcontroller/bcm283x/pin.py
@@ -1,9 +1,16 @@
-import RPi.GPIO as GPIO
-GPIO.setmode(GPIO.BCM)    # Use BCM pins D4 = GPIO #4
-GPIO.setwarnings(False)   # shh!
+# SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+"""Broadcom BCM283x pin names"""
+from RPi import GPIO
+
+GPIO.setmode(GPIO.BCM)  # Use BCM pins D4 = GPIO #4
+GPIO.setwarnings(False)  # shh!
+
 
-# Pins dont exist in CPython so...lets make our own!
 class Pin:
+    """Pins dont exist in CPython so...lets make our own!"""
+
     IN = 0
     OUT = 1
     LOW = 0
@@ -11,11 +18,11 @@ class Pin:
     PULL_NONE = 0
     PULL_UP = 1
     PULL_DOWN = 2
-    
+
     id = None
     _value = LOW
     _mode = IN
-    
+
     def __init__(self, bcm_number):
         self.id = bcm_number
 
@@ -26,7 +33,8 @@ class Pin:
         return self.id == other
 
     def init(self, mode=IN, pull=None):
-        if mode != None:
+        """Initialize the Pin"""
+        if mode is not None:
             if mode == self.IN:
                 self._mode = self.IN
                 GPIO.setup(self.id, GPIO.IN)
@@ -35,7 +43,7 @@ class Pin:
                 GPIO.setup(self.id, GPIO.OUT)
             else:
                 raise RuntimeError("Invalid mode for pin: %s" % self.id)
-        if pull != None:
+        if pull is not None:
             if self._mode != self.IN:
                 raise RuntimeError("Cannot set pull resistor on output")
             if pull == self.PULL_UP:
@@ -43,10 +51,11 @@ class Pin:
             elif pull == self.PULL_DOWN:
                 GPIO.setup(self.id, GPIO.IN, pull_up_down=GPIO.PUD_DOWN)
             else:
-                raise RuntimeError("Invalid pull for pin: %s" % self.id)       
+                raise RuntimeError("Invalid pull for pin: %s" % self.id)
 
     def value(self, val=None):
-        if val != None:
+        """Set or return the Pin Value"""
+        if val is not None:
             if val == self.LOW:
                 self._value = val
                 GPIO.output(self.id, val)
@@ -55,8 +64,9 @@ class Pin:
                 GPIO.output(self.id, val)
             else:
                 raise RuntimeError("Invalid value for pin")
-        else:
-            return GPIO.input(self.id)
+            return None
+        return GPIO.input(self.id)
+
 
 # Pi 1B rev1 only?
 D0 = Pin(0)
@@ -80,7 +90,7 @@ MISO = Pin(9)
 D10 = Pin(10)
 MOSI = Pin(10)
 D11 = Pin(11)
-SCLK = Pin(11) # Raspberry Pi naming
+SCLK = Pin(11)  # Raspberry Pi naming
 SCK = Pin(11)  # CircuitPython naming
 
 D12 = Pin(12)
@@ -131,13 +141,19 @@ D44 = Pin(44)
 D45 = Pin(45)
 
 # ordered as spiId, sckId, mosiId, misoId
-spiPorts = ((0, SCLK, MOSI, MISO), (1, SCLK_1, MOSI_1, MISO_1), (2, SCLK_2, MOSI_2, MISO_2))
+spiPorts = (
+    (0, SCLK, MOSI, MISO),
+    (1, SCLK_1, MOSI_1, MISO_1),
+    (2, SCLK_2, MOSI_2, MISO_2),
+)
 
 # ordered as uartId, txId, rxId
-uartPorts = (
-    (1, TXD, RXD),
-)
+uartPorts = ((1, TXD, RXD),)
 
+# These are the known hardware I2C ports / pins.
+# For software I2C ports created with the i2c-gpio overlay, see:
+#     https://github.com/adafruit/Adafruit_Python_Extended_Bus
 i2cPorts = (
-    (3, SCL, SDA), (1, SCL, SDA), (0, D1, D0),   # both pi 1 and pi 2 i2c ports!
+    (1, SCL, SDA),
+    (0, D1, D0),  # both pi 1 and pi 2 i2c ports!
 )