rbxii3/firmware
1
0
Fork 0
mirror of https://github.com/meshtastic/firmware.git synced 2025-12-22 10:42:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Trace Route on BaseUI (#7386)

Browse Source 
* Add TraceRoute function to menus and modules to support node path tracing

* Adjust text spacing and line wrapping logic in trace route result result.

* Add HAS_SCREEN for TraceRouteModule drawFrame.

---------

Co-authored-by: Tom Fifield <tom@tomfifield.net>
Co-authored-by: Ben Meadors <benmmeadors@gmail.com>
This commit is contained in:
Wilson
2025-07-25 06:23:45 +08:00
committed by GitHub
parent 4f895f744b
commit 7a4a915312
4 changed files with 652 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
src/modules/TraceRouteModule.h
View File

@@ -1,16 +1,40 @@
#pragma once
#include "ProtobufModule.h"
#include "concurrency/OSThread.h"
#include "graphics/Screen.h"
#include "graphics/SharedUIDisplay.h"
#include "input/InputBroker.h"
#if HAS_SCREEN
#include "OLEDDisplayUi.h"
#endif
#define ROUTE_SIZE sizeof(((meshtastic_RouteDiscovery *)0)->route) / sizeof(((meshtastic_RouteDiscovery *)0)->route[0])
/**
* A module that traces the route to a certain destination node
*/
class TraceRouteModule : public ProtobufModule<meshtastic_RouteDiscovery>
enum TraceRouteRunState { TRACEROUTE_STATE_IDLE, TRACEROUTE_STATE_TRACKING, TRACEROUTE_STATE_RESULT, TRACEROUTE_STATE_COOLDOWN };
class TraceRouteModule : public ProtobufModule<meshtastic_RouteDiscovery>,
public Observable<const UIFrameEvent *>,
private concurrency::OSThread
{
public:
TraceRouteModule();
bool startTraceRoute(NodeNum node);
void launch(NodeNum node);
void handleTraceRouteResult(const String &result);
bool shouldDraw();
#if HAS_SCREEN
virtual void drawFrame(OLEDDisplay *display, OLEDDisplayUiState *state, int16_t x, int16_t y) override;
#endif
const char *getNodeName(NodeNum node);
virtual bool wantUIFrame() override { return shouldDraw(); }
virtual Observable<const UIFrameEvent *> *getUIFrameObservable() override { return this; }
protected:
bool handleReceivedProtobuf(const meshtastic_MeshPacket &mp, meshtastic_RouteDiscovery *r) override;
@@ -20,6 +44,8 @@ class TraceRouteModule : public ProtobufModule<meshtastic_RouteDiscovery>
the route array containing the IDs of nodes this packet went through */
void alterReceivedProtobuf(meshtastic_MeshPacket &p, meshtastic_RouteDiscovery *r) override;
virtual int32_t runOnce() override;
private:
// Call to add unknown hops (e.g. when a node couldn't decrypt it) to the route based on hopStart and current hopLimit
void insertUnknownHops(meshtastic_MeshPacket &p, meshtastic_RouteDiscovery *r, bool isTowardsDestination);
@@ -31,6 +57,17 @@ class TraceRouteModule : public ProtobufModule<meshtastic_RouteDiscovery>
Set origin to where the request came from.
Set dest to the ID of its destination, or NODENUM_BROADCAST if it has not yet arrived there. */
void printRoute(meshtastic_RouteDiscovery *r, uint32_t origin, uint32_t dest, bool isTowardsDestination);
TraceRouteRunState runState = TRACEROUTE_STATE_IDLE;
unsigned long lastTraceRouteTime = 0;
unsigned long resultShowTime = 0;
unsigned long cooldownMs = 30000;
unsigned long resultDisplayMs = 10000;
unsigned long trackingTimeoutMs = 10000;
String bannerText;
String resultText;
NodeNum tracingNode = 0;
bool initialized = false;
};
extern TraceRouteModule *traceRouteModule;