{"id":16237555,"url":"https://github.com/lexus2k/esp_ota_upgrade","last_synced_at":"2025-03-19T16:30:20.329Z","repository":{"id":108162816,"uuid":"419595097","full_name":"lexus2k/esp_ota_upgrade","owner":"lexus2k","description":"Improved ESP OTA Upgrade component","archived":false,"fork":false,"pushed_at":"2022-03-23T08:37:18.000Z","size":15,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-28T19:38:27.789Z","etag":null,"topics":["esp32","esp32-idf","esp32-ota","ota","ota-firmware-updates","ota-server","ota-update","ota-updater"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lexus2k.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-21T05:38:38.000Z","updated_at":"2023-10-25T14:30:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"85da09a2-15d5-453a-9a20-d2d30e7147e5","html_url":"https://github.com/lexus2k/esp_ota_upgrade","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lexus2k%2Fesp_ota_upgrade","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lexus2k%2Fesp_ota_upgrade/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lexus2k%2Fesp_ota_upgrade/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lexus2k%2Fesp_ota_upgrade/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lexus2k","download_url":"https://codeload.github.com/lexus2k/esp_ota_upgrade/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244003532,"owners_count":20382199,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esp32","esp32-idf","esp32-ota","ota","ota-firmware-updates","ota-server","ota-update","ota-updater"],"created_at":"2024-10-10T13:36:08.022Z","updated_at":"2025-03-19T16:30:20.324Z","avatar_url":"https://github.com/lexus2k.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ESP OTA enhanced upgrade\n\nImproved ESP OTA Upgrade component\n\n# How to use\n\n## How to add FW upgrade function to your web-server on the IoT device\n\n![image](https://user-images.githubusercontent.com/16983230/159657446-a23b0caa-f3f0-4737-b708-0d643c55d1e4.png)\n\n\n```.cpp\n\n\nstatic void on_upgrade_start(void)\n{\n    // Here you can do anything before upgrade process is started\n}\n\nstatic void on_upgrade_end(bool success)\n{\n    if ( success )\n    {\n    }\n    else\n    {\n    }\n}\n\nstatic bool before_upgrade_check(httpd_req_t *req)\n{\n    // Do, whatever you need to do to make sure that sender is allowed to upgrade IoT device\n    uint8_t authenticated = validate_session(req, \"POST\"); // This is an example function\n    if ( !authenticated)\n    {\n        // Do, whatever you want to do in case Upgrade is cancelled\n        redirect_to_login_page(req, false);\n        return false;\n    }\n    return true;\n}\n\n\n...\n    // Registers /fwupdate URI\n    register_httpd_ota_handler(server, before_upgrade_check, on_upgrade_start, on_upgrade_end );\n...\n\n\n```\n\n## Initiate self-upgrade by the device itself\n\n```.cpp\n\nstatic void on_upgrade_start(void)\n{\n    // Here you can do anything before upgrade process is started\n}\n\nstatic void on_upgrade_end(bool success)\n{\n    if ( success )\n    {\n    }\n    else\n    {\n    }\n}\n\nbool on_validate_version(const char * new_ver)\n{\n    // Validate here the version\n    return true;\n}\n\n...\n    http_client_ota_upgrade( \"https://path/to/version/file.txt\", // Can be NULL if you don't have version file with the name\n                             \"https://path/to/new/firmware.bin\",\n                              on_validate_version,\n                              on_upgrade_start,\n                              on_upgrade_end );\n...\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flexus2k%2Fesp_ota_upgrade","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flexus2k%2Fesp_ota_upgrade","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flexus2k%2Fesp_ota_upgrade/lists"}