rfquack / RFQuack

RFQuack: the versatile RF-analysis tool that quacks!
https://rfquack.org
GNU General Public License v2.0
223 stars 35 forks source link

Troublesome installation and use of cli #51

Open maxdd opened 2 hours ago

maxdd commented 2 hours ago

Hello, This is not really a bug but it's more related to the flow in using this project. I'm currently struggling to find a somewhat flawless or the intended installation method and usage. I have compiled and flashed my esp32devikit with make clean build flash and i get

[RFQK]        134 T: Standalone mode network setup: done!
...
[RFQK]        630 T: Setup is over.
[RFQK]        630 T: Transport is sending 2 bytes on topic RFQUACK/out/set/discovery/rfquack_CmdReply/discovery
<RFQUACK/out/set/discovery/rfquack_CmdReply/discovery~CAA=␀[RFQK]       1652 T: Starting main loop.

but the proper usage of the cli in this repo is somewhat undocumented, the repo says

The CLI is now integrated in this repository. The old rfquack/RFQuack-cli repository is no longer used nor maintained. but unless a setup.py isn't provided the rfq command will never work. It also misses some dependencies as well (loguru).

maxdd commented 2 hours ago

The only reasonable solution i've found was

make docker-build-image
docker run --device /dev/ttyUSB0 --user=root --rm -it rfquack/rfquack bash
pip install loguru rich
cd client
PYTHONPATH=$PYTHONPATH:$(pwd) python3 rfquack/cli.py tty -P /dev/ttyUSB0
phretor commented 1 minute ago

I saw your comment on missing the import time ; did you solve this? If yes, do you mind sending a pull request?