rpitx/csdr
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Docs: trying formatting

Browse source
This commit is contained in:
ha7ilm 2017-04-02 12:59:23 +02:00
parent 6c842ed65a
commit 35b8999068
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -140,17 +140,21 @@ You can use these commands on complex streams, too, as they are only interleaved
> Note: The the functions with `i16` in their names have been renamed, but still work (e.g. `csdr convert_f_i16`).
#### csdr commands
### csdr commands
`csdr` should be considered as a reference implementation on using `libcsdr`. For additional details on how to use the library, check `csdr.c` and `libcsdr.c`.
Regarding `csdr`, the first command-line parameter is the name of a function, others are the parameters for the given function. Compulsory parameters are noted as `<parameter>`, optional parameters are noted as `[parameter]`.
Optional parameters have safe defaults, for more info look at the code.
### [realpart_cf](#realpart_cf)
realpart_cf
It takes the real part of the complex signal, and throws away the imaginary part.
### [clipdetect_ff](#clipdetect_ff)
clipdetect_ff
It clones the signal (the input and the output is the same), but it prints a warning on `stderr` if any sample value is out of the -1.0 ... 1.0 range.
@ -478,6 +482,8 @@ E.g. you can send `-0.05 0.02\n`
You can search the functions available in `csdr` just as if you typed: `csdr 2>&1 | grep <search_what>`
### [=](#evaluate-python-expression>
=<evaluate_python_expression>
When running complicated `csdr` commands, we usually run into using `python` to calculate certain parameters.