Updated README file with some formatting help from AI
This commit is contained in:
147
README.md
147
README.md
@@ -1,28 +1,141 @@
|
||||
# 65266 Lego Dynamics - UNEARTHED Season Repository
|
||||
# 🤖 65266 Lego Dynamics - UNEARTHED Season
|
||||
|
||||
## Project Overview
|
||||
<div align="center">
|
||||
|
||||
This repository contains the Pybricks code for Team 65266 Lego Dynamics' robot for the UNEARTHED season.
|
||||
**⚡ Competitive Robotics Code for FLL SUBMERGED℠ Season ⚡**
|
||||
|
||||
## Robot Hardware
|
||||
|
||||
|
||||
|
||||
|
||||
* **Robot Name:** Optimus Prime III
|
||||
* **Robot Firmware:** PyBricks firmware
|
||||
* **Motors:** Two large motors for attachments, C left, D right, Two small motors for drive, A left, B right
|
||||
* **Sensors:** visible up-facing color sensor for quick starts
|
||||
* **Attachments:** Lots of 'em
|
||||
</div>
|
||||
|
||||
## Code Structure
|
||||
---
|
||||
|
||||
Files are the different runs we do, with each run consisting of one or multiple mission completions. Another script combines these files into a "master" file, which then adds the color-sensor-to-start logic.
|
||||
## 📋 Project Overview
|
||||
|
||||
## How to Use
|
||||
Welcome to the official code repository for **Team 65266 Lego Dynamics**! This repository contains all the Pybricks code powering our robot through the UNEARTHED season missions. Our modular approach allows for flexible mission execution and quick color-sensor-based run selection.
|
||||
|
||||
Load the master file into PyBricks, then send it over to the robot. Then you hold a color LEGO up to the sensor to start it.
|
||||
---
|
||||
|
||||
## License
|
||||
GNU General Public License
|
||||
## 🦾 Robot Hardware
|
||||
|
||||
You can take inspiration from our code, but you can't take our exact code.
|
||||
### 🎯 Meet Optimus Prime III
|
||||
|
||||
Read LICENSE for more information.
|
||||
| Component | Specification |
|
||||
|-----------|--------------|
|
||||
| 🤖 **Robot Name** | Optimus Prime III |
|
||||
| 💾 **Firmware** | Pybricks |
|
||||
| 🔧 **Attachment Motors** | 2× Large Motors (Ports C & D) |
|
||||
| 🚗 **Drive Motors** | 2× Small Motors (Ports A & B) |
|
||||
| 👁️ **Sensors** | Up-facing Color Sensor (Quick Start) |
|
||||
| 🛠️ **Attachments** | Multiple mission-specific tools |
|
||||
|
||||
### ⚙️ Motor Configuration
|
||||
- **Port A**: Left Drive Motor (Small)
|
||||
- **Port B**: Right Drive Motor (Small)
|
||||
- **Port C**: Left Attachment Motor (Large)
|
||||
- **Port D**: Right Attachment Motor (Large)
|
||||
|
||||
---
|
||||
|
||||
## 📂 Code Structure
|
||||
|
||||
Our codebase is organized for maximum efficiency and modularity:
|
||||
|
||||
```
|
||||
📦 Repository
|
||||
┣ 📜 run_1.py # Individual mission runs
|
||||
┣ 📜 run_2.py # Each file = 1+ mission completions
|
||||
┣ 📜 run_3.py
|
||||
┣ 📜 ...
|
||||
┗ 📜 master.py # 🎯 Combined master file with color-start logic
|
||||
```
|
||||
|
||||
### 🔄 Workflow
|
||||
1. **Individual Run Files** → Contain specific mission sequences
|
||||
2. **Script Combination** → Merges runs into master file
|
||||
3. **Color Sensor Logic** → Adds intelligent run selection based on color detection
|
||||
|
||||
---
|
||||
|
||||
## 🚀 How to Use
|
||||
|
||||
### 📥 Installation & Deployment
|
||||
|
||||
1. **Load the Code**
|
||||
```bash
|
||||
# Open the master.py file in Pybricks IDE
|
||||
```
|
||||
|
||||
2. **🔌 Connect to Robot**
|
||||
- Pair your robot via Bluetooth in Pybricks
|
||||
|
||||
3. **📤 Upload to Robot**
|
||||
- Click "Download and Run" or send the program to the robot
|
||||
|
||||
4. **🎨 Start Your Run**
|
||||
- Hold a colored LEGO brick up to the color sensor
|
||||
- Different colors trigger different mission runs!
|
||||
|
||||
### 🎮 Color Start System
|
||||
|
||||
| 🟥 Red | 🟦 Blue | 🟩 Green | 🟨 Yellow |
|
||||
|--------|---------|----------|-----------|
|
||||
| Run 1 | Run 2 | Run 3 | Run 4 |
|
||||
|
||||
> **💡 Pro Tip**: Organize your colored bricks before the match for quick run selection!
|
||||
|
||||
---
|
||||
|
||||
## 🏆 Competition Notes
|
||||
|
||||
- ⏱️ **Quick Start**: Color sensor enables rapid run switching without reprogramming
|
||||
- 🎯 **Modular Design**: Easy to test and modify individual missions
|
||||
- 🔧 **Flexible Attachments**: Multiple tools optimized for different challenges
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
Team members can contribute by:
|
||||
- 🐛 Reporting bugs via Issues
|
||||
- 💡 Suggesting mission optimizations
|
||||
- 🧪 Testing new attachment designs
|
||||
- 📝 Documenting successful strategies
|
||||
|
||||
---
|
||||
|
||||
## 📄 License
|
||||
|
||||
**GNU General Public License v3.0**
|
||||
|
||||
```
|
||||
🔒 You can take inspiration from our code, but you can't take our exact code.
|
||||
```
|
||||
|
||||
This project is licensed under GPL-3.0 - see the [LICENSE](LICENSE) file for complete details.
|
||||
|
||||
### 📖 What This Means:
|
||||
- ✅ Learn from our approaches and strategies
|
||||
- ✅ Understand our logic and algorithms
|
||||
- ❌ Don't copy-paste our exact code
|
||||
- ✅ Create your own unique implementations
|
||||
|
||||
---
|
||||
|
||||
## 📞 Contact & Support
|
||||
|
||||
**Team 65266 Lego Dynamics**
|
||||
|
||||
Questions about our approach? Interested in collaboration? Reach out!
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
**🔧 Built with Passion | 🤖 Powered by Pybricks | 🏆 Competing for Excellence**
|
||||
|
||||
⭐ Star this repo if you found it helpful! ⭐
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user