Skip to content

Commit 60627fb

Browse files
Copilotdorkmo
andcommitted
Update workflow README documentation for TankAlarm-112025
Co-authored-by: dorkmo <[email protected]>
1 parent bc82060 commit 60627fb

File tree

1 file changed

+33
-6
lines changed

1 file changed

+33
-6
lines changed

.github/workflows/README.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,17 @@ This directory contains automated CI/CD workflows for the ArduinoSMSTankAlarm pr
77
**File:** `arduino-ci.yml`
88

99
### Purpose
10-
Automatically compiles the Arduino code for the TankAlarm-092025 projects
11-
(both Client and Server) to ensure code quality and catch compilation errors early.
10+
Automatically compiles the Arduino code for both TankAlarm-092025 and TankAlarm-112025 projects
11+
to ensure code quality and catch compilation errors early.
1212

1313
### Triggers
1414
The workflow runs on:
1515
- **Push events** to `main` or `master` branches when changes are made to:
1616
- `TankAlarm-092025-Client-Hologram/` directory
1717
- `TankAlarm-092025-Server-Hologram/` directory
18+
- `TankAlarm-112025-Client-BluesOpta/` directory
19+
- `TankAlarm-112025-Server-BluesOpta/` directory
20+
- `TankAlarm-112025-Viewer-BluesOpta/` directory
1821
- The workflow file itself
1922
- **Pull requests** targeting `main` or `master` branches
2023
- **Manual trigger** via workflow_dispatch
@@ -25,21 +28,32 @@ The workflow runs on:
2528
- Checks out the repository code
2629
- Installs Arduino CLI
2730
- Installs Arduino SAMD core for MKR boards
31+
- Installs Arduino Mbed OS Opta Boards core for Arduino Opta
2832

2933
2. **Installs required libraries**
3034
- MKRNB (cellular connectivity)
3135
- SD (SD card operations)
3236
- ArduinoLowPower (power management)
3337
- RTCZero (real-time clock)
3438
- Ethernet (network connectivity for server)
39+
- ArduinoJson (JSON parsing for configuration)
40+
- Blues Wireless Notecard (cellular connectivity via Blues)
3541

3642
3. **Compiles the sketches**
43+
44+
**TankAlarm-092025 (Arduino MKR NB 1500):**
3745
- Compiles `TankAlarm-092025-Client-Hologram.ino`
3846
- Compiles `TankAlarm-092025-Server-Hologram.ino`
3947
- Target board: Arduino MKR NB 1500 (`arduino:samd:mkrnb1500`)
48+
49+
**TankAlarm-112025 (Arduino Opta):**
50+
- Compiles `TankAlarm-112025-Client-BluesOpta.ino`
51+
- Compiles `TankAlarm-112025-Server-BluesOpta.ino`
52+
- Compiles `TankAlarm-112025-Viewer-BluesOpta.ino`
53+
- Target board: Arduino Opta (`arduino:mbed_opta:opta`)
4054

4155
4. **Handles compilation failures**
42-
- If either compilation fails, automatically creates a GitHub issue
56+
- If any compilation fails, automatically creates a GitHub issue
4357
- Assigns the issue to the copilot user
4458
- Labels the issue with: `arduino`, `compilation-error`, `bug`
4559
- Mentions @copilot in the issue body for notifications
@@ -75,24 +89,37 @@ You can test Arduino compilation locally using Arduino CLI:
7589
# Install Arduino CLI
7690
curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh
7791

78-
# Install the SAMD core
92+
# Install cores
7993
arduino-cli core update-index
8094
arduino-cli core install arduino:samd
95+
arduino-cli core install arduino:mbed_opta
8196

8297
# Install required libraries
98+
arduino-cli lib update-index
8399
arduino-cli lib install "MKRNB"
84100
arduino-cli lib install "SD"
85101
arduino-cli lib install "ArduinoLowPower"
86102
arduino-cli lib install "RTCZero"
87103
arduino-cli lib install "Ethernet"
104+
arduino-cli lib install "ArduinoJson"
105+
arduino-cli lib install "Blues Wireless Notecard"
88106

89-
# Compile the client sketch
107+
# Compile TankAlarm-092025 sketches
90108
arduino-cli compile --fqbn arduino:samd:mkrnb1500 \
91109
TankAlarm-092025-Client-Hologram/TankAlarm-092025-Client-Hologram.ino
92110

93-
# Compile the server sketch
94111
arduino-cli compile --fqbn arduino:samd:mkrnb1500 \
95112
TankAlarm-092025-Server-Hologram/TankAlarm-092025-Server-Hologram.ino
113+
114+
# Compile TankAlarm-112025 sketches
115+
arduino-cli compile --fqbn arduino:mbed_opta:opta \
116+
TankAlarm-112025-Client-BluesOpta/TankAlarm-112025-Client-BluesOpta.ino
117+
118+
arduino-cli compile --fqbn arduino:mbed_opta:opta \
119+
TankAlarm-112025-Server-BluesOpta/TankAlarm-112025-Server-BluesOpta.ino
120+
121+
arduino-cli compile --fqbn arduino:mbed_opta:opta \
122+
TankAlarm-112025-Viewer-BluesOpta/TankAlarm-112025-Viewer-BluesOpta.ino
96123
```
97124

98125
### Troubleshooting

0 commit comments

Comments
 (0)