Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

SpanOTA in progress

This commit is contained in:
Gregg 2022-03-12 14:31:15 -06:00
parent 2f1044b013
commit f3d5092340
3 changed files with 32 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
src/HomeSpan.cpp
View File

@ -139,31 +139,11 @@ void Span::begin(Category catID, const char *displayName, const char *hostNameBa
esp_ota_img_states_t otaState; esp_ota_img_states_t otaState;
esp_ota_get_state_partition(esp_ota_get_running_partition(),&otaState); esp_ota_get_state_partition(esp_ota_get_running_partition(),&otaState);
Serial.printf("\nPartition: %s (%X)",esp_ota_get_running_partition()->label,otaState); Serial.printf("\nPartition: %s (%X)",esp_ota_get_running_partition()->label,otaState);
Serial.printf("\nMagic Cookie: %s",spanPartition.magicCookie);
esp_app_desc_t appDesc;
esp_ota_get_partition_description(esp_ota_get_running_partition(),&appDesc);
char newDesc[256];
esp_partition_read(esp_ota_get_running_partition(), sizeof(esp_image_header_t) + sizeof(esp_image_segment_header_t) + sizeof(esp_app_desc_t), newDesc, sizeof(newDesc));
Serial.println();
Serial.println(appDesc.version);
Serial.println(appDesc.project_name);
Serial.println(appDesc.time);
Serial.println(appDesc.date);
Serial.println(appDesc.idf_ver);
if(strlen(spanPartition.magicCookie))
{Serial.println("HI\n");
}
Serial.println(newDesc);
Serial.print("\n\nDevice Name: "); Serial.print("\n\nDevice Name: ");
Serial.print(displayName); Serial.print(displayName);
Serial.print("\n\n"); Serial.print("\n\n");
} // begin } // begin
/////////////////////////////// ///////////////////////////////
@ -305,7 +285,7 @@ void Span::poll() {
HAPClient::checkNotifications(); HAPClient::checkNotifications();
HAPClient::checkTimedWrites(); HAPClient::checkTimedWrites();
if(otaEnabled) if(spanOTA.enabled)
ArduinoOTA.handle(); ArduinoOTA.handle();
if(controlButton.primed()){ if(controlButton.primed()){
@ -525,11 +505,10 @@ void Span::checkConnect(){
else else
mdns_service_txt_item_set("_hap","_tcp","sf","0"); // set Status Flag = 0 mdns_service_txt_item_set("_hap","_tcp","sf","0"); // set Status Flag = 0
mdns_service_txt_item_set("_hap","_tcp","hspn",HOMESPAN_VERSION); // HomeSpan Version Number (info only - NOT used by HAP) mdns_service_txt_item_set("_hap","_tcp","hspn",HOMESPAN_VERSION); // HomeSpan Version Number (info only - NOT used by HAP)
mdns_service_txt_item_set("_hap","_tcp","ard-esp32",ARDUINO_ESP_VERSION); // Arduino-ESP32 Version Number (info only - NOT used by HAP) mdns_service_txt_item_set("_hap","_tcp","ard-esp32",ARDUINO_ESP_VERSION); // Arduino-ESP32 Version Number (info only - NOT used by HAP)
mdns_service_txt_item_set("_hap","_tcp","board",ARDUINO_VARIANT); // Board Name (info only - NOT used by HAP) mdns_service_txt_item_set("_hap","_tcp","board",ARDUINO_VARIANT); // Board Name (info only - NOT used by HAP)
mdns_service_txt_item_set("_hap","_tcp","sketch",sketchVersion); // Sketch Version (info only - NOT used by HAP) mdns_service_txt_item_set("_hap","_tcp","sketch",sketchVersion); // Sketch Version (info only - NOT used by HAP)
mdns_service_txt_item_set("_hap","_tcp","ota",otaEnabled?"yes":"no"); // OTA Enabled (info only - NOT used by HAP)
uint8_t hashInput[22]; uint8_t hashInput[22];
uint8_t hashOutput[64]; uint8_t hashOutput[64];
@ -542,48 +521,14 @@ void Span::checkConnect(){
mbedtls_base64_encode((uint8_t *)setupHash,9,&len,hashOutput,4); // Step 3: Encode the first 4 bytes of hashOutput in base64, which results in an 8-character, null-terminated, setupHash mbedtls_base64_encode((uint8_t *)setupHash,9,&len,hashOutput,4); // Step 3: Encode the first 4 bytes of hashOutput in base64, which results in an 8-character, null-terminated, setupHash
mdns_service_txt_item_set("_hap","_tcp","sh",setupHash); // Step 4: broadcast the resulting Setup Hash mdns_service_txt_item_set("_hap","_tcp","sh",setupHash); // Step 4: broadcast the resulting Setup Hash
if(otaEnabled){ if(spanOTA.enabled){
if(esp_ota_get_running_partition()!=esp_ota_get_next_update_partition(NULL)){ if(esp_ota_get_running_partition()!=esp_ota_get_next_update_partition(NULL)){
ArduinoOTA.setHostname(hostName); ArduinoOTA.setHostname(hostName);
if(otaAuth) if(otaAuth)
ArduinoOTA.setPasswordHash(otaPwd); ArduinoOTA.setPasswordHash(otaPwd);
ArduinoOTA.onStart(spanOTA.start).onEnd(spanOTA.end).onProgress(spanOTA.progress).onError(spanOTA.error); ArduinoOTA.onStart(spanOTA.start).onEnd(spanOTA.end).onProgress(spanOTA.progress).onError(spanOTA.error);
// ArduinoOTA
// .onStart([]() {
// Serial.printf("\n*** Current Partition: %s\n*** New Partition: %s\n*** OTA Starting..",
// esp_ota_get_running_partition()->label,esp_ota_get_next_update_partition(NULL)->label);
// otaPercent=-10;
// homeSpan.statusLED.start(LED_OTA_STARTED);
// })
// .onEnd([]() {
// Serial.printf(" DONE! Rebooting...\n");
// char newDesc[256];
// esp_partition_read(esp_ota_get_next_update_partition(NULL), sizeof(esp_image_header_t) + sizeof(esp_image_segment_header_t) + sizeof(esp_app_desc_t), newDesc, sizeof(newDesc));
// Serial.printf("Found: %s\n",newDesc);
// homeSpan.statusLED.off();
// })
// .onProgress([](unsigned int progress, unsigned int total) {
// int percent=progress*100/total;
// if(percent/10 != otaPercent/10){
// otaPercent=percent;
// Serial.printf("%d%%..",progress*100/total);
// if(progress*100/total>20){
// Serial.println("BAD!!\n");
// Update.abort();
// }
// }
// })
// .onError([](ota_error_t error) {
// Serial.printf("*** OTA Error[%u]: ", error);
// if (error == OTA_AUTH_ERROR) Serial.println("Auth Failed\n");
// else if (error == OTA_BEGIN_ERROR) Serial.println("Begin Failed\n");
// else if (error == OTA_CONNECT_ERROR) Serial.println("Connect Failed\n");
// else if (error == OTA_RECEIVE_ERROR) Serial.println("Receive Failed\n");
// else if (error == OTA_END_ERROR) Serial.println("End Failed\n");
// });
ArduinoOTA.begin(); ArduinoOTA.begin();
Serial.print("Starting OTA Server: "); Serial.print("Starting OTA Server: ");
@ -594,11 +539,11 @@ void Span::checkConnect(){
Serial.print(otaAuth?"Enabled\n\n":"DISABLED!\n\n"); Serial.print(otaAuth?"Enabled\n\n":"DISABLED!\n\n");
} else { } else {
Serial.print("\n*** WARNING: Can't start OTA Server - Partition table used to compile this sketch is not configured for OTA.\n\n"); Serial.print("\n*** WARNING: Can't start OTA Server - Partition table used to compile this sketch is not configured for OTA.\n\n");
otaEnabled=false; spanOTA.enabled=false;
} }
} }
mdns_service_txt_item_set("_hap","_tcp","ota",otaEnabled?"yes":"no"); // OTA status (info only - NOT used by HAP) mdns_service_txt_item_set("_hap","_tcp","ota",spanOTA.enabled?"yes":"no"); // OTA status (info only - NOT used by HAP)
if(webLog.isEnabled){ if(webLog.isEnabled){
mdns_service_txt_item_set("_hap","_tcp","logURL",webLog.statusURL.c_str()+4); // Web Log status (info only - NOT used by HAP) mdns_service_txt_item_set("_hap","_tcp","logURL",webLog.statusURL.c_str()+4); // Web Log status (info only - NOT used by HAP)
@ -755,7 +700,7 @@ void Span::processSerialCommand(const char *c){
nvs_commit(HAPClient::otaNVS); nvs_commit(HAPClient::otaNVS);
Serial.print("... Accepted! Password change will take effect after next restart.\n"); Serial.print("... Accepted! Password change will take effect after next restart.\n");
if(!otaEnabled) if(!spanOTA.enabled)
Serial.print("... Note: OTA has not been enabled in this sketch.\n"); Serial.print("... Note: OTA has not been enabled in this sketch.\n");
Serial.print("\n"); Serial.print("\n");
} }
@ -2031,6 +1976,13 @@ void SpanWebLog::addLog(const char *fmt, ...){
// SpanOTA // // SpanOTA //
/////////////////////////////// ///////////////////////////////
void SpanOTA::init(boolean auth, boolean safeLoad){
enabled=true;
safeLoad=safeLoad;
this->auth=auth;
homeSpan.reserveSocketConnections(1);
}
void SpanOTA::start(){ void SpanOTA::start(){
Serial.printf("\n*** Current Partition: %s\n*** New Partition: %s\n*** OTA Starting..", Serial.printf("\n*** Current Partition: %s\n*** New Partition: %s\n*** OTA Starting..",
esp_ota_get_running_partition()->label,esp_ota_get_next_update_partition(NULL)->label); esp_ota_get_running_partition()->label,esp_ota_get_next_update_partition(NULL)->label);
@ -2042,10 +1994,6 @@ void SpanOTA::start(){
void SpanOTA::end(){ void SpanOTA::end(){
Serial.printf(" DONE! Rebooting...\n"); Serial.printf(" DONE! Rebooting...\n");
// char newDesc[256];
SpanPartition newSpanPartition;
esp_partition_read(esp_ota_get_next_update_partition(NULL), sizeof(esp_image_header_t) + sizeof(esp_image_segment_header_t) + sizeof(esp_app_desc_t), &newSpanPartition, sizeof(newSpanPartition));
Serial.printf("Found: %s\n",newSpanPartition.magicCookie);
homeSpan.statusLED.off(); homeSpan.statusLED.off();
} }
@ -2056,10 +2004,14 @@ void SpanOTA::progress(uint32_t progress, uint32_t total){
if(percent/10 != otaPercent/10){ if(percent/10 != otaPercent/10){
otaPercent=percent; otaPercent=percent;
Serial.printf("%d%%..",progress*100/total); Serial.printf("%d%%..",progress*100/total);
if(progress*100/total>20){ }
Serial.println("BAD!!\n");
// Update.abort(); if(safeLoad && progress==total){
} SpanPartition newSpanPartition;
esp_partition_read(esp_ota_get_next_update_partition(NULL), sizeof(esp_image_header_t) + sizeof(esp_image_segment_header_t) + sizeof(esp_app_desc_t), &newSpanPartition, sizeof(newSpanPartition));
Serial.printf("Checking for HomeSpan Magic Cookie: %s..",newSpanPartition.magicCookie);
if(strcmp(newSpanPartition.magicCookie,spanPartition.magicCookie))
Update.abort();
} }
} }
@ -2077,7 +2029,7 @@ void SpanOTA::error(ota_error_t err){
/////////////////////////////// ///////////////////////////////
int SpanOTA::otaPercent; int SpanOTA::otaPercent;
boolean SpanOTA::verified; boolean SpanOTA::safeLoad;

9
src/HomeSpan.h
View File

@ -128,8 +128,11 @@ struct SpanWebLog{ // optional web status/log data
/////////////////////////////// ///////////////////////////////
struct SpanOTA{ // manages OTA process struct SpanOTA{ // manages OTA process
boolean enabled=false;
boolean auth;
static int otaPercent; static int otaPercent;
static boolean verified; static boolean safeLoad;
void init(boolean auth, boolean safeLoad);
static void start(); static void start();
static void end(); static void end();
static void progress(uint32_t progress, uint32_t total); static void progress(uint32_t progress, uint32_t total);
@ -173,10 +176,8 @@ struct Span{
unsigned long comModeLife=DEFAULT_COMMAND_TIMEOUT*1000; // length of time (in milliseconds) to keep Command Mode alive before resuming normal operations unsigned long comModeLife=DEFAULT_COMMAND_TIMEOUT*1000; // length of time (in milliseconds) to keep Command Mode alive before resuming normal operations
uint16_t tcpPortNum=DEFAULT_TCP_PORT; // port for TCP communications between HomeKit and HomeSpan uint16_t tcpPortNum=DEFAULT_TCP_PORT; // port for TCP communications between HomeKit and HomeSpan
char qrID[5]=""; // Setup ID used for pairing with QR Code char qrID[5]=""; // Setup ID used for pairing with QR Code
boolean otaEnabled=false; // enables Over-the-Air ("OTA") updates
char otaPwd[33]; // MD5 Hash of OTA password, represented as a string of hexidecimal characters char otaPwd[33]; // MD5 Hash of OTA password, represented as a string of hexidecimal characters
boolean otaAuth; // OTA requires password when set to true boolean otaAuth; // OTA requires password when set to true
boolean otaDownload=false; // set to true in NVS if last download was via OTA
void (*wifiCallback)()=NULL; // optional callback function to invoke once WiFi connectivity is established void (*wifiCallback)()=NULL; // optional callback function to invoke once WiFi connectivity is established
void (*pairCallback)(boolean isPaired)=NULL; // optional callback function to invoke when pairing is established (true) or lost (false) void (*pairCallback)(boolean isPaired)=NULL; // optional callback function to invoke when pairing is established (true) or lost (false)
boolean autoStartAPEnabled=false; // enables auto start-up of Access Point when WiFi Credentials not found boolean autoStartAPEnabled=false; // enables auto start-up of Access Point when WiFi Credentials not found
@ -246,7 +247,7 @@ struct Span{
void setPairingCode(const char *s){sprintf(pairingCodeCommand,"S %9s",s);} // sets the Pairing Code - use is NOT recommended. Use 'S' from CLI instead void setPairingCode(const char *s){sprintf(pairingCodeCommand,"S %9s",s);} // sets the Pairing Code - use is NOT recommended. Use 'S' from CLI instead
void deleteStoredValues(){processSerialCommand("V");} // deletes stored Characteristic values from NVS void deleteStoredValues(){processSerialCommand("V");} // deletes stored Characteristic values from NVS
void enableOTA(boolean auth=true){otaEnabled=true;otaAuth=auth;reserveSocketConnections(1);} // enables Over-the-Air updates, with (auth=true) or without (auth=false) authorization password void enableOTA(boolean auth=true, boolean safeLoad=true){spanOTA.init(auth, safeLoad);} // enables Over-the-Air updates, with (auth=true) or without (auth=false) authorization password
void enableWebLog(uint16_t maxEntries=0, const char *serv=NULL, const char *tz="UTC", const char *url=DEFAULT_WEBLOG_URL){ // enable Web Logging void enableWebLog(uint16_t maxEntries=0, const char *serv=NULL, const char *tz="UTC", const char *url=DEFAULT_WEBLOG_URL){ // enable Web Logging
webLog.init(maxEntries, serv, tz, url); webLog.init(maxEntries, serv, tz, url);

2
src/Settings.h
View File

@ -86,7 +86,7 @@
///////////////////////////////////////////////////// /////////////////////////////////////////////////////
// OTA PARTITION INFO // // OTA PARTITION INFO //
#define HOMESPAN_MAGIC_COOKIE "HomeSpanMagicCookie" #define HOMESPAN_MAGIC_COOKIE "HomeSpanMagicCookie##2022"
///////////////////////////////////////////////////// /////////////////////////////////////////////////////
// STATUS LED SETTINGS // // STATUS LED SETTINGS //