diff --git a/README.md b/README.md new file mode 100644 index 0000000..0baccba --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# Example Arduino Code For My Serial Communications Protocol + diff --git a/include/serialConnector.h b/include/serialConnector.h index bcecbbb..6c2c2e9 100644 --- a/include/serialConnector.h +++ b/include/serialConnector.h @@ -1,6 +1,17 @@ #pragma once #include +/** + * @file serialConnector.h + * @author Lyubomir Penev (me@lpenev.com) + * @brief This file contains all the code to send and receive data over the the Arduino's serial port while ensuring complete data integrity + * @version 1 + * @date 2026-01-25 + * + * @copyright Copyright (c) 2026 + * + */ + class SerialConnector { diff --git a/src/serialConnector.cpp b/src/serialConnector.cpp index 4982693..699f25c 100644 --- a/src/serialConnector.cpp +++ b/src/serialConnector.cpp @@ -1,5 +1,16 @@ #include +/** + * @file serialConnector.cpp + * @author Lyubomir Penev (me@lpenev.com) + * @brief This file contains all the code to send and receive data over the the Arduino's serial port while ensuring complete data integrity + * @version 1 + * @date 2026-01-25 + * + * @copyright Copyright (c) 2026 + * + */ + // Main polling loop: read incoming serial frames, validate the check-bit, // acknowledge valid messages and dispatch handlers based on the command. void SerialConnector::cycle()