Started work on auto-enabling OTA to start even if not enabled.

This commit is contained in:
Gregg 2022-03-13 10:19:11 -05:00
parent eac06129fc
commit b6eb5afcbf
5 changed files with 69 additions and 13 deletions

View File

@ -40,11 +40,9 @@ void HAPClient::init(){
nvs_open("SRP",NVS_READWRITE,&srpNVS); // open SRP data namespace in NVS nvs_open("SRP",NVS_READWRITE,&srpNVS); // open SRP data namespace in NVS
nvs_open("HAP",NVS_READWRITE,&hapNVS); // open HAP data namespace in NVS nvs_open("HAP",NVS_READWRITE,&hapNVS); // open HAP data namespace in NVS
nvs_open("OTA",NVS_READWRITE,&otaNVS); // open OTA data namespace in NVS
nvs_open("STATE",NVS_READWRITE,&stateNVS); // open STATE data namespace in NVS
if(!nvs_get_str(otaNVS,"OTADATA",NULL,&len)){ // if found OTA data in NVS if(!nvs_get_str(homeSpan.otaNVS,"OTADATA",NULL,&len)){ // if found OTA data in NVS
nvs_get_str(otaNVS,"OTADATA",homeSpan.spanOTA.otaPwd,&len); // retrieve data nvs_get_str(homeSpan.otaNVS,"OTADATA",homeSpan.spanOTA.otaPwd,&len); // retrieve data
} else { } else {
MD5Builder otaPwdHash; MD5Builder otaPwdHash;
otaPwdHash.begin(); otaPwdHash.begin();
@ -1750,8 +1748,6 @@ void Nonce::inc(){
TLV<kTLVType,10> HAPClient::tlv8; TLV<kTLVType,10> HAPClient::tlv8;
nvs_handle HAPClient::hapNVS; nvs_handle HAPClient::hapNVS;
nvs_handle HAPClient::srpNVS; nvs_handle HAPClient::srpNVS;
nvs_handle HAPClient::otaNVS;
nvs_handle HAPClient::stateNVS;
uint8_t HAPClient::httpBuf[MAX_HTTP+1]; uint8_t HAPClient::httpBuf[MAX_HTTP+1];
HKDF HAPClient::hkdf; HKDF HAPClient::hkdf;
pairState HAPClient::pairStatus; pairState HAPClient::pairStatus;

View File

@ -80,8 +80,6 @@ struct HAPClient {
static TLV<kTLVType,10> tlv8; // TLV8 structure (HAP Section 14.1) with space for 10 TLV records of type kTLVType (HAP Table 5-6) static TLV<kTLVType,10> tlv8; // TLV8 structure (HAP Section 14.1) with space for 10 TLV records of type kTLVType (HAP Table 5-6)
static nvs_handle hapNVS; // handle for non-volatile-storage of HAP data static nvs_handle hapNVS; // handle for non-volatile-storage of HAP data
static nvs_handle srpNVS; // handle for non-volatile-storage of SRP data static nvs_handle srpNVS; // handle for non-volatile-storage of SRP data
static nvs_handle otaNVS; // handle for non-volatile-storage of OTA data
static nvs_handle stateNVS; // handle for non-volatile-storage of HomeSpan STATE data
static uint8_t httpBuf[MAX_HTTP+1]; // buffer to store HTTP messages (+1 to leave room for storing an extra 'overflow' character) static uint8_t httpBuf[MAX_HTTP+1]; // buffer to store HTTP messages (+1 to leave room for storing an extra 'overflow' character)
static HKDF hkdf; // generates (and stores) HKDF-SHA-512 32-byte keys derived from an inputKey of arbitrary length, a salt string, and an info string static HKDF hkdf; // generates (and stores) HKDF-SHA-512 32-byte keys derived from an inputKey of arbitrary length, a salt string, and an info string
static pairState pairStatus; // tracks pair-setup status static pairState pairStatus; // tracks pair-setup status

View File

@ -74,6 +74,7 @@ void Span::begin(Category catID, const char *displayName, const char *hostNameBa
nvs_flash_init(); // initialize non-volatile-storage partition in flash nvs_flash_init(); // initialize non-volatile-storage partition in flash
nvs_open("CHAR",NVS_READWRITE,&charNVS); // open Characteristic data namespace in NVS nvs_open("CHAR",NVS_READWRITE,&charNVS); // open Characteristic data namespace in NVS
nvs_open("WIFI",NVS_READWRITE,&wifiNVS); // open WIFI data namespace in NVS nvs_open("WIFI",NVS_READWRITE,&wifiNVS); // open WIFI data namespace in NVS
nvs_open("OTA",NVS_READWRITE,&otaNVS); // open OTA data namespace in NVS
size_t len; size_t len;
@ -136,9 +137,18 @@ void Span::begin(Category catID, const char *displayName, const char *hostNameBa
Serial.print(" "); Serial.print(" ");
Serial.print(__TIME__); Serial.print(__TIME__);
uint8_t prevSHA[32]={0};
uint8_t sha256[32];
if(!nvs_get_blob(otaNVS,"SHA256",NULL,&len)) // get previous app SHA256 (if it exists)
nvs_get_blob(otaNVS,"SHA256",prevSHA,&len);
esp_partition_get_sha256(esp_ota_get_running_partition(),sha256); // get current app SHA256
newCode=(memcmp(prevSHA,sha256,32)!=0); // set newCode flag based on comparison of previous and current SHA256 values
nvs_set_blob(otaNVS,"SHA256",sha256,sizeof(sha256)); // save current SHA256
nvs_commit(otaNVS);
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 (%s-0x%0X)",esp_ota_get_running_partition()->label,newCode?"NEW":"REBOOTED",otaState);
Serial.print("\n\nDevice Name: "); Serial.print("\n\nDevice Name: ");
Serial.print(displayName); Serial.print(displayName);
@ -521,6 +531,45 @@ 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
int otaStatus=SpanOTA::OTA_OPTIONAL;
nvs_get_i32(otaNVS,"OTASTATUS",&otaStatus);
Serial.printf("*** OTA STATUS: %d ***\n\r",otaStatus);
if(otaStatus==SpanOTA::OTA_REQUIRED){ // most recent reboot was a result of new code being downloaded via OTA
spanOTA.enabled=true; // must enable OTA even if it is not set
Serial.printf("AUTO-ENABLING OTA-1\n\r");
nvs_set_i32(otaNVS,"OTASTATUS",SpanOTA::OTA_MAINTAIN); // reset flag to OTA_MAINTAIN
} // OTA_REQUIRED
else if(otaStatus==SpanOTA::OTA_MAINTAIN){ // most recent reboot was NOT a direct result of new code being downloaded via OTA
if(!newCode){ // codebase has not changed - this is just a reboot of code previously downloaded via OTA
spanOTA.enabled=true; // must enable OTA even if it is not set
Serial.printf("AUTO-ENABLING OTA-2\n\r");
} else { // codebase has changed, but was NOT a result of an OTA update (must be serial download)
Serial.printf("SKIPPING OTA\n\r");
nvs_set_i32(otaNVS,"OTASTATUS",SpanOTA::OTA_OPTIONAL); // reset flag to OTA_OPTIONAL
}
} // OTA_MAINTAIN
nvs_commit(otaNVS);
Serial.printf("\n\rRESET REASON=%d\n\r",esp_reset_reason());
// for(int i=0;i<32;i++)
// Serial.printf("%02X",prevSHA[i]);
// Serial.printf("\n");
//
// for(int i=0;i<32;i++)
// Serial.printf("%02X",sha256[i]);
// Serial.printf("\n");
//
// if(memcmp(prevSHA,sha256,32))
// Serial.printf("SHAs are DIFFERENT\n");
// else
// Serial.printf("SHAs do MATCH\n");
if(spanOTA.enabled){ 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);
@ -696,8 +745,8 @@ void Span::processSerialCommand(const char *c){
otaPwdHash.add(textPwd); otaPwdHash.add(textPwd);
otaPwdHash.calculate(); otaPwdHash.calculate();
otaPwdHash.getChars(spanOTA.otaPwd); otaPwdHash.getChars(spanOTA.otaPwd);
nvs_set_str(HAPClient::otaNVS,"OTADATA",spanOTA.otaPwd); // update data nvs_set_str(otaNVS,"OTADATA",spanOTA.otaPwd); // update data
nvs_commit(HAPClient::otaNVS); nvs_commit(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(!spanOTA.enabled) if(!spanOTA.enabled)
@ -866,6 +915,8 @@ void Span::processSerialCommand(const char *c){
nvs_commit(wifiNVS); nvs_commit(wifiNVS);
nvs_erase_all(charNVS); nvs_erase_all(charNVS);
nvs_commit(charNVS); nvs_commit(charNVS);
nvs_erase_all(otaNVS);
nvs_commit(otaNVS);
Serial.print("\n*** FACTORY RESET! Restarting...\n\n"); Serial.print("\n*** FACTORY RESET! Restarting...\n\n");
delay(1000); delay(1000);
ESP.restart(); ESP.restart();
@ -1995,8 +2046,11 @@ void SpanOTA::start(){
/////////////////////////////// ///////////////////////////////
void SpanOTA::end(){ void SpanOTA::end(){
nvs_set_i32(homeSpan.otaNVS,"OTASTATUS",OTA_REQUIRED);
nvs_commit(homeSpan.otaNVS);
Serial.printf(" DONE! Rebooting...\n"); Serial.printf(" DONE! Rebooting...\n");
homeSpan.statusLED.off(); homeSpan.statusLED.off();
delay(100); // make sure commit it finished before reboot
} }
/////////////////////////////// ///////////////////////////////

View File

@ -128,6 +128,12 @@ struct SpanWebLog{ // optional web status/log data
/////////////////////////////// ///////////////////////////////
struct SpanOTA{ // manages OTA process struct SpanOTA{ // manages OTA process
enum { // keep track of whether OTA need to be required based on prior download
OTA_OPTIONAL,
OTA_MAINTAIN,
OTA_REQUIRED
};
boolean enabled=false; // enables OTA - default if not enabled boolean enabled=false; // enables OTA - default if not enabled
boolean auth; // indicates whether OTA password is required boolean auth; // indicates whether OTA password is required
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
@ -160,8 +166,10 @@ struct Span{
const char *sketchVersion="n/a"; // version of the sketch const char *sketchVersion="n/a"; // version of the sketch
nvs_handle charNVS; // handle for non-volatile-storage of Characteristics data nvs_handle charNVS; // handle for non-volatile-storage of Characteristics data
nvs_handle wifiNVS=0; // handle for non-volatile-storage of WiFi data nvs_handle wifiNVS=0; // handle for non-volatile-storage of WiFi data
nvs_handle otaNVS; // handle for non-volatile storaget of OTA data
char pairingCodeCommand[12]=""; // user-specified Pairing Code - only needed if Pairing Setup Code is specified in sketch using setPairingCode() char pairingCodeCommand[12]=""; // user-specified Pairing Code - only needed if Pairing Setup Code is specified in sketch using setPairingCode()
String lastClientIP="0.0.0.0"; // IP address of last client accessing device through encrypted channel String lastClientIP="0.0.0.0"; // IP address of last client accessing device through encrypted channel
boolean newCode; // flag indicating new application code has been loaded (based on keeping track of app SHA256)
boolean connected=false; // WiFi connection status boolean connected=false; // WiFi connection status
unsigned long waitTime=60000; // time to wait (in milliseconds) between WiFi connection attempts unsigned long waitTime=60000; // time to wait (in milliseconds) between WiFi connection attempts

View File

@ -21,7 +21,7 @@ void setup() {
homeSpan.setPortNum(1201); homeSpan.setPortNum(1201);
// homeSpan.setMaxConnections(6); // homeSpan.setMaxConnections(6);
// homeSpan.setQRID("One1"); // homeSpan.setQRID("One1");
homeSpan.enableOTA(); // homeSpan.enableOTA(false);
homeSpan.setSketchVersion("OTA Test 5"); homeSpan.setSketchVersion("OTA Test 5");
homeSpan.setWifiCallback(wifiEstablished); homeSpan.setWifiCallback(wifiEstablished);