Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SmingHub/Sming
Sming - powerful open source framework simplifying the creation of embedded C++ applications.
https://github.com/SmingHub/Sming
arduino async c-plus-plus embedded esp32 esp8266 espressif framework internet-of-things iot microcontroller rboot rp2040 sming ssl-support upnp wifi
Last synced: about 2 months ago
JSON representation
Sming - powerful open source framework simplifying the creation of embedded C++ applications.
- Host: GitHub
- URL: https://github.com/SmingHub/Sming
- Owner: SmingHub
- License: lgpl-3.0
- Created: 2015-03-15T16:36:22.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-13T08:26:58.000Z (5 months ago)
- Last Synced: 2024-04-14T00:35:24.089Z (5 months ago)
- Topics: arduino, async, c-plus-plus, embedded, esp32, esp8266, espressif, framework, internet-of-things, iot, microcontroller, rboot, rp2040, sming, ssl-support, upnp, wifi
- Language: C++
- Homepage: https://sming.readthedocs.io
- Size: 93.2 MB
- Stars: 1,437
- Watchers: 110
- Forks: 348
- Open Issues: 94
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Sming
Sming is an asynchronous embedded C/C++ framework with superb performance and multiple network features.
Sming is [open source](LICENSE), modular and supports [multiple architectures](https://sming.readthedocs.io/en/latest/features.html) including ESP8266, ESP32 and RP2040.
[](https://github.com/SmingHub/Sming/wiki/examples)
[](https://gitter.im/SmingHub/Sming?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](#financial-contributions)
[](#financial-contributions)
[](https://github.com/SmingHub/Sming/releases/latest)
[](https://github.com/SmingHub/Sming/actions/workflows/ci.yml)
[](https://www.codacy.com/gh/SmingHub/Sming/dashboard?utm_source=github.com&utm_medium=referral&utm_content=SmingHub/Sming&utm_campaign=Badge_Grade)
[](https://scan.coverity.com/projects/sminghub-sming)
If you like **Sming**, give it a star, or fork it and [contribute](#contribute)!
[](https://github.com/SmingHub/Sming/stargazers)
[](https://github.com/SmingHub/Sming/network)
## Getting Started
Sming supports multiple architectures and has a [plethora of features](https://sming.readthedocs.io/en/latest/index.html#summary).
Choose the architecture of your choice to [install the needed development software](https://sming.readthedocs.io/en/latest/getting-started).
You can also try Sming without installing anything locally. We have an [interactive tutorial](https://killercoda.com/slaff/scenario/sming-host-emulator) that can be run directly from your browser.
## Documentation
The purpose of Sming is to simplify the creation of embedded applications. The documentation will help you get started in no time.
- [**Documentation for version 5.1.0**](https://sming.readthedocs.io/en/stable) - current stable version.
- [Documentation for latest](https://sming.readthedocs.io/en/latest) - development version.
## Releases
### Stable
- [Sming V5.1.0](https://github.com/SmingHub/Sming/releases/tag/5.1.0) - great new features, performance and stability improvements.
### Development
To follow the latest development you will need to clone our `develop` branch:
```
git clone https://github.com/SmingHub/Sming.git
```
## 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.
- [Basic Blink](#basic-blink)
- [Simple GPIO input/output](#simple-gpio-inputoutput)
- [Start Serial communication](#start-serial-communication)
- [Connect to WiFi](#connect-to-wifi)
- [Read DHT22 sensor](#read-dht22-sensor)
- [HTTP Client](#http-client)
- [OTA Application Update](#ota-application-update)
- [HTTP Server](#http-server)
- [Email Client](#email-client)
### Basic Blink
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 **[Sample Projects](https://sming.readthedocs.io/en/latest/samples.html)** page.
### Simple GPIO Input/Output
```c++
#define LED_PIN 2 // GPIO2
...
pinMode(LED_PIN, OUTPUT);
digitalWrite(LED_PIN, HIGH);
```
For a complete example take a look at the [Basic_Blink](samples/Basic_Blink/app/application.cpp) sample.
### Start Serial Communication
```c++
Serial.begin(9600);
Serial.println("Hello Sming! Let's do smart things.");
```
### Connect to WiFi
```c++
WifiStation.enable(true);
WifiStation.config("LOCAL-NETWORK", "123456789087"); // Put your SSID and password here
```
### Read DHT22 sensor
```c++
#include // 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](samples/Humidity_DHT22/app/application.cpp) sample.
### HTTP Client
```c++
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](samples/HttpClient/app/application.cpp), [HttpClient_Instapush](samples/HttpClient_Instapush/app/application.cpp) and [HttpClient_ThingSpeak](samples/HttpClient_ThingSpeak/app/application.cpp) samples.
### OTA Application Update
```c++
void doUpgrade()
{
// need a clean object, otherwise if run before and failed will not run again
if(otaUpdater) {
delete otaUpdater;
}
otaUpdater = new Ota::Network::HttpUpgrader();
// select rom partition to flash
auto part = ota.getNextBootPartition();
// The content located on ROM_0_URL will be stored to the new partition
otaUpdater->addItem(ROM_0_URL, part);
// and/or set a callback (called on failure or success without switching requested)
otaUpdater->setCallback(upgradeCallback);
// start update
otaUpdater->start();
}
```
For a complete example take a look at the [Basic_Ota](samples/Basic_Ota/app/application.cpp) sample.
### HTTP Server
```c++
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](samples/HttpServer_ConfigNetwork/app/application.cpp), [HttpServer_Bootstrap](samples/HttpServer_Bootstrap/app/application.cpp), [HttpServer_WebSockets](samples/HttpServer_WebSockets/app/application.cpp) and [HttpServer_AJAX](samples/HttpServer_AJAX/app/application.cpp) samples.
### Email Client
```c++
SmtpClient emailClient;
emailClient.connect(Url("smtp://user:[email protected]"));
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](samples/SmtpClient/app/application.cpp) 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:
See [LiveDebug sample](samples/LiveDebug/) for details.
## Contribute
You can contribute to Sming by
- Providing Pull Requests with new features, bug fixes, new ideas, etc. See [Contributing](https://smingdev.readthedocs.io/en/latest/contribute/index.html) 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](https://opencollective.com/Sming) page.
They help us improve the project and the community around it. If you would like to support us you can [become a backer](https://opencollective.com/Sming#backer) or [a sponsor](https://opencollective.com/Sming#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.
