mirror of
https://github.com/meshtastic/firmware.git
synced 2025-12-22 10:42:49 +00:00
4284fc2aec
* full thing. works * works * minimal changes * roll back previous changes, move to using the alloc() overrride * clean up comments * format * run clang-format manually. Trunk may be the absolute worst formatter in existance * format on WSL to fix trunks awfulness * add a 3 minute cooldown to prevent messages going back and forth * add ignoring the dummy neighbor. * fix or. * fix spelling, increase logging --------- Co-authored-by: Ben Meadors <benmmeadors@gmail.com>
77 lines
3.1 KiB
C++
77 lines
3.1 KiB
C++
#pragma once
|
|
#include "ProtobufModule.h"
|
|
#define MAX_NUM_NEIGHBORS 10 // also defined in NeighborInfo protobuf options
|
|
|
|
/*
|
|
* Neighborinfo module for sending info on each node's 0-hop neighbors to the mesh
|
|
*/
|
|
class NeighborInfoModule : public ProtobufModule<meshtastic_NeighborInfo>, private concurrency::OSThread
|
|
{
|
|
CallbackObserver<NeighborInfoModule, const meshtastic::Status *> nodeStatusObserver =
|
|
CallbackObserver<NeighborInfoModule, const meshtastic::Status *>(this, &NeighborInfoModule::handleStatusUpdate);
|
|
|
|
std::vector<meshtastic_Neighbor> neighbors;
|
|
|
|
public:
|
|
/*
|
|
* Expose the constructor
|
|
*/
|
|
NeighborInfoModule();
|
|
|
|
/* Reset neighbor info after clearing nodeDB*/
|
|
void resetNeighbors();
|
|
|
|
protected:
|
|
/*
|
|
* Called to handle a particular incoming message
|
|
* @return true if you've guaranteed you've handled this message and no other handlers should be considered for it
|
|
*/
|
|
virtual bool handleReceivedProtobuf(const meshtastic_MeshPacket &mp, meshtastic_NeighborInfo *nb) override;
|
|
|
|
/* Messages can be received that have the want_response bit set. If set, this callback will be invoked
|
|
* so that subclasses can (optionally) send a response back to the original sender. */
|
|
virtual meshtastic_MeshPacket *allocReply() override;
|
|
|
|
/*
|
|
* Collect neighbor info from the nodeDB's history, capping at a maximum number of entries and max time
|
|
* @return the number of entries collected
|
|
*/
|
|
uint32_t collectNeighborInfo(meshtastic_NeighborInfo *neighborInfo);
|
|
|
|
/*
|
|
Remove neighbors from the database that we haven't heard from in a while
|
|
*/
|
|
void cleanUpNeighbors();
|
|
|
|
/* Allocate a new NeighborInfo packet */
|
|
meshtastic_NeighborInfo *allocateNeighborInfoPacket();
|
|
|
|
// Find a neighbor in our DB, create an empty neighbor if missing
|
|
meshtastic_Neighbor *getOrCreateNeighbor(NodeNum originalSender, NodeNum n, uint32_t node_broadcast_interval_secs, float snr);
|
|
|
|
/*
|
|
* Send info on our node's neighbors into the mesh
|
|
*/
|
|
void sendNeighborInfo(NodeNum dest = NODENUM_BROADCAST, bool wantReplies = false);
|
|
|
|
/* update neighbors with subpacket sniffed from network */
|
|
void updateNeighbors(const meshtastic_MeshPacket &mp, const meshtastic_NeighborInfo *np);
|
|
|
|
/* update a NeighborInfo packet with our NodeNum as last_sent_by_id */
|
|
void alterReceivedProtobuf(meshtastic_MeshPacket &p, meshtastic_NeighborInfo *n) override;
|
|
|
|
/* Does our periodic broadcast */
|
|
int32_t runOnce() override;
|
|
|
|
/* Override wantPacket to say we want to see all packets when enabled, not just those for our port number.
|
|
Exception is when the packet came via MQTT */
|
|
virtual bool wantPacket(const meshtastic_MeshPacket *p) override { return enabled && !p->via_mqtt; }
|
|
|
|
/* These are for debugging only */
|
|
void printNeighborInfo(const char *header, const meshtastic_NeighborInfo *np);
|
|
void printNodeDBNeighbors();
|
|
|
|
private:
|
|
uint32_t lastSentReply = 0; // Last time we sent a position reply (used for reply throttling only)
|
|
};
|
|
extern NeighborInfoModule *neighborInfoModule; |