Dynamic AxThread : A Platform IO Library for handling asynchronous multiple processes.

Table of Contents

• Installation
• Introduction
• Methods
• License

Installation

Type lib name and version into your platformio.ini file.

lib_deps =
    apexcaptain/AxThread @ 1.0.3

Current version is 1.0.3.

Introduction

There are lots of conventional ways to implement asynchronous processes in Arduino environment. But if I have to create a Thread instance every single time I want to use it and also controll, stop or delete'em manually, that is not simple to me at all. Furthermore, total number of threads are usually limited and also need to set very strong connection between parent and child instances. These are probably due to some sort of memory management.

Instead, with AxThread, you don't need to do stuffs, such as...

• Creating thread instance.
• Connecting child instance with its parent one, of course.
• Counting number of threads manually.

There are one .hpp and one .cpp file. There is no public class. You don't have to take care of inner Thread or ThreadController classes. Instead, you can use namespace.

#include <Arduino.h>
#include <AxThread.hpp>

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

    /* Setting interavl thread. */
    Axt::setInterval(1000 /* Repeat Cycle. 1000ms | 1sec */, []() -> Axt::AxSignal {
        Serial.println("Hello AxT!");
        return Axt::CONTINUE;
    });

}

void loop() {
    Axt::executeThreads();
}

This is an example printing out Hello AxT! text every second through AxThread. As you can see, there's no Class at all but only namespace : Axt.

Axt::setInterval function automatically creates, adds new task into its inner thread deque and returns new thread id. First argument is interval milliseconds for each repetition cycle. Second one is callback. A task, a thread, a process or a behavior whatever you call it, this is the actual action body that is gonna run. You can have a check more detail at the following Methods section.

Methods

Periodic process repeating a certain number of times : setRepetition

Syntax

Axt::ThreadId id = Axt::setRepetition(unsigned long delay, unsigned int count, Axt::AxCallback lambda);

Parameters

• unsigned long -- Delay, the time in milliseconds(thousandths of asecond), inner thread controller delays in between executions of the specified lambda for certain count.
• unsigned int -- Count is the number of repetition of the thread.
• () -> Axt::AxSignal -- Lambda is literally the lambda function block to be executed at every delay for count times.

example

Printing out text for 5 times and expires.

#include <Arduino.h>
#include <AxThread.hpp>

void setup() {
    Serial.begin(115200);
    Axt::setRepetition(1000, 5, []() -> Axt::AxSignal {
        Serial.println("Hello AxT!");
        return Axt::CONTINUE;
    });
}

void loop() {
    Axt::executeThreads();
}

Signle instant Process : setImmediate

Syntax

Axt::ThreadId id = Axt::setImmediate(Axt::AxCallback lambda);

Parameters

• () -> Axt::AxSignal -- Lambda is literally the lambda function block to be executed at the very next moment.

Example

Printing out text and expires.

#include <Arduino.h>
#include <AxThread.hpp>

void setup() {
    Serial.begin(115200);
    Axt::setImmediate([]() -> Axt::AxSignal {
        Serial.println("Hello AxT!");
        return Axt::CONTINUE;
    });
}

void loop() {
    Axt::executeThreads();
}

Single Retarded Process. : setTimeout

Syntax

Axt::ThreadId id = Axt::setTimeout(unsigned long delay, Axt::AxCallback lambda);

Parameters

• unsigned long -- Delay, the time in milliseconds(thousandths of a second), inner thread controller waits before the specified lambda is executed.
• () -> Axt::AxSignal -- Lambda is literally the lambda function block to be executed after delay and expires.

Example

Printing out text after 2 seconds.

#include <Arduino.h>
#include <AxThread.hpp>

void setup() {
    Serial.begin(115200);
    Axt::setTimeout(2000, []() -> Axt::AxSignal {
        Serial.println("Hello AxT!");
        return Axt::CONTINUE;
    });
}

void loop() {
    Axt::executeThreads();
}

Periodic Repetition Cycle. : setInterval

Syntax

Axt::ThreadId id = Axt::setInterval(unsigned long delay, Axt::AxCallback lambda);

Parameters

• unsigned long -- Delay, the time in milliseconds(thousandths of a second), inner thread controller delays in between executions of the specified lambda.
• () -> Axt::AxSignal -- Lambda is literally the lambda function block to be executed every delay milliseconds.

Example

Printing out text every second.

#include <Arduino.h>
#include <AxThread.hpp>

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

    Axt::setInterval(1000, []() -> Axt::AxSignal {
        Serial.println("Hello AxT!");
        return Axt::CONTINUE;
    });

}

void loop() {
    Axt::executeThreads();
}

Printing out text every second, when inner code executed more than 5 times, delete the thread.

#include <Arduino.h>
#include <AxThread.hpp>

void setup() {
    Serial.begin(115200);
    int repeatCount = 0;
    Axt::setInterval(1000, [repeatCount]() mutable -> Axt::AxSignal {
        Serial.println("Hello AxT!");
        repeatCount++;
        if(repeatCount >= 5) return Axt::BREAK;
        return Axt::CONTINUE;
    });
}

void loop() {
    Axt::executeThreads();
}

ETC

• void Axt::clear(Axt::ThreadId) -- Stop the thread matching the given thread id and delete it.
• void Axt::restart(Axt::ThreadId) -- Restart the thread. If the thread is disabled, enable it.
• bool Axt::isEnabled(Axt::ThreadId) -- Check if the thread is acitvated and returns it. (boolean)
• void Axt::enable(Axt::ThreadId) -- Activate thread.
• void Axt::disable(Axt::ThreadId) -- Deactivate thread.
• void Axt::toggle(Axt::ThreadId) -- Toggle availability of thread.
• bool Axt::doesExist(Axt::ThreadId) -- Check whether certain thread does exist and returns the result. (boolean)
• unsigned int Axt::getThreadCount() -- Get the number of currently registered threads.

License

MIT License

Copyright (c) 2020 SangHun Lee

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.