Commit Graph

3 Commits

Author SHA1 Message Date
scottp 95bc2ae9fe docs: fix dangling references, document Gitea/GitHub mirror split
CONTRIBUTING.md: remove the deleted wii5_modes sketch from the testing
guidance; mention the surviving test/ subsystem sketches instead.

README.md: drop the now-incorrect "hardware schematics" entry from the
repository-layout block (doc/hardware/ was removed earlier). Add a
Repository section naming the Gitea canonical and the GitHub mirror
(https://github.com/SH3D/WII5Firmware) used for community issues and PRs.

SECURITY.md, CODE_OF_CONDUCT.md: point at the GitHub mirror for security
advisories; drop the vague "private GitHub message" path from the CoC.

CHANGELOG: replace the "TODO" placeholder with a real v5.5.1 initial
public release entry.

Doxyfile: rewrite the PROJECT_NUMBER injection example to use
`git describe` instead of the deleted VERSION file.

VERSION: removed. It was bumped by tools/tag_version.sh +
tools/build_version.sh (both deleted in c89c636); build_local.sh injects
WII5_SOFTWARE_VERSION from `git log -1 --pretty=%h` at compile time, so
nothing load-bearing depends on the file.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-14 11:06:27 +10:00
scottp c89c636cb7 tools: cull to a minimal user-facing set
Reduce tools/ to the four scripts an outside contributor needs: build,
verify, flash, and size-profile. Drop maintainer-only workflow scripts
(sibling-repo pulls, firmware-archive auto-commit, version tagging),
broken stubs (doxygen.sh, variables.sh), and the entire tools/2024/
directory.

tools/2024/ included a 647 KB Arduino.tar.gz bundling 20 third-party
Arduino libraries (RadioHead = GPLv2, TinyGPSPlus = LGPL, etc.) without
per-library attribution in NOTICE; a 503 KB GPL avrdude.conf; the GPL
Optiboot bootloader hex; and pre-built firmware/test binaries. Users
install the libraries via Arduino Library Manager (per README), use the
system avrdude, and reproduce the firmware from source.

README.md: add EEPROMEx to the library list (used by WII5Config /
WII5Sh3dConfig); note that RadioHead is GPLv2 dual-licensed and only
LoRa builds (-DWII5_RADIO_LORA) link it.

CONTRIBUTING.md: replace the dead tools/upload.sh reference with the
generic *.local.sh pattern.

Kept: build_local.sh, verify.sh, icsp.sh, memory.pl.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-14 10:33:09 +10:00
scottp 295abb37ee Initial public release of WII5 Buoy firmware
Firmware for an autonomous wave-measurement buoy (ATmega2560-based
WII5 v2 board). Reads wave motion from a Sparton AHRS-M1/M2 IMU,
samples GPS and battery state, and reports back over Iridium SBD
satellite telemetry. Originally developed 2012-2024.

This is the first public release. Code, documentation, and field-tested
operating modes (Capture, Sleep, Position, ManualTest, SelfTest,
LowBattery) are licensed under Apache 2.0 — see LICENSE and NOTICE.

See README.md for an overview and build instructions, CONTRIBUTING.md
for how to contribute, and DEPLOYMENTS.md for the field-deployment log.
2026-05-07 16:27:18 +10:00