{"id":42306270,"url":"https://github.com/magradze/synapse","last_synced_at":"2026-01-27T11:09:56.463Z","repository":{"id":309650535,"uuid":"1006940994","full_name":"magradze/synapse","owner":"magradze","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-12T16:09:24.000Z","size":198542,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-12T18:43:48.793Z","etag":null,"topics":["esp32","iot","synapse"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/magradze.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/contributing/.gitkeep","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/security/.gitkeep","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-06-23T08:18:17.000Z","updated_at":"2025-08-16T15:43:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"ee3da622-ddae-49f4-89e8-88fdee2233c7","html_url":"https://github.com/magradze/synapse","commit_stats":null,"previous_names":["magradze/synapse"],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/magradze/synapse","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magradze%2Fsynapse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magradze%2Fsynapse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magradze%2Fsynapse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magradze%2Fsynapse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/magradze","download_url":"https://codeload.github.com/magradze/synapse/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magradze%2Fsynapse/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28812371,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T07:41:26.337Z","status":"ssl_error","status_checked_at":"2026-01-27T07:41:08.776Z","response_time":168,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","iot","synapse"],"created_at":"2026-01-27T11:09:56.201Z","updated_at":"2026-01-27T11:09:56.450Z","avatar_url":"https://github.com/magradze.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/espressif/esp-idf\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/espressif/esp-idf/master/docs/_static/espressif-logo.svg\" width=\"120\" alt=\"ESP-IDF Logo\"/\u003e\n  \u003c/a\u003e\n  \n# Synapse ESP Framework\n  \n  _A powerful, modular, and extensible platform for ESP32 devices._\n  \n  [![Manifesto](https://img.shields.io/badge/-Manifesto-black?style=for-the-badge\u0026logo=gitbook)](manifesto.md)\n  [![Getting Started](https://img.shields.io/badge/-Getting%20Started-blue?style=for-the-badge\u0026logo=read-the-docs)](docs/tutorials/getting_started.md)\n  [![API Reference](https://img.shields.io/badge/-API%20Reference-green?style=for-the-badge\u0026logo=c)](docs/api_reference/api_index.md)\n  [![Contributing](https://img.shields.io/badge/-Contributing-orange?style=for-the-badge\u0026logo=github)](docs/contributing/contributing_guide.md)\n\u003c/div\u003e\n\n---\n\n## 🔥 Project Overview\n\nSynapse is not just a framework. It is a **design philosophy** for building scalable, maintainable, and robust firmware. To understand the core principles that guide our development, please read our **[Manifesto](manifesto.md)**.\n\nThe Synapse ESP Framework is an open-source platform designed to simplify the development of complex IoT systems on the ESP32. It provides a modular architecture, flexible APIs, and enforces best practices for security and performance. The framework's key strengths are its **automatic module discovery** and **decentralized configuration**, making the development process exceptionally flexible and scalable.\n\n---\n\n## 🚀 Getting Started\n\n1. **Prerequisites:**\n    * [ESP-IDF](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html) v5.4.1+\n    * Python 3.x, Git\n\n2. **Clone the Project:**\n\n    ```sh\n    git clone https://github.com/magradze/synapse.git\n    cd synapse\n    ```\n\n3. **Explore the Structure:**\n    * See the [Directory Structure](docs/structure/directory_structure.md) for a detailed overview.\n    * Key directories: `main/`, `components/`, `configs/`, `docs/`.\n\n4. **Configure Your Modules:**\n    * **New in v5.0.0+:** Modules are configured via their own `config.json` files, located at `components/modules/{category}/{module_name}/config.json`.\n    * Follow the detailed instructions in the [Getting Started Guide](docs/tutorials/getting_started.md).\n\n5. **Build and Flash:**\n    * Use the standard ESP-IDF commands to build, flash, and monitor your application:\n\n      ```sh\n      idf.py build\n      idf.py -p \u003cYOUR_PORT\u003e flash monitor\n      ```\n\n---\n\n## 📚 API Reference \u0026 Documentation\n\nThe Synapse Framework is extensively documented to ensure a smooth development experience.\n\n| Document | Description |\n| :--- | :--- |\n| 📖 **[API Reference Index](docs/api_reference/api_index.md)** | The complete reference for all public APIs, including Core, Modules, and System services. |\n| 🏛️ **[Architectural Conventions](docs/convention/convention_index.md)** | The rules that govern the framework, from naming conventions to communication patterns. |\n| 🏗️ **[Structural Blueprints](docs/structure/project_overview.md)** | An in-depth look at the project's structure, module architecture, and lifecycle. |\n| 🤝 **[Contributing Guide](docs/contributing/contributing_guide.md)** | Everything you need to know to contribute to the project, including branching and commit guidelines. |\n\n---\n\n## ✨ Key Features\n\n* **True Modularity:** All functionalities are independent modules that can be enabled or disabled at compile-time.\n* **Strict Isolation:** Direct dependencies between modules are forbidden. Communication is mediated exclusively through the `Service Locator`, `Event Bus`, or `Promise Manager`.\n* **Automated Integration:** A powerful CMake-based build system automatically discovers modules, generates the module factory, and integrates configurations.\n* **Promise-based Asynchrony:** A clean, robust API for handling asynchronous request-response operations, eliminating \"callback hell\" and race conditions.\n* **Centralized CLI:** A built-in `Command Router` allows any module to register commands, accessible via a unified serial shell.\n\n---\n\n## 🛡️ Security\n\nSecurity is a first-class citizen in Synapse. We provide and enforce best practices to build secure IoT devices.\n\n* **[Security Best Practices](docs/security/security_best_practices.md):** Our recommendations for secure development.\n* **Key Principles:**\n  * Use TLS/SSL for all external communication.\n  * Store credentials securely using the `Storage Manager` (NVS backend).\n  * Implement secure firmware updates via Signed OTA.\n  * Validate all external inputs in every module.\n\n---\n\n## ⚡ Performance\n\nThe framework is designed to be lightweight and efficient, ensuring optimal performance even on resource-constrained devices.\n\n* **[Performance Best Practices](docs/performance/performance_best_practices.md):** Guidelines for optimizing your application.\n* **Key Principles:**\n  * Use static allocation where possible to reduce heap fragmentation.\n  * Leverage Kconfig to compile only the necessary modules, minimizing firmware size.\n  * Utilize lazy initialization to conserve resources.\n\n---\n\n## 🛠️ Troubleshooting\n\n* Encountering an issue? Check our **[Troubleshooting FAQ](docs/troubleshooting/faq.md)** for solutions to common problems.\n\n---\n\n## 📄 License\n\nThis project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.\n\n---\n\n\u003cdiv align=\"center\"\u003e\n  \u003csub\u003eFor more detailed information, please refer to the \u003ca href=\"docs/README.md\"\u003efull documentation\u003c/a\u003e.\u003c/sub\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagradze%2Fsynapse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmagradze%2Fsynapse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagradze%2Fsynapse/lists"}