|
| 1 | +# Centre of Innovation in IoT PROJECT DESCRIPTION TEMPLATE |
| 2 | + |
| 3 | +## 1. Project Overview |
| 4 | +Provide a concise description of what the project does, who it is for, and why it exists. |
| 5 | + |
| 6 | +## 2. Technical Architecture |
| 7 | +Create block diagrams or flowcharts to illustrate the architecture. |
| 8 | +Preferably made with mermaid because it is supported in GitHub markdown. |
| 9 | + |
| 10 | +## 3. Technologies Used |
| 11 | +List all technologies and major components the project relies on. |
| 12 | + |
| 13 | +Examples: |
| 14 | +- Wireless technologies (BLE, Wi-Fi, Zigbee, Matter, Thread, Z-Wave, Wi-SUN) |
| 15 | +- SDKs or frameworks (GSDK, Zephyr, FreeRTOS, Micrium OS) |
| 16 | +- Programming languages (C, C++, Python, JavaScript, Rust…) |
| 17 | +- Tools (Simplicity Studio, VS Code, CMake, GitHub Actions) |
| 18 | + |
| 19 | +## 4. Hardware components |
| 20 | +**Silicon labs hardware** |
| 21 | +- EFR32 SoC(s) |
| 22 | +- Radio Boards |
| 23 | +- Development Kits |
| 24 | +- Sensors or expansion boards |
| 25 | + |
| 26 | +**External hardware** |
| 27 | +List here the necessary hardware components from third parties. |
| 28 | +- (e.g. Raspberry Pi) |
| 29 | +- tools (e.g. logic analyzer. scope) |
| 30 | + |
| 31 | + |
| 32 | +## 7. Software components / Dependencies |
| 33 | +**Silicon Labs Dependencies** |
| 34 | +- gecko SDK version |
| 35 | +- Simplicity Studio version |
| 36 | +- Reference example version (if applicable) |
| 37 | + |
| 38 | +**External software Dependencies** |
| 39 | +List here any third-party libraries, frameworks, or tools required. |
| 40 | + |
| 41 | +## 8. Licensing |
| 42 | +State the chosen license clearly (Apache 2.0, Zlib, MSLA, etc.). |
| 43 | +Dont forget to mention any third-party licenses if applicable. |
| 44 | + |
| 45 | +## 9. Maintainers / Contacts |
| 46 | +List project maintainers or points of contact. |
| 47 | +Example table: |
| 48 | +| Name | Role | Contact Information | Github Profile | |
| 49 | +| ---------- | ------------------ | ---------------------- | ---------------------------- | |
| 50 | +| John Doe | Project Maintainer | [email protected] | https://github.com/johndoe | |
| 51 | +| Jane Smith | Technical Lead | [email protected] | https://github.com/janesmith | |
0 commit comments