src/busio.py

   1 """
   2 `busio` - Bus protocol support like I2C and SPI
   3 =================================================
   4
   5 See `CircuitPython:busio` in CircuitPython for more details.
   6
   7 * Author(s): cefn
   8 """
   9
  10 from adafruit_blinka import Enum, Lockable, agnostic
  11 from adafruit_blinka.agnostic import board_id
  12 import adafruit_platformdetect.board as ap_board
  13
  14 EMBEDDED_LINUX_BOARDS = (
  15     ap_board.RASPBERRY_PI_2B,
  16     ap_board.RASPBERRY_PI_3B,
  17     ap_board.RASPBERRY_PI_3B_PLUS,
  18     ap_board.BEAGLEBONE_BLACK,
  19     ap_board.ORANGEPI_PC,
  20 )
  21
  22 class I2C(Lockable):
  23     def __init__(self, scl, sda, frequency=400000):
  24         self.init(scl, sda, frequency)
  25
  26     def init(self, scl, sda, frequency):
  27         self.deinit()
  28         if board_id in EMBEDDED_LINUX_BOARDS:
  29             from adafruit_blinka.microcontroller.generic_linux.i2c import I2C as _I2C
  30         else:
  31             from machine import I2C as _I2C
  32         from microcontroller.pin import i2cPorts
  33         for portId, portScl, portSda in i2cPorts:
  34             if scl == portScl and sda == portSda:
  35                 self._i2c = _I2C(portId, mode=_I2C.MASTER, baudrate=frequency)
  36                 break
  37         else:
  38             raise NotImplementedError(
  39                 "No Hardware I2C on (scl,sda)={}\nValid UART ports: {}".format((scl, sda), i2cPorts)
  40             )
  41
  42     def deinit(self):
  43         try:
  44             del self._i2c
  45         except AttributeError:
  46             pass
  47
  48     def __enter__(self):
  49         return self
  50
  51     def __exit__(self, exc_type, exc_value, traceback):
  52         self.deinit()
  53
  54     def scan(self):
  55         return self._i2c.scan()
  56
  57     def readfrom_into(self, address, buffer, *, start=0, end=None):
  58         if start is not 0 or end is not None:
  59             if end is None:
  60                 end = len(buffer)
  61             buffer = memoryview(buffer)[start:end]
  62         stop = True  # remove for efficiency later
  63         return self._i2c.readfrom_into(address, buffer, stop=stop)
  64
  65     def writeto(self, address, buffer, *, start=0, end=None, stop=True):
  66         if isinstance(buffer, str):
  67             buffer = bytes([ord(x) for x in buffer])
  68         if start is not 0 or end is not None:
  69             if end is None:
  70                 return self._i2c.writeto(address, memoryview(buffer)[start:], stop=stop)
  71             else:
  72                 return self._i2c.writeto(address, memoryview(buffer)[start:end], stop=stop)
  73         return self._i2c.writeto(address, buffer, stop=stop)
  74
  75     def writeto_then_readfrom(self, address, buffer_out, buffer_in, *, out_start=0, out_end=None, in_start=0, in_end=None, stop=False):
  76         return self._i2c.writeto_then_readfrom(address, buffer_out, buffer_in,
  77                                                out_start=out_start, out_end=out_end,
  78                                                in_start=in_start, in_end=in_end, stop=stop)
  79
  80 class SPI(Lockable):
  81     def __init__(self, clock, MOSI=None, MISO=None):
  82         self.deinit()
  83         if board_id in EMBEDDED_LINUX_BOARDS:
  84             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
  85         else:
  86             from machine import SPI as _SPI
  87         from microcontroller.pin import spiPorts
  88         for portId, portSck, portMosi, portMiso in spiPorts:
  89             if ((clock == portSck) and                   # Clock is required!
  90                 (MOSI == portMosi or MOSI == None) and   # But can do with just output
  91                 (MISO == portMiso or MISO == None)):      # Or just input
  92                 self._spi = _SPI(portId)
  93                 self._pins = (portSck, portMosi, portMiso)
  94                 break
  95         else:
  96             raise NotImplementedError(
  97                 "No Hardware SPI on (SCLK, MOSI, MISO)={}\nValid SPI ports:{}".
  98                 format((clock, MOSI, MISO), spiPorts))
  99
 100     def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):
 101         if board_id in ap_board.ANY_RASPBERRY_PI_2_OR_3:
 102             from adafruit_blinka.microcontroller.bcm283x.pin import Pin
 103             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 104         elif board_id == ap_board.BEAGLEBONE_BLACK:
 105             from adafruit_blinka.microcontroller.am335x.pin import Pin
 106             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 107         elif board_id == ap_board.ORANGEPI_PC:
 108             from adafruit_blinka.microcontroller.allwinner_h3.pin import Pin
 109             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 110         else:
 111             from machine import SPI as _SPI
 112             from machine import Pin
 113
 114         if self._locked:
 115             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
 116             self._spi.init(
 117                 baudrate=baudrate,
 118                 polarity=polarity,
 119                 phase=phase,
 120                 bits=bits,
 121                 firstbit=_SPI.MSB,
 122                 sck=Pin(self._pins[0].id),
 123                 mosi=Pin(self._pins[1].id),
 124                 miso=Pin(self._pins[2].id)
 125             )
 126         else:
 127             raise RuntimeError("First call try_lock()")
 128
 129     def deinit(self):
 130         self._spi = None
 131         self._pinIds = None
 132
 133     def write(self, buf, start=0, end=None):
 134         return self._spi.write(buf, start, end)
 135
 136     def readinto(self, buf, start=0, end=None, write_value=0):
 137         return self._spi.readinto(buf, start, end)
 138
 139     def write_readinto(self, buffer_out, buffer_in,  out_start=0, out_end=None, in_start=0, in_end=None):
 140         return self._spi.write_readinto(buffer_out, buffer_in, out_start, out_end, in_start, in_end)
 141
 142
 143 class UART(Lockable):
 144     class Parity(Enum):
 145         pass
 146
 147     Parity.ODD = Parity()
 148     Parity.EVEN = Parity()
 149
 150     def __init__(self,
 151                  tx,
 152                  rx,
 153                  baudrate=9600,
 154                  bits=8,
 155                  parity=None,
 156                  stop=1,
 157                  timeout=1000,
 158                  receiver_buffer_size=64,
 159                  flow=None):
 160         from machine import UART as _UART
 161         from microcontroller.pin import uartPorts
 162
 163         self.baudrate = baudrate
 164
 165         if flow is not None:  # default 0
 166             raise NotImplementedError(
 167                 "Parameter '{}' unsupported on {}".format(
 168                     "flow", agnostic.board_id))
 169
 170         # translate parity flag for Micropython
 171         if parity is UART.Parity.ODD:
 172             parity = 1
 173         elif parity is UART.Parity.EVEN:
 174             parity = 0
 175         elif parity is None:
 176             pass
 177         else:
 178             raise ValueError("Invalid parity")
 179
 180         # check tx and rx have hardware support
 181         for portId, portTx, portRx in uartPorts:  #
 182             if portTx == tx and portRx == rx:
 183                 self._uart = _UART(
 184                     portId,
 185                     baudrate,
 186                     bits=bits,
 187                     parity=parity,
 188                     stop=stop,
 189                     timeout=timeout,
 190                     read_buf_len=receiver_buffer_size
 191                 )
 192                 break
 193         else:
 194             raise NotImplementedError(
 195                 "No Hardware UART on (tx,rx)={}\nValid UART ports: {}".format((tx, rx), uartPorts)
 196             )
 197
 198     def deinit(self):
 199         self._uart = None
 200
 201     def read(self, nbytes=None):
 202         return self._uart.read(nbytes)
 203
 204     def readinto(self, buf, nbytes=None):
 205         return self._uart.readinto(buf, nbytes)
 206
 207     def readline(self):
 208         return self._uart.readline()
 209
 210     def write(self, buf):
 211         return self._uart.write(buf)