oep-client-python 0.0.3__py3-none-any.whl → 0.0.4__py3-none-any.whl

oep_client/__init__.py

@@ -2,4 +2,4 @@
 
 __all__ = ["__version__"]
 
-__version__ = "0.0.3"
+__version__ = "0.0.4"

oep_client/__main__.py

@@ -4,6 +4,7 @@
   oep config show <probe>
   oep config slot <probe> --name x035 --wire rvswd --pins 2,54 --attach at-boot --retry 1 --mechanism dmseq
   oep config bind <probe> --port 1 --mode last-reset --stream slot:x035
+  oep config plan <probe> oep.fixture.uart#2 rx=48 tx=49       (the fn's whole plan; fn number or name#instance)
   oep config remove <probe> bind 1        oep config save <probe>        oep config erase <probe>
 
 <probe>: a serial port, tcp://HOST:PORT or usb[:VID:PID[:SERIAL]]. A change takes the lock (owner "oep config") and
@@ -58,7 +59,7 @@ def _config_parser(sub) -> None:
     slot.add_argument("probe")
     slot.add_argument("--slot", type=int, default=0, help="the slot number (default 0)")
     slot.add_argument("--name", required=True, help="1-32 of a-z 0-9 - _ (the oep://<probe>/<name> address)")
-    slot.add_argument("--wire", default="rvswd", help="rvswd or swio (or an fn)")
+    slot.add_argument("--wire", help="rvswd or swio (or an fn); default: the probe's only wire")
     slot.add_argument("--pins", help="swdio,swclk (one pin on swio); default: the wire's only pin set")
     slot.add_argument("--attach", choices=sorted(config.ATTACH), default="host")
     slot.add_argument("--retry", type=int, default=0, help="at-boot: try again every N s while absent (0: never)")
@@ -72,6 +73,21 @@ def _config_parser(sub) -> None:
     bind.add_argument("--stream", action="append", required=True, help="slot:NAME, slot:N or uart:FN (repeatable)")
     bind.add_argument("--select", type=int, default=0, help="manual: the stream it carries (index in --stream)")
     bind.add_argument("--save", action="store_true")
+    plan = cs.add_parser("plan", help="the pins an interface keeps (its whole plan, kept as a setting)")
+    plan.add_argument("probe")
+    plan.add_argument("fn", help="an fn, or an interface name with #k for its k-th instance (1 = the first)")
+    plan.add_argument("roles", nargs="+", help="ROLE=CHANNEL, ROLE a number or the interface's role name (rx, tx, line...)")
+    plan.add_argument("--save", action="store_true")
+    label = cs.add_parser("label", help="name a channel (shown in oep.core's describe)")
+    label.add_argument("probe")
+    label.add_argument("channel", type=int)
+    label.add_argument("text")
+    label.add_argument("--save", action="store_true")
+    idle = cs.add_parser("idle", help="the state of a free pin")
+    idle.add_argument("probe")
+    idle.add_argument("channel", type=int)
+    idle.add_argument("mode", choices=sorted(config.IDLE))
+    idle.add_argument("--save", action="store_true")
     rm = cs.add_parser("remove", help="remove one item: slot N, bind PORT, plan FN, label CH, idle CH")
     rm.add_argument("probe")
     rm.add_argument("kind", choices=["slot", "bind", "plan", "label", "idle"])
@@ -95,8 +111,40 @@ def _pins(hst, fn: int, text: str | None, wire: str) -> tuple[int, int]:
     return groups[0]
 
 
-def _wire_fn(hst, wire: str) -> int:
-    return int(wire) if wire.isdigit() else core.find(hst, wire if wire.startswith("oep.") else f"oep.wire.{wire}")
+def _plan_fn(hst, spec: str) -> tuple[int, dict[str, int]]:
+    """fn and its role names (from the registry) for `spec`: an fn number, or name[#k] (k-th instance, 1-based)."""
+    from . import registry as reg
+    if spec.isdigit():
+        fn = int(spec)
+        name = next((e.name for e in core.list_entries(hst) if e.fn == fn), "")
+    else:
+        name, _, k = spec.partition("#")
+        fns = core.find_all(hst, name)
+        if not fns:
+            raise SystemExit(f"the probe offers no {name}")
+        index = int(k) - 1 if k else 0
+        if not 0 <= index < len(fns):
+            raise SystemExit(f"{name}: {len(fns)} instance(s), fns {fns}")
+        fn = fns[index]
+    iface = reg.INTERFACES.get(name)
+    roles = dict(iface.enum.get("role", {})) if iface else {}
+    return fn, roles
+
+
+def _wire_fn(hst, wire: str | None) -> int:
+    if wire is None:
+        wires = [e for e in core.list_entries(hst, "oep.wire") if e.name in ("oep.wire.rvswd", "oep.wire.swio")]
+        if len(wires) != 1:
+            raise SystemExit("this probe has " + (", ".join(f"{e.name} (fn {e.fn})" for e in wires) or "no RISC-V wire")
+                             + ": name one with --wire")
+        return wires[0].fn
+    name = wire if wire.startswith("oep.") else f"oep.wire.{wire}"
+    if wire.isdigit():
+        return int(wire)
+    try:
+        return core.find(hst, name)
+    except LookupError:
+        raise SystemExit(f"this probe does not offer {name}") from None
 
 
 def _stream(spec: str, slots: dict[str, int]) -> tuple[str, int]:
@@ -129,6 +177,7 @@ def _config(args) -> int:
             return _show(hst, cfg, args.json)
         if args.action == "slot":
             fn = _wire_fn(hst, args.wire)
+            args.wire = args.wire or str(fn)
             lock = None
             if args.lock:
                 mask, _, value = args.lock.partition(":")
@@ -140,6 +189,22 @@ def _config(args) -> int:
             slots = {it.name: it.slot for it in cfg.items() if isinstance(it, config.Slot)}
             it = config.Bind(args.port, args.mode, [_stream(s, slots) for s in args.stream], args.select)
             _change(hst, cfg, [it], args.save)
+        elif args.action == "plan":
+            fn, roles = _plan_fn(hst, args.fn)
+            items = []
+            for spec in args.roles:
+                role, _, ch = spec.partition("=")
+                if not ch:
+                    raise SystemExit(f"{spec}: want ROLE=CHANNEL")
+                number = int(role) if role.isdigit() else roles.get(role.lower())
+                if number is None:
+                    raise SystemExit(f"{role}: not a role of fn {fn} (roles: {', '.join(sorted(roles)) or 'numbers only'})")
+                items.append(config.Plan(fn, number, int(ch, 0)))
+            _change(hst, cfg, items, args.save)
+        elif args.action == "label":
+            _change(hst, cfg, [config.Label(args.channel, args.text)], args.save)
+        elif args.action == "idle":
+            _change(hst, cfg, [config.Idle(args.channel, args.mode)], args.save)
         elif args.action == "remove":
             _change(hst, cfg, [config.remove(args.kind, args.key)], args.save)
         else:

oep_client/fake_serial.py

@@ -5,7 +5,8 @@
 
 - a candidate runs from a 0x00 to the next 0x00; if it decodes and its CRC matches it is a request, otherwise it
   (with its leading 0x00) is raw bytes, and the closing 0x00 starts the next candidate; bytes outside a candidate
-  are raw at once; a candidate that stops for 200 ms (`tick`) is raw; an empty candidate (0x00 0x00) is nothing
+  are raw at once; a candidate that stops for 200 ms (`tick`) is raw; a candidate that is only its 0x00 (0x00 0x00,
+  or the closing 0x00 of a frame when nothing follows) is nothing
 - raw bytes go to the endpoint's bind for this port (`Endpoint.port_input`)
 - answers go out as 0x00 <COBS> 0x00, ahead of raw chunks (`Endpoint.port_output`); one writer, never a raw byte
   inside a frame
@@ -80,7 +81,8 @@ class FakeSerialPort:
     def _gap(self, now: int) -> None:
         if self.cand is not None and now - self.last_ms >= GAP_MS:
             raw, self.cand = bytes(self.cand), None
-            self._raw(bytearray(raw))
+            if len(raw) > 1:                         # only its 0x00: a delimiter (a frame's closing 0x00), not raw
+                self._raw(bytearray(raw))
 
     def _raw(self, raw: bytearray) -> None:
         if raw:

{oep_client_python-0.0.3.dist-info → oep_client_python-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: oep-client-python
-Version: 0.0.3
+Version: 0.0.4
 Summary: Open Embedded Probe (OEP) v1 host: serial / USB / TCP transports, the session rules, the standard interfaces, and a fake probe
 Project-URL: Homepage, https://github.com/Open-Embedded-Probe/oep-client-python
 Project-URL: Repository, https://github.com/Open-Embedded-Probe/oep-client-python

{oep_client_python-0.0.3.dist-info → oep_client_python-0.0.4.dist-info}/RECORD

@@ -1,5 +1,5 @@
-oep_client/__init__.py,sha256=3ghnlprMZ1C37XShRP-aKKubXhCXuoHsf8alRiJXv54,163
-oep_client/__main__.py,sha256=5uaqPAP6hcv74-7O4cyk0monyu1b8yuU3yISBYXDq5w,10849
+oep_client/__init__.py,sha256=F5if_qpFrTQuYzjKnNr2nZ1QRiCVH8b_c43b3GQbvmQ,163
+oep_client/__main__.py,sha256=Ta7D7jhtg5IhFWuI3KTikbDNYazh9QKCH3FtMMnDMjg,14143
 oep_client/arm.py,sha256=JLyUhLSPcmsk73schZcaJYoOKuHzrvnU8kPmfrEvVuo,12331
 oep_client/capture.py,sha256=RZgDnWqr8Aqy49U7PqQpnKIQEL18djVuDJFydxrmv-c,17996
 oep_client/catalog.py,sha256=EqAQnSgHFxGbCO2GQ_Ee-uheJKbBBUUpL1-0qHfNMXU,6574
@@ -13,7 +13,7 @@ oep_client/dump.py,sha256=GAnmu2abuDmGmbWcbbEfC3EUuPp5Hady9vQVNcQ-724,6743
 oep_client/endpoint.py,sha256=70eFSDQuu-UffiuooF74e9kS33dhE4DyJeC7yllRR7Y,72248
 oep_client/esp32_targets.py,sha256=b8tNH-nb2KC-XgNfWg5l3TO0cyhZOF-gJajaVxNVSGQ,4988
 oep_client/fake.py,sha256=UzpB-A42Ma2QqJj0l-JmwCJkMn6DPVHHN77fcemT59U,13104
-oep_client/fake_serial.py,sha256=6fhtrit9kWix-D83yYfUKFLHJ11pEiMDrlKNeJKvCfU,4314
+oep_client/fake_serial.py,sha256=uKl0UNcifhdeykQtm8gnRRhqV7TT4vPwBFuBhbf-9BI,4504
 oep_client/fake_serve.py,sha256=dIuYxhlAixSb8_OQ4b4UXTkWqW5Tpf_F9uuqMNWn0F4,14612
 oep_client/fixture.py,sha256=653hCD-Iz0Lfs8dT4Hdg3QyubbbOGs1_xjq_3nb8foU,5564
 oep_client/frames.py,sha256=xjgjnXmXUqNJZ5m0h91r4Cy48WoVK1mEMW4gRg-mlMI,3991
@@ -29,8 +29,8 @@ oep_client/rp2350.py,sha256=7OMyj270k3AY1e3-ljicPwOjf9jOlokbT6QNkA0b0yY,4227
 oep_client/target.py,sha256=R8BvYfFfYNhZF0MysJkNb8b69YgBlmeGXNX8ReZIe5k,1068
 oep_client/uiapduino.py,sha256=IEPG3LbZPksi8g3wmAf6T0CRWSfYKW1_qrH_GBVQdxY,6090
 oep_client/usb_stream.py,sha256=1nvuRNLQkpp8054eG-JutBKh9y0F_8PHGDAfG0ZSbaY,8819
-oep_client_python-0.0.3.dist-info/METADATA,sha256=GdLtSyD2YzfeWvDBKGNI_40MyqUD4ygzDccoNXYaCF0,7359
-oep_client_python-0.0.3.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-oep_client_python-0.0.3.dist-info/entry_points.txt,sha256=h6_8QX89Ww1ogALEGG5g4kspT3IOV6O51lwKqf5BWco,49
-oep_client_python-0.0.3.dist-info/licenses/LICENSE,sha256=ntlalztb3L1OaNAxmQdHlubu5fVhjMc9oRZi3PeQhXg,1076
-oep_client_python-0.0.3.dist-info/RECORD,,
+oep_client_python-0.0.4.dist-info/METADATA,sha256=7HtJZthSGhDIG5Ce8dvLIvdwtQpN5AYve_5YhSk8l5M,7359
+oep_client_python-0.0.4.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+oep_client_python-0.0.4.dist-info/entry_points.txt,sha256=h6_8QX89Ww1ogALEGG5g4kspT3IOV6O51lwKqf5BWco,49
+oep_client_python-0.0.4.dist-info/licenses/LICENSE,sha256=ntlalztb3L1OaNAxmQdHlubu5fVhjMc9oRZi3PeQhXg,1076
+oep_client_python-0.0.4.dist-info/RECORD,,