A powerful library for saving and modify your application settings

Features:

• UNIX style serial terminal
• EEPROM support for saving parameters
• Enables access to application-parameter and application-functions
• Robust design with no Heap-Fragmentation
• Integrated Eventmanager + Timer
• Wifi + Telnet + Mqtt + OTA Features
• ESP32 RTOS Wifi/Telnet/NTP/MQTT in seperate Threads
• Stable MQTT-TLS Support on ESP8266 and ESP32
• Small AVR footprint (<1k Bytes of SRAM)

Serial CLI: (Baud 9600 on AVR | 112500 on ESP8266)

arduinoOS:/>help
Commands:
gpio                 🖥  gpio [pin] [0|1]
get                  🖥  get [filter]
set                  🖥  set [par] [val]
lock                 🖥
reboot               🖥
reset                🖥
status               🖥
wifiStatus           📶 Shows System / Wifi status
wifiFirmware         📶 [url] | load and install new firmware from URL (http or https)
wifiScan             📶 Scans for nearby networks
wifiConnect          📶 [network] [password] | apply network settings and connect to configured network
wifiDns              📶 [ip] | check internet connection
mqttStatus           📡 Shows System / Wifi / MQTT status
mqttConnect          📡 [mqtt_server] [mqtt_port] [mqtt_user] [mqtt_password] | Apply and configured
mqttPublish          📡 [topic] [message] | publish a message to topic
arduinoOS:/>get
Variables:
sys/hostname         : arduinoOS                 
sys/password         : aos                       
wifi/enable          : false                    📶 Enable WiFi STA-Mode 
wifi/network         :                          📶 Network SSID 
wifi/password        :                          📶 Network Password 
wifi/ip              : 0.0.0.0                  📶 IP (leave blank to use DHCP) 
wifi/subnet          : 0.0.0.0                  📶 Subnet 
wifi/gateway         : 0.0.0.0                  📶 Gateway 
wifi/dns             : 0.0.0.0                  📶 DNS 
hotspot/enable       : false                    📶 Enable WiFi Hotspot-Mode 
hotspot/password     :                          📶 Hotspot Password 
telnet/enable        : true                     📶 Enable Telnet support on Port 23 (require reboot) 
ntp/enable           : false                    ⏱  Enable NTP Sync 
ntp/server           :                          ⏱  NTP Server adress 
ntp/offset           : 0                        ⏱  NTP Time offset 
mqtt/enable          : false                    📡 mqtt_enable MQTT 
mqtt/server          :                          📡 MQTT mqtt_server IP or Name 
mqtt/port            : 1883                     📡 MQTT mqtt_server Port 
mqtt/tls             : false                    📡 Use TLS 
mqtt/tlsVerify       : false                    📡 Verify TLS Certificates 
mqtt/user            :                          📡 Username 
mqtt/password        :                          📡 Password 
demo/bool            : true                      
demo/int             : 1234                      
demo/double          : 1234.12                   
demo/string          : DEMO                     ..comment.. 
arduinoOS:/>

• EEPROM will automatically reset after sketch upload

Parameter

static bool commandAdd(char* name,void (*)(char**, u8) callbackFunction,char* description,bool hidden);
static bool commandCall(char* name,char** param, u8 paramCnt);

Commands

static bool variableAdd(char* name,bool&    variableRef,  char* description,bool hidden, bool protected);
static bool variableAdd(char* name,int&     variableRef,  char* description,bool hidden, bool protected);
static bool variableAdd(char* name,double&  variableRef,  char* description,bool hidden, bool protected);
static bool variableAdd(char* name,String&  variableRef,  char* description,bool hidden, bool protected);

Events

static void eventListen(char* name,void(*)(void*) callbackFunction);
static void eventEmit(char* name,void* parameter,bool callImmediately);

Tasks / Timeouts

static u16  setInterval(void(*)() callbackFunction,u16 ms);
static u16  setTimeout(void(*)() callbackFunction, u16 ms);
static AOS_ unsetInterval(u16 id);

ESP8266: MQTT

static void publish(char* topic, char* payload, bool retain, u8 qos);
static void publish(String& topic, String& payload, bool retain, u8 qos);
static void subscripe(char* topic,u8,void (*function)(char*,char*) callbackFunction);
static void unsubscripe(char* topic);

QuickStart

#include <arduinoOS.h>
ArduinoOS aos;

setup(){
    aos.begin(Serial);
}

loop(){
    aos.loop();
}

• Serial: Reference to serial interface to start the Terminal. Allowed data types: HardwareSerial.
• NOTICE: You have to add all your parameter before calling aos.begin(Serial) to make the EEPROM layout clear to the system.
• NOTICE: Your command-function have to take these parameters: void(char** param,uint8_t parCnt){};

AVR Example sketch:

#include <arduinoOS.h>
ArduinoOS aos;

bool    demoBool{true};
int     demoInt{1234};
double  demoDouble{1234.1234};
String  demoString{"DEMO"};

void setup()
{
    aos.variableAdd("demo/bool",    demoBool);
    aos.variableAdd("demo/int",     demoInt);
    aos.variableAdd("demo/double",  demoDouble);
    aos.variableAdd("demo/string",  demoString, "..comment..", false, false);

    aos.commandAdd("demo",[](char** param,u8 parCnt){
        Serial.println("Hello from Demo Function");
        Serial.println("Parameter count: " + (String)parCnt);
        for(int i{0};i<parCnt;i++){
            Serial.println("- " + (String)param[i]);
        }
    });

    aos.setInterval([](){
        aos.o("Every Second");
    },1000);


    aos.setTimeout([](){
        aos.o("Once after 5 Seconds");
    },5000);

    aos.begin();
}

void loop()
{ 
    aos.loop();
}

ESP8266 MQTT Example sketch:

#include <arduinoOS_mqtt.h>
#include <ArduinoJson.h>

ArduinoOS_mqtt aos;
StaticJsonDocument<200> doc;

void handle(char* topic,char* payload){
    aos.o(topic);
    aos.o(payload);
};

void setup()
{
    aos.begin();
    aos.subscripe("demo",2,handle);
    aos.unsubscripe("demo");
}

void loop()
{ 
    aos.loop();
}

Display JSON-Encoded MQTT Value on OLED-Screen:

/**
 * 
 * Dependencies:
 *      https://github.com/calkoe/arduinoOS
 *      https://github.com/bblanchon/ArduinoJson
 *      https://github.com/adafruit/Adafruit_BusIO
 *      https://github.com/adafruit/Adafruit_SSD1306
 *
 */

#include <arduinoOS_mqtt.h>
#include <Wire.h>
#include <Adafruit_SSD1306.h>
#include <ArduinoJson.h>

ArduinoOS_mqtt aos;
Adafruit_SSD1306 display(128, 32, &Wire);
StaticJsonDocument<200> doc;

void setup()
{
    aos.autoReset=false;
    aos.begin();

    //Setup Display
    if(!display.begin(SSD1306_SWITCHCAPVCC, 0x3C)) { 
        Serial.println(F("SSD1306 allocation failed"));
        for(;;);
    }
    display.clearDisplay();
    display.setTextSize(4);             
    display.setTextColor(WHITE); 

    aos.subscripe("my/own/datatopic",0,[](char* t, char* payload){
        deserializeJson(doc, payload);
        display.clearDisplay();
        display.setCursor(0,0); 
        display.println((float)(doc["kmh"]));
        display.display();
    });

}

void loop()
{ 
    aos.loop();
}

Roadmap:

• Allow WIFI-Config on ESP8266
• Telnet Server on ESP8266
• Allow MQTT-Config on ESP8266 (TLS Supported)
• Allow NTP-Config on ESP8266
• HTTP OTA Update capability on ESP8266
• Add ESP32 Support

Contact:

• Calvin Köcher
• [email protected]
• https://www.imakeyouintelligent.com