Public Access
M3 step 4: the LoRa Scanner App, Sniffer and Captures
The Sniffer lists packets newest first (time, RSSI, SNR, and for Meshtastic the sender, receiver and hops), with the clear header and a hex dump on Enter (Q96); `p` picks an EU868 preset, kept in Settings (Q95). `c` starts a Capture: pcap with LoRaTap in /captures/lora, its own Clean-up category, recorded by a small Service so it carries on with the App closed (Q97, Q100). The Status Bar shows L while listening, bright on each packet, and CAP while capturing (Q101). StorageService gains raw appends for binary files. Debug Builds get `lora inject` to test all of this with no transmitter in range: a Capture made on the device reads back in TShark field for field. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
This commit is contained in:
@@ -0,0 +1,231 @@
|
||||
#include "lora_scanner_app.h"
|
||||
|
||||
#include <Arduino.h>
|
||||
|
||||
#include <algorithm>
|
||||
#include <cstdio>
|
||||
#include <ctime>
|
||||
|
||||
#include "meshtastic_presets.h"
|
||||
#include "packet_view.h"
|
||||
#include "ui/canvas.h"
|
||||
#include "ui/fonts.h"
|
||||
#include "ui/widgets.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
namespace {
|
||||
constexpr uint32_t kMessageMs = 4000;
|
||||
}
|
||||
|
||||
void LoraScannerApp::onEnter() {
|
||||
int i = std::clamp<int>(settings_.getInt(Setting::LoraPreset), 0, meshtastic::kEu868PresetCount - 1);
|
||||
const meshtastic::Preset& p = meshtastic::kEu868Presets[i];
|
||||
if (std::string(radio_.config().name) != p.name) radio_.setPreset(p);
|
||||
radio_.listen(RadioService::App, true);
|
||||
view_ = View::Packets;
|
||||
selectedSeq_ = 0;
|
||||
followNewest_ = true;
|
||||
shownSeq_ = 0;
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
void LoraScannerApp::onExit() { radio_.listen(RadioService::App, false); }
|
||||
|
||||
bool LoraScannerApp::meshtasticSettings() const { return radio_.config().syncWord == meshtastic::kSyncWord; }
|
||||
|
||||
void LoraScannerApp::say(const std::string& text) {
|
||||
message_ = text;
|
||||
messageMs_ = millis();
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
bool LoraScannerApp::onKey(const KeyEvent& e) {
|
||||
if (view_ == View::Details) {
|
||||
int last = std::max<int>(0, static_cast<int>(details_.size()) - 8);
|
||||
if (e.key == Key::Up) detailsTop_ = std::max(0, detailsTop_ - 1);
|
||||
else if (e.key == Key::Down) detailsTop_ = std::min(last, detailsTop_ + 1);
|
||||
else if (e.key == Key::Back || e.key == Key::Select) view_ = View::Packets;
|
||||
else return true;
|
||||
requestRedraw();
|
||||
return true;
|
||||
}
|
||||
if (view_ == View::Presets) {
|
||||
if (e.key == Key::Up) presets_.up();
|
||||
else if (e.key == Key::Down) presets_.down();
|
||||
else if (e.key == Key::Select) {
|
||||
int i = presets_.selected();
|
||||
settings_.setInt(Setting::LoraPreset, i);
|
||||
radio_.setPreset(meshtastic::kEu868Presets[i]);
|
||||
say(std::string("Listening on ") + meshtastic::kEu868Presets[i].name);
|
||||
view_ = View::Packets;
|
||||
} else if (e.key == Key::Back) view_ = View::Packets;
|
||||
else return true;
|
||||
requestRedraw();
|
||||
return true;
|
||||
}
|
||||
// The packet list.
|
||||
if (e.key == Key::Up || e.key == Key::Down) {
|
||||
e.key == Key::Up ? packets_.up() : packets_.down();
|
||||
selectedSeq_ = packets_.selected() >= 0 ? radio_.received() - packets_.selected() : 0;
|
||||
followNewest_ = packets_.selected() <= 0;
|
||||
requestRedraw();
|
||||
return true;
|
||||
}
|
||||
if (e.key == Key::Select) {
|
||||
openDetails();
|
||||
return true;
|
||||
}
|
||||
if (e.key == Key::Char && (e.ch == 'p' || e.ch == 'P')) {
|
||||
presets_.setCount(meshtastic::kEu868PresetCount);
|
||||
presets_.select(settings_.getInt(Setting::LoraPreset));
|
||||
view_ = View::Presets;
|
||||
requestRedraw();
|
||||
return true;
|
||||
}
|
||||
if (e.key == Key::Char && (e.ch == 'c' || e.ch == 'C')) {
|
||||
if (capture_.capturing()) capture_.stop();
|
||||
else {
|
||||
std::string why = capture_.start(millis());
|
||||
if (!why.empty()) say(why);
|
||||
}
|
||||
requestRedraw();
|
||||
return true;
|
||||
}
|
||||
return false; // Back leaves the App
|
||||
}
|
||||
|
||||
void LoraScannerApp::openDetails() {
|
||||
RadioPacket p;
|
||||
if (!selectedSeq_ || !radio_.packet(selectedSeq_, p)) return say("That packet has left the list");
|
||||
details_.clear();
|
||||
char line[64];
|
||||
std::snprintf(line, sizeof line, "%s, %u bytes%s", timeOf(p).c_str(), p.len, p.crcOk ? "" : ", bad CRC");
|
||||
details_.push_back(line);
|
||||
std::snprintf(line, sizeof line, "%.0f dBm, SNR %.1f dB, noise %.0f", p.rx.rssi, p.rx.snr, p.rx.noiseFloor);
|
||||
details_.push_back(line);
|
||||
std::snprintf(line, sizeof line, "%.4f MHz, off by %.0f Hz", p.rx.frequencyHz / 1e6, p.frequencyError);
|
||||
details_.push_back(line);
|
||||
if (meshtasticSettings())
|
||||
for (auto& l : lora::headerLines(p.data, p.len)) details_.push_back(l);
|
||||
for (auto& l : lora::hexDump(p.data, p.len)) details_.push_back(l);
|
||||
detailsTop_ = 0;
|
||||
view_ = View::Details;
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
std::string LoraScannerApp::timeOf(const RadioPacket& p) const {
|
||||
int64_t now = clock_.utcNow();
|
||||
if (now < 0) { // no Clock yet: how long ago
|
||||
char ago[16];
|
||||
std::snprintf(ago, sizeof ago, "-%lus", (unsigned long)((millis() - p.ms) / 1000));
|
||||
return ago;
|
||||
}
|
||||
time_t t = static_cast<time_t>(now - static_cast<int64_t>((millis() - p.ms) / 1000));
|
||||
struct tm local;
|
||||
localtime_r(&t, &local);
|
||||
char buf[12];
|
||||
std::snprintf(buf, sizeof buf, "%02d:%02d:%02d", local.tm_hour, local.tm_min, local.tm_sec);
|
||||
return buf;
|
||||
}
|
||||
|
||||
void LoraScannerApp::update(uint32_t nowMs) {
|
||||
if (radio_.received() != shownSeq_ || nowMs - lastDrawMs_ >= 1000 ||
|
||||
(!message_.empty() && nowMs - messageMs_ >= kMessageMs))
|
||||
requestRedraw();
|
||||
}
|
||||
|
||||
void LoraScannerApp::draw(Canvas& c) {
|
||||
lastDrawMs_ = millis();
|
||||
c.setTextDatum(top_left);
|
||||
if (!radio_.present()) {
|
||||
c.setFont(&fonts::bold);
|
||||
c.setTextColor(theme::kWarning);
|
||||
c.drawString("No LoRa radio found", 4, theme::kContent.y + 4);
|
||||
c.setFont(&fonts::body);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString("Is the Cap LoRa-1262 attached?", 4, theme::kContent.y + 22);
|
||||
return;
|
||||
}
|
||||
switch (view_) {
|
||||
case View::Packets: drawPackets(c); break;
|
||||
case View::Details: drawDetails(c); break;
|
||||
case View::Presets: drawPresets(c); break;
|
||||
}
|
||||
}
|
||||
|
||||
void LoraScannerApp::drawPackets(Canvas& c) {
|
||||
const auto& area = theme::kContent;
|
||||
RadioService::Config cfg = radio_.config();
|
||||
uint32_t newest = radio_.received();
|
||||
shownSeq_ = newest;
|
||||
|
||||
// What it's listening to, and the noise floor.
|
||||
char head[64];
|
||||
std::snprintf(head, sizeof head, "%s %.3f MHz, noise %.0f", cfg.name, cfg.frequencyHz / 1e6, radio_.noiseFloor());
|
||||
c.setFont(&fonts::small);
|
||||
c.setTextColor(radio_.listening() ? theme::kMuted : theme::kWarning);
|
||||
c.drawString(radio_.listening() ? head : "Starting the radio...", 4, area.y + 2);
|
||||
if (capture_.capturing()) {
|
||||
c.setTextDatum(top_right);
|
||||
c.setTextColor(theme::kWarning);
|
||||
c.drawString(("CAP " + std::to_string(capture_.packets())).c_str(), area.w - 3, area.y + 2);
|
||||
c.setTextDatum(top_left);
|
||||
}
|
||||
|
||||
// The list, newest first; the selection stays on its packet as new ones arrive.
|
||||
int count = static_cast<int>(radio_.available());
|
||||
packets_.setCount(count);
|
||||
if (!followNewest_ && selectedSeq_ && newest >= selectedSeq_ && newest - selectedSeq_ < static_cast<uint32_t>(count))
|
||||
packets_.select(static_cast<int>(newest - selectedSeq_));
|
||||
else if (count > 0) {
|
||||
followNewest_ = true;
|
||||
packets_.select(0);
|
||||
selectedSeq_ = newest;
|
||||
}
|
||||
theme::Rect list{area.x, area.y + 12, area.w, kListRows * theme::kLineHeight};
|
||||
if (count == 0) {
|
||||
c.setFont(&fonts::body);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString("No packets yet.", 4, list.y + 4);
|
||||
c.drawString(meshtasticSettings() ? "Meshtastic nodes in range show here." : "Custom settings.", 4,
|
||||
list.y + 4 + theme::kLineHeight);
|
||||
} else {
|
||||
bool mesh = meshtasticSettings();
|
||||
widgets::list(c, packets_, list, [&](int i) {
|
||||
RadioPacket p;
|
||||
if (!radio_.packet(newest - i, p)) return std::string("(gone)");
|
||||
return lora::row({p.data, p.len, p.rx.rssi, p.rx.snr, p.crcOk, mesh}, timeOf(p));
|
||||
});
|
||||
}
|
||||
|
||||
// Footer: a message for a few seconds, or the keys.
|
||||
c.setFont(&fonts::small);
|
||||
bool showMessage = !message_.empty() && millis() - messageMs_ < kMessageMs;
|
||||
c.setTextColor(showMessage ? theme::kWarning : theme::kMuted);
|
||||
std::string keys = std::string("Enter: details p: preset c: ") + (capture_.capturing() ? "stop capture" : "capture");
|
||||
c.drawString(showMessage ? message_.c_str() : keys.c_str(), 4, area.y + area.h - 9);
|
||||
}
|
||||
|
||||
void LoraScannerApp::drawDetails(Canvas& c) {
|
||||
const auto& area = theme::kContent;
|
||||
widgets::textLines(c, details_, detailsTop_, {area.x + 2, area.y + 2, area.w - 2, area.h - 2});
|
||||
}
|
||||
|
||||
void LoraScannerApp::drawPresets(Canvas& c) {
|
||||
const auto& area = theme::kContent;
|
||||
c.setFont(&fonts::small);
|
||||
c.setTextColor(theme::kMuted);
|
||||
c.drawString("Meshtastic presets allowed in EU868", 4, area.y + 2);
|
||||
widgets::list(
|
||||
c, presets_, {area.x, area.y + 12, area.w, (kListRows + 1) * theme::kLineHeight},
|
||||
[](int i) { return std::string(meshtastic::kEu868Presets[i].name); },
|
||||
[](int i) {
|
||||
char v[24];
|
||||
const auto& p = meshtastic::kEu868Presets[i];
|
||||
std::snprintf(v, sizeof v, "SF%u %.0fk %.3f", p.sf, p.bwKHz, meshtastic::eu868FrequencyHz(p) / 1e6);
|
||||
return std::string(v);
|
||||
});
|
||||
}
|
||||
|
||||
} // namespace roro
|
||||
@@ -0,0 +1,58 @@
|
||||
#pragma once
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "app.h"
|
||||
#include "list_model.h"
|
||||
#include "services/clock_service.h"
|
||||
#include "services/lora_capture_service.h"
|
||||
#include "services/radio_service.h"
|
||||
#include "settings.h"
|
||||
#include "ui/theme.h"
|
||||
|
||||
namespace roro {
|
||||
|
||||
// The LoRa Scanner (docs/milestones/M3.md). Sniffer: the packets the radio hears, newest first,
|
||||
// with the Meshtastic header read (Q96) and a hex dump on Enter; p picks the preset (Q95), c starts
|
||||
// or stops a Capture (Q97). The radio listens while the App is open (Q100).
|
||||
class LoraScannerApp : public App {
|
||||
public:
|
||||
LoraScannerApp(RadioService& radio, LoraCaptureService& capture, Settings& settings, ClockService& clock)
|
||||
: radio_(radio), capture_(capture), settings_(settings), clock_(clock) {}
|
||||
void onEnter() override;
|
||||
void onExit() override;
|
||||
bool onKey(const KeyEvent& e) override;
|
||||
void update(uint32_t nowMs) override;
|
||||
void draw(Canvas& c) override;
|
||||
|
||||
private:
|
||||
enum class View { Packets, Details, Presets };
|
||||
static constexpr int kListRows = 7;
|
||||
|
||||
void drawPackets(Canvas& c);
|
||||
void drawDetails(Canvas& c);
|
||||
void drawPresets(Canvas& c);
|
||||
void openDetails();
|
||||
std::string timeOf(const RadioPacket& p) const;
|
||||
bool meshtasticSettings() const;
|
||||
void say(const std::string& text); // a line in the footer for a few seconds
|
||||
|
||||
RadioService& radio_;
|
||||
LoraCaptureService& capture_;
|
||||
Settings& settings_;
|
||||
ClockService& clock_;
|
||||
View view_ = View::Packets;
|
||||
ListModel packets_{kListRows};
|
||||
ListModel presets_{kListRows + 1};
|
||||
uint32_t shownSeq_ = 0; // the newest packet at the last redraw
|
||||
uint32_t selectedSeq_ = 0; // what the selection points at, kept as packets arrive
|
||||
bool followNewest_ = true; // until the user moves the selection off the top
|
||||
std::vector<std::string> details_;
|
||||
int detailsTop_ = 0;
|
||||
uint32_t lastDrawMs_ = 0;
|
||||
std::string message_;
|
||||
uint32_t messageMs_ = 0;
|
||||
};
|
||||
|
||||
} // namespace roro
|
||||
Reference in New Issue
Block a user