Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for multiple traffic views #195

Merged
merged 2 commits into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/packetry-window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/traffic-pane-hierarchical.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/traffic-pane-packets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/traffic-pane-transactions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/traffic-pane.png
Binary file not shown.
36 changes: 31 additions & 5 deletions docs/source/user_interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,42 @@ Traffic Pane
------------

Beneath the Action Bar is the Traffic Pane. This is Packetry's main view of captured USB data.
At the top of the Traffic Pane there are buttons to switch between different views of the captured data.

.. image:: ../images/traffic-pane.png
:alt: Traffic Pane
Each packet is displayed with a precise time stamp relative to the start of capture.
Higher level groups have a time stamp matching the first packet that is a part of the group.

The Traffic Pane displays packets in an interactive hierarchical view, allowing you to expand high level events to explore their constituent low level transactions and packets.
The Traffic Pane is cleared at the start of each capture or when a file is loaded.

Each packet is displayed with a precise time stamp relative to the start of capture. Higher level groups have a time stamp matching the first packet that is a part of the group.
Hierarchical View
^^^^^^^^^^^^^^^^^

The Traffic Pane is cleared at the start of each capture or when a file is loaded.
.. image:: ../images/traffic-pane-hierarchical.png
:alt: Traffic Pane Hierarchical View

This displays an interactive hierarchical view, allowing you to expand high level events to explore their constituent low level transactions and packets.

.. note::

Since multiple high level events can be happening at the same time, this view may show packets out of chronological order.
An interleaved view that still shows packets in order is in progress, tracked here: https://github.com/greatscottgadgets/packetry/pull/150

Transactions View
^^^^^^^^^^^^^^^^^

.. image:: ../images/traffic-pane-transactions.png
:alt: Traffic Pane Transactions View

This combines packets into expandable groups for each USB transaction.
It is more verbose than the hierarchical view, but guarantees that all items are shown in chronological order.

Packets View
^^^^^^^^^^^^

.. image:: ../images/traffic-pane-packets.png
:alt: Traffic Pane Packets View

This shows all packets captured on the wire in order, with no grouping.

Device Pane
-----------
Expand Down
3 changes: 3 additions & 0 deletions docs/source/what_is_packetry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ What is Packetry?
=================

Packetry is a fast, intuitive USB 2.0 protocol analysis application for use with `Cynthion <https://greatscottgadgets.com/cynthion/>`__ or for exploring previously captured USB traffic. Designed from the ground up to handle the challenges of USB analysis, Packetry enables live capture and visual representation of physical layer packet data for High Speed (480 Mbps), Full Speed (12 Mbps), and Low Speed (1.5 Mbps) USB.

.. image:: ../images/packetry-window.png
:alt: Packetry main window
Loading