unsignedio/docs/software/LoRaMon.html

89 lines
4.9 KiB
HTML
Raw Permalink Normal View History

2025-12-22 19:09:59 +01:00
<!doctype html>
<html>
<head>
<link rel="stylesheet" href="../css/water.css?v=19">
<link rel="shortcut icon" type="image/x-icon" href="../gfx/icon.png">
<meta charset="utf-8"/>
<title>LoRaMon | unsigned.io</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta property="og:title" content="LoRaMon">
<meta name="description" content="LoRaMon page at unsigned.io">
<meta property="og:description" content="LoRaMon page at unsigned.io">
<meta property="og:image" content="https://unsigned.io/gfx/unsigned_logo.webp">
<meta property="og:url" content="https://unsigned.io/software/LoRaMon.html">
<meta property="og:title" content="LoRaMon">
<meta name="twitter:card" content="summary_large_image">
<meta property="twitter:domain" content="unsigned.io">
<meta property="twitter:url" content="https://unsigned.io/software/LoRaMon.html">
<meta name="twitter:title" content="LoRaMon">
<meta name="twitter:description" content="LoRaMon page at unsigned.io">
<meta name="twitter:image" content="https://unsigned.io/gfx/unsigned_logo.webp">
</head>
<body>
<div id="load_overlay" style="background-color:#2a2a2f; position:absolute; top:0px; left:0px; width:100%; height:100%; z-index:2000;"></div>
<span class="logo">unsigned.io</span>
<center>
<p><span class="menu"><a href="../index.html">Home</a> | <a href="../log.html">Log</a> | <a href="../guides.html">Guides</a> | <a href="../software/index.html">Software</a> | <a href="../hardware/index.html">Hardware</a> | <a href="https://github.com/markqvist/Reticulum/discussions">Discussions</a> | <a href="../shop.html">Shop</a> | <a href="../contact.html">Contact Me</a> | <a href="../donate.html">Donate</a></span></p>
</center><hr><h1>LoRa Packet Sniffer</h1>
<p>This utility allows you to sniff LoRa networks with an <a href="https://unsigned.io/rnode/">RNode</a>, and dump captured packets to the console or files.</p>
<pre><code class="language-sh">usage: loramon [-h] [-C] [-W directory] [--freq Hz] [--bw Hz] [--txp dBm]
[--sf factor] [--cr rate]
[port]
LoRa packet sniffer for RNode hardware.
positional arguments:
port Serial port where RNode is attached
optional arguments:
-h, --help show this help message and exit
-C, --console Print captured packets to the console
-W directory Write captured packets to a directory
--freq Hz Frequency in Hz
--bw Hz Bandwidth in Hze
--txp dBm TX power in dBm
--sf factor Spreading factor
--cr rate Coding rate
</code></pre>
<h2>Installation</h2>
<p>If you already have Python3 and pip installed, you can easily install LoRaMon through pip:</p>
<pre><code class="language-sh">pip3 install loramon
</code></pre>
<p>On Arch Linux it is also possible to install using the <code>loramon</code> package from the <a href="https://aur.archlinux.org/packages/loramon">AUR</a>.</p>
<p>If you want to install directly from this repository, first install the dependencies:</p>
<pre><code class="language-sh">sudo apt install python3 python3-pip
sudo pip3 install pyserial
</code></pre>
<p>And then clone the repository and make LoRaMon executable:</p>
<pre><code class="language-sh">git clone https://github.com/markqvist/LoRaMon.git
cd LoRaMon
chmod a+x loramon
./loramon --help
</code></pre>
<h2>Usage Examples</h2>
<h3>Dump to console</h3>
<p>Listens on a specified frequency and displays captured packets in the console.</p>
<pre><code class="language-sh">loramon /dev/ttyUSB0 --freq 868000000 --bw 125000 --sf 7 --cr 5 -C
</code></pre>
<h3>Dump to console and disk</h3>
<p>Like above, but also writes all captured packets individually to a specified directory.</p>
<pre><code class="language-sh">loramon /dev/ttyUSB0 --freq 868000000 --bw 125000 --sf 7 --cr 5 -C -W capturedir
</code></pre>
<h3>Sniff implicit header mode packets</h3>
<p>If you want to sniff LoRa packets with implicit header mode, use the --implicit option along with the length in bytes of the expected packet. This mode needs an RNode with a firmware version of at least 1.17.</p>
<pre><code class="language-sh">loramon /dev/ttyUSB0 --freq 868000000 --bw 125000 --sf 7 --cr 5 -C -W capturedir --implicit 12
</code></pre>
<br/><hr/><span class="no_print"><center><br/><i>This website is running on a 100% solar powered server</i><br/><br/>☀️<br/><br/><i><small>Unless otherwise noted, everything here is put into the world under a <a href="../LICENSE.txt">CC BY-NC-SA 4.0</a> license.<br/>Feel free to share and remix, just remember the attribution.
</small></i></center></span>
<div class="print_only donation_block"><br/>
Contribute to keeping information on Free & Open Communications systems available for all.<br/>
You can donate directly to <b>unsigned.io</b> by using one of the following QR codes:<br/><br/>
<span class="donate_qr"><img src="../gfx/donate_xmr.png"/><br/>Monero</span>
<span class="donate_qr"><img src="../gfx/donate_btc.png"/><br/>Bitcoin</span>
<span class="donate_qr"><img src="../gfx/donate_eth.png"/><br/>Ethereum</span>
</div>
</body></html>