updated README
This commit is contained in:
parent
60ca038c36
commit
7e5fc7dc82
1 changed files with 18 additions and 2 deletions
20
README.md
20
README.md
|
|
@ -1,12 +1,14 @@
|
||||||
# LoRaTransmit
|
# 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
|
## Usage
|
||||||
|
|
||||||
provide payload as command line argument or via pipe
|
provide payload as command line argument or via pipe
|
||||||
|
|
||||||
```
|
```sh
|
||||||
usage: loratransmit [-h] [--freq Hz] [--bw Hz] [--txp dBm] [--sf factor]
|
usage: loratransmit [-h] [--freq Hz] [--bw Hz] [--txp dBm] [--sf factor]
|
||||||
[--cr rate]
|
[--cr rate]
|
||||||
[port] [payload]
|
[port] [payload]
|
||||||
|
|
@ -25,3 +27,17 @@ options:
|
||||||
--sf factor Spreading factor
|
--sf factor Spreading factor
|
||||||
--cr rate Coding rate
|
--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
|
||||||
|
```
|
||||||
Loading…
Add table
Add a link
Reference in a new issue