diff --git a/docs/images/packetry-window.png b/docs/images/packetry-window.png new file mode 100644 index 00000000..1a94ae0f Binary files /dev/null and b/docs/images/packetry-window.png differ diff --git a/docs/images/traffic-pane-hierarchical.png b/docs/images/traffic-pane-hierarchical.png new file mode 100644 index 00000000..faf25f1b Binary files /dev/null and b/docs/images/traffic-pane-hierarchical.png differ diff --git a/docs/images/traffic-pane-packets.png b/docs/images/traffic-pane-packets.png new file mode 100644 index 00000000..e809811d Binary files /dev/null and b/docs/images/traffic-pane-packets.png differ diff --git a/docs/images/traffic-pane-transactions.png b/docs/images/traffic-pane-transactions.png new file mode 100644 index 00000000..770bdebc Binary files /dev/null and b/docs/images/traffic-pane-transactions.png differ diff --git a/docs/images/traffic-pane.png b/docs/images/traffic-pane.png deleted file mode 100644 index 2e9c9484..00000000 Binary files a/docs/images/traffic-pane.png and /dev/null differ diff --git a/docs/source/user_interface.rst b/docs/source/user_interface.rst index 3335ea4b..99d999a1 100644 --- a/docs/source/user_interface.rst +++ b/docs/source/user_interface.rst @@ -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 ----------- diff --git a/docs/source/what_is_packetry.rst b/docs/source/what_is_packetry.rst index 3e2f2334..8e48ae30 100644 --- a/docs/source/what_is_packetry.rst +++ b/docs/source/what_is_packetry.rst @@ -3,3 +3,6 @@ What is Packetry? ================= Packetry is a fast, intuitive USB 2.0 protocol analysis application for use with `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