Skip to content

nut-driver/: this repo is the driver's source of truth - #14

Merged
miklosbagi merged 1 commit into
mainfrom
nut-driver-reorg
Aug 16, 2026
Merged

miklosbagi merged 1 commit into
mainfrom
nut-driver-reorg

Conversation

@miklosbagi

Copy link
Copy Markdown
Owner

Summary

  • Renamed driver/ -> nut-driver/, and documented why: sigennut is where the driver is actually developed, a fork is just a periodic export target for the upstream PR attempt, and this repo's build never depends on that PR's fate.
  • Fixed relative-path references to private sibling repos in the driver's own header comment (dead for anyone else cloning this).
  • Switched the driver's copyright/author email to mb_nutdco@mbag.at (NUT-submission-specific, distinct from mb_sigennut@mbag.at).
  • Validated the low_battery_soc -x override before strtod (typo'd value silently became a 0.0 threshold).
  • Reformatted with indent -kr -i8 -T FILE -l1000 -nhnl to actually match byte-for-byte, and added a new nut-driver-style CI job enforcing it going forward.

Test plan

  • Driver rebuilds warning-free
  • Full docker-compose smoke test passes with real captured data
  • indent gate passes locally (verified idempotent)

sigennut, not any fork or PR branch, is where the driver is actually
developed and versioned. A fork (miklosbagi/nut) becomes a periodic
export target purely for proposing it upstream -- this repo's own
build never depends on that fork existing or that PR being accepted,
rejected, or ever resolved. Worst case, this stays a permanently
maintained 'NUT plus this one driver' image regardless of what
upstream decides.

Also, while updating nut-driver/sigenergy_modbus.c for the move:
- Fixed relative-path references to private sibling repos
  (../../nut-sigenergy, ../../sigennut) in the header comment -- those
  don't exist for anyone else cloning this, and leaked private planning
  doc names into what's meant to be a self-contained public file.
- Switched the copyright/author email to mb_nutdco@mbag.at, the
  NUT-submission-specific contact (distinct from mb_sigennut@mbag.at,
  which stays scoped to this Docker image's own artifacts).
- Validated the low_battery_soc -x override before strtod() -- a typo'd
  value silently became a 0.0 threshold (LB would never trigger) with
  no error logged.
- Reformatted with  to actually
  match NUT's own recommended house style byte-for-byte (verified
  idempotent), now enforced by a new nut-driver-style CI job.

Verified: driver still builds warning-free, full docker-compose smoke
test still passes with real captured data after all of the above.
@github-actions github-actions Bot added the Tag/Patch Bump patch version (x.y.Z) on merge label Aug 16, 2026
@miklosbagi
miklosbagi merged commit a0e08f5 into main Aug 16, 2026
7 checks passed
@miklosbagi
miklosbagi deleted the nut-driver-reorg branch August 16, 2026 04:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Tag/Patch Bump patch version (x.y.Z) on merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant