latest platformdetect api; clean up some pylint complaints & minor bugs

[hackapet/Adafruit_Blinka.git] / src / busio.py

diff --git a/src/busio.py b/src/busio.py
old mode 100644 (file)
new mode 100755 (executable)
index e6c24f9..d3bdbf5
--- a/src/busio.py
+++ b/src/busio.py
@@ -1,33 +1,128 @@
+"""
+`busio` - Bus protocol support like I2C and SPI
+=================================================
+
+See `CircuitPython:busio` in CircuitPython for more details.
+
+* Author(s): cefn
+"""
+

 from adafruit_blinka import Enum, Lockable, agnostic
 from adafruit_blinka import Enum, Lockable, agnostic

+from adafruit_blinka.agnostic import board_id
+import adafruit_platformdetect.board as ap_board
+
+EMBEDDED_LINUX_BOARDS = (
+    ap_board.RASPBERRY_PI_2B,
+    ap_board.RASPBERRY_PI_3B,
+    ap_board.RASPBERRY_PI_3B_PLUS,
+    ap_board.BEAGLEBONE_BLACK,
+    ap_board.ORANGEPI_PC,
+)
+
+class I2C(Lockable):
+    def __init__(self, scl, sda, frequency=400000):
+        self.init(scl, sda, frequency)
+
+    def init(self, scl, sda, frequency):
+        self.deinit()
+        if board_id in EMBEDDED_LINUX_BOARDS:
+            from adafruit_blinka.microcontroller.generic_linux.i2c import I2C as _I2C
+        else:
+            from machine import I2C as _I2C
+        from microcontroller.pin import i2cPorts
+        for portId, portScl, portSda in i2cPorts:
+            if scl == portScl and sda == portSda:
+                self._i2c = _I2C(portId, mode=_I2C.MASTER, baudrate=frequency)
+                break
+        else:
+            raise NotImplementedError(
+                "No Hardware I2C on (scl,sda)={}\nValid UART ports: {}".format((scl, sda), i2cPorts)
+            )
+
+    def deinit(self):
+        try:
+            del self._i2c
+        except AttributeError:
+            pass

 
 

+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.deinit()
+
+    def scan(self):
+        return self._i2c.scan()
+
+    def readfrom_into(self, address, buffer, *, start=0, end=None):
+        if start is not 0 or end is not None:
+            if end is None:
+                end = len(buffer)
+            buffer = memoryview(buffer)[start:end]
+        stop = True  # remove for efficiency later
+        return self._i2c.readfrom_into(address, buffer, stop=stop)
+
+    def writeto(self, address, buffer, *, start=0, end=None, stop=True):
+        if isinstance(buffer, str):
+            buffer = bytes([ord(x) for x in buffer])
+        if start is not 0 or end is not None:
+            if end is None:
+                return self._i2c.writeto(address, memoryview(buffer)[start:], stop=stop)
+            else:
+                return self._i2c.writeto(address, memoryview(buffer)[start:end], stop=stop)
+        return self._i2c.writeto(address, buffer, stop=stop)
+
+    def writeto_then_readfrom(self, address, buffer_out, buffer_in, *, out_start=0, out_end=None, in_start=0, in_end=None, stop=False):
+        return self._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, stop=stop)

 
 class SPI(Lockable):
     def __init__(self, clock, MOSI=None, MISO=None):
 
 class SPI(Lockable):
     def __init__(self, clock, MOSI=None, MISO=None):

-        from microcontroller import spiPorts
-        for spiId, sck, mosi, miso in spiPorts:
-            if sck == clock.id and mosi == MOSI.id and miso == MISO.id:
-                self._spi = SPI(spiId)
-                self._pinIds = (sck, mosi, miso)
+        self.deinit()
+        if board_id in EMBEDDED_LINUX_BOARDS:
+            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
+        else:
+            from machine import SPI as _SPI
+        from microcontroller.pin import spiPorts
+        for portId, portSck, portMosi, portMiso in spiPorts:
+            if ((clock == portSck) and                   # Clock is required!
+                (MOSI == portMosi or MOSI == None) and   # But can do with just output
+                (MISO == portMiso or MISO == None)):      # Or just input
+                self._spi = _SPI(portId)
+                self._pins = (portSck, portMosi, portMiso)

                 break
         else:
             raise NotImplementedError(
                 break
         else:
             raise NotImplementedError(

-                "No Hardware SPI on (clock, MOSI, MISO)={}\nValid SPI ports:{}".
+                "No Hardware SPI on (SCLK, MOSI, MISO)={}\nValid SPI ports:{}".

                 format((clock, MOSI, MISO), spiPorts))
 
     def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):
                 format((clock, MOSI, MISO), spiPorts))
 
     def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):

-        if self._locked:
+        if board_id in ap_board.ANY_RASPBERRY_PI_2_OR_3:
+            from adafruit_blinka.microcontroller.bcm283x.pin import Pin
+            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
+        elif board_id == ap_board.BEAGLEBONE_BLACK:
+            from adafruit_blinka.microcontroller.am335x.pin import Pin
+            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
+        elif board_id == ap_board.ORANGEPI_PC:
+            from adafruit_blinka.microcontroller.allwinner_h3.pin import Pin
+            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
+        else:
+            from machine import SPI as _SPI

             from machine import Pin
             from machine import Pin

-            from microcontroller import spiPorts
+
+        if self._locked:

             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
             self._spi.init(
                 baudrate=baudrate,
                 polarity=polarity,
                 phase=phase,
                 bits=bits,
             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
             self._spi.init(
                 baudrate=baudrate,
                 polarity=polarity,
                 phase=phase,
                 bits=bits,

-                firstbit=SPI.MSB,
-                sck=Pin(self._pinIds[0]),
-                mosi=Pin(self._pinIds[1]),
-                miso=Pin(self._pinIds[2]))
+                firstbit=_SPI.MSB,
+                sck=Pin(self._pins[0].id),
+                mosi=Pin(self._pins[1].id),
+                miso=Pin(self._pins[2].id)
+            )

         else:
             raise RuntimeError("First call try_lock()")
 
         else:
             raise RuntimeError("First call try_lock()")
 


@@ -35,14 +130,14 @@ class SPI(Lockable):
         self._spi = None
         self._pinIds = None
 
         self._spi = None
         self._pinIds = None
 

-    def write(self, buf):
-        return self._spi.write(buf)
+    def write(self, buf, start=0, end=None):
+        return self._spi.write(buf, start, end)

 
 

-    def readinto(self, buf):
-        return self.readinto(buf)
+    def readinto(self, buf, start=0, end=None, write_value=0):
+        return self._spi.readinto(buf, start, end)

 
 

-    def write_readinto(self, buffer_out, buffer_in):
-        return self.write_readinto(buffer_out, buffer_in)
+    def write_readinto(self, buffer_out, buffer_in,  out_start=0, out_end=None, in_start=0, in_end=None):
+        return self._spi.write_readinto(buffer_out, buffer_in, out_start, out_end, in_start, in_end)

 
 
 class UART(Lockable):
 
 
 class UART(Lockable):


@@ -52,7 +147,6 @@ class UART(Lockable):
     Parity.ODD = Parity()
     Parity.EVEN = Parity()
 
     Parity.ODD = Parity()
     Parity.EVEN = Parity()
 

-    # TODO investigate UART receiver_buffer_size as e.g. read_buf_len in https://github.com/micropython/micropython/blob/3eb0694b97c6a8f0e93b874549aac40d8b78b0e5/ports/stm32/uart.c

     def __init__(self,
                  tx,
                  rx,
     def __init__(self,
                  tx,
                  rx,


@@ -60,26 +154,18 @@ class UART(Lockable):
                  bits=8,
                  parity=None,
                  stop=1,
                  bits=8,
                  parity=None,
                  stop=1,

-                 timeout=None,
-                 receiver_buffer_size=None,
+                 timeout=1000,
+                 receiver_buffer_size=64,

                  flow=None):
                  flow=None):

-        from microcontroller import uartPorts
-        from machine import UART
+        from machine import UART as _UART
+        from microcontroller.pin import uartPorts

 
         self.baudrate = baudrate
 
 
         self.baudrate = baudrate
 

-        if timeout is not None:  # default 1000
-            raise NotImplementedError(
-                "Parameter '{}' unsupported on {}".format(
-                    "timeout", agnostic.board))
-        if receiver_buffer_size is not None:  # default 64
-            raise NotImplementedError(
-                "Parameter '{}' unsupported on {}".format(
-                    "receiver_buffer_size", agnostic.board))

         if flow is not None:  # default 0
             raise NotImplementedError(
                 "Parameter '{}' unsupported on {}".format(
         if flow is not None:  # default 0
             raise NotImplementedError(
                 "Parameter '{}' unsupported on {}".format(

-                    "flow", agnostic.board))
+                    "flow", agnostic.board_id))

 
         # translate parity flag for Micropython
         if parity is UART.Parity.ODD:
 
         # translate parity flag for Micropython
         if parity is UART.Parity.ODD:


@@ -93,19 +179,21 @@ class UART(Lockable):
 
         # check tx and rx have hardware support
         for portId, portTx, portRx in uartPorts:  #
 
         # check tx and rx have hardware support
         for portId, portTx, portRx in uartPorts:  #

-            if portTx == tx.id and portRx == rx.id:
-                self._uart = UART(
+            if portTx == tx and portRx == rx:
+                self._uart = _UART(

                     portId,
                     baudrate,
                     bits=bits,
                     parity=parity,
                     stop=stop,
                     portId,
                     baudrate,
                     bits=bits,
                     parity=parity,
                     stop=stop,

-                    timeout=timeout)
+                    timeout=timeout,
+                    read_buf_len=receiver_buffer_size
+                )

                 break
         else:
             raise NotImplementedError(
                 break
         else:
             raise NotImplementedError(

-                "No Hardware UART on (tx,rx)={}\nValid UART ports".format(
-                    (tx, rx), uartPorts))
+                "No Hardware UART on (tx,rx)={}\nValid UART ports: {}".format((tx, rx), uartPorts)
+            )

 
     def deinit(self):
         self._uart = None
 
     def deinit(self):
         self._uart = None