{"id":14963412,"url":"https://github.com/windowsair/corsacota","last_synced_at":"2025-10-25T02:30:36.419Z","repository":{"id":42488013,"uuid":"429325374","full_name":"windowsair/corsacOTA","owner":"windowsair","description":"An esp8266/esp32 websocket OTA library","archived":false,"fork":false,"pushed_at":"2024-04-28T14:30:07.000Z","size":293,"stargazers_count":7,"open_issues_count":1,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-31T04:51:30.998Z","etag":null,"topics":["esp-idf","esp32","esp32c3","esp8266","ota"],"latest_commit_sha":null,"homepage":"http://corsacota.surge.sh/","language":"C","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/windowsair.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-11-18T06:47:35.000Z","updated_at":"2024-07-13T04:41:40.000Z","dependencies_parsed_at":"2024-04-28T14:30:52.338Z","dependency_job_id":"a1a37e4d-bd66-4dee-a69a-63777404a1e8","html_url":"https://github.com/windowsair/corsacOTA","commit_stats":{"total_commits":25,"total_committers":3,"mean_commits":8.333333333333334,"dds":"0.19999999999999996","last_synced_commit":"31816a8e82b001a135a6d7a22d6731c7fcb7fbd6"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windowsair%2FcorsacOTA","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windowsair%2FcorsacOTA/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windowsair%2FcorsacOTA/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windowsair%2FcorsacOTA/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/windowsair","download_url":"https://codeload.github.com/windowsair/corsacOTA/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238059129,"owners_count":19409601,"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":["esp-idf","esp32","esp32c3","esp8266","ota"],"created_at":"2024-09-24T13:31:28.193Z","updated_at":"2025-10-25T02:30:29.408Z","avatar_url":"https://github.com/windowsair.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"assets/logo_light.png\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003ecorsacOTA\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n\nAn esp8266/esp32 websocket OTA library.\n\n[![deploy status][github-action-deploy-image]][github-action-deploy-url] [![test status][github-action-test-image]][github-action-test-url] [![license][license-image]][license-url]\n\n[github-action-deploy-image]: https://github.com/windowsair/corsacOTA/actions/workflows/surge-deploy.yml/badge.svg\n[github-action-deploy-url]: https://github.com/windowsair/corsacOTA/actions/workflows/surge-deploy.yml\n\n[github-action-test-image]: https://github.com/windowsair/corsacOTA/actions/workflows/test.yml/badge.svg\n[github-action-test-url]: https://github.com/windowsair/corsacOTA/actions/workflows/test.yml\n\n[license-image]: https://img.shields.io/badge/license-MIT-green.svg\n[license-url]: https://github.com/windowsair/corsacOTA/LICENSE\n\n**Warning: This project is not yet ready for production, API and document are subject to change without notice.**\n\n\u003c/div\u003e\n\n## Features\n\n- ⚙️ Fine-granular OTA management.\n- 📦 A frontend component out of the box.\n- 🔨 Easy to integrate into user projects.\n- ✂️ No need to embed the frontend page, lower firmware and memory usage.\n- 🚀 Lightweight and fast WebSocket implementation.\n\nSupport device\n\n- [x] esp8266/esp8285\n- [x] esp32\n- [x] esp32c3\n- [x] esp32s3\n\n## Use the web client for OTA\n\n[🌐 Demo Site](http://corsacOTA.surge.sh)\n\nhttps://user-images.githubusercontent.com/17078589/146638094-34c46717-1b1a-42a6-961f-4835347cc6e5.mp4\n\n\n## Usage\n\ncorsacOTA works with esp-idf.\n\nJust add [src/corsacOTA.c](src/corsacOTA.c) to your project:\n```c\nco_handle_t handle;\nco_config_t config = {\n    .thread_name = \"corsacOTA\",\n    .stack_size = 4096,\n    .thread_prio = 8,\n    .listen_port = 3241,\n    .max_listen_num = 4,\n    .wait_timeout_sec = 60,\n    .wait_timeout_usec = 0,\n};\n\ncorsacOTA_init(\u0026handle, \u0026config);\n```\n\nRelated examples of use can be found here: [examples](./examples)\n\n## Document\n\n### API for frontend\n\ncorsacOTA provides a default frontend for performing online OTA, and you can also implement it yourself. See: [corsacOTA API on postman](https://www.postman.com/corsacOTA/workspace/corsacota/collection/61bb4cf5bdc5c3127b44f99c?uac=y)\n\n![postman screenshot](assets/postman.png)\n\n### Parition table\nCurrently supported OTA partition table modes: Factory app, two OTA definitions.\n\n### Motivation and Notes\n\nEase of use, minimal dependencies, and fine-grained OTA management were the starting points for this project.\n\n----\n\n**Why do we use websockets in our projects?**\n\nIn the world of browser, the use of websockets is somewhere between pure sockets and HTTP. Considering that most of the usage scenarios are in the browser, we have chosen websocket.\n\nHowever, WebSocket is not always a good idea because operations such as handshake and mask add a certain level of complexity. If the network is good, then other solutions should achieve the same results.\n\nNevertheless, it has some advantages in complex network conditions with frequent packet loss, where you can achieve easy flow control and more precise progress control in the browser.\n\nOverall, our solution is a compromise between ease of use, compatibility and speed.\n\n## Dependency\n\nFor the main part of the project, there are no dependencies on third-party libraries other than esp-idf.\n\nFor frontend:\n\n- [Vue3](https://github.com/vuejs/vue-next)\n- [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss)\n\n## Credit\n\nCredits to the following project, people and organizations:\n\n- [@HeavenSpree](https://www.github.com/HeavenSpree)\n- [@Vizards](https://www.github.com/Vizards)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindowsair%2Fcorsacota","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwindowsair%2Fcorsacota","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindowsair%2Fcorsacota/lists"}