THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

Sming - Open Source framework for high efficiency native ESP8266 development
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Mike 02655d309a Fix `flashmem_get_address()` to account for rBoot mapping (#1964) 3 days ago
.appveyor Install current MinGW version for appveyor (#1920) 3 days ago
.github Initial support button. 4 months ago
.travis Include only the relative path to the submodule files in the archive. (#1963) 4 days ago
Sming Fix `flashmem_get_address()` to account for rBoot mapping (#1964) 3 days ago
docs Update windows manual installation instructions (#1883) 1 month ago
samples Fix `OneWire does not name a type` error (#1949) (#1950) 1 week ago
tests Make String object size configurable and revise tests to accommodate the largest size. (#1961) 1 week ago
.clang-format Initial version of the coding style guide and tools to help enforce it. (#1400) 1 year ago
.clang-tidy Initial version of the coding style guide and tools to help enforce it. (#1400) 1 year ago
.gitattributes Fix line-ending problems (#1768) 4 months ago
.gitignore New documentation system (#1766) 3 months ago
.gitmodules Add experimental SSL to host emulator using axtls-8266 (#1852) 1 month ago
.readthedocs.yml New documentation system (#1766) 3 months ago
.travis.yml Fix deployment condition. (#1911) 3 weeks ago
CONTRIBUTING.md Documentation update plus build improvements (#1783) 3 months ago
LICENSE Initial commit 4 years ago
Readme.md Preparation for release 4.0.0 and 3.8.1 LTS. (#1934) 2 weeks ago
appveyor.yml Preparation for release 4.0.0 rc2 (#1878) 1 month ago

Readme.md

Sming

Sming is an asynchronous C/C++ framework with superb performance and multiple network features. Sming is open source and is tailored towards embedded devices. It supports multiple architectures as ESP8266 for example.

Gitter (chat) Backers Sponsors Download Build Codacy Badge Coverity Badge

If you like Sming, give it a star, or fork it and contribute!

GitHub stars GitHub forks

Table of Contents

Please note develop branch documentation is at sming.readthedocs.io.

Summary

  • Superb performance and memory usage (Sming compiles to native firmware!).
  • Fast and user friendly development.
  • Simple yet powerful hardware API wrappers.
  • Compatible with standard Arduino Libraries - use any popular hardware in few lines of code.
  • Built-in file system: spiffs.
  • Built-in powerful wireless modules.
  • Powerful asynchronous (async) network stack.
    • Async TCP and UDP stack based on LWIP.
    • With clients supporting: HTTP, MQTT, WebSockets and SMTP.
    • And servers for: DNS, FTP, HTTP(+ WebSockets), Telnet.
    • With SSL support for all network clients and servers based on axTLS 2.1+ with Lwirax.
    • Out of the box support for OTA over HTTPS.
  • ESP8266 specific features.
  • Linux/Windows features
    • Sming has a host emulator that allows libraries and sample applications to be compiled on a Linux/Windows host system and be tested before uploading them to an actual microcontroller.

Compatibility

Architecture: ESP8266

OS/SDK Linux Mac OS X Windows FreeBSD-current
UDK (v1.5)     n/a   n/a         Build status           n/a        
esp-open-sdk (v1.5.x **, v2.0.0 **, v3.0.x) :sunny:   :sunny: n/a :sunny:
  • OS = Operating System.
  • SDK = Software Development Kit.
  • n/a = The selected SDK is not available on that OS.
  • ** = not supported officially. Samples and library should compile and run but we recommend using version >= 3.0.1.

Architecture: Host

Linux and Windows OSes with gcc compilers are supported. Clang is NOT supported.

Releases

Stable

  • Sming V4.0.0 - great new features, performance and stability improvements.
  • Sming V3.8.1 LTS - suitable for older applications that are not yet migrated to Sming v4.x.x. Long Term Support (LTS) is available till 1st of April, 2020.

Development

To follow the latest development you will need to clone our develop branch:

git clone https://github.com/SmingHub/Sming.git

Getting Started

Sming supports multiple architectures. Choose the architecture of your choice to install the needed development software and toolchain(s).

You can also try Sming without installing anything locally. We have an interactive tutorial that can be run directly from your browser.

Documentation

In addition to our online documentation, you can also generate a complete documentation locally by following these instructions.

Examples

The examples are a great way to learn the API and brush up your C/C++ knowledge. Once you have completed the installation of the development tools, you can get the latest source code.

git clone https://github.com/SmingHub/Sming.git

And check some of the examples.

Blinking is something like the “Hello World” example for the embedded world. You can check it using the commands below:

cd Sming/samples
cd Basic_Blink
make # -- compiles the application
make flash # -- tries to upload the application to your ESP8266 device.

More information at Wiki Examples page.

Simple GPIO Input/Output

#define LED_PIN 2 // GPIO2
...
pinMode(LED_PIN, OUTPUT);
digitalWrite(LED_PIN, HIGH);

For a complete example take a look at the Basic_Blink sample.

Start Serial Communication

Serial.begin(9600);
Serial.println("Hello Sming! Let's do smart things.");

Connect to WiFi

WifiStation.enable(true);
WifiStation.config("LOCAL-NETWORK", "123456789087"); // Put you SSID and Password here

Read DHT22 sensor

#include <Libraries/DHTesp/DHTesp.h> // This is just a popular Arduino library!

#define DHT_PIN 0 // GPIO0
DHTesp dht;

void init()
{
  dht.setup(DHT_PIN, DHTesp::DHT22);

  float h = dht.getHumidity();
  float t = dht.getTemperature();
}

Take a look at the code of the Humidity_DHT22 sample.

HTTP Client

HttpClient thingSpeak;
...
thingSpeak.downloadString("http://api.thingspeak.com/update?key=XXXXXXX&field1=" + String(sensorValue), onDataSent);

void onDataSent(HttpClient& client, bool successful)
{
  if (successful) {
    Serial.println("Successful!");
  }
  else {
    Serial.println("Failed");
  }
}

For more examples take a look at the HttpClient, HttpClient_Instapush and HttpClient_ThingSpeak samples.

OTA Application Update Based on rBoot

void OtaUpdate()
{
  uint8 slot;
  rboot_config bootconf;

  Serial.println("Updating...");

  // need a clean object, otherwise if run before and failed will not run again
  if (otaUpdater) {
    delete otaUpdater;
  }

  otaUpdater = new RbootHttpUpdater();

  // select rom slot to flash
  bootconf = rboot_get_config();
  slot = bootconf.current_rom;
  if (slot == 0) {
    slot = 1;
  }
  else {
    slot = 0;
  }

  // flash rom to position indicated in the rBoot config rom table
  otaUpdater->addItem(bootconf.roms[slot], ROM_0_URL);

  // and/or set a callback (called on failure or success without switching requested)
  otaUpdater->setCallback(OtaUpdate_CallBack);

  // start update
  otaUpdater->start();
}

For a complete example take a look at the Basic_rBoot sample.

HTTP Server

server.listen(80);
server.paths.set("/", onIndex);
server.paths.set("/hello", onHello);
server.paths.setDefault(onFile);

Serial.println("=== WEB SERVER STARTED ===");
Serial.println(WifiStation.getIP());

...

void onIndex(HttpRequest &request, HttpResponse &response)
{
  TemplateFileStream *tmpl = new TemplateFileStream("index.html");
  auto &vars = tmpl->variables();
  vars["counter"] = String(counter);
  vars["IP"] = WifiStation.getIP().toString();
  vars["MAC"] = WifiStation.getMAC();
  response.sendTemplate(tmpl);
}

void onFile(HttpRequest &request, HttpResponse &response)
{
  String file = request.getPath();
  if (file[0] == '/')
    file = file.substring(1);

  response.setCache(86400, true);
  response.sendFile(file);
}

For more examples take a look at the HttpServer_ConfigNetwork, HttpServer_Bootstrap, HttpServer_WebSockets and HttpServer_AJAX samples.

Email Client

SmtpClient emailClient;

emailClient.connect(Url("smtp://user:password@domain.com"));

MailMessage* mail = new MailMessage();
mail->from = "developers@sming";
mail->to = "iot-developers@world";
mail->subject = "Greetings from Sming";
mail->setBody("Hello");

FileStream* file= new FileStream("image.png");
mail->addAttachment(file);

emailClient.onMessageSent(onMailSent);
emailClient.send(mail);

...

int onMailSent(SmtpClient& client, int code, char* status)
{
    MailMessage* mail = client.getCurrentMessage();

    ...

    if(!client.countPending()) {
        client.quit();
    }

    return 0;
}

See the SmtpClient sample for details.

Live Debugging

Applications based on Sming Framework that are flashed and running on an ESP8266 device can be debugged using interactive debuggers. In order to debug an application it has to be re-compiled with the ENABLE_GDB=1 directive. And then flashed on the device. As shown below:

cd $SMING_HOME/../samples/LiveDebug
make clean
make ENABLE_GDB=1
make flashapp # <-- this will update only the application firmware.

Once the debuggable application is flashed on the device the developers have to run GDB. The easiest way to run the command-line GDB is to execute the following command:

make gdb

Developers using Eclipse CDT can have debugging sessions like the one below: Debugging Session in Eclipse CDT

See LiveDebug sample for details.

Contribute

You can contribute to Sming by

  • Providing Pull Requests with new features, bug fixes, new ideas, etc. Make sure to follow our Coding-Style-Rules. Read our Contributing guide for details.
  • Testing our latest source code and reporting issues.
  • Supporting us financially to acquire hardware for testing and implementing or out of gratitude

Financial contributions

We welcome financial contributions in full transparency on our open collective page. They help us improve the project and the community around it. If you would like to support us you can become a backer or a sponsor.

In addition to that anyone who is helping this project can file an expense. If the expense makes sense for the development of the community, it will be “merged” in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

Backers and sponsors

Thank you to all the people who have backed Sming

or sponsored it.