Skip to content

Docs: curated Lua driver catalog - #16

Merged
frahlg merged 1 commit into
masterfrom
docs-driver-catalog-table
Apr 15, 2026
Merged

frahlg merged 1 commit into
masterfrom
docs-driver-catalog-table

Conversation

@frahlg

@frahlg frahlg commented Apr 15, 2026

Copy link
Copy Markdown
Member

Summary

  • New docs/driver-catalog.md: a single markdown table of every Lua driver shipped or in flight — manufacturer, protocol, capabilities, control support, tested model IDs, file path — alphabetized by manufacturer. 71 lines.
  • "Supported devices" section added to README.md, placed between the project intro and the architecture section, linking to the catalog.
  • Cross-link from docs/writing-a-driver.md section 8 so authors find the catalog from the driver-writing guide.

Covers 17 drivers across 15 manufacturers: the 2 already on master (Ferroamp MQTT, Sungrow) plus 15 being ported in parallel (Solis, Huawei, Deye, SMA, Fronius, SolarEdge, SDM630, Pixii, Kostal, GoodWe, Growatt, Sofar, Fronius Smart Meter, Ferroamp Modbus, Victron). Read-only: 11. With control: 6. Two sibling docs referenced here (writing-a-driver-with-claude-code.md, testing-drivers-live.md) are forward-references to parallel sibling units; reviewers will reconcile as those land.

Test plan

  • cd go && go test ./... — all packages pass (e2e 23.6s)
  • Doc uses ATX headers, no emoji, ≤ 250 lines (71)
  • Alphabetized by manufacturer
  • "Tested models" column: concrete model IDs only
  • README.md link lands in the new section early in the file
  • Cross-link from writing-a-driver.md section 8 resolves

Generated with Claude Code

Add docs/driver-catalog.md with the full table of shipped + in-flight
Lua drivers (manufacturer, protocol, capabilities, control support,
tested models). Link it from README.md under a new "Supported devices"
section and cross-link from docs/writing-a-driver.md so the catalog is
discoverable from both the landing page and the driver-authoring guide.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6778642a40

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +58 to +60
17 Lua drivers covering 15 manufacturers — Ferroamp, Sungrow, Solis,
Huawei, Deye, SMA, Fronius, SolarEdge, Eastron SDM, Pixii, Kostal,
GoodWe, Growatt, Sofar, Victron. Six drivers participate in EMS

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Advertise only drivers that are actually present

This new "Supported devices" claim says there are 17 Lua drivers across 15 manufacturers, but the repository currently contains only drivers/ferroamp.lua and drivers/sungrow.lua; the rest of the catalog entries point to files that do not exist. Presenting unlanded/in-flight drivers as currently supported is misleading for users and integrators who rely on README support statements to decide whether the product works with their hardware.

Useful? React with 👍 / 👎.

@frahlg
frahlg merged commit 491c8ff into master Apr 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 2.0.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@frahlg
frahlg deleted the docs-driver-catalog-table branch August 7, 2026 08:16
frahlg added a commit that referenced this pull request Sep 27, 2026
…st proxies (#1454)

Owner decision 2026-09-26: the signed control v2 runtime has been
unreachable since the Device Support package format was removed (#1432);
driverrepo only ever binds a read-only policy now.

- #16 Remove control v2: LuaDriver.CommandV2/DefaultModeV2, the v2 load and
  lifecycle timeouts, write scopes, write budget and host evidence, the
  command/result envelope types and validation, the registry's v2 dispatch,
  lease timer, stale/lease-expiry defaults and v2 startup default, and
  Registry.CommandResultSink with its main.go wiring. The legacy
  driver_command/driver_default_mode path, the recovery gate and the
  observe_only handling from #1444 are unchanged.
- RuntimePolicy (control_v2.go -> runtime_policy.go) keeps only the
  read-only policy; validate rejects any other, and allowWrite refuses
  every write from a driver that carries a policy.
- Drop the 100 ms host.sleep cap that, after v2, applied only to signed
  read-only drivers, so a file sleeps the same whichever source it came
  from (new test).
- driver_command_results is no longer created and its write-only store
  method is gone; existing tables are left inert with a note in migrate().
- #38 Delete the unused HostEnv mqttSubscribe, mqttPublish,
  mqttPollMessages, modbusWriteSingle and modbusWriteMulti proxies.
- Move the surviving read-only lifecycle test, adapt the HTTP 302 and
  OAuth sign-in tests, and update the roadmap, driver guide and comments
  that described v2.


Claude-Session: https://claude.ai/code/session_01MuerPFZFG88kgu8sWVHeq7

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant