https://github.com/caioaletroca/queueduino
A action queue list for Arduino, with persistent data
https://github.com/caioaletroca/queueduino
actions list nodemcu persistent queue
Last synced: about 1 month ago
JSON representation
A action queue list for Arduino, with persistent data
- Host: GitHub
- URL: https://github.com/caioaletroca/queueduino
- Owner: caioaletroca
- License: mit
- Created: 2019-02-07T17:27:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-19T22:12:11.000Z (over 7 years ago)
- Last Synced: 2025-07-14T12:29:52.453Z (12 months ago)
- Topics: actions, list, nodemcu, persistent, queue
- Language: C++
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QueueDuino · [](LICENSE)
This libraries creates a queue list with Strings data, passed as argument to a user configured action. Recommended when you have to perform a current action later, like request a server. The list is also stored on the flash memory.
# Quick Start
## Installation
Download as zip and use the Arduino Library Manager. QueueDuino requires [ArduinoSTL](https://github.com/mike-matera/ArduinoSTL) to run.
## Usage
Include the library on your sketch
```cpp
#include
```
Initialize a global instance of the library
```cpp
QueueDuino queue;
```
In your loop function, run the queue loop
```cpp
queue.loop();
```
# Documentation
### Constructors
```cpp
QueueDuino();
```
> Default constructor. Uses a default file name on the flash memory
```cpp
QueueDuino(String filename);
```
> Defines a custom filename to save or load on the flash memory
## Methods
### push
```cpp
void push(String item)
```
> Adds (push) a new string item to the queue
### pop
```cpp
void pop()
```
> Removes (pop) the last item from the queue
### clear
```cpp
void clear()
```
> Clears and wipe out all items
### run
```cpp
void run()
```
> Set the queue to run the next time the loop method will be called
### cancel
```cpp
void cancel()
```
> Cancels the queue execution
### loop
```cpp
void loop()
```
> The queue main method. When active, tries to perform the actions and triggers events about the results. If some of the actions failed, the queue is cancelled
## Events
### onStart
```cpp
void onStart( [] () -> void {} )
```
> Receives a lambda function as argument, or you can also defines a function separated. onStart event is fired when the queue starts
##### Example
```cpp
void callback() {
// do your stuff
}
queue.onStart(callback);
```
### onSuccess
```cpp
void onSuccess( [] () -> void {} )
```
> Receives a lambda function as argument, or you can also defines a function separated. onSuccess event is fired when the entire queue was successful
##### Example
```cpp
void callback() {
// do your stuff
}
queue.onSuccess(callback);
```
### onFailed
```cpp
void onFailed( [] () -> void {} )
```
> Receives a lambda function as argument, or you can also defines a function separated. onFailed event is fired when one item action failed
##### Example
```cpp
void callback() {
// do your stuff
}
queue.onSuccess(callback);
```
## Action Methods
### setAction
```cpp
void setAction( [] (const String item) -> bool {} )
```
> Receives a lambda function as argument. Configures the action that will run on every queue item. Must return a boolean if the action was successful or not
### runAction
```cpp
void runAction(String item)
```
> Runs the current configured action if a argument item
## Misc Methods
### save
```cpp
void save()
```
> Saves the current queue on the flash memory. Push, pop and loop automatically saves the queue
### load
```cpp
void load()
```
> Loads the queue saved on the flash memory. The queue is loaded automatically on the constructor
### toSerial
```cpp
void toSerial()
```
> Prints the entire queue, line by line on the default Serial
# Example
Follow the simple setup to undestand how to use the queue [here](https://github.com/caioaletroca/QueueDuino/blob/master/Examples/SimpleExample/SimpleExample.ino).
# Extra Information
It was only tested on NodeMCU, but may work on commom devices as Arduino Uno, Nano and Mega.
Feel free to make pull request to improve this library as you want.