Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dariocasciato/arduino-template-oop
This is a template repository for developing firmware using Object-Oriented Programming (OOP) principles with Arduino and PlatformIO.
https://github.com/dariocasciato/arduino-template-oop
Last synced: about 2 months ago
JSON representation
This is a template repository for developing firmware using Object-Oriented Programming (OOP) principles with Arduino and PlatformIO.
- Host: GitHub
- URL: https://github.com/dariocasciato/arduino-template-oop
- Owner: DarioCasciato
- License: mit
- Created: 2023-06-28T09:31:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-05T12:15:45.000Z (5 months ago)
- Last Synced: 2024-08-05T14:04:41.899Z (5 months ago)
- Language: C++
- Homepage:
- Size: 225 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Arduino Firmware Template Repository
This is a template repository for developing firmware using Object-Oriented Programming (OOP) principles with Arduino and PlatformIO. It provides a structured starting point for creating Arduino projects that follow best practices for modularity, maintainability, and scalability.
## Features
- Object-Oriented Programming approach for organizing code into reusable and modular classes.
- PlatformIO integration for easy project management, dependency management, and build system configuration.
- Basic directory structure to organize your code effectively.
## Prerequisites
To use this template repository, you need to have the following installed:
- [Arduino IDE](https://www.arduino.cc/en/software)
- [PlatformIO Core](https://platformio.org/platformio-ide)
- [PlatformIO CLI](https://docs.platformio.org/en/latest/core/installation.html)
- [Git](https://git-scm.com/)
## Getting Started
To create a new firmware project using this template repository, follow these steps:
1. Click on the "Use this template" button at the top of the repository page to create a new repository based on this template.
2. Clone the newly created repository to your local machine using Git.
```
git clone https://github.com/your-username/your-project.git
```
3. Change into the project directory.
```
cd your-project
```
4. Open the project in your preferred integrated development environment (i personally use VS-Code).
5. Build and upload the firmware to your Arduino board using PlatformIO.
## Directory Structure
The directory structure of this template repository is as follows:
```
│
├───lib
│ │ README
│ │
│ └───downloaded
│ README
│
├───src
│ │ configurations.h
│ │ hardware.cpp
│ │ hardware.h
│ │ main.cpp
│ │ state.cpp
│ │ state.h
│ │
│ └───Flash
│ Flash.cpp
│ Flash.h
│ FlashStructure.h
│
└───utils
├───Arduino
├───Buzzer
├───Connectivity
│ ├───APIHandler
│ └───ESPWiFi
├───EdgeDetection
├───LED
├───Logging
├───Potentiometer
├───Screen
│ ├───ePaper
│ └───OLED_u8g2
├───Security
├───Storage
├───Timer
└───utilities
```
- **`lib/`**: This directory contains extern libraries (downloaded). You can add additional libraries as needed.
- **`src/`**: This directory contains the main firmware code. You can create additional source files as needed, such as configuration files (`configurations.h`) or modules (`hardware.cpp`, `hardware.h`, etc.).
- **`utils/`**: contains useful libraries
- **`README.md`**: This file provides an overview and instructions for the template repository.
## Contributing
Contributions to improve this template repository are always welcome. If you find any issues or have suggestions for enhancements, please open an issue or submit a pull request.
## License
This template repository is licensed under the [MIT License](LICENSE). Feel free to use it as a starting point for your own firmware projects.
## Resources
- [Arduino Reference](https://www.arduino.cc/reference/en/)
- [PlatformIO Documentation](https://docs.platformio.org/)
- [Arduino Forum](https://forum.arduino.cc/)
- [PlatformIO Community](https://community.platformio.org/)