diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 0000000..56d8b16 --- /dev/null +++ b/README_EN.md @@ -0,0 +1,107 @@ +# PhoneBed + +> We built a bed for your phone, so you don't have to bring it to yours. + +## Overview + +PhoneBed is an open-source smart bedside dock designed to help reduce late-night phone usage. When you place your phone on the bed, it starts wireless charging and automatically covers the phone with a mechanical blanket. The phone remains inaccessible until the configured alarm rings, encouraging healthier sleep habits. + +## Features + +- 📱 Wireless charging support +- ⏰ Built-in alarm clock +- 🛏️ Automatic mechanical blanket +- 🖥️ Touchscreen interface +- ⚙️ ESP32-S3 based firmware +- 🔓 Fully open-source hardware and software + +## Repository Structure + +``` +PhoneBed/ +├── Code/ # ESP-IDF firmware source code +├── Docs/ # Documentation and images +├── Hardware/ # PCB design files (JLCEDA/EasyEDA) +├── LICENSE +└── README.md +``` + +## Hardware Requirements + +To build the PhoneBed, you will need: + +- Waveshare ESP32-S3-Touch-LCD-3.49B-EN development board +- Wireless charging module (3.3V signal) +- GA12-N20 geared motors ×2 +- 9015 cooling fans ×2 +- Adapter PCB +- Controller PCB +- Button PCB +- Motor limit PCB +- 3D printed parts (PLA/PETG) +- Various screws, magnets, cables, and connectors + +For the complete Bill of Materials (BOM), refer to the original documentation. + +## Software Requirements + +- ESP-IDF v5.5.1 +- Visual Studio Code (recommended) +- ESP-IDF Extension for VS Code + +For ESP-IDF installation instructions, visit: +https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/get-started/ + +## Features + +- Displays the current time +- Configurable alarm +- Touchscreen and button controls +- Automatic phone cover mechanism +- Wireless charging support +- Alarm remains active until manually dismissed + +## Building the Project + +1. Install ESP-IDF v5.5.1. +2. Clone this repository. +3. Navigate to the `Code` directory. +4. Configure the project using ESP-IDF. +5. Build and flash the firmware to the ESP32-S3 development board. + +Example commands: + +```bash +cd Code +idf.py set-target esp32s3 +idf.py build +idf.py flash +idf.py monitor +``` + +## Contributing + +Contributions are welcome! + +If you find a bug, improve the documentation, or add a new feature, feel free to: + +1. Fork the repository. +2. Create a new branch. +3. Commit your changes. +4. Open a Pull Request. + +Please follow the existing coding style and provide clear commit messages. + +## License + +This project is licensed under the MIT License. See the `LICENSE` file for details. + +## Acknowledgements + +This project uses the following open-source projects: + +- LVGL +- MultiButton +- Waveshare ESP32-S3-Touch-LCD libraries + +Special thanks to the original authors of PhoneBed for making this project open source. \ No newline at end of file