Tasks List

[FrancoPerotti]

Task List

1. Project Plan and Milestones

Objective: Develop a comprehensive project plan outlining all key stages, goals, and milestones.

Deliverables:

• [x] Write a high-level project description (one paragraph).
• [x] Define main objectives and success criteria for the project.
• [x] Create a project timeline and assign tasks to each team member.
• [x] (Optional) Set up a checklist or Kanban-style board in GitHub Projects to track task progress.

2. System Design Documentation

Objective: Outline the design of the embedded system to ensure all team members understand the structure and functionality.

Deliverables:

• [x] Create block diagrams or flowcharts representing system architecture.
• [x] Design state diagrams or flow diagrams for critical functions or states.
• [x] Define main modules, their purpose, and how they interact.
• [x] Describe communication between components, especially peripherals like ADC, DAC, GPIO, or sensors.

3. Implement Continuous Integration and Continuous Deployment (CI/CD) (if applicable)

Objective: Set up a CI/CD pipeline to automate the build and test process.

Deliverables:

• [x] Configure GitHub Actions to build the code upon each pull request.
• [x] Integrate code quality checks using clang-format for consistent coding style.
• [ ] (Optional) Configure unit tests and static analysis tools to catch potential issues early.

4. Code Implementation and Style Guidelines

Objective: Implement code with a consistent and professional style, documented thoroughly.

Deliverables:

• [x] Write clean, modular code that follows best practices and uses meaningful names for variables and functions.
• [x] Run clang-format on all code to ensure consistent styling across the project.
• [x] #15

5. Comprehensive Documentation with Doxygen

Objective: Ensure code is thoroughly documented for ease of understanding and maintainability.

Deliverables:

• [x] Document functions, modules, and key variables using Doxygen-style comments.
• [x] Write a README.md explaining code functionality, listing team members, and providing general notes.
• [x] Use Doxygen to generate HTML documentation and commit it to a docs/ directory for easy access.

6. INSTALL.md - Installation and Setup Guide

Objective: Provide a clear guide for building, flashing, and running the firmware on the target hardware.

Deliverables:

• [x] Write instructions on compiling the code, including required tools or dependencies.
• [x] Provide detailed steps for flashing firmware onto target hardware (e.g., using OpenOCD, ST-Link).
• [x] Document supported platforms, including operating systems and specific microcontroller details.

7. Hardware Specifications and Schematics

Objective: Provide relevant details about the hardware configuration and connections.

Deliverables:

• [x] Write an overview of the hardware used (e.g., microcontroller type, sensors, actuators).
• [x] Provide circuit schematics (image or SVG format) detailing component connections.
• [x] Write a hardware setup guide describing component connections.

8. Additional Suggestions

• [x] Use Git branches for each feature or module, and merge them only after review and approval by at least two team members and the team leader.
• [x] Create a branch 1.0.0 as the release branch, and merge only upon review and professor's approval.
• [x] DO NOT merge directly to master or make direct commits.
• [x] Apply good software engineering practices.
• [x] Consider creating an Issue Tracker for each task, and use comments to log progress.
• [x] Utilize GitHub's Wiki or Project Board features for workflow organization and visualization.