Placing scripts in the generated project
This commit is contained in:
Eric Ratliff
@@ -1,29 +1,38 @@
|
||||
# {{PROJECT_NAME}}
|
||||
|
||||
Arduino project generated by Anvil v{{ANVIL_VERSION}}.
|
||||
Arduino project generated by [Anvil](https://github.com/nexusworkshops/anvil) v{{ANVIL_VERSION}}.
|
||||
|
||||
This project is self-contained. After creation, it only needs `arduino-cli`
|
||||
in PATH -- the Anvil binary is not required for day-to-day work.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Check your system
|
||||
anvil doctor
|
||||
# Compile only (verify)
|
||||
./build.sh
|
||||
|
||||
# Find connected boards
|
||||
anvil devices
|
||||
|
||||
# Compile only (no upload)
|
||||
anvil build --verify {{PROJECT_NAME}}
|
||||
|
||||
# Compile and upload
|
||||
anvil build {{PROJECT_NAME}}
|
||||
# Compile and upload to board
|
||||
./upload.sh
|
||||
|
||||
# Compile, upload, and open serial monitor
|
||||
anvil build --monitor {{PROJECT_NAME}}
|
||||
./upload.sh --monitor
|
||||
|
||||
# Open serial monitor (no compile)
|
||||
./monitor.sh
|
||||
|
||||
# Persistent monitor (reconnects after reset/replug)
|
||||
./monitor.sh --watch
|
||||
|
||||
# Run host-side unit tests (no board needed)
|
||||
cd test && ./run_tests.sh
|
||||
./test/run_tests.sh
|
||||
```
|
||||
|
||||
On Windows, use `build.bat`, `upload.bat`, `monitor.bat`, and
|
||||
`test\run_tests.bat` instead.
|
||||
|
||||
All scripts read settings from `.anvil.toml` -- edit it to change
|
||||
the board, baud rate, include paths, or compiler flags.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
@@ -44,6 +53,9 @@ cd test && ./run_tests.sh
|
||||
CMakeLists.txt Test build system
|
||||
run_tests.sh Test runner (Linux/Mac)
|
||||
run_tests.bat Test runner (Windows)
|
||||
build.sh / build.bat Compile sketch
|
||||
upload.sh / upload.bat Compile + upload to board
|
||||
monitor.sh / monitor.bat Serial monitor
|
||||
.anvil.toml Project configuration
|
||||
```
|
||||
|
||||
@@ -52,7 +64,7 @@ cd test && ./run_tests.sh
|
||||
All hardware access goes through the `Hal` interface. The app code
|
||||
(`lib/app/`) depends only on `Hal`, never on `Arduino.h` directly.
|
||||
This means the app can be compiled and tested on the host without
|
||||
any Arduino SDK.
|
||||
any Arduino hardware.
|
||||
|
||||
Two HAL implementations:
|
||||
- `ArduinoHal` -- passthroughs to real hardware (used in the .ino)
|
||||
@@ -72,3 +84,9 @@ extra_flags = ["-Werror"]
|
||||
[monitor]
|
||||
baud = 115200
|
||||
```
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- `arduino-cli` in PATH with `arduino:avr` core installed
|
||||
- For host tests: `cmake`, `g++` (or `clang++`), `git`
|
||||
- Install everything at once: `anvil setup`
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
# Build artifacts
|
||||
.build/
|
||||
test/build/
|
||||
|
||||
# IDE
|
||||
|
||||
126
templates/basic/build.bat
Normal file
126
templates/basic/build.bat
Normal file
@@ -0,0 +1,126 @@
|
||||
@echo off
|
||||
setlocal enabledelayedexpansion
|
||||
|
||||
:: build.bat -- Compile the sketch using arduino-cli
|
||||
::
|
||||
:: Reads all settings from .anvil.toml. No Anvil binary required.
|
||||
::
|
||||
:: Usage:
|
||||
:: build.bat Compile (verify only)
|
||||
:: build.bat --clean Delete build cache first
|
||||
:: build.bat --verbose Show full compiler output
|
||||
|
||||
set "SCRIPT_DIR=%~dp0"
|
||||
set "CONFIG=%SCRIPT_DIR%.anvil.toml"
|
||||
|
||||
if not exist "%CONFIG%" (
|
||||
echo FAIL: No .anvil.toml found in %SCRIPT_DIR%
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:: -- Parse .anvil.toml ----------------------------------------------------
|
||||
for /f "tokens=1,* delims==" %%a in ('findstr /b "name " "%CONFIG%"') do (
|
||||
set "SKETCH_NAME=%%b"
|
||||
)
|
||||
for /f "tokens=1,* delims==" %%a in ('findstr /b "fqbn " "%CONFIG%"') do (
|
||||
set "FQBN=%%b"
|
||||
)
|
||||
for /f "tokens=1,* delims==" %%a in ('findstr /b "warnings " "%CONFIG%"') do (
|
||||
set "WARNINGS=%%b"
|
||||
)
|
||||
|
||||
:: Strip quotes and whitespace
|
||||
set "SKETCH_NAME=%SKETCH_NAME: =%"
|
||||
set "SKETCH_NAME=%SKETCH_NAME:"=%"
|
||||
set "FQBN=%FQBN: =%"
|
||||
set "FQBN=%FQBN:"=%"
|
||||
set "WARNINGS=%WARNINGS: =%"
|
||||
set "WARNINGS=%WARNINGS:"=%"
|
||||
|
||||
if "%SKETCH_NAME%"=="" (
|
||||
echo FAIL: Could not read project name from .anvil.toml
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
set "SKETCH_DIR=%SCRIPT_DIR%%SKETCH_NAME%"
|
||||
set "BUILD_DIR=%SCRIPT_DIR%.build"
|
||||
|
||||
:: -- Parse arguments ------------------------------------------------------
|
||||
set "DO_CLEAN=0"
|
||||
set "VERBOSE="
|
||||
|
||||
:parse_args
|
||||
if "%~1"=="" goto done_args
|
||||
if "%~1"=="--clean" set "DO_CLEAN=1" & shift & goto parse_args
|
||||
if "%~1"=="--verbose" set "VERBOSE=--verbose" & shift & goto parse_args
|
||||
if "%~1"=="--help" goto show_help
|
||||
if "%~1"=="-h" goto show_help
|
||||
echo FAIL: Unknown option: %~1
|
||||
exit /b 1
|
||||
|
||||
:show_help
|
||||
echo Usage: build.bat [--clean] [--verbose]
|
||||
echo Compiles the sketch. Settings from .anvil.toml.
|
||||
exit /b 0
|
||||
|
||||
:done_args
|
||||
|
||||
:: -- Preflight ------------------------------------------------------------
|
||||
where arduino-cli >nul 2>nul
|
||||
if errorlevel 1 (
|
||||
echo FAIL: arduino-cli not found in PATH.
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
if not exist "%SKETCH_DIR%" (
|
||||
echo FAIL: Sketch directory not found: %SKETCH_DIR%
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:: -- Clean ----------------------------------------------------------------
|
||||
if "%DO_CLEAN%"=="1" (
|
||||
if exist "%BUILD_DIR%" (
|
||||
echo Cleaning build cache...
|
||||
rmdir /s /q "%BUILD_DIR%"
|
||||
)
|
||||
)
|
||||
|
||||
:: -- Build include flags --------------------------------------------------
|
||||
set "BUILD_FLAGS="
|
||||
for %%d in (lib\hal lib\app) do (
|
||||
if exist "%SCRIPT_DIR%%%d" (
|
||||
set "BUILD_FLAGS=!BUILD_FLAGS! -I%SCRIPT_DIR%%%d"
|
||||
)
|
||||
)
|
||||
set "BUILD_FLAGS=!BUILD_FLAGS! -Werror"
|
||||
|
||||
:: -- Compile --------------------------------------------------------------
|
||||
echo Compiling %SKETCH_NAME%...
|
||||
echo Board: %FQBN%
|
||||
echo Sketch: %SKETCH_DIR%
|
||||
echo.
|
||||
|
||||
if not exist "%BUILD_DIR%" mkdir "%BUILD_DIR%"
|
||||
|
||||
set "COMPILE_CMD=arduino-cli compile --fqbn %FQBN% --build-path "%BUILD_DIR%" --warnings %WARNINGS%"
|
||||
|
||||
if not "%BUILD_FLAGS%"=="" (
|
||||
set "COMPILE_CMD=%COMPILE_CMD% --build-property "build.extra_flags=%BUILD_FLAGS%""
|
||||
)
|
||||
|
||||
if not "%VERBOSE%"=="" (
|
||||
set "COMPILE_CMD=%COMPILE_CMD% %VERBOSE%"
|
||||
)
|
||||
|
||||
set "COMPILE_CMD=%COMPILE_CMD% "%SKETCH_DIR%""
|
||||
|
||||
%COMPILE_CMD%
|
||||
if errorlevel 1 (
|
||||
echo.
|
||||
echo FAIL: Compilation failed.
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
echo.
|
||||
echo ok Compile succeeded.
|
||||
echo.
|
||||
145
templates/basic/build.sh
Normal file
145
templates/basic/build.sh
Normal file
@@ -0,0 +1,145 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# build.sh -- Compile the sketch using arduino-cli
|
||||
#
|
||||
# Reads all settings from .anvil.toml. No Anvil binary required.
|
||||
#
|
||||
# Usage:
|
||||
# ./build.sh Compile (verify only)
|
||||
# ./build.sh --clean Delete build cache first
|
||||
# ./build.sh --verbose Show full compiler output
|
||||
#
|
||||
# Prerequisites: arduino-cli in PATH, arduino:avr core installed
|
||||
# Install: anvil setup (or manually: arduino-cli core install arduino:avr)
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
CONFIG="$SCRIPT_DIR/.anvil.toml"
|
||||
|
||||
# -- Colors ----------------------------------------------------------------
|
||||
if [[ -t 1 ]]; then
|
||||
RED=$'\033[0;31m'; GRN=$'\033[0;32m'; YLW=$'\033[0;33m'
|
||||
CYN=$'\033[0;36m'; BLD=$'\033[1m'; RST=$'\033[0m'
|
||||
else
|
||||
RED=''; GRN=''; YLW=''; CYN=''; BLD=''; RST=''
|
||||
fi
|
||||
|
||||
ok() { echo "${GRN}ok${RST} $*"; }
|
||||
warn() { echo "${YLW}warn${RST} $*"; }
|
||||
die() { echo "${RED}FAIL${RST} $*" >&2; exit 1; }
|
||||
|
||||
# -- Parse .anvil.toml -----------------------------------------------------
|
||||
[[ -f "$CONFIG" ]] || die "No .anvil.toml found in $SCRIPT_DIR"
|
||||
|
||||
# Extract a simple string value: toml_get "key"
|
||||
# Searches the whole file; for sectioned keys, grep is specific enough
|
||||
# given our small, flat schema.
|
||||
toml_get() {
|
||||
grep "^$1 " "$CONFIG" | head -1 | sed 's/.*= *"\{0,1\}\([^"]*\)"\{0,1\}/\1/' | tr -d ' '
|
||||
}
|
||||
|
||||
# Extract a TOML array as space-separated values: toml_array "key"
|
||||
toml_array() {
|
||||
grep "^$1 " "$CONFIG" | head -1 \
|
||||
| sed 's/.*\[//; s/\].*//; s/"//g; s/,/ /g' | tr -s ' '
|
||||
}
|
||||
|
||||
SKETCH_NAME="$(toml_get 'name')"
|
||||
FQBN="$(toml_get 'fqbn')"
|
||||
WARNINGS="$(toml_get 'warnings')"
|
||||
INCLUDE_DIRS="$(toml_array 'include_dirs')"
|
||||
EXTRA_FLAGS="$(toml_array 'extra_flags')"
|
||||
|
||||
[[ -n "$SKETCH_NAME" ]] || die "Could not read project name from .anvil.toml"
|
||||
[[ -n "$FQBN" ]] || die "Could not read fqbn from .anvil.toml"
|
||||
|
||||
SKETCH_DIR="$SCRIPT_DIR/$SKETCH_NAME"
|
||||
BUILD_DIR="$SCRIPT_DIR/.build"
|
||||
|
||||
# -- Parse arguments -------------------------------------------------------
|
||||
DO_CLEAN=0
|
||||
VERBOSE=""
|
||||
|
||||
for arg in "$@"; do
|
||||
case "$arg" in
|
||||
--clean) DO_CLEAN=1 ;;
|
||||
--verbose) VERBOSE="--verbose" ;;
|
||||
-h|--help)
|
||||
echo "Usage: ./build.sh [--clean] [--verbose]"
|
||||
echo " Compiles the sketch. Settings from .anvil.toml."
|
||||
exit 0
|
||||
;;
|
||||
*) die "Unknown option: $arg" ;;
|
||||
esac
|
||||
done
|
||||
|
||||
# -- Preflight -------------------------------------------------------------
|
||||
command -v arduino-cli &>/dev/null \
|
||||
|| die "arduino-cli not found in PATH. Install it first."
|
||||
|
||||
[[ -d "$SKETCH_DIR" ]] \
|
||||
|| die "Sketch directory not found: $SKETCH_DIR"
|
||||
|
||||
[[ -f "$SKETCH_DIR/$SKETCH_NAME.ino" ]] \
|
||||
|| die "Sketch file not found: $SKETCH_DIR/$SKETCH_NAME.ino"
|
||||
|
||||
# -- Clean -----------------------------------------------------------------
|
||||
if [[ $DO_CLEAN -eq 1 ]] && [[ -d "$BUILD_DIR" ]]; then
|
||||
echo "${YLW}Cleaning build cache...${RST}"
|
||||
rm -rf "$BUILD_DIR"
|
||||
ok "Cache cleared."
|
||||
fi
|
||||
|
||||
# -- Build include flags ---------------------------------------------------
|
||||
BUILD_FLAGS=""
|
||||
for dir in $INCLUDE_DIRS; do
|
||||
abs="$SCRIPT_DIR/$dir"
|
||||
if [[ -d "$abs" ]]; then
|
||||
BUILD_FLAGS="$BUILD_FLAGS -I$abs"
|
||||
else
|
||||
warn "Include directory not found: $dir"
|
||||
fi
|
||||
done
|
||||
for flag in $EXTRA_FLAGS; do
|
||||
BUILD_FLAGS="$BUILD_FLAGS $flag"
|
||||
done
|
||||
|
||||
# -- Compile ---------------------------------------------------------------
|
||||
echo "${CYN}${BLD}Compiling ${SKETCH_NAME}...${RST}"
|
||||
echo " Board: $FQBN"
|
||||
echo " Sketch: $SKETCH_DIR"
|
||||
echo ""
|
||||
|
||||
mkdir -p "$BUILD_DIR"
|
||||
|
||||
COMPILE_ARGS=(
|
||||
compile
|
||||
--fqbn "$FQBN"
|
||||
--build-path "$BUILD_DIR"
|
||||
--warnings "$WARNINGS"
|
||||
)
|
||||
|
||||
if [[ -n "$BUILD_FLAGS" ]]; then
|
||||
COMPILE_ARGS+=(--build-property "build.extra_flags=$BUILD_FLAGS")
|
||||
fi
|
||||
|
||||
if [[ -n "$VERBOSE" ]]; then
|
||||
COMPILE_ARGS+=("$VERBOSE")
|
||||
fi
|
||||
|
||||
COMPILE_ARGS+=("$SKETCH_DIR")
|
||||
|
||||
arduino-cli "${COMPILE_ARGS[@]}" || die "Compilation failed."
|
||||
|
||||
echo ""
|
||||
ok "Compile succeeded."
|
||||
|
||||
# -- Binary size -----------------------------------------------------------
|
||||
ELF="$BUILD_DIR/$SKETCH_NAME.ino.elf"
|
||||
if [[ -f "$ELF" ]] && command -v avr-size &>/dev/null; then
|
||||
echo ""
|
||||
avr-size --mcu=atmega328p -C "$ELF"
|
||||
fi
|
||||
|
||||
echo ""
|
||||
74
templates/basic/monitor.bat
Normal file
74
templates/basic/monitor.bat
Normal file
@@ -0,0 +1,74 @@
|
||||
@echo off
|
||||
setlocal enabledelayedexpansion
|
||||
|
||||
:: monitor.bat -- Open the serial monitor
|
||||
::
|
||||
:: Reads baud rate from .anvil.toml. No Anvil binary required.
|
||||
::
|
||||
:: Usage:
|
||||
:: monitor.bat Open monitor (auto-detect port)
|
||||
:: monitor.bat -p COM3 Specify port
|
||||
:: monitor.bat -b 9600 Override baud rate
|
||||
|
||||
set "SCRIPT_DIR=%~dp0"
|
||||
set "CONFIG=%SCRIPT_DIR%.anvil.toml"
|
||||
|
||||
if not exist "%CONFIG%" (
|
||||
echo FAIL: No .anvil.toml found in %SCRIPT_DIR%
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:: -- Parse .anvil.toml ----------------------------------------------------
|
||||
for /f "tokens=1,* delims==" %%a in ('findstr /b "baud " "%CONFIG%"') do (
|
||||
set "BAUD=%%b"
|
||||
)
|
||||
set "BAUD=%BAUD: =%"
|
||||
set "BAUD=%BAUD:"=%"
|
||||
if "%BAUD%"=="" set "BAUD=115200"
|
||||
|
||||
:: -- Parse arguments ------------------------------------------------------
|
||||
set "PORT="
|
||||
|
||||
:parse_args
|
||||
if "%~1"=="" goto done_args
|
||||
if "%~1"=="-p" set "PORT=%~2" & shift & shift & goto parse_args
|
||||
if "%~1"=="--port" set "PORT=%~2" & shift & shift & goto parse_args
|
||||
if "%~1"=="-b" set "BAUD=%~2" & shift & shift & goto parse_args
|
||||
if "%~1"=="--baud" set "BAUD=%~2" & shift & shift & goto parse_args
|
||||
if "%~1"=="--help" goto show_help
|
||||
if "%~1"=="-h" goto show_help
|
||||
echo FAIL: Unknown option: %~1
|
||||
exit /b 1
|
||||
|
||||
:show_help
|
||||
echo Usage: monitor.bat [-p PORT] [-b BAUD]
|
||||
echo Opens serial monitor. Baud rate from .anvil.toml.
|
||||
exit /b 0
|
||||
|
||||
:done_args
|
||||
|
||||
:: -- Preflight ------------------------------------------------------------
|
||||
where arduino-cli >nul 2>nul
|
||||
if errorlevel 1 (
|
||||
echo FAIL: arduino-cli not found in PATH.
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:: -- Auto-detect port -----------------------------------------------------
|
||||
if "%PORT%"=="" (
|
||||
for /f "tokens=1" %%p in ('arduino-cli board list 2^>nul ^| findstr /i "serial" ^| findstr /n "." ^| findstr "^1:"') do (
|
||||
set "PORT=%%p"
|
||||
)
|
||||
set "PORT=!PORT:1:=!"
|
||||
if "!PORT!"=="" (
|
||||
echo FAIL: No serial port detected. Specify with: monitor.bat -p COM3
|
||||
exit /b 1
|
||||
)
|
||||
echo warn Auto-detected port: !PORT! (use -p to override)
|
||||
)
|
||||
|
||||
:: -- Monitor --------------------------------------------------------------
|
||||
echo Opening serial monitor on %PORT% at %BAUD% baud...
|
||||
echo Press Ctrl+C to exit.
|
||||
echo.
|
||||
arduino-cli monitor -p %PORT% -c "baudrate=%BAUD%"
|
||||
107
templates/basic/monitor.sh
Normal file
107
templates/basic/monitor.sh
Normal file
@@ -0,0 +1,107 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# monitor.sh -- Open the serial monitor
|
||||
#
|
||||
# Reads baud rate from .anvil.toml. No Anvil binary required.
|
||||
#
|
||||
# Usage:
|
||||
# ./monitor.sh Auto-detect port
|
||||
# ./monitor.sh -p /dev/ttyUSB0 Specify port
|
||||
# ./monitor.sh -b 9600 Override baud rate
|
||||
# ./monitor.sh --watch Reconnect after reset/replug
|
||||
#
|
||||
# Prerequisites: arduino-cli in PATH
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
CONFIG="$SCRIPT_DIR/.anvil.toml"
|
||||
|
||||
# -- Colors ----------------------------------------------------------------
|
||||
if [[ -t 1 ]]; then
|
||||
RED=$'\033[0;31m'; GRN=$'\033[0;32m'; YLW=$'\033[0;33m'
|
||||
CYN=$'\033[0;36m'; BLD=$'\033[1m'; RST=$'\033[0m'
|
||||
else
|
||||
RED=''; GRN=''; YLW=''; CYN=''; BLD=''; RST=''
|
||||
fi
|
||||
|
||||
warn() { echo "${YLW}warn${RST} $*"; }
|
||||
die() { echo "${RED}FAIL${RST} $*" >&2; exit 1; }
|
||||
|
||||
# -- Parse .anvil.toml -----------------------------------------------------
|
||||
[[ -f "$CONFIG" ]] || die "No .anvil.toml found in $SCRIPT_DIR"
|
||||
|
||||
toml_get() {
|
||||
grep "^$1 " "$CONFIG" | head -1 | sed 's/.*= *"\{0,1\}\([^"]*\)"\{0,1\}/\1/' | tr -d ' '
|
||||
}
|
||||
|
||||
BAUD="$(toml_get 'baud')"
|
||||
BAUD="${BAUD:-115200}"
|
||||
|
||||
# -- Parse arguments -------------------------------------------------------
|
||||
PORT=""
|
||||
DO_WATCH=0
|
||||
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case "$1" in
|
||||
-p|--port) PORT="$2"; shift 2 ;;
|
||||
-b|--baud) BAUD="$2"; shift 2 ;;
|
||||
--watch) DO_WATCH=1; shift ;;
|
||||
-h|--help)
|
||||
echo "Usage: ./monitor.sh [-p PORT] [-b BAUD] [--watch]"
|
||||
echo " Opens serial monitor. Baud rate from .anvil.toml."
|
||||
exit 0
|
||||
;;
|
||||
*) die "Unknown option: $1" ;;
|
||||
esac
|
||||
done
|
||||
|
||||
# -- Preflight -------------------------------------------------------------
|
||||
command -v arduino-cli &>/dev/null \
|
||||
|| die "arduino-cli not found in PATH."
|
||||
|
||||
# -- Auto-detect port ------------------------------------------------------
|
||||
auto_detect() {
|
||||
arduino-cli board list 2>/dev/null \
|
||||
| grep -i "serial" \
|
||||
| head -1 \
|
||||
| awk '{print $1}'
|
||||
}
|
||||
|
||||
if [[ -z "$PORT" ]]; then
|
||||
PORT="$(auto_detect)"
|
||||
if [[ -z "$PORT" ]]; then
|
||||
die "No serial port detected. Is the board plugged in?\n Specify manually: ./monitor.sh -p /dev/ttyUSB0"
|
||||
fi
|
||||
warn "Auto-detected port: $PORT (use -p to override)"
|
||||
fi
|
||||
|
||||
# -- Watch mode ------------------------------------------------------------
|
||||
if [[ $DO_WATCH -eq 1 ]]; then
|
||||
echo "${CYN}${BLD}Persistent monitor on ${PORT} at ${BAUD} baud${RST}"
|
||||
echo "Reconnects after upload / reset / replug."
|
||||
echo "Press Ctrl+C to exit."
|
||||
echo ""
|
||||
|
||||
trap "echo ''; echo 'Monitor stopped.'; exit 0" INT
|
||||
|
||||
while true; do
|
||||
if [[ -e "$PORT" ]]; then
|
||||
arduino-cli monitor -p "$PORT" -c "baudrate=$BAUD" 2>/dev/null || true
|
||||
echo "${YLW}--- ${PORT} disconnected ---${RST}"
|
||||
else
|
||||
echo "${CYN}--- Waiting for ${PORT} ...${RST}"
|
||||
while [[ ! -e "$PORT" ]]; do
|
||||
sleep 0.5
|
||||
done
|
||||
sleep 1
|
||||
echo "${GRN}--- ${PORT} connected ---${RST}"
|
||||
fi
|
||||
sleep 0.5
|
||||
done
|
||||
else
|
||||
echo "Opening serial monitor on $PORT at $BAUD baud..."
|
||||
echo "Press Ctrl+C to exit."
|
||||
echo ""
|
||||
arduino-cli monitor -p "$PORT" -c "baudrate=$BAUD"
|
||||
fi
|
||||
144
templates/basic/upload.bat
Normal file
144
templates/basic/upload.bat
Normal file
@@ -0,0 +1,144 @@
|
||||
@echo off
|
||||
setlocal enabledelayedexpansion
|
||||
|
||||
:: upload.bat -- Compile and upload the sketch to the board
|
||||
::
|
||||
:: Reads all settings from .anvil.toml. No Anvil binary required.
|
||||
::
|
||||
:: Usage:
|
||||
:: upload.bat Auto-detect port, compile + upload
|
||||
:: upload.bat -p COM3 Specify port
|
||||
:: upload.bat --monitor Open serial monitor after upload
|
||||
:: upload.bat --clean Clean build cache first
|
||||
:: upload.bat --verbose Full compiler + avrdude output
|
||||
|
||||
set "SCRIPT_DIR=%~dp0"
|
||||
set "CONFIG=%SCRIPT_DIR%.anvil.toml"
|
||||
|
||||
if not exist "%CONFIG%" (
|
||||
echo FAIL: No .anvil.toml found in %SCRIPT_DIR%
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:: -- Parse .anvil.toml ----------------------------------------------------
|
||||
for /f "tokens=1,* delims==" %%a in ('findstr /b "name " "%CONFIG%"') do (
|
||||
set "SKETCH_NAME=%%b"
|
||||
)
|
||||
for /f "tokens=1,* delims==" %%a in ('findstr /b "fqbn " "%CONFIG%"') do (
|
||||
set "FQBN=%%b"
|
||||
)
|
||||
for /f "tokens=1,* delims==" %%a in ('findstr /b "warnings " "%CONFIG%"') do (
|
||||
set "WARNINGS=%%b"
|
||||
)
|
||||
for /f "tokens=1,* delims==" %%a in ('findstr /b "baud " "%CONFIG%"') do (
|
||||
set "BAUD=%%b"
|
||||
)
|
||||
|
||||
set "SKETCH_NAME=%SKETCH_NAME: =%"
|
||||
set "SKETCH_NAME=%SKETCH_NAME:"=%"
|
||||
set "FQBN=%FQBN: =%"
|
||||
set "FQBN=%FQBN:"=%"
|
||||
set "WARNINGS=%WARNINGS: =%"
|
||||
set "WARNINGS=%WARNINGS:"=%"
|
||||
set "BAUD=%BAUD: =%"
|
||||
set "BAUD=%BAUD:"=%"
|
||||
|
||||
if "%SKETCH_NAME%"=="" (
|
||||
echo FAIL: Could not read project name from .anvil.toml
|
||||
exit /b 1
|
||||
)
|
||||
if "%BAUD%"=="" set "BAUD=115200"
|
||||
|
||||
set "SKETCH_DIR=%SCRIPT_DIR%%SKETCH_NAME%"
|
||||
set "BUILD_DIR=%SCRIPT_DIR%.build"
|
||||
|
||||
:: -- Parse arguments ------------------------------------------------------
|
||||
set "PORT="
|
||||
set "DO_MONITOR=0"
|
||||
set "DO_CLEAN=0"
|
||||
set "VERBOSE="
|
||||
|
||||
:parse_args
|
||||
if "%~1"=="" goto done_args
|
||||
if "%~1"=="-p" set "PORT=%~2" & shift & shift & goto parse_args
|
||||
if "%~1"=="--port" set "PORT=%~2" & shift & shift & goto parse_args
|
||||
if "%~1"=="--monitor" set "DO_MONITOR=1" & shift & goto parse_args
|
||||
if "%~1"=="--clean" set "DO_CLEAN=1" & shift & goto parse_args
|
||||
if "%~1"=="--verbose" set "VERBOSE=--verbose" & shift & goto parse_args
|
||||
if "%~1"=="--help" goto show_help
|
||||
if "%~1"=="-h" goto show_help
|
||||
echo FAIL: Unknown option: %~1
|
||||
exit /b 1
|
||||
|
||||
:show_help
|
||||
echo Usage: upload.bat [-p PORT] [--monitor] [--clean] [--verbose]
|
||||
echo Compiles and uploads the sketch. Settings from .anvil.toml.
|
||||
exit /b 0
|
||||
|
||||
:done_args
|
||||
|
||||
:: -- Preflight ------------------------------------------------------------
|
||||
where arduino-cli >nul 2>nul
|
||||
if errorlevel 1 (
|
||||
echo FAIL: arduino-cli not found in PATH.
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
:: -- Auto-detect port -----------------------------------------------------
|
||||
if "%PORT%"=="" (
|
||||
for /f "tokens=1" %%p in ('arduino-cli board list 2^>nul ^| findstr /i "serial" ^| findstr /n "." ^| findstr "^1:"') do (
|
||||
set "PORT=%%p"
|
||||
)
|
||||
:: Strip the line number prefix
|
||||
set "PORT=!PORT:1:=!"
|
||||
if "!PORT!"=="" (
|
||||
echo FAIL: No serial port detected. Specify with: upload.bat -p COM3
|
||||
exit /b 1
|
||||
)
|
||||
echo warn Auto-detected port: !PORT! (use -p to override)
|
||||
)
|
||||
|
||||
:: -- Clean ----------------------------------------------------------------
|
||||
if "%DO_CLEAN%"=="1" (
|
||||
if exist "%BUILD_DIR%" rmdir /s /q "%BUILD_DIR%"
|
||||
)
|
||||
|
||||
:: -- Build include flags --------------------------------------------------
|
||||
set "BUILD_FLAGS="
|
||||
for %%d in (lib\hal lib\app) do (
|
||||
if exist "%SCRIPT_DIR%%%d" (
|
||||
set "BUILD_FLAGS=!BUILD_FLAGS! -I%SCRIPT_DIR%%%d"
|
||||
)
|
||||
)
|
||||
set "BUILD_FLAGS=!BUILD_FLAGS! -Werror"
|
||||
|
||||
:: -- Compile --------------------------------------------------------------
|
||||
echo Compiling %SKETCH_NAME%...
|
||||
if not exist "%BUILD_DIR%" mkdir "%BUILD_DIR%"
|
||||
|
||||
arduino-cli compile --fqbn %FQBN% --build-path "%BUILD_DIR%" --warnings %WARNINGS% --build-property "build.extra_flags=%BUILD_FLAGS%" %VERBOSE% "%SKETCH_DIR%"
|
||||
if errorlevel 1 (
|
||||
echo FAIL: Compilation failed.
|
||||
exit /b 1
|
||||
)
|
||||
echo ok Compile succeeded.
|
||||
|
||||
:: -- Upload ---------------------------------------------------------------
|
||||
echo.
|
||||
echo Uploading to %PORT%...
|
||||
|
||||
arduino-cli upload --fqbn %FQBN% --port %PORT% --input-dir "%BUILD_DIR%" %VERBOSE%
|
||||
if errorlevel 1 (
|
||||
echo FAIL: Upload failed.
|
||||
exit /b 1
|
||||
)
|
||||
echo ok Upload complete!
|
||||
|
||||
:: -- Monitor --------------------------------------------------------------
|
||||
if "%DO_MONITOR%"=="1" (
|
||||
echo.
|
||||
echo Opening serial monitor on %PORT% at %BAUD% baud...
|
||||
echo Press Ctrl+C to exit.
|
||||
echo.
|
||||
arduino-cli monitor -p %PORT% -c "baudrate=%BAUD%"
|
||||
)
|
||||
164
templates/basic/upload.sh
Normal file
164
templates/basic/upload.sh
Normal file
@@ -0,0 +1,164 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# upload.sh -- Compile and upload the sketch to the board
|
||||
#
|
||||
# Reads all settings from .anvil.toml. No Anvil binary required.
|
||||
#
|
||||
# Usage:
|
||||
# ./upload.sh Auto-detect port, compile + upload
|
||||
# ./upload.sh -p /dev/ttyUSB0 Specify port
|
||||
# ./upload.sh --monitor Open serial monitor after upload
|
||||
# ./upload.sh --clean Clean build cache first
|
||||
# ./upload.sh --verbose Full compiler + avrdude output
|
||||
#
|
||||
# Prerequisites: arduino-cli in PATH, arduino:avr core installed
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
CONFIG="$SCRIPT_DIR/.anvil.toml"
|
||||
|
||||
# -- Colors ----------------------------------------------------------------
|
||||
if [[ -t 1 ]]; then
|
||||
RED=$'\033[0;31m'; GRN=$'\033[0;32m'; YLW=$'\033[0;33m'
|
||||
CYN=$'\033[0;36m'; BLD=$'\033[1m'; RST=$'\033[0m'
|
||||
else
|
||||
RED=''; GRN=''; YLW=''; CYN=''; BLD=''; RST=''
|
||||
fi
|
||||
|
||||
ok() { echo "${GRN}ok${RST} $*"; }
|
||||
warn() { echo "${YLW}warn${RST} $*"; }
|
||||
die() { echo "${RED}FAIL${RST} $*" >&2; exit 1; }
|
||||
|
||||
# -- Parse .anvil.toml -----------------------------------------------------
|
||||
[[ -f "$CONFIG" ]] || die "No .anvil.toml found in $SCRIPT_DIR"
|
||||
|
||||
toml_get() {
|
||||
grep "^$1 " "$CONFIG" | head -1 | sed 's/.*= *"\{0,1\}\([^"]*\)"\{0,1\}/\1/' | tr -d ' '
|
||||
}
|
||||
|
||||
toml_array() {
|
||||
grep "^$1 " "$CONFIG" | head -1 \
|
||||
| sed 's/.*\[//; s/\].*//; s/"//g; s/,/ /g' | tr -s ' '
|
||||
}
|
||||
|
||||
SKETCH_NAME="$(toml_get 'name')"
|
||||
FQBN="$(toml_get 'fqbn')"
|
||||
WARNINGS="$(toml_get 'warnings')"
|
||||
INCLUDE_DIRS="$(toml_array 'include_dirs')"
|
||||
EXTRA_FLAGS="$(toml_array 'extra_flags')"
|
||||
BAUD="$(toml_get 'baud')"
|
||||
|
||||
[[ -n "$SKETCH_NAME" ]] || die "Could not read project name from .anvil.toml"
|
||||
[[ -n "$FQBN" ]] || die "Could not read fqbn from .anvil.toml"
|
||||
|
||||
BAUD="${BAUD:-115200}"
|
||||
SKETCH_DIR="$SCRIPT_DIR/$SKETCH_NAME"
|
||||
BUILD_DIR="$SCRIPT_DIR/.build"
|
||||
|
||||
# -- Parse arguments -------------------------------------------------------
|
||||
PORT=""
|
||||
DO_MONITOR=0
|
||||
DO_CLEAN=0
|
||||
VERBOSE=""
|
||||
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case "$1" in
|
||||
-p|--port) PORT="$2"; shift 2 ;;
|
||||
--monitor) DO_MONITOR=1; shift ;;
|
||||
--clean) DO_CLEAN=1; shift ;;
|
||||
--verbose) VERBOSE="--verbose"; shift ;;
|
||||
-h|--help)
|
||||
echo "Usage: ./upload.sh [-p PORT] [--monitor] [--clean] [--verbose]"
|
||||
echo " Compiles and uploads the sketch. Settings from .anvil.toml."
|
||||
exit 0
|
||||
;;
|
||||
*) die "Unknown option: $1" ;;
|
||||
esac
|
||||
done
|
||||
|
||||
# -- Preflight -------------------------------------------------------------
|
||||
command -v arduino-cli &>/dev/null \
|
||||
|| die "arduino-cli not found in PATH."
|
||||
|
||||
[[ -d "$SKETCH_DIR" ]] \
|
||||
|| die "Sketch directory not found: $SKETCH_DIR"
|
||||
|
||||
# -- Auto-detect port ------------------------------------------------------
|
||||
if [[ -z "$PORT" ]]; then
|
||||
# Look for the first serial port arduino-cli can see
|
||||
PORT=$(arduino-cli board list 2>/dev/null \
|
||||
| grep -i "serial" \
|
||||
| head -1 \
|
||||
| awk '{print $1}')
|
||||
|
||||
if [[ -z "$PORT" ]]; then
|
||||
die "No serial port detected. Is the board plugged in?\n Specify manually: ./upload.sh -p /dev/ttyUSB0"
|
||||
fi
|
||||
|
||||
warn "Auto-detected port: $PORT (use -p to override)"
|
||||
fi
|
||||
|
||||
# -- Clean -----------------------------------------------------------------
|
||||
if [[ $DO_CLEAN -eq 1 ]] && [[ -d "$BUILD_DIR" ]]; then
|
||||
echo "${YLW}Cleaning build cache...${RST}"
|
||||
rm -rf "$BUILD_DIR"
|
||||
fi
|
||||
|
||||
# -- Build include flags ---------------------------------------------------
|
||||
BUILD_FLAGS=""
|
||||
for dir in $INCLUDE_DIRS; do
|
||||
abs="$SCRIPT_DIR/$dir"
|
||||
if [[ -d "$abs" ]]; then
|
||||
BUILD_FLAGS="$BUILD_FLAGS -I$abs"
|
||||
fi
|
||||
done
|
||||
for flag in $EXTRA_FLAGS; do
|
||||
BUILD_FLAGS="$BUILD_FLAGS $flag"
|
||||
done
|
||||
|
||||
# -- Compile ---------------------------------------------------------------
|
||||
echo "${CYN}${BLD}Compiling ${SKETCH_NAME}...${RST}"
|
||||
mkdir -p "$BUILD_DIR"
|
||||
|
||||
COMPILE_ARGS=(
|
||||
compile
|
||||
--fqbn "$FQBN"
|
||||
--build-path "$BUILD_DIR"
|
||||
--warnings "$WARNINGS"
|
||||
)
|
||||
|
||||
if [[ -n "$BUILD_FLAGS" ]]; then
|
||||
COMPILE_ARGS+=(--build-property "build.extra_flags=$BUILD_FLAGS")
|
||||
fi
|
||||
|
||||
[[ -n "$VERBOSE" ]] && COMPILE_ARGS+=("$VERBOSE")
|
||||
COMPILE_ARGS+=("$SKETCH_DIR")
|
||||
|
||||
arduino-cli "${COMPILE_ARGS[@]}" || die "Compilation failed."
|
||||
ok "Compile succeeded."
|
||||
|
||||
# -- Upload ----------------------------------------------------------------
|
||||
echo ""
|
||||
echo "${CYN}${BLD}Uploading to ${PORT}...${RST}"
|
||||
|
||||
UPLOAD_ARGS=(
|
||||
upload
|
||||
--fqbn "$FQBN"
|
||||
--port "$PORT"
|
||||
--input-dir "$BUILD_DIR"
|
||||
)
|
||||
|
||||
[[ -n "$VERBOSE" ]] && UPLOAD_ARGS+=("$VERBOSE")
|
||||
|
||||
arduino-cli "${UPLOAD_ARGS[@]}" || die "Upload failed."
|
||||
ok "Upload complete!"
|
||||
|
||||
# -- Monitor ---------------------------------------------------------------
|
||||
if [[ $DO_MONITOR -eq 1 ]]; then
|
||||
echo ""
|
||||
echo "Opening serial monitor on $PORT at $BAUD baud..."
|
||||
echo "Press Ctrl+C to exit."
|
||||
echo ""
|
||||
arduino-cli monitor -p "$PORT" -c "baudrate=$BAUD"
|
||||
fi
|
||||
Reference in New Issue
Block a user