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

Add brief info to docs about what each use-case is for #177

Open
x0rloser opened this issue Aug 20, 2024 · 3 comments
Open

Add brief info to docs about what each use-case is for #177

x0rloser opened this issue Aug 20, 2024 · 3 comments
Labels
documentation documentation improvement or addition

Comments

@x0rloser
Copy link

When new to cynthion it is not clear what the different uses are for.
I'd submit a pull request for this, but since I am very new to cynthion its probably best someone else writes these.
I suggest adding a brief sentence to the start of the following pages to help make it clear for new users.

docs/source/getting_started_packetry.rst
docs/source/getting_started_facedancer.rst
docs/source/getting_started_usbproxy.rst

For example on the getting_started_packetry.rst page, right at the top under the main heading, you might put a sentence like:
"This uses cynthion as a usb packet capture device between a usb host and target in order to analyze the packets sent."

The facedancer page might have something like:
"This uses cynthion to emulate usb devices"

The usb proxy page might have:
"This uses cynthion to proxy packets between another usb host and a usb target on the control machine."

@x0rloser
Copy link
Author

I would also suggest adding a link to the "Getting started with packetry" doc page at the end of the "Using cynthion with pcketry" doc page, as the cynthion doc page feels like it stops part way through explaining how to use packetry.

So at the bottom of the page:
https://cynthion.readthedocs.io/en/latest/getting_started_packetry.html
(docs/source/getting_started_packetry.rst)

Add a link to one of the following:
https://packetry.readthedocs.io/en/latest/quick_start.html#
https://packetry.readthedocs.io/en/latest/quick_start.html#install-packetry
https://packetry.readthedocs.io/en/latest/quick_start.html#connect-cynthion
https://packetry.readthedocs.io/en/latest/quick_start.html#launch-packetry
https://packetry.readthedocs.io/en/latest/quick_start.html#start-capturing-usb-traffic

Whichever of these links you feel it is best for the reader to get directed to.
The "Connect cynthion" info in the packetry docs is more fully explained than in the cynthion docs, and packetry install is not covered in cynthion docs, and also the steps to follow when capturing traffic is also missing.

Actually I think the install packetry link might be the best choice to link to
https://packetry.readthedocs.io/en/latest/quick_start.html#install-packetry

@straithe straithe added the documentation documentation improvement or addition label Sep 19, 2024
@udif
Copy link

udif commented Sep 22, 2024

Here is more information I think is missing:

  • Meaning of different LED patterns

  • Be more explicit in explaining that Target-A and Target-C are physically shorted

  • Explain what AUX USB-C is for

  • Explain How the reset/user/program switches are used

  • Explain What the A & B signal banks on the side can be used for

  • Include a copy of the cable configuration for packetry --test-cynthion (I think that for Windows that would be packetry-cli.exe --test-cynthion)
    Also mention thyat in Windows low-speed will currently fail with Test failed: Test device not found)
    https://discord.com/channels/807355811281109082/816773068277809182/1261922256972419143
    cynthion test cable arrangement

@miek miek mentioned this issue Sep 30, 2024
@straithe
Copy link
Member

Thank you for the extra documentation suggestions. We will add the extra information when we can.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation documentation improvement or addition
Projects
None yet
Development

No branches or pull requests

3 participants