room-audio/esp-anchor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: implement OTA updates over HTTP(S), initiated over MQTT

Browse Source
This commit is contained in:
dvdrw
2026-05-17 00:24:43 +02:00
parent 8992e311ba
commit b9195a0dda
10 changed files with 221 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
components/config_store/src/config_store.c
+22 -5
View File
@@ -5,10 +5,12 @@
#include "esp_log.h"
#include <string.h>
#define NS "anchor_cfg"
#define KEY_PROV "provisioned"
#define KEY_HOST "mqtt_host"
#define KEY_PORT "mqtt_port"
#define NS "anchor_cfg"
#define KEY_PROV "provisioned"
#define KEY_HOST "mqtt_host"
#define KEY_PORT "mqtt_port"
#define KEY_SCHEMA_VER "schema_ver"
#define CURRENT_SCHEMA_VER 1
static const char *TAG = "config_store";
@@ -20,7 +22,22 @@ esp_err_t config_store_init(void)
ESP_ERROR_CHECK(nvs_flash_erase());
err = nvs_flash_init();
}
return err;
if (err != ESP_OK) return err;
nvs_handle_t h;
err = nvs_open(NS, NVS_READWRITE, &h);
if (err != ESP_OK) return err;
uint8_t schema_ver = 0;
nvs_get_u8(h, KEY_SCHEMA_VER, &schema_ver);
if (schema_ver < CURRENT_SCHEMA_VER) {
/* Add migration steps here for future schema changes */
nvs_set_u8(h, KEY_SCHEMA_VER, CURRENT_SCHEMA_VER);
nvs_commit(h);
ESP_LOGI(TAG, "NVS schema migrated %u -> %u", schema_ver, CURRENT_SCHEMA_VER);
}
nvs_close(h);
return ESP_OK;
}
bool config_store_is_provisioned(void)
components/mqtt_publisher/include/mqtt_publisher.h
+13
View File
@@ -13,6 +13,7 @@
#define MQTT_DESELECTED_BIT BIT4
#define MQTT_FACTORY_RESET_BIT BIT5
#define MQTT_RECONFIGURE_SETTINGS_BIT BIT6
#define MQTT_OTA_BIT BIT7
/* Populated by handle_cmd() before MQTT_RECONFIGURE_SETTINGS_BIT is set.
* All fields are optional — empty string means "not provided, leave unchanged". */
@@ -27,6 +28,18 @@ typedef struct {
* MQTT_RECONFIGURE_SETTINGS_BIT fires; must be read before the next MQTT event. */
const mqtt_reconfigure_data_t *mqtt_publisher_get_reconfigure_data(void);
typedef struct {
char url[256];
char version[32];
} mqtt_ota_data_t;
/** Returns a pointer to the last parsed OTA payload. Valid only after
* MQTT_OTA_BIT fires; must be read before the next MQTT event. */
const mqtt_ota_data_t *mqtt_publisher_get_ota_data(void);
/** Publish OTA status to localiser/sensor/{id}/ota. Non-blocking (QoS 1). */
void mqtt_publisher_send_ota_status(const char *status, const char *version);
/**
* Initialise and connect the MQTT client.
*
components/mqtt_publisher/src/mqtt_publisher.c
+32 -1
View File
@@ -7,21 +7,29 @@
#define TAG "mqtt_publisher"
#define TOPIC_PREFIX "localiser/sensor"
#define TOPIC_OTA_BROADCAST "localiser/ota"
static esp_mqtt_client_handle_t s_client = NULL;
static char s_sensor_id[32];
static EventGroupHandle_t s_evt = NULL;
static mqtt_reconfigure_data_t s_reconfigure_data;
static mqtt_ota_data_t s_ota_data;
const mqtt_reconfigure_data_t *mqtt_publisher_get_reconfigure_data(void)
{
return &s_reconfigure_data;
}
const mqtt_ota_data_t *mqtt_publisher_get_ota_data(void)
{
return &s_ota_data;
}
/* Pre-built topic strings */
static char s_topic_rssi[96];
static char s_topic_announce[96];
static char s_topic_cmd[96];
static char s_topic_ota[96];
static void build_topics(void)
{
@@ -31,6 +39,8 @@ static void build_topics(void)
"%s/%s/announce", TOPIC_PREFIX, s_sensor_id);
snprintf(s_topic_cmd, sizeof(s_topic_cmd),
"%s/%s/cmd", TOPIC_PREFIX, s_sensor_id);
snprintf(s_topic_ota, sizeof(s_topic_ota),
"%s/%s/ota", TOPIC_PREFIX, s_sensor_id);
}
static void handle_cmd(const char *data, int data_len)
@@ -50,6 +60,15 @@ static void handle_cmd(const char *data, int data_len)
else if (strcmp(a, "selected") == 0) xEventGroupSetBits(s_evt, MQTT_SELECTED_BIT);
else if (strcmp(a, "deselected") == 0) xEventGroupSetBits(s_evt, MQTT_DESELECTED_BIT);
else if (strcmp(a, "factory_reset") == 0) xEventGroupSetBits(s_evt, MQTT_FACTORY_RESET_BIT);
else if (strcmp(a, "ota") == 0) {
memset(&s_ota_data, 0, sizeof(s_ota_data));
cJSON *url_j = cJSON_GetObjectItemCaseSensitive(root, "url");
cJSON *ver_j = cJSON_GetObjectItemCaseSensitive(root, "version");
if (cJSON_IsString(url_j)) strncpy(s_ota_data.url, url_j->valuestring, sizeof(s_ota_data.url) - 1);
if (cJSON_IsString(ver_j)) strncpy(s_ota_data.version, ver_j->valuestring, sizeof(s_ota_data.version) - 1);
if (s_ota_data.url[0] != '\0') xEventGroupSetBits(s_evt, MQTT_OTA_BIT);
else ESP_LOGW(TAG, "OTA cmd missing url");
}
else if (strcmp(a, "reconfigure_settings") == 0) {
memset(&s_reconfigure_data, 0, sizeof(s_reconfigure_data));
cJSON *ssid_j = cJSON_GetObjectItemCaseSensitive(root, "ssid");
@@ -75,6 +94,7 @@ static void mqtt_event_handler(void *arg, esp_event_base_t base,
case MQTT_EVENT_CONNECTED:
ESP_LOGI(TAG, "Connected to broker");
esp_mqtt_client_subscribe(s_client, s_topic_cmd, 1);
esp_mqtt_client_subscribe(s_client, TOPIC_OTA_BROADCAST, 1);
xEventGroupSetBits(s_evt, MQTT_CONNECTED_BIT);
mqtt_publisher_announce();
break;
@@ -85,7 +105,8 @@ static void mqtt_event_handler(void *arg, esp_event_base_t base,
break;
case MQTT_EVENT_DATA:
if (strncmp(event->topic, s_topic_cmd, event->topic_len) == 0) {
if (strncmp(event->topic, s_topic_cmd, event->topic_len) == 0 ||
strncmp(event->topic, TOPIC_OTA_BROADCAST, event->topic_len) == 0) {
handle_cmd(event->data, event->data_len);
}
break;
@@ -150,3 +171,13 @@ void mqtt_publisher_send_beacon(const char *type, const char *id, int8_t tx_powe
type, id, (int)tx_power, (int)rssi);
esp_mqtt_client_publish(s_client, s_topic_rssi, payload, len, 1, 0);
}
void mqtt_publisher_send_ota_status(const char *status, const char *version)
{
if (!s_client) return;
char payload[96];
int len = snprintf(payload, sizeof(payload),
"{\"status\":\"%s\",\"version\":\"%s\"}", status, version ? version : "");
esp_mqtt_client_publish(s_client, s_topic_ota, payload, len, 1, 0);
}
components/ota_manager/CMakeLists.txt
+5
View File
@@ -0,0 +1,5 @@
idf_component_register(
SRCS "src/ota_manager.c"
INCLUDE_DIRS "include"
REQUIRES esp_https_ota app_update mqtt_publisher esp_system
)
components/ota_manager/include/ota_manager.h
+12
View File
@@ -0,0 +1,12 @@
#pragma once
#include "esp_err.h"
/**
* Begin an OTA update in a background task.
* Applies a MAC-derived jitter delay before downloading so a fleet-wide
* trigger staggers reboots instead of dropping all coverage at once.
* Reports status via mqtt_publisher_send_ota_status().
* On success the device reboots; on failure it stays on the current firmware.
*/
esp_err_t ota_manager_start(const char *url, const char *version);
components/ota_manager/src/ota_manager.c
+84
View File
@@ -0,0 +1,84 @@
#include "ota_manager.h"
#include "mqtt_publisher.h"
#include "esp_https_ota.h"
#include "esp_ota_ops.h"
#include "esp_mac.h"
#include "esp_log.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include <string.h>
#include <stdlib.h>
#define TAG "ota_manager"
/* Prevent concurrent OTA attempts */
static volatile bool s_ota_running = false;
typedef struct {
char url[256];
char version[32];
} ota_task_arg_t;
static void ota_task(void *arg)
{
ota_task_arg_t *params = (ota_task_arg_t *)arg;
/* Spread reboots across up to 60 s using last 3 MAC bytes as seed */
uint8_t mac[6];
esp_read_mac(mac, ESP_MAC_WIFI_STA);
uint32_t jitter_ms = ((uint32_t)(mac[3] ^ mac[4] ^ mac[5])) % 60000;
if (jitter_ms > 0) {
ESP_LOGI(TAG, "OTA jitter: %lu ms", jitter_ms);
mqtt_publisher_send_ota_status("pending", params->version);
vTaskDelay(pdMS_TO_TICKS(jitter_ms));
}
ESP_LOGI(TAG, "Starting OTA from %s", params->url);
mqtt_publisher_send_ota_status("downloading", params->version);
esp_http_client_config_t http_cfg = {
.url = params->url,
.timeout_ms = 30000,
.keep_alive_enable = true,
};
esp_https_ota_config_t ota_cfg = {
.http_config = &http_cfg,
};
esp_err_t err = esp_https_ota(&ota_cfg);
if (err == ESP_OK) {
ESP_LOGI(TAG, "OTA succeeded, rebooting");
mqtt_publisher_send_ota_status("rebooting", params->version);
vTaskDelay(pdMS_TO_TICKS(500)); /* let MQTT publish flush */
esp_restart();
} else {
ESP_LOGE(TAG, "OTA failed: %s", esp_err_to_name(err));
mqtt_publisher_send_ota_status("failed", params->version);
}
free(params);
s_ota_running = false;
vTaskDelete(NULL);
}
esp_err_t ota_manager_start(const char *url, const char *version)
{
if (s_ota_running) {
ESP_LOGW(TAG, "OTA already in progress, ignoring");
return ESP_ERR_INVALID_STATE;
}
ota_task_arg_t *params = malloc(sizeof(ota_task_arg_t));
if (!params) return ESP_ERR_NO_MEM;
strncpy(params->url, url, sizeof(params->url) - 1);
strncpy(params->version, version ? version : "", sizeof(params->version) - 1);
s_ota_running = true;
if (xTaskCreate(ota_task, "ota_task", 8192, params, 5, NULL) != pdPASS) {
free(params);
s_ota_running = false;
return ESP_FAIL;
}
return ESP_OK;
}