elduko/Serial-Comms-Protocol-Arduino
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added copyright comments to serialConnector

Browse Source
This commit is contained in:
ElDuko
2026-01-25 16:19:04 +01:00
parent 1a6dce142c
commit ddc3a0b124
3 changed files with 24 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md Normal file
View File

@@ -0,0 +1,2 @@
# Example Arduino Code For My Serial Communications Protocol

11
include/serialConnector.h
View File

@@ -1,6 +1,17 @@
#pragma once #pragma once
#include <Arduino.h> #include <Arduino.h>
/**
* @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 class SerialConnector
{ {

11
src/serialConnector.cpp
View File

@@ -1,5 +1,16 @@
#include <serialConnector.h> #include <serialConnector.h>
/**
* @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, // Main polling loop: read incoming serial frames, validate the check-bit,
// acknowledge valid messages and dispatch handlers based on the command. // acknowledge valid messages and dispatch handlers based on the command.
void SerialConnector::cycle() void SerialConnector::cycle()