Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Centre of Innovation in IoT PROJECT DESCRIPTION TEMPLATE

## 1. Project Overview
Provide a concise description of what the project does, who it is for, and why it exists.

## 2. Technical Architecture
Create block diagrams or flowcharts to illustrate the architecture.
Preferably made with mermaid because it is supported in GitHub markdown.

## 3. Technologies Used
List all technologies and major components the project relies on.

Examples:
- Wireless technologies (BLE, Wi-Fi, Zigbee, Matter, Thread, Z-Wave, Wi-SUN)
- SDKs or frameworks (GSDK, Zephyr, FreeRTOS, Micrium OS)
- Programming languages (C, C++, Python, JavaScript, Rust…)
- Tools (Simplicity Studio, VS Code, CMake, GitHub Actions)

## 4. Hardware components
**Silicon labs hardware**
- EFR32 SoC(s)
- Radio Boards
- Development Kits
- Sensors or expansion boards

**External hardware**
List here the necessary hardware components from third parties.
- (e.g. Raspberry Pi)
- tools (e.g. logic analyzer. scope)


## 7. Software components / Dependencies
**Silicon Labs Dependencies**
- gecko SDK version
- Simplicity Studio version
- Reference example version (if applicable)

**External software Dependencies**
List here any third-party libraries, frameworks, or tools required.

## 8. Licensing
State the chosen license clearly (Apache 2.0, Zlib, MSLA, etc.).
Dont forget to mention any third-party licenses if applicable.

## 9. Maintainers / Contacts
List project maintainers or points of contact.
Example table:
| Name | Role | Contact Information | Github Profile |
| ---------- | ------------------ | ---------------------- | ---------------------------- |
| John Doe | Project Maintainer | [email protected] | https://github.com/johndoe |
| Jane Smith | Technical Lead | [email protected] | https://github.com/janesmith |
Loading