Skip to content

Commit

Permalink
add SPIFFS flashing over the air
Browse files Browse the repository at this point in the history
  • Loading branch information
pgollor committed Sep 18, 2015
1 parent 5e3fb60 commit da7114c
Show file tree
Hide file tree
Showing 3 changed files with 417 additions and 21 deletions.
294 changes: 294 additions & 0 deletions libraries/ESP8266mDNS/OTA-mDNS-SPIFFS/OTA-mDNS-SPIFFS.ino
Original file line number Diff line number Diff line change
@@ -0,0 +1,294 @@
/**
* @file OTA-mDNS-SPIFFS.ino
*
* @author Pascal Gollor (http://www.pgollor.de/cms/)
* @data 2015-09-18
*
*/


#include <ESP8266WiFi.h>
#include <ESP8266mDNS.h>
#include <WiFiUdp.h>
#include <FS.h>


/**
* @brief mDNS and OTA Constants
* @{
*/
#define HOSTNAME "ESP8266-ota" ///< Hostename
#define APORT 8266 ///< Port for OTA update
/// @}

/**
* @brief Default WiFi connection information.
* @{
*/
const char* ap_default_ssid = "esp8266"; ///< Default SSID.
const char* ap_default_psk = "esp8266esp8266"; ///< Default PSK.
/// @}

/// OTA Update UDP server handle.
WiFiUDP OTA;

/// Global WiFi SSID.
String g_ssid = "";

/// Global WiFi PSK.
String g_pass = "";


/**
* @brief Read WiFi connection information from file system.
* @param ssid String pointer for storing SSID.
* @param pass String pointer for storing PSK.
* @return True or False.
*
* The config file have to containt the WiFi SSID in the first line
* and the WiFi PSK in the second line.
* Line seperator have to be \r\n (CR LF).
*/
bool loadConfig(String *ssid, String *pass)
{
// open file for reading.
File configFile = SPIFFS.open("/cl_conf.txt", "r");
if (!configFile)
{
Serial.println("Failed to open cl_conf.txt.");

return false;
}

// Read content from config file.
String content = configFile.readString();
configFile.close();

content.trim();

// Check if ther is a second line available.
uint8_t pos = content.indexOf("\r\n");
if (pos == 0)
{
Serial.println("Infvalid content.");
Serial.println(content);

return false;
}

// Store SSID and PSK into string vars.
*ssid = content.substring(0, pos);
*pass = content.substring(pos + 2);

// Print SSID.
Serial.print("ssid: ");
Serial.println(*ssid);

return true;
} // loadConfig


/**
* @brief Save WiFi SSID and PSK to configuration file.
* @param ssid SSID as string pointer.
* @param pass PSK as string pointer,
* @return True or False.
*/
bool saveConfig(String *ssid, String *pass)
{
// Open config file for writing.
File configFile = SPIFFS.open("/cl_conf.txt", "w");
if (!configFile)
{
Serial.println("Failed to open cl_conf.txt for writing");

return false;
}

// Save SSID and PSK.
configFile.println(*ssid);
configFile.println(*pass);

configFile.close();

return true;
} // saveConfig


/**
* @brief Handle OTA update stuff.
*
* This function comes from ESP8266 Arduino example:
* https://github.com/esp8266/Arduino/blob/esp8266/hardware/esp8266com/esp8266/libraries/ESP8266mDNS/examples/DNS_SD_Arduino_OTA/DNS_SD_Arduino_OTA.ino
*
* Modification for uploading SPIFFS images from Pascal Gollor.
*
*/
static inline void ota_handle(void)
{
bool spiffs = false;

if (! OTA.parsePacket())
{
return;
}

// Get remote IP
IPAddress remote = OTA.remoteIP();

// Get command
int cmd = OTA.parseInt();
Serial.print("command: ");
Serial.println(cmd);
if (cmd == U_SPIFFS)
{
spiffs = true;
Serial.println("Get SPIFFS image.");
}

// Get remote port
int port = OTA.parseInt();

// Get sketch size.
int sketch_size = OTA.parseInt();

// Output stuff
Serial.print("Update Start: ip:");
Serial.print(remote);
Serial.printf(", port:%d, size:%d\r\n", port, sketch_size);

// Stop all UDP connections.
WiFiUDP::stopAll();

// OTA start Time
uint32_t startTime = millis();

// Start Updateing.
if(!Update.begin(sketch_size, cmd))
{
Serial.println("Update Begin Error");
return;
}

WiFiClient client;
if (client.connect(remote, port))
{
uint32_t written;
while(!Update.isFinished())
{
written = Update.write(client);
if(written > 0) client.print(written, DEC);
}
Serial.setDebugOutput(false);

if(Update.end())
{
client.println("OK");
Serial.printf("Update Success: %u\nRebooting...\n", (unsigned int)(millis() - startTime));
ESP.restart();
}
else
{
Update.printError(client);
Update.printError(Serial);
}
}
else
{
Serial.printf("Connect Failed: %u\n", (unsigned int)(millis() - startTime));
}
} // ota_handle


/**
* @brief Arduino setup function.
*/
void setup()
{
g_ssid = "";
g_pass = "";

Serial.begin(115200);

delay(100);

Serial.println("\r\n");
Serial.print("Chip ID: ");
Serial.println(ESP.getChipId(), HEX);

// Initialize file system.
if (!SPIFFS.begin())
{
Serial.println("Failed to mount file system");
return;
}

// Load wifi connection information.
if (! loadConfig(&g_ssid, &g_pass))
{
g_ssid = "";
g_pass = "";

Serial.println("No WiFi connection information available.");
}

// Set Hostname.
WiFi.hostname(HOSTNAME);

Serial.println("Wait for WiFi connection.");

// Try to connect to WiFi AP.
WiFi.mode(WIFI_STA);
delay(10);
WiFi.begin(g_ssid.c_str(), g_pass.c_str());

// Give ESP 10 seconds to connect to ap.
unsigned long startTime = millis();
while (WiFi.status() != WL_CONNECTED && millis() - startTime < 10000)
{
Serial.write('.');
delay(500);
}
Serial.println();

// check connection
if(WiFi.status() == WL_CONNECTED)
{
Serial.print("IP address: ");
Serial.println(WiFi.localIP());
}
else
{
Serial.println("Can not connect. Go into AP mode.");

// Go into AP mode.
WiFi.mode(WIFI_AP);

delay(10);

WiFi.softAP(ap_default_ssid, ap_default_psk);

Serial.print("IP address: ");
Serial.println(WiFi.softAPIP());
}

// Initialize mDNS service.
MDNS.begin(HOSTNAME);

// ... Add OTA service.
MDNS.addService("arduino", "tcp", APORT);

// Open OTA Server.
OTA.begin(APORT);
}


/**
* @brief Arduino loop function.
*/
void loop()
{
// Handle OTA update.
ota_handle();
}

2 changes: 2 additions & 0 deletions libraries/ESP8266mDNS/OTA-mDNS-SPIFFS/data/cl_conf.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
YOUR_SSID
YOUR_PSK
Loading

0 comments on commit da7114c

Please sign in to comment.