Create basic serial read/write class.

Author: SFE-Brudnerd

src/SparkFun_Toolkit.h

@@ -21,5 +21,5 @@
 // Just include the toolkit headers
 #include "sfTkArdI2C.h"
 #include "sfTkArdSPI.h"
-#include "sfTkArdUART.h"
+#include "sfTkArdSerial.h"
 #include "sfTkArduino.h"

src/sfTk/sfTkISerial.h

@@ -59,11 +59,21 @@ const sfTkError_t ksfTkErrSerialNullSettings = ksfTkErrFail * (ksfTkErrBaseSeria
 const sfTkError_t ksfTkErrSerialNullBuffer = ksfTkErrFail * (ksfTkErrBaseSerial + 6);
 
 /**
- * @brief Returned when the bus is under read. Warning.
+ * @brief Returned when the serial is under read. Warning.
  *
  */
 const sfTkError_t ksfTkErrSerialUnderRead = ksfTkErrBaseSerial + 7;
 
+/**
+ * @brief Returned when the serial is not enabled. Warning
+ */
+const sfTkError_t ksfTkErrSerialNotEnabled = ksfTkErrBaseBus + 8;
+
+/**
+ * @brief Returned when the serial data is bad or corrupted.
+ */
+const sfTkError_t ksfTkErrSerialBadData = ksfTkErrFail * (ksfTkErrBaseBus + 9);
+
 class sfTkISerial
 {
   public:
@@ -112,4 +122,31 @@ class sfTkISerial
 
         return read(&data, sizeof(data), nRead);
     }
+
+    /**
+     * @brief Check if there are bytes available to read
+     *
+     * @return int Returns the number of bytes available to read in the read buffer
+     */
+    virtual int available() = 0;
+
+    /**
+     * @brief Check if the serial interface is available for writing
+     *
+     * @return int Returns the number of bytes available to write
+     */
+    virtual int availableForWrite() = 0;
+
+    /**
+     * @brief Peek at the next byte available to read without removing it from the buffer
+     *
+     * @return int Returns the next byte available to read, or -1 if no bytes are available
+     */
+    virtual int peek() = 0;
+
+    /**
+     * @brief Flush the serial interface's write buffer
+     *
+     */
+    virtual void flush() = 0;
 };

src/sfTk/sfTkISerialBus.h

@@ -21,7 +21,7 @@
 
 const uint8_t ksfTkBusTypeSerialBus = 0x03;
 
-class sfTkISerialBus : sfTkIBus
+class sfTkISerialBus : public sfTkIBus
 {
   public:
     /**

src/sfTkArdSerial.cpp

@@ -0,0 +1,95 @@
+/**
+ * @file sfTkArdSerial.cpp
+ * @brief Implementation file for the SparkFun Toolkit Arduino Serial driver.
+ *
+ * This file contains the Arduino Serial driver for the SparkFun Toolkit library.
+ *
+ * @author SparkFun Electronics
+ * @date 2025
+ * @copyright Copyright (c) 2025, SparkFun Electronics Inc. This project is released under the MIT License.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+#include <Arduino.h>
+
+// clang-format off
+#include "sfTkArdSerial.h"
+#include "sfTk/sfTkError.h"
+#include "sfTk/sfTkISerial.h"
+// clang-format on
+
+sfTkError_t sfTkArdSerial::init(Stream &hwStream)
+{
+    _hwStream = &hwStream;
+
+    return init();
+}
+
+sfTkError_t sfTkArdSerial::init()
+{
+    if (!_hwStream)
+        return ksfTkErrSerialNotInit;
+
+    if (!_hwStream->availableForWrite())
+        return ksfTkErrSerialNoResponse;
+
+    return ksfTkErrOk;
+}
+
+sfTkError_t sfTkArdSerial::write(const uint8_t *data, size_t length)
+{
+    if (!_hwStream)
+        return ksfTkErrSerialNotInit;
+
+    return (_hwStream->write(data, length) == length ? ksfTkErrOk : ksfTkErrSerialUnderRead);
+}
+
+sfTkError_t sfTkArdSerial::read(uint8_t *data, size_t length, size_t &bytesRead)
+{
+    if (!_hwStream)
+        return ksfTkErrSerialNotInit;
+
+    if (!data)
+        return ksfTkErrSerialNullBuffer;
+
+    if (length == 0)
+        return ksfTkErrSerialDataTooLong; // nothing to read
+
+    bytesRead = 0; // zero out value
+
+    bytesRead = _hwStream->readBytes(data, length);
+
+    if (bytesRead == 0)
+        return ksfTkErrFail;
+
+    // return success if all bytes read
+    return (bytesRead == length) ? ksfTkErrOk : ksfTkErrSerialUnderRead;
+}
+
+int sfTkArdSerial::available()
+{
+    if (!_hwStream)
+        return 0;
+    return _hwStream->available();
+}
+
+int sfTkArdSerial::availableForWrite()
+{
+    if (!_hwStream)
+        return 0;
+    return _hwStream->availableForWrite();
+}
+
+int sfTkArdSerial::peek()
+{
+    if (!_hwStream)
+        return -1;
+    return _hwStream->peek();
+}
+
+void sfTkArdSerial::flush()
+{
+    if (!_hwStream)
+        return;
+    _hwStream->flush();
+}

src/sfTkArdSerial.h

@@ -0,0 +1,136 @@
+/**
+ * @file sfTkArdSerial.h
+ * @brief header file for the SparkFun Toolkit Arduino Serial driver.
+ *
+ * This file contains the Arduino Serial header for the SparkFun Toolkit library.
+ *
+ * @author SparkFun Electronics
+ * @date 2025
+ * @copyright Copyright (c) 2025, SparkFun Electronics Inc. This project is released under the MIT License.
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#pragma once
+
+#include <Arduino.h>
+
+// clang-format off
+#include "sfTk/sfTkError.h"
+#include "sfTk/sfTkISerial.h"
+#include "sfTkArduino.h"
+// clang-format on
+
+class sfTkArdSerial : public sfTkISerial
+
+{
+  public:
+    /**
+     * @brief Default constructor for the sfTkArdSerial class.
+     *        Initializes the object with no hardware stream.
+     */
+    sfTkArdSerial() : sfTkISerial(), _hwStream{nullptr}
+    {
+    }
+
+    /**
+     * @brief Constructor for the sfTkArdSerial class.
+     *        Initializes the object with a given hardware stream.
+     *
+     * @param hwStream Reference to a Stream object to be used for communication.
+     */
+    sfTkArdSerial(Stream &hwStream) : sfTkISerial(), _hwStream{&hwStream}
+    {
+    }
+
+    /**
+     * @brief Copy Constructor for the sfTkArdSerial class.
+     *
+     * @param rhs Reference to another sfTkArdSerial object to copy from.
+     */
+    sfTkArdSerial(sfTkArdSerial const &rhs) : sfTkISerial(), _hwStream(rhs._hwStream)
+    {
+    }
+
+    /**
+     * @brief Assignment operator for the sfTkArdSerial class.
+     *
+     * @param rhs Reference to another sfTkArdSerial object to assign from.
+     * @return value of the left hand side of the assignment
+     */
+    sfTkArdSerial &operator=(const sfTkArdSerial &rhs)
+    {
+        if (this != &rhs)
+        {
+            _hwStream = rhs._hwStream;
+        }
+        return *this;
+    }
+
+    /**
+     * @brief Initializes the sfTkArdSerial object with a hardware stream.
+     *
+     * @note hwStream is not initialized here, it must be initialized external to this class.
+     *
+     * @param hwStream Reference to a Stream object to be used for communication.
+     * @return sfTkError_t Error code indicating the result of the initialization.
+     */
+    sfTkError_t init(Stream &hwStream);
+
+    /**
+     * @brief Initializes the sfTkArdSerial object with the default hardware stream.
+     *
+     * @note The stream object is not initialized here, it must be initialized external to this class.
+     *
+     * @return sfTkError_t Error code indicating the result of the initialization.
+     */
+    sfTkError_t init();
+
+    /**
+     * @brief Writes data to the hardware stream.
+     *
+     * @param data Pointer to the data buffer to be written.
+     * @param length Number of bytes to write from the data buffer.
+     * @return sfTkError_t Error code indicating the result of the write operation.
+     */
+    sfTkError_t write(const uint8_t *data, size_t length) override;
+
+    /**
+     * @brief Reads data from the hardware stream.
+     *
+     * @param data Pointer to the buffer where the read data will be stored.
+     * @param length Number of bytes to read.
+     * @param readBytes Reference to a variable where the number of bytes actually read will be stored.
+     * @return sfTkError_t Error code indicating the result of the read operation.
+     */
+    sfTkError_t read(uint8_t *data, size_t length, size_t &readBytes) override;
+
+    /**
+     * @brief Gets the number of bytes available to read from the hardware stream.
+     *
+     * @return int Number of bytes available to read.
+     */
+    int available() override;
+
+    /**
+     * @brief Check if the serial interface is available for writing
+     *
+     * @return int Returns the number of bytes available to write
+     */
+    int availableForWrite() override;
+
+    /**
+     * @brief Peeks at the next byte in the hardware stream without removing it.
+     *
+     * @return int The next byte in the stream, or -1 if no data is available.
+     */
+    int peek() override;
+
+    /**
+     * @brief Flushes the hardware stream, ensuring all data is transmitted.
+     */
+    void flush() override;
+
+  protected:
+    Stream *_hwStream = nullptr;
+};