sdwire 0.1.1__py3-none-any.whl → 0.2.0__py3-none-any.whl

sdwire/backend/detect.py

@@ -0,0 +1,68 @@
+import logging
+from typing import List
+from adafruit_board_toolkit import circuitpython_serial as cpserial
+from serial.tools.list_ports_common import ListPortInfo
+
+from sdwire import constants
+from .device.sdwire import SDWire
+from .device.sdwirec import SDWireC
+from .device.usb_device import PortInfo
+
+import usb.core
+import usb.util
+from usb.core import Device
+
+log = logging.getLogger(__name__)
+
+
+def get_sdwirec_devices() -> List[SDWireC]:
+    devices: List[Device] = usb.core.find(find_all=True)
+    if not devices:
+        log.info("no usb devices found while searching for SDWireC..")
+        return []
+
+    device_list = []
+    for device in devices:
+        product = None
+        serial = None
+        manufacturer = None
+        try:
+            product = device.product
+            serial = device.serial_number
+            manufacturer = device.manufacturer
+        except Exception as e:
+            log.debug(
+                "not able to get usb product, serial_number and manufacturer information, err: %s",
+                e,
+            )
+
+        # filter with product string to allow non Badger'd sdwire devices to be detected
+        if product == constants.SDWIREC_PRODUCT_STRING:
+            device_list.append(
+                SDWireC(port_info=PortInfo(None, product, manufacturer, serial, device))
+            )
+
+    return device_list
+
+
+def get_sdwire_devices() -> List[SDWire]:
+    ports = cpserial.data_comports()
+
+    # Badgerd SDWire Gen2
+    # VID = 0x1209 PID = 0x2404
+    # Badgerd SDWireC
+    # VID = 0x04e8 PID = 0x6001
+    result = []
+    for p in ports:
+        if p.vid == constants.SDWIRE_GEN2_VID and p.pid == constants.SDWIRE_GEN2_PID:
+            result.append(
+                SDWire(
+                    port_info=PortInfo(
+                        p.device, p.product, p.manufacturer, p.serial_number, p
+                    )
+                )
+            )
+    # Search for legacy SDWireC devices
+    legacy_devices = get_sdwirec_devices()
+
+    return result + legacy_devices

sdwire/backend/device/sdwire.py

@@ -0,0 +1,25 @@
+from serial import Serial
+from .usb_device import USBDevice, PortInfo
+
+
+class SDWire(USBDevice):
+
+    def __init__(self, port_info: PortInfo):
+        super().__init__(port_info)
+
+    @property
+    def serial_string(self) -> str:
+        return "sdwire_gen2_101"
+
+    def invoke(self, command: str) -> None:
+        with Serial(self.dev_string) as channel:
+            channel.timeout = 0.05
+            data = command.encode() + b"\n"
+            print(f"data={data}")
+            channel.write(data)
+
+    def __str__(self):
+        return f"{self.serial_string}\t\t[{self.product_string}::{self.manufacturer_string}]"
+
+    def __repr__(self):
+        return self.__str__()

sdwire/backend/device/sdwirec.py

@@ -0,0 +1,40 @@
+import logging
+from pyftdi.ftdi import Ftdi
+from serial import Serial
+from .usb_device import USBDevice, PortInfo
+
+log = logging.getLogger(__name__)
+
+
+class SDWireC(USBDevice):
+
+    def __init__(self, port_info: PortInfo):
+        super().__init__(port_info)
+
+    def __str__(self):
+        return (
+            f"{self.serial_string}\t[{self.product_string}::{self.manufacturer_string}]"
+        )
+
+    def __repr__(self):
+        return self.__str__()
+
+    def switch_ts(self):
+        self._set_sdwire(1)
+
+    def switch_dut(self):
+        self._set_sdwire(0)
+
+    def _set_sdwire(self, target):
+        try:
+            ftdi = Ftdi()
+            ftdi.open_from_device(self.usb_device)
+            log.info(f"Set CBUS to 0x{0xF0 | target:02X}")
+            ftdi.set_bitmode(0xF0 | target, Ftdi.BitMode.CBUS)
+            ftdi.close()
+        except Exception as e:
+            import sys
+
+            log.debug("error while updating ftdi device", exc_info=1)
+            print("couldnt switch sdwire device")
+            sys.exit(1)

sdwire/backend/device/usb_device.py

@@ -0,0 +1,33 @@
+from collections import namedtuple
+from serial.tools.list_ports_common import ListPortInfo
+
+PortInfo = namedtuple(
+    "PortInfo", ("device", "product", "manufacturer", "serial", "usb_device")
+)
+
+
+class USBDevice:
+    __port_info = None
+
+    def __init__(self, port_info: PortInfo):
+        self.__port_info = port_info
+
+    @property
+    def usb_device(self):
+        return self.__port_info.usb_device
+
+    @property
+    def dev_string(self) -> str:
+        return self.__port_info.device
+
+    @property
+    def product_string(self) -> str:
+        return self.__port_info.product
+
+    @property
+    def manufacturer_string(self) -> str:
+        return self.__port_info.manufacturer
+
+    @property
+    def serial_string(self) -> str:
+        return self.__port_info.serial

sdwire/backend/utils.py

@@ -0,0 +1,56 @@
+import sys
+import logging
+import click
+from .device.sdwire import SDWire
+from .device.sdwirec import SDWireC
+from . import detect
+
+log = logging.getLogger(__name__)
+
+
+def handle_switch_host_command(ctx):
+    device = ctx.obj["device"]
+    if isinstance(device, SDWireC):
+        device.switch_ts()
+
+
+def handle_switch_target_command(ctx):
+    device = ctx.obj["device"]
+    if isinstance(device, SDWireC):
+        device.switch_dut()
+
+
+def handle_switch_off_command(ctx):
+    device = ctx.obj["device"]
+    if isinstance(device, SDWireC):
+        log.info("SDWireC or legacy sdwire devices dont have off functionality")
+        print("SDWireC dont have off functionality")
+        sys.exit(1)
+
+
+def handle_switch_command(ctx, serial):
+    devices = detect.get_sdwire_devices()
+
+    if serial is None:
+        # check the devices
+        if len(devices) == 0:
+            raise click.UsageError("There is no sdwire device connected!")
+        if len(devices) > 1:
+            raise click.UsageError(
+                "There is more then 1 sdwire device connected, please use --serial|-s to specify!"
+            )
+        log.info("1 sdwire/sdwirec device detected")
+        ctx.obj["device"] = devices[0]
+    else:
+        for device in devices:
+            if device.serial_string == serial:
+                ctx.obj["device"] = device
+                break
+        else:
+            raise click.UsageError(
+                f"There is no such sdwire device connected with serial={serial}"
+            )
+
+    device = ctx.obj["device"]
+    if isinstance(device, SDWire):
+        device.invoke(" ".join(sys.argv[1:]))

main.py → sdwire/main.py

@@ -1,8 +1,8 @@
 #!/usr/bin/env python
 import click
-from backend import utils
-from backend import detect
-from backend.device.sdwire import SDWire
+from .backend import utils
+from .backend import detect
+from .backend.device.sdwire import SDWire
 
 
 @click.group()

{sdwire-0.1.1.dist-info → sdwire-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sdwire
-Version: 0.1.1
+Version: 0.2.0
 Summary: CLI application to interact with Badgerd SDWire Gen2 devices
 License: GPL-3
 Author: Talha Can Havadar
@@ -56,3 +56,45 @@ Commands:
   ts      ts/host => connects the sdcard interface to host machine
 ```
 
+## Listing SDWire Devices
+
+`sdwire list` command will search through usb devices connected to the system
+and prints out the list of gen2 and legacy devices.
+
+```
+❯ sdwire list
+Serial			Product Info
+sdwire_gen2_101		[SDWire-Gen2::Badgerd Technologies]
+bdgrd_sdwirec_522	[sd-wire::SRPOL]
+```
+
+## Switching SD Card Connection
+
+`sdwire switch` command switches the sd card connection to specified direction.
+If there is more than one sdwire connected to then you need specify which sdwire
+you want to alter with `--serial` or `-s` options.
+
+If there is only one sdwire connected then you dont need to specify the serial,
+it will pick the one connected automatically. See the examples below.
+
+```
+❯ sdwire list
+Serial			Product Info
+sdwire_gen2_101		[SDWire-Gen2::Badgerd Technologies]
+bdgrd_sdwirec_522	[sd-wire::SRPOL]
+
+❯ sdwire switch -s bdgrd_sdwirec_522 target
+
+❯ sdwire switch target
+Usage: sdwire switch [OPTIONS] COMMAND [ARGS]...
+Try 'sdwire switch --help' for help.
+
+Error: There is more then 1 sdwire device connected, please use --serial|-s to specify!
+
+❯ sdwire list
+Serial			Product Info
+bdgrd_sdwirec_522	[sd-wire::SRPOL]
+
+❯ sdwire switch host
+```
+

sdwire-0.2.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+sdwire/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sdwire/backend/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sdwire/backend/detect.py,sha256=3iSPiG0fLjxCp5sSJ6D4AO39P2wypHY4nApsJWYgCyI,2024
+sdwire/backend/device/sdwire.py,sha256=Cl1WSWdH9Zr9D0bH5g7jz_rTqJiS5KVydJfV83GUEbg,675
+sdwire/backend/device/sdwirec.py,sha256=BZXvCq3bmJzzA5seCVOYIdmr6FBeAreE95_n-2kiuMQ,1035
+sdwire/backend/device/usb_device.py,sha256=6Mt24B22yTD4RdY24LgnRaVtbX60EPE2SAK-pN0ZESc,775
+sdwire/backend/utils.py,sha256=ruOZJTPVtTKaQOLP-FylHAb67ygoCJ-o2ug8XjQUr44,1615
+sdwire/constants.py,sha256=Ip2d7ow5Nj0nO0OyHeiXuGJJcK33BGmTspLtNEduFAo,127
+sdwire/main.py,sha256=ndbRoCkSckItLDH0q3zacC0mqfa0ZL-TJGDkIGJKrBU,2138
+sdwire-0.2.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+sdwire-0.2.0.dist-info/METADATA,sha256=R1n5WrLSXVDYUTMyhuTrNnIZL71CP8EsYMtUrDEG6nQ,3010
+sdwire-0.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+sdwire-0.2.0.dist-info/entry_points.txt,sha256=pxy0zJKVcNWXPk5PtNjTLExOBpqFNth37wtdYdYRXCE,43
+sdwire-0.2.0.dist-info/RECORD,,

sdwire-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+sdwire=sdwire:main.main
+

__init__.py

@@ -1 +0,0 @@
-print(__file__)

sdwire-0.1.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-__init__.py,sha256=F67sqTglxRRS7eDtAnZ4JXt3DqT0l7tEvUMbM75n-Dg,16
-constants.py,sha256=Ip2d7ow5Nj0nO0OyHeiXuGJJcK33BGmTspLtNEduFAo,127
-main.py,sha256=adVUleGCnEEQp2MakaD1t3muaevxH8W74rpJGxuX98o,2135
-sdwire-0.1.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-sdwire-0.1.1.dist-info/METADATA,sha256=8Pd6_omUvK9txgweNZsgVwVl2CJ6zArCaArsrOega6o,1839
-sdwire-0.1.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-sdwire-0.1.1.dist-info/entry_points.txt,sha256=OCGskaVs56CWHqKFr0_vFxqMv039fWVeAizS8-TTcZ0,36
-sdwire-0.1.1.dist-info/RECORD,,

sdwire-0.1.1.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-sdwire=main:main
-