serial.h

Go to the documentation of this file.

// Arduino-compatible Serial API for FastLED
// Provides a familiar interface for serial I/O across all platforms
 
#pragma once
 
#include "fl/stl/has_include.h"  // IWYU pragma: keep
 
#include "fl/stl/stdint.h"
#include "fl/stl/cstddef.h"
#include "fl/stl/cstdio.h"  // for fl::serial_begin
#include "fl/stl/stdio.h"  // for fl::snprintf
#include "fl/stl/type_traits.h"  // for enable_if and is_multi_byte_integer
#include "fl/stl/noexcept.h"
 
namespace fl {

class SerialPort {
public:
    void begin(u32 baudRate = 115200) FL_NO_EXCEPT { fl::serial_begin(baudRate); }

    void end() FL_NO_EXCEPT;

    int available() FL_NO_EXCEPT;

    int read() FL_NO_EXCEPT;

    int peek() FL_NO_EXCEPT;

    size_t write(u8 byte) FL_NO_EXCEPT;

    size_t write(const u8* buffer, size_t size) FL_NO_EXCEPT;

    size_t print(const char* str) FL_NO_EXCEPT;

    size_t print(int value) FL_NO_EXCEPT;

    size_t print(long value) FL_NO_EXCEPT;

    template<typename T>
    typename fl::enable_if<fl::is_multi_byte_integer<T>::value &&
                          !fl::is_signed<T>::value,
                          size_t>::type
    print(T value) FL_NO_EXCEPT;

    size_t println(const char* str) FL_NO_EXCEPT;

    size_t println() FL_NO_EXCEPT;

    size_t println(int value) FL_NO_EXCEPT;

    size_t println(long value) FL_NO_EXCEPT;

    template<typename T>
    typename fl::enable_if<fl::is_multi_byte_integer<T>::value &&
                          !fl::is_signed<T>::value,
                          size_t>::type
    println(T value) FL_NO_EXCEPT;

    template<typename... Args>
    size_t printf(const char* format, Args... args) FL_NO_EXCEPT;  // ok snprintf — method routes through fl::snprintf at line 284

    bool flush(u32 timeoutMs = 1000) FL_NO_EXCEPT;

    explicit operator bool() const FL_NO_EXCEPT;

    void setTimeout(u32 timeoutMs) FL_NO_EXCEPT;

    fl::string readString() FL_NO_EXCEPT;

    fl::string readStringUntil(char delimiter) FL_NO_EXCEPT;

    size_t readBytes(u8* buffer, size_t length) FL_NO_EXCEPT;

    size_t readBytesUntil(char delimiter, u8* buffer, size_t length) FL_NO_EXCEPT;

    long parseInt() FL_NO_EXCEPT;

    float parseFloat() FL_NO_EXCEPT;
 
private:
    u32 mTimeoutMs = 1000;  // Default 1 second timeout
};
 
// ============================================================================
// Template Implementations
// ============================================================================
 
 
 
template<typename... Args>
inline size_t SerialPort::printf(const char* format, Args... args) FL_NO_EXCEPT {
    if (!format) {
        return 0;
    }
 
    // Format into a fixed-size buffer using fl::snprintf
    char buffer[256];  // Maximum formatted string length
    int len = fl::snprintf(buffer, sizeof(buffer), format, args...);
 
    if (len < 0) {
        return 0;  // Formatting error
    }
 
    // Delegate to print() method
    return print(buffer);
}
 
// Global Serial object (Arduino-compatible)
// FL_MAYBE_UNUSED allows compiler to elide if not used
extern FL_MAYBE_UNUSED SerialPort fl_serial;
 
} // namespace fl
 
// Define Serial as fl::fl_serial ONLY when Arduino is not available
// When Arduino.h exists, Serial remains the Arduino Serial object
// When Arduino.h doesn't exist, Serial is defined as fl::fl_serial for convenience
#if !FL_HAS_INCLUDE(<Arduino.h>)
#define Serial fl::fl_serial
#endif