meshcore-dev/MeshCore
1
0
Fork 0
mirror of https://github.com/meshcore-dev/MeshCore.git synced 2026-04-20 22:13:47 +00:00
Code Issues Projects Releases Packages Wiki Activity

Rename SerialBridge to RS232Bridge

Browse source
This commit is contained in:
João Brázio 2025-09-05 11:28:40 +01:00
parent 375093f78d
commit 5843a12c71
No known key found for this signature in database
GPG key ID: 56A1490716A324DD
6 changed files with 46 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

61
src/helpers/SerialBridge.h
View file

@ -1,61 +0,0 @@
#pragma once
#include "helpers/AbstractBridge.h"
#include "helpers/SimpleMeshTables.h"
#include <Stream.h>
#ifdef BRIDGE_OVER_SERIAL
/**
* @brief A bridge implementation that uses a serial port to connect two mesh networks.
*/
class SerialBridge : public AbstractBridge {
public:
/**
* @brief Construct a new Serial Bridge object
*
* @param serial The serial port to use for the bridge.
* @param mgr A pointer to the packet manager.
* @param rtc A pointer to the RTC clock.
*/
SerialBridge(Stream& serial, mesh::PacketManager* mgr, mesh::RTCClock* rtc);
void begin() override;
void loop() override;
void onPacketTransmitted(mesh::Packet* packet) override;
void onPacketReceived(mesh::Packet* packet) override;
private:
const char* getLogDateTime();
/**
* @brief The 2-byte magic word used to signify the start of a packet.
*/
static constexpr uint16_t SERIAL_PKT_MAGIC = 0xCAFE;
/**
* @brief The total overhead of the serial protocol in bytes.
* [MAGIC_WORD (2 bytes)] [LENGTH (2 bytes)] [PAYLOAD (variable)] [CHECKSUM (2 bytes)]
*/
static constexpr uint16_t SERIAL_OVERHEAD = 6;
/**
* @brief The maximum size of a packet on the serial line.
*
* This is calculated as the sum of:
* - 1 byte for the packet header (from mesh::Packet)
* - 4 bytes for transport codes (from mesh::Packet)
* - 1 byte for the path length (from mesh::Packet)
* - MAX_PATH_SIZE for the path itself (from MeshCore.h)
* - MAX_PACKET_PAYLOAD for the payload (from MeshCore.h)
* - SERIAL_OVERHEAD for the serial framing
*/
static constexpr uint16_t MAX_SERIAL_PACKET_SIZE = (MAX_TRANS_UNIT + 1) + SERIAL_OVERHEAD;
Stream* _serial;
mesh::PacketManager* _mgr;
mesh::RTCClock* _rtc;
SimpleMeshTables _seen_packets;
uint8_t _rx_buffer[MAX_SERIAL_PACKET_SIZE]; // Buffer for serial data
uint16_t _rx_buffer_pos = 0;
};
#endif