lili/amodem
1
0
Fork 0
mirror of https://github.com/romanz/amodem.git synced 2026-04-22 14:26:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

move and rename CLI script

Browse Source
This commit is contained in:
Roman Zeyde
2014-11-02 09:28:43 +02:00
parent 9d754b04cf
commit c8f5924c12
3 changed files with 10 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -42,9 +42,7 @@ Make sure that `numpy` and `bitarray` Python packages are installed.
Clone and setup relevant path variables: Clone and setup relevant path variables:
$ git clone https://github.com/romanz/amodem.git $ git clone https://github.com/romanz/amodem.git
$ cd amodem $ export PATH=$PATH:$PWD/amodem
$ export PYTHONPATH=`pwd`
$ export PATH=$PATH:`pwd`/scripts
## via pip (for users) ## via pip (for users)
@@ -60,8 +58,8 @@ For graphs and visualization (optional), install:
Run: Run:
$ amodem -h $ amodem-cli -h
usage: amodem [-h] [-v | -q] {send,recv} ... usage: amodem-cli [-h] [-v | -q] {send,recv} ...
Audio OFDM MODEM: 48.0 kb/s (64-QAM x 8 carriers) Fs=32.0 kHz Audio OFDM MODEM: 48.0 kb/s (64-QAM x 8 carriers) Fs=32.0 kHz
@@ -83,12 +81,12 @@ following scripts:
- On the sender's side: - On the sender's side:
``` ```
~/sender $ amodem send --calibrate ~/sender $ amodem-cli send --calibrate
``` ```
- On the receiver's side: - On the receiver's side:
``` ```
~/receiver $ amodem recv --calibrate ~/receiver $ amodem-cli recv --calibrate
``` ```
Change the sender computer's output audio level, until Change the sender computer's output audio level, until
@@ -110,7 +108,7 @@ If the signal is "too strong", decrease the sender's output audio level.
If the signal is "too noisy", please re-run the receiver for at least 10 seconds: If the signal is "too noisy", please re-run the receiver for at least 10 seconds:
``` ```
~/receiver $ amodem recv --wave >recording.raw ~/receiver $ amodem-cli recv --wave >recording.raw
``` ```
and please send me `recording.raw` file for debugging. and please send me `recording.raw` file for debugging.
@@ -127,12 +125,12 @@ and please send me `recording.raw` file for debugging.
- Start the receiver, which will wait for the sender to start: - Start the receiver, which will wait for the sender to start:
``` ```
~/receiver $ amodem -vv recv >data.rx ~/receiver $ amodem-cli -vv recv >data.rx
``` ```
- Start the sender, which will modulate the data and start the transmission: - Start the sender, which will modulate the data and start the transmission:
``` ```
~/sender $ amodem -vv send <data.tx ~/sender $ amodem-cli -vv send <data.tx
``` ```
- A similar log should be emitted by the sender: - A similar log should be emitted by the sender:
@@ -184,5 +182,5 @@ and please send me `recording.raw` file for debugging.
Make sure that `matplotlib` package is installed, and run (at the receiver side): Make sure that `matplotlib` package is installed, and run (at the receiver side):
``` ```
~/receiver $ amodem recv --plot >data.rx ~/receiver $ amodem-cli recv --plot >data.rx
``` ```

3
scripts/amodem → amodem-cli
View File

@@ -108,9 +108,6 @@ def main():
output_type=FileType('wb') output_type=FileType('wb')
) )
# Configuration
subparsers.add_parser('config').set_defaults(main=config.dump)
argcomplete.autocomplete(p) argcomplete.autocomplete(p)
args = p.parse_args() args = p.parse_args()
if args.verbose == 0: if args.verbose == 0:

2
setup.py
View File

@@ -48,5 +48,5 @@ setup(
"Topic :: System :: Networking", "Topic :: System :: Networking",
"Topic :: Communications", "Topic :: Communications",
], ],
scripts=['scripts/amodem'], scripts=['amodem-cli'],
) )