Skip to content

Use Arduino_Threads concept for Serial examples #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
void setup()
{
Serial.begin(9600);
}

void loop()
{
Serial.block();
Serial.println("Thread #1: Lorem ipsum ...");
Serial.unblock();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
void setup()
{
Serial.begin(9600);
}

void loop()
{
Serial.block();
Serial.println("Thread #2: Lorem ipsum ...");
Serial.unblock();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
void setup()
{
Serial.begin(9600);
}

void loop()
{
Serial.block();
Serial.println("Thread #3: Lorem ipsum ...");
Serial.unblock();
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,54 +3,41 @@
**************************************************************************************/

#include <Arduino_Threads.h>

/**************************************************************************************
* CONSTANTS
**************************************************************************************/

static size_t constexpr NUM_THREADS = 5;

/**************************************************************************************
* FUNCTION DECLARATION
**************************************************************************************/

String serial_log_message_prefix(String const & /* msg */);
String serial_log_message_suffix(String const & prefix, String const & msg);
void serial_thread_func();

/**************************************************************************************
* GLOBAL VARIABLES
**************************************************************************************/

static char thread_name[NUM_THREADS][32];
#undef Serial
#ifdef ARDUINO_PORTENTA_H7_M4
SerialDispatcher Serial(Serial1); /* No SerialUSB for Portenta H7 / M4 Core */
#else
SerialDispatcher Serial(SerialUSB);
#endif

/**************************************************************************************
* SETUP/LOOP
**************************************************************************************/

void setup()
{
Serial.begin(9600);
while (!Serial) { }

Serial.global_prefix(serial_log_message_prefix);
Serial.global_suffix(serial_log_message_suffix);

/* Fire up some threads all accessing the LSM6DSOX */
for(size_t i = 0; i < NUM_THREADS; i++)
{
snprintf(thread_name[i], sizeof(thread_name[i]), "Thread #%02d", i);
rtos::Thread * t = new rtos::Thread(osPriorityNormal, OS_STACK_SIZE, nullptr, thread_name[i]);
t->start(serial_thread_func);
}
Thread_1.start();
Thread_2.start();
Thread_3.start();
}

void loop()
{

Serial.block();
Serial.println("Thread #0: Lorem ipsum ...");
Serial.unblock();

/* If we don't hand back control then the main thread
* will hog the CPU and all other thread's won't get
* time to be executed.
*/
rtos::ThisThread::yield();
}

/**************************************************************************************
Expand All @@ -68,20 +55,3 @@ String serial_log_message_suffix(String const & prefix, String const & msg)
{
return String("\r\n");
}

void serial_thread_func()
{
Serial.begin(9600);

for(;;)
{
/* Sleep between 5 and 500 ms */
rtos::ThisThread::sleep_for(rtos::Kernel::Clock::duration_u32(random(5,500)));
/* Print a unbroken log message including thread name and timestamp as a prefix. */
Serial.block();
Serial.print(rtos::ThisThread::get_name());
Serial.print(": ");
Serial.print("Lorem ipsum ...");
Serial.unblock();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
/**************************************************************************************
* FUNCTION DEFINITION
**************************************************************************************/

static String nmea_message_prefix(String const & /* msg */)
{
return String("$");
}

static String nmea_message_suffix(String const & prefix, String const & msg)
{
/* NMEA checksum is calculated over the complete message
* starting with '$' and ending with the end of the message.
*/
byte checksum = 0;
std::for_each(msg.c_str(),
msg.c_str() + msg.length(),
[&checksum](char const c)
{
checksum ^= static_cast<uint8_t>(c);
});
/* Assemble the footer of the NMEA message. */
char footer[16] = {0};
snprintf(footer, sizeof(footer), "*%02X\r\n", checksum);
return String(footer);
}

/**************************************************************************************
* SETUP/LOOP
**************************************************************************************/

void setup()
{
Serial.begin(9600);

Serial.prefix(nmea_message_prefix);
Serial.suffix(nmea_message_suffix);
}

void loop()
{
/* Sleep between 5 and 500 ms */
rtos::ThisThread::sleep_for(rtos::Kernel::Clock::duration_u32(random(5,500)));

/* Print a fake NMEA GPRMC message:
* $GPRMC,062101.714,A,5001.869,N,01912.114,E,955535.7,116.2,290520,000.0,W*45\r\n
*/
Serial.block();

Serial.print("GPRMC,");
Serial.print(millis());
Serial.print(",A,");
Serial.print("5001.869,");
Serial.print("N,");
Serial.print("01912.114,");
Serial.print("E,");
Serial.print("955535.7,");
Serial.print("116.2,");
Serial.print("290520,");
Serial.print("000.0,");
Serial.print("W");

Serial.unblock();
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,107 +4,23 @@

#include <Arduino_Threads.h>

/**************************************************************************************
* CONSTANTS
**************************************************************************************/

static size_t constexpr NUM_THREADS = 5;

/**************************************************************************************
* FUNCTION DECLARATION
**************************************************************************************/

void serial_thread_func();

/**************************************************************************************
* GLOBAL VARIABLES
**************************************************************************************/

static char thread_name[NUM_THREADS][32];
#undef Serial
#ifdef ARDUINO_PORTENTA_H7_M4
SerialDispatcher Serial(Serial1); /* No SerialUSB for Portenta H7 / M4 Core */
#else
SerialDispatcher Serial(SerialUSB);
#endif

/**************************************************************************************
* SETUP/LOOP
**************************************************************************************/

void setup()
{
/* Fire up some threads all accessing the LSM6DSOX */
for(size_t i = 0; i < NUM_THREADS; i++)
{
snprintf(thread_name[i], sizeof(thread_name[i]), "Thread #%02d", i);
rtos::Thread * t = new rtos::Thread(osPriorityNormal, OS_STACK_SIZE, nullptr, thread_name[i]);
t->start(serial_thread_func);
}
}

void loop()
{

}

/**************************************************************************************
* FUNCTION DEFINITION
**************************************************************************************/
Serial.begin(9600);
while (!Serial) { }

String nmea_message_prefix(String const & /* msg */)
{
return String("$");
GPS_Thread.start();
}

String nmea_message_suffix(String const & prefix, String const & msg)
void loop()
{
/* NMEA checksum is calculated over the complete message
* starting with '$' and ending with the end of the message.
/* If we don't hand back control then the main thread
* will hog the CPU and all other thread's won't get
* time to be executed.
*/
byte checksum = 0;
std::for_each(msg.c_str(),
msg.c_str() + msg.length(),
[&checksum](char const c)
{
checksum ^= static_cast<uint8_t>(c);
});
/* Assemble the footer of the NMEA message. */
char footer[16] = {0};
snprintf(footer, sizeof(footer), "*%02X\r\n", checksum);
return String(footer);
}

void serial_thread_func()
{
Serial.begin(9600);

Serial.prefix(nmea_message_prefix);
Serial.suffix(nmea_message_suffix);

for(;;)
{
/* Sleep between 5 and 500 ms */
rtos::ThisThread::sleep_for(rtos::Kernel::Clock::duration_u32(random(5,500)));

/* Print a fake NMEA GPRMC message:
* $GPRMC,062101.714,A,5001.869,N,01912.114,E,955535.7,116.2,290520,000.0,W*45\r\n
*/
Serial.block();

Serial.print("GPRMC,");
Serial.print(millis());
Serial.print(",A,");
Serial.print("5001.869,");
Serial.print("N,");
Serial.print("01912.114,");
Serial.print("E,");
Serial.print("955535.7,");
Serial.print("116.2,");
Serial.print("290520,");
Serial.print("000.0,");
Serial.print("W");

Serial.unblock();
}
rtos::ThisThread::yield();
}
Empty file.
28 changes: 28 additions & 0 deletions examples/Threadsafe_IO/Threadsafe_Serial_Reader/Thread_1.inot
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
void setup()
{
Serial.begin(9600);

Serial.block();
Serial.println("Thread #1 started.");
Serial.unblock();
}

void loop()
{
/* Read data from the serial interface into a String. */
String serial_msg;
while (Serial.available())
serial_msg += (char)Serial.read();

/* Print thread id and chip id value to serial. */
if (serial_msg.length())
{
Serial.block();
Serial.print("[");
Serial.print(millis());
Serial.print("] Thread #1: ");
Serial.print(serial_msg);
Serial.println();
Serial.unblock();
}
}
28 changes: 28 additions & 0 deletions examples/Threadsafe_IO/Threadsafe_Serial_Reader/Thread_2.inot
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
void setup()
{
Serial.begin(9600);

Serial.block();
Serial.println("Thread #2 started.");
Serial.unblock();
}

void loop()
{
/* Read data from the serial interface into a String. */
String serial_msg;
while (Serial.available())
serial_msg += (char)Serial.read();

/* Print thread id and chip id value to serial. */
if (serial_msg.length())
{
Serial.block();
Serial.print("[");
Serial.print(millis());
Serial.print("] Thread #2: ");
Serial.print(serial_msg);
Serial.println();
Serial.unblock();
}
}
28 changes: 28 additions & 0 deletions examples/Threadsafe_IO/Threadsafe_Serial_Reader/Thread_3.inot
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
void setup()
{
Serial.begin(9600);

Serial.block();
Serial.println("Thread #3 started.");
Serial.unblock();
}

void loop()
{
/* Read data from the serial interface into a String. */
String serial_msg;
while (Serial.available())
serial_msg += (char)Serial.read();

/* Print thread id and chip id value to serial. */
if (serial_msg.length())
{
Serial.block();
Serial.print("[");
Serial.print(millis());
Serial.print("] Thread #3: ");
Serial.print(serial_msg);
Serial.println();
Serial.unblock();
}
}
Loading