Provide a generalized interface for transport log replay capabilities
@silverv is already working on this.
Since Dec 10, 2022.
Assessment
This issue has not been assessed yet.
Description
There may be different means of recording and replaying transport logs for diagnostic purposes. One existing solution is pycyphal.transport.can.media.candump.CandumpMedia. The following requirements are common for all log replay pseudo-transports:
- Report the origin and final timestamps of the log file (min and max timestamp value).
- Report the number of transport frames in the log file.
- Report the current position of the replay cursor as:
- timestamp (origin timestamp initially);
- index of the transport frame (0 initially).
- Position the replay cursor immediately before:
- the specified time point;
- the specified frame index.
- Resume/pause the replay.
- Set the replay speed (1.0 is the default).
- Single-stepping: replay one frame (disregarding the timing) and pause.
- Report the name of the underlying resource (file path).
Note that estimation of the final timestamp and the total number of frames would often require full traversal of the log file, which may be very costly. The API should be designed with that cost in mind.
The existing CandumpMedia should implement this interface.
To facilitate the proper integration of the log replay capability into user-level software, it might be sensible to extend the pycyphal.transport.Transport interface with a new method that checks whether the transport in its current configuration is connected to a log file. If the transport is connected to a live network, the method would return nothing; otherwise, it would return an instance implementing this playback interface. Higher-level software will be able to benefit from it in the following manner:
- Yakut would be able to report the current progress via stderr and automatically exit when the file is fully replayed.
- A GUI tool like Yukon will be able to present the user with a nice UI like this:

One feature not covered here is the ability to scan the log file for all transport frames at once. This will be required by graphical tools to present the user with a high-level analysis of the log file contents (see the screenshot above): which ports are available, how the traffic intensity is distributed across the log file per port, whether there are transport errors or other noteworthy events, etc. There are at least two obvious ways to approach this:
-
Implement a dedicated method that returns an async iterator going over every recorded item frame in the log file. The items will be returned as instances of
pycyphal.transport.Capture. The caller will then handle them the same way captured traffic is handled: by feeding them into apycyphal.transport.Tracerinstance. -
Implement a cloning method that allows the caller to construct an independent copy of the entire transport fully detached from its original owner, then invoke
begin_capture()on that transport instance. The result would be identical to the above.
Relates to https://github.com/OpenCyphal/yakut/issues/1
@silverv @thirtytwobits FYI
- Dominant language
- Python
- Stars
- 143
- Forks
- 110
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from OpenCyphal/pycyphal
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
OpenCyphal/pycyphal#396 ·
-
class-feature domain-core help wanted severity-minor
Difficulty 4/5 3-5 days Newbie friendliness 38/100
OpenCyphal/pycyphal#339 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
OpenCyphal/pycyphal#338 · 3 comments ·
-
DiagnosticPublisher attempts to use the main asyncio event loop from worker threads (which fails)Openclass-defect domain-core help wanted severity-major
Difficulty 3/5 1-2 days Newbie friendliness 45/100
OpenCyphal/pycyphal#336 ·
-
class-defect domain-core help wanted severity-minor
Difficulty 3/5 1-2 days Newbie friendliness 38/100
OpenCyphal/pycyphal#334 ·
All issues in OpenCyphal/pycyphal
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 86/100
py-econometrics/pyfixest#2072 ·
Maintainers usually reply within 1 day
-
~planning docs
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Kromatic-Innovation/athenaeum#3084 ·
Maintainers usually reply within 1 day
-
Bosch Room Thermostat II number entities offer -500 to 3000 °C setpoint limits and a -32768 to 32767 °C outdoor temperaturePossibly taken @zigpy-review-bot claimed this today. Openbot: code audit
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
zigpy/zha-device-handlers#5769 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 Half a day Newbie friendliness 80/100
R0Y00/Xbox2Windows#254 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kludex/python-multipart#375 ·
Maintainers usually reply within 1 day