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

Better Documentation for urh_cli #993

Open
EdwinFairchild opened this issue Aug 2, 2022 · 3 comments
Open

Better Documentation for urh_cli #993

EdwinFairchild opened this issue Aug 2, 2022 · 3 comments

Comments

@EdwinFairchild
Copy link

Is your feature request related to a problem?
  • I keep getting asked for modulation parameters but there is no documentation of proper syntax and what are my options.
  • Furthermore I am not modulating, I am only passing the -rx parameter and settings things that relate to demodulation so that also has me scratching my head and thinking, what modulation parameters?
Describe the solution you'd like
  • Just better documentation of the cli interface in general. Some features of the GUI are also undocumented and found them through someone else's question and answer to themselves.
  • ascii files filled with ones and zeros can get huge, an option for binary output of the captures would be great.
Describe alternatives you've considered
Additional context
@TomKranenburg
Copy link

+1 for this. Trying to decipher the command line arguments is very taxing. The only example given is out of date. Making the CLI interface redundant.

@TomKranenburg
Copy link

Example, this:

-e ENCODING, --encoding ENCODING
Specify encoding

What options are available?

@TomKranenburg
Copy link

To any poor soul drifting through this unknown code. There are some examples in here:

https://github.com/jopohl/urh/blob/71153babe497a1dafa12f8dd371ed0adc305a8bb/tests/cli/test_cli_parsing.py

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

No branches or pull requests

3 participants