c++
Sming supports multiple architectures. Choose the architecture of your choice to install the needed development software and toolchain(s).
/arch/esp8266/getting-started/index /arch/esp32/getting-started/index /arch/host/host-emulator
You can also try Sming without installing anything locally. We have an interactive tutorial that can be run directly from your browser.
In addition to our online documentation, you can also generate a complete documentation locally by following these instructions </_inc/docs/README>
.
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
- Simple GPIO input/output
- Start Serial communication
- Connect to WiFi
- Read DHT22 sensor
- HTTP client
- OTA application update based on rBoot
- Embedded HTTP Web Server
- Email Client
Further documentation about the samples
is available too.
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.
See Basic_Blink
for more information.
#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.
Serial.begin(9600);
Serial.println("Hello Sming! Let's do smart things.");
WifiStation.enable(true);
WifiStation.config("LOCAL-NETWORK", "123456789087"); // Put you SSID and Password here
#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.
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.
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.
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.getMacAddress().toString();
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.
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() == 0) {
client.quit();
}
return 0;
}
See the SmtpClient
sample for details.
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 for details.