From 7e5fc7dc8265b1845f5acebed488d2a960c91616 Mon Sep 17 00:00:00 2001 From: randogoth Date: Fri, 12 May 2023 15:44:29 +0300 Subject: [PATCH] updated README --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0221a29..1fefecd 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # LoRaTransmit -LoRa packet transmitter for RNode hardware +Simple commandline raw LoRa packet transmitter for [RNode](https://unsigned.io/articles/2023_01_16_The_New_RNode_Ecosystem_Is_Here.html) hardware. + +It's meant to be complementary to the packet sniffer [LoRaMon](https://github.com/markqvist/LoRaMon) and uses the latest [Python Module](https://github.com/markqvist/RNode_Firmware/tree/master/Python%20Module) that comes with the [RNode Firmware](https://github.com/markqvist/RNode_Firmware). ## Usage provide payload as command line argument or via pipe -``` +```sh usage: loratransmit [-h] [--freq Hz] [--bw Hz] [--txp dBm] [--sf factor] [--cr rate] [port] [payload] @@ -24,4 +26,18 @@ options: --txp dBm TX power in dBm --sf factor Spreading factor --cr rate Coding rate +``` + +## Example + +Payload passed as argument + +```sh +$ /bin/python3 loratransmit.py --freq 917500000 /dev/ttyACM0 "Hello World" +``` + +Payload passed through pipe + +```sh +$ echo "Hello World" | /bin/python3 loratransmit.py --freq 917500000 /dev/ttyACM0 ``` \ No newline at end of file