-
Notifications
You must be signed in to change notification settings - Fork 0
Add Arduino IDE setup documentation for 112025 projects #77
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…jects Co-authored-by: dorkmo <[email protected]>
…uidance Co-authored-by: dorkmo <[email protected]>
|
@copilot should we remove #include <LittleFS.h> from the .ino? and what about IWatchdog.h ? |
Your comment appears to be incomplete. Could you clarify which #include statement you're referring to and in which file? The documentation I added doesn't contain code with #include statements - it only references library names for users to install via the Arduino Library Manager. |
on line 23 and 41 of TankAlarm-112025-Server-BluesOpta.ino |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive Arduino IDE setup documentation for the 112025 projects (Blues Wireless + Arduino Opta), directly addressing issue #76 which requested setup instructions for the Arduino IDE and required libraries.
Key Changes:
- Created detailed installation guides (INSTALLATION.md) for both client and server projects with step-by-step Arduino IDE and library installation instructions
- Added project overview READMEs with quick start guides and feature descriptions
- Updated main repository documentation to reference the new 112025 installation guides
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| TankAlarm-112025-Server-BluesOpta/INSTALLATION.md | Comprehensive 491-line installation guide covering Arduino IDE setup, board support installation, required libraries (ArduinoJson 7.x, Blues Wireless Notecard, Ethernet, LittleFS), compilation steps, and extensive troubleshooting |
| TankAlarm-112025-Server-BluesOpta/README.md | 347-line project overview documenting server features, hardware requirements, quick start guide, web dashboard capabilities, API endpoints, configuration, and troubleshooting |
| TankAlarm-112025-Client-BluesOpta/INSTALLATION.md | Complete 363-line client installation guide with Arduino IDE setup, library installation instructions, configuration options, and troubleshooting section |
| TankAlarm-112025-Client-BluesOpta/README.md | 209-line client overview covering hardware setup, software requirements, configuration fields, operation modes, communication protocols, and troubleshooting |
| README.md | Added new 112025 version section with quick links to installation guides and documentation of the fleet-based communication and LittleFS storage approach |
| QUICK_REFERENCE_FLEET_SETUP.md | Added Arduino IDE setup section with required software, library list, and installation steps, plus links to detailed guides |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Issue requested Arduino IDE setup instructions for 112025 projects, specifically how to install required libraries (ArduinoJson, LittleFS, etc.).
New Installation Guides
Created comprehensive setup documentation for both 112025 projects:
Each guide covers:
ArduinoJson7.x (breaking changes from v6)Blues Wireless Notecard(latest)Ethernet(server only)LittleFS,WireQuick Start READMEs
Added project overviews with quick start guides:
Updated References
Key Details
Arduino Opta requires Mbed OS core, not SAMD:
LittleFS is built into Mbed core (no separate installation needed). ArduinoJson v7 is required (v6 incompatible).
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.