Welcome to the Windy repository! This folder contains everything you need to build our air quality device. Whether you are a hobbyist, student, or professional, you will find useful resources here.
- Introduction
- Features
- Getting Started
- Hardware Components
- Software Setup
- 3D Printing
- Mobile Application
- PCB Design
- Contributing
- License
- Contact
- Releases
Air quality is vital for our health and well-being. With the Windy device, you can monitor air quality in real-time. This project combines various technologies, including sensors, microcontrollers, and mobile applications.
- Real-time air quality monitoring
- User-friendly mobile application for Android and iOS
- Open-source design for easy customization
- 3D-printed housing for a sleek look
- Easy-to-follow instructions
To get started with the Windy project, follow these steps:
-
Clone the Repository
git clone https://github.com/felpsSS/Windy.git
-
Navigate to the Directory
cd Windy
-
Check the Documentation Refer to the
docs
folder for detailed instructions.
To build the Windy device, you will need the following components:
- ESP32 Microcontroller: This will be the brain of your device.
- Air Quality Sensor: Choose a sensor that meets your needs (e.g., MQ-135).
- Power Supply: Ensure you have a reliable power source.
- 3D Printed Case: You can find the design files in the
3D-Print
folder.
Component | Description |
---|---|
ESP32 | Dual-core microcontroller |
MQ-135 Sensor | Measures air quality |
Battery Pack | For portable use |
Jumper Wires | For connections |
The software setup involves several steps:
- Install the Arduino IDE: Download from the official website.
- Install ESP32 Board Support: Follow the instructions in the Arduino IDE to add ESP32 support.
- Upload the Code: Open the
Windy.ino
file and upload it to your ESP32.
Make sure to install the following libraries in the Arduino IDE:
DHT sensor library
WiFi library
HTTPClient library
To create the housing for your Windy device, you will need to 3D print the case. The STL files are located in the 3D-Print
folder.
- Material: Use PLA or ABS for durability.
- Layer Height: 0.2 mm for a good balance of quality and speed.
- Infill: 20% should be sufficient.
The Windy mobile application is available for both Android and iOS. It allows you to monitor air quality data from your device.
- Real-time data display
- Historical data tracking
- Alerts for poor air quality
- User-friendly interface
You can download the mobile app from the respective app stores.
The PCB design files are included in the repository. You can modify them as needed.
We recommend using KiCAD or Eagle for PCB design.
We welcome contributions! If you want to improve the Windy project, please follow these steps:
- Fork the repository.
- Create a new branch.
- Make your changes.
- Submit a pull request.
This project is licensed under the MIT License. See the LICENSE
file for details.
For questions or feedback, feel free to reach out:
- Email: [email protected]
- GitHub: felpsSS
For the latest updates and releases, visit our Releases section. You can download the necessary files and execute them as needed.
Thank you for checking out the Windy project! We hope you enjoy building your air quality device. For any further questions, please refer to the documentation or contact us directly.