Provide a generalized interface for transport log replay capabilities
@silverv 已经在做这个了。
开始于 2022年12月10日。
评估
这个 Issue 还没有评估数据。
描述
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
- 主要语言
- Python
- 星标
- 143
- 派生
- 110
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
OpenCyphal/pycyphal 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 48/100
OpenCyphal/pycyphal#396 ·
-
class-feature domain-core help wanted severity-minor
难度 4/5 3-5 天 新手友好度 38/100
OpenCyphal/pycyphal#339 ·
-
难度 2/5 1-3 小时 新手友好度 35/100
OpenCyphal/pycyphal#338 · 3 条评论 ·
-
DiagnosticPublisher attempts to use the main asyncio event loop from worker threads (which fails)未关闭class-defect domain-core help wanted severity-major
难度 3/5 1-2 天 新手友好度 45/100
OpenCyphal/pycyphal#336 ·
-
class-defect domain-core help wanted severity-minor
难度 3/5 1-2 天 新手友好度 38/100
OpenCyphal/pycyphal#334 ·
查看 OpenCyphal/pycyphal 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 86/100
py-econometrics/pyfixest#2072 ·
维护者通常 1 天内回复
-
~planning docs
难度 2/5 1-3 小时 新手友好度 64/100
Kromatic-Innovation/athenaeum#3084 ·
维护者通常 1 天内回复
-
Bosch Room Thermostat II number entities offer -500 to 3000 °C setpoint limits and a -32768 to 32767 °C outdoor temperature可能已有人在做 @zigpy-review-bot 今天认领。 未关闭bot: code audit
难度 2/5 1-3 小时 新手友好度 82/100
zigpy/zha-device-handlers#5769 ·
维护者通常 1 天内回复
-
难度 2/5 半天 新手友好度 80/100
R0Y00/Xbox2Windows#254 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
Kludex/python-multipart#375 ·
维护者通常 1 天内回复