bridge_serial.hpp

Go to the documentation of this file.

 
#ifndef LSH_CORE_COMMUNICATION_BRIDGE_SERIAL_HPP
#define LSH_CORE_COMMUNICATION_BRIDGE_SERIAL_HPP
 
#include <stdint.h>
 
#include "communication/deserializer.hpp"
 
namespace BridgeSerial
{
struct ReceiveResult
{
    Deserializer::DispatchResult dispatch{};  
    uint16_t consumedBytes = 0U;              
    bool payloadDispatched = false;           
};
 
extern uint16_t receiveIdleAge_ms;
 
void init();  // Initialize the hardware serial link used by the bridge.
auto receiveAndDispatch(uint16_t maxBytesToConsume)
    -> ReceiveResult;                         // Consume up to N bytes and dispatch at most one complete bridge payload.
void tickSendIdleTimer(uint16_t elapsed_ms);  // Advance the ping idle timer using the elapsed bridge-housekeeping time.
[[nodiscard]] auto canPing() -> bool;         // Return true when another heartbeat may be emitted.
void updateLastSentTime();                    // Reset the ping idle timer after a payload transmission.
[[nodiscard]] auto isConnected() -> bool;     // Return true when the bridge is still considered online.
}  // namespace BridgeSerial
 
#endif  // LSH_CORE_COMMUNICATION_BRIDGE_SERIAL_HPP