X-Git-Url: https://git.ayoreis.com/Adafruit_Blinka-hackapet.git/blobdiff_plain/a3770186a94117be56a8d9a8038a2d540bd2884c..de082d32a6a103f50b65b072250b127a94113a6d:/src/busio.py diff --git a/src/busio.py b/src/busio.py index e95a44e..1cad051 100755 --- a/src/busio.py +++ b/src/busio.py @@ -7,36 +7,53 @@ See `CircuitPython:busio` in CircuitPython for more details. * Author(s): cefn """ -import threading +try: + import threading +except ImportError: + threading = None -from adafruit_blinka import Enum, Lockable, agnostic -from adafruit_blinka.agnostic import board_id, detector import adafruit_platformdetect.constants.boards as ap_board import adafruit_platformdetect.constants.chips as ap_chip +from adafruit_blinka import Enum, Lockable, agnostic +from adafruit_blinka.agnostic import board_id, detector + +# pylint: disable=import-outside-toplevel,too-many-branches,too-many-statements +# pylint: disable=too-many-arguments,too-many-function-args class I2C(Lockable): + """ + Busio I2C Class for CircuitPython Compatibility. Used + for both MicroPython and Linux. + """ + def __init__(self, scl, sda, frequency=400000): self.init(scl, sda, frequency) def init(self, scl, sda, frequency): + """Initialization""" self.deinit() if detector.board.ftdi_ft232h: - from adafruit_blinka.microcontroller.ft232h.i2c import I2C + from adafruit_blinka.microcontroller.ft232h.i2c import I2C as _I2C - self._i2c = I2C(frequency=frequency) + self._i2c = _I2C(frequency=frequency) return - elif detector.board.binho_nova: - from adafruit_blinka.microcontroller.nova.i2c import I2C + if detector.board.binho_nova: + from adafruit_blinka.microcontroller.nova.i2c import I2C as _I2C - self._i2c = I2C(frequency=frequency) + self._i2c = _I2C(frequency=frequency) return - elif detector.board.microchip_mcp2221: - from adafruit_blinka.microcontroller.mcp2221.i2c import I2C + if detector.board.microchip_mcp2221: + from adafruit_blinka.microcontroller.mcp2221.i2c import I2C as _I2C - self._i2c = I2C(frequency=frequency) + self._i2c = _I2C(frequency=frequency) return - elif detector.board.any_embedded_linux: + if detector.board.greatfet_one: + from adafruit_blinka.microcontroller.nxp_lpc4330.i2c import I2C as _I2C + + self._i2c = _I2C(frequency=frequency) + return + if detector.board.any_embedded_linux: from adafruit_blinka.microcontroller.generic_linux.i2c import I2C as _I2C else: from machine import I2C as _I2C @@ -55,27 +72,32 @@ class I2C(Lockable): (scl, sda), i2cPorts ) ) - - self._lock = threading.RLock() + if threading is not None: + self._lock = threading.RLock() def deinit(self): + """Deinitialization""" try: del self._i2c except AttributeError: pass def __enter__(self): - self._lock.acquire() + if threading is not None: + self._lock.acquire() return self def __exit__(self, exc_type, exc_value, traceback): - self._lock.release() + if threading is not None: + self._lock.release() self.deinit() def scan(self): + """Scan for attached devices""" return self._i2c.scan() def readfrom_into(self, address, buffer, *, start=0, end=None): + """Read from a device at specified address into a buffer""" if start != 0 or end is not None: if end is None: end = len(buffer) @@ -84,15 +106,13 @@ class I2C(Lockable): return self._i2c.readfrom_into(address, buffer, stop=stop) def writeto(self, address, buffer, *, start=0, end=None, stop=True): + """Write to a device at specified address from a buffer""" if isinstance(buffer, str): buffer = bytes([ord(x) for x in buffer]) if start != 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, memoryview(buffer)[start:end], stop=stop) return self._i2c.writeto(address, buffer, stop=stop) def writeto_then_readfrom( @@ -107,6 +127,9 @@ class I2C(Lockable): in_end=None, stop=False ): + """ "Write to a device at specified address from a buffer then read + from a device at specified address into a buffer + """ return self._i2c.writeto_then_readfrom( address, buffer_out, @@ -120,6 +143,11 @@ class I2C(Lockable): class SPI(Lockable): + """ + Busio SPI Class for CircuitPython Compatibility. Used + for both MicroPython and Linux. + """ + def __init__(self, clock, MOSI=None, MISO=None): self.deinit() if detector.board.ftdi_ft232h: @@ -129,14 +157,21 @@ class SPI(Lockable): self._spi = _SPI() self._pins = (SCK, MOSI, MISO) return - elif detector.board.binho_nova: + if detector.board.binho_nova: from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI from adafruit_blinka.microcontroller.nova.pin import SCK, MOSI, MISO self._spi = _SPI(clock) self._pins = (SCK, MOSI, MISO) return - elif detector.board.any_embedded_linux: + if detector.board.greatfet_one: + from adafruit_blinka.microcontroller.nxp_lpc4330.spi import SPI as _SPI + from adafruit_blinka.microcontroller.nxp_lpc4330.pin import SCK, MOSI, MISO + + self._spi = _SPI() + self._pins = (SCK, MOSI, MISO) + return + if detector.board.any_embedded_linux: from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI else: from machine import SPI as _SPI @@ -145,8 +180,8 @@ class SPI(Lockable): for portId, portSck, portMosi, portMiso in spiPorts: if ( (clock == portSck) - and (MOSI == portMosi or MOSI == None) # Clock is required! - and (MISO == portMiso or MISO == None) # But can do with just output + and MOSI in (portMosi, None) # Clock is required! + and MISO in (portMiso, None) # But can do with just output ): # Or just input self._spi = _SPI(portId) self._pins = (portSck, portMosi, portMiso) @@ -159,6 +194,7 @@ class SPI(Lockable): ) def configure(self, baudrate=100000, polarity=0, phase=0, bits=8): + """Update the configuration""" if detector.board.any_raspberry_pi or detector.board.any_raspberry_pi_40_pin: from adafruit_blinka.microcontroller.bcm283x.pin import Pin from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI @@ -180,6 +216,9 @@ class SPI(Lockable): elif board_id == ap_board.ODROID_C4: from adafruit_blinka.microcontroller.amlogic.s905x3.pin import Pin from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI + elif board_id == ap_board.ODROID_XU4: + from adafruit_blinka.microcontroller.samsung.exynos5422.pin import Pin + from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI elif board_id == ap_board.DRAGONBOARD_410C: from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI @@ -198,6 +237,9 @@ class SPI(Lockable): elif board_id == ap_board.JETSON_NX: from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI from adafruit_blinka.microcontroller.tegra.t194.pin import Pin + elif detector.board.ROCK_PI_S: + from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI + from adafruit_blinka.microcontroller.rockchip.rk3308.pin import Pin elif detector.board.SIFIVE_UNLEASHED: from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI from adafruit_blinka.microcontroller.hfu540.pin import Pin @@ -207,11 +249,10 @@ class SPI(Lockable): elif detector.board.binho_nova: from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI from adafruit_blinka.microcontroller.nova.pin import Pin - elif ( - board_id == ap_board.PINE64 - or board_id == ap_board.PINEBOOK - or board_id == ap_board.PINEPHONE - ): + elif detector.board.greatfet_one: + from adafruit_blinka.microcontroller.nxp_lpc4330.spi import SPI as _SPI + from adafruit_blinka.microcontroller.nxp_lpc4330.pin import Pin + elif board_id in (ap_board.PINE64, ap_board.PINEBOOK, ap_board.PINEPHONE): from adafruit_blinka.microcontroller.allwinner.a64.pin import Pin from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI elif board_id == ap_board.CLOCKWORK_CPI3: @@ -240,35 +281,47 @@ class SPI(Lockable): raise RuntimeError("First call try_lock()") def deinit(self): + """Deinitialization""" self._spi = None self._pinIds = None @property def frequency(self): + """Return the baud rate if implemented""" try: return self._spi.frequency except AttributeError: raise NotImplementedError( "Frequency attribute not implemented for this platform" - ) + ) from AttributeError def write(self, buf, start=0, end=None): + """Write to the SPI device""" return self._spi.write(buf, start, end) def readinto(self, buf, start=0, end=None, write_value=0): + """Read from the SPI device into a buffer""" return self._spi.readinto(buf, start, end, write_value=write_value) def write_readinto( self, buffer_out, buffer_in, out_start=0, out_end=None, in_start=0, in_end=None ): + """Write to the SPI device and read from the SPI device into a buffer""" return self._spi.write_readinto( buffer_out, buffer_in, out_start, out_end, in_start, in_end ) class UART(Lockable): + """ + Busio UART Class for CircuitPython Compatibility. Used + for MicroPython and a few other non-Linux boards. + """ + class Parity(Enum): - pass + """Parity Enumeration""" + + pass # pylint: disable=unnecessary-pass Parity.ODD = Parity() Parity.EVEN = Parity() @@ -289,8 +342,10 @@ class UART(Lockable): raise RuntimeError( "busio.UART not supported on this platform. Please use pyserial instead." ) - elif detector.board.binho_nova: + if detector.board.binho_nova: from adafruit_blinka.microcontroller.nova.uart import UART as _UART + elif detector.board.greatfet_one: + from adafruit_blinka.microcontroller.nxp_lpc4330.uart import UART as _UART else: from machine import UART as _UART @@ -337,18 +392,56 @@ class UART(Lockable): ) def deinit(self): + """Deinitialization""" if detector.board.binho_nova: self._uart.deinit() self._uart = None def read(self, nbytes=None): + """Read from the UART""" return self._uart.read(nbytes) def readinto(self, buf, nbytes=None): + """Read from the UART into a buffer""" return self._uart.readinto(buf, nbytes) def readline(self): + """Read a line of characters up to a newline charater from the UART""" return self._uart.readline() def write(self, buf): + """Write to the UART from a buffer""" return self._uart.write(buf) + + +class OneWire: + """ + Stub class for OneWire, which is currently not implemented + """ + + def __init__(self, pin): + raise NotImplementedError("OneWire has not been implemented") + + def deinit(self): + """ + Deinitialize the OneWire bus and release any hardware resources for reuse. + """ + raise NotImplementedError("OneWire has not been implemented") + + def reset(self): + """ + Reset the OneWire bus and read presence + """ + raise NotImplementedError("OneWire has not been implemented") + + def read_bit(self): + """ + Read in a bit + """ + raise NotImplementedError("OneWire has not been implemented") + + def write_bit(self, value): + """ + Write out a bit based on value. + """ + raise NotImplementedError("OneWire has not been implemented")