diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..6fd6d42 --- /dev/null +++ b/readme.md @@ -0,0 +1,124 @@ +# ModuleAir Screen Only + +[![PlatformIO](https://img.shields.io/badge/PlatformIO-Ready-orange.svg)](https://platformio.org/) +[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) + +A dedicated screen display module for the ModuleAir air quality monitoring system. + +## 📋 Description + +ModuleAir_screenOnly is a specialized firmware component designed to handle visual display functionality for air quality monitoring devices. This module focuses exclusively on screen management and data visualization, providing a clean interface for displaying environmental sensor data. + +## 🚀 Features + +- **Screen-Only Operation**: Dedicated display management without sensor overhead +- **PlatformIO Support**: Easy development and deployment workflow +- **Modular Design**: Clean separation of display logic from sensor operations +- **Optimized Performance**: Lightweight codebase for efficient display updates + +## 🛠️ Hardware Requirements + +- Compatible microcontroller (ESP32/ESP8266/Arduino) +- Display module (specify your display type) +- USB cable for programming + +## 📦 Installation + +### Prerequisites + +- [PlatformIO](https://platformio.org/) installed on your system +- Git for version control +- USB drivers for your microcontroller + +### Setup + +1. Clone the repository: +```bash +git clone http://gitea.aircarto.fr/PaulVua/ModuleAir_screenOnly.git +cd ModuleAir_screenOnly +``` + +2. Open in your IDE (VS Code recommended): +```bash +code . +``` + +3. Install dependencies: +```bash +pio pkg install +``` + +4. Build the project: +```bash +pio run +``` + +5. Upload to your device: +```bash +pio run --target upload +``` + +## 🔧 Configuration + +Edit the `platformio.ini` file to match your hardware configuration: + +```ini +[env:your_board] +platform = espressif32 +board = your_board_type +framework = arduino +``` + +## 📖 Usage + +Once uploaded to your device, the module will: +1. Initialize the display hardware +2. Wait for data from connected sensors or network +3. Render environmental data on the screen +4. Update display based on configured refresh intervals + +## 🏗️ Project Structure + +``` +ModuleAir_screenOnly/ +├── src/ # Source files +│ └── main.cpp # Main application code +├── include/ # Header files +├── lib/ # Project libraries +├── test/ # Test files +├── .vscode/ # VS Code configuration +├── platformio.ini # PlatformIO configuration +└── README.md # This file +``` + +## 🤝 Contributing + +Contributions are welcome! Please feel free to submit pull requests or open issues for bugs and feature requests. + +1. Fork the repository +2. Create your feature branch (`git checkout -b feature/AmazingFeature`) +3. Commit your changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +## 📝 License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +## 👤 Author + +**PaulVua** + +- Gitea: [@PaulVua](http://gitea.aircarto.fr/PaulVua) + +## 🔗 Related Projects + +- [ModuleAir Main Repository](http://gitea.aircarto.fr/PaulVua/ModuleAir) *(if applicable)* + +## 📧 Support + +For questions and support, please open an issue on the [issue tracker](http://gitea.aircarto.fr/PaulVua/ModuleAir_screenOnly/issues). + +--- + +⭐ If you find this project useful, please consider giving it a star! \ No newline at end of file