Skip to content

Docs: fix driver-catalog count and host-api header - #49

Merged
frahlg merged 1 commit into
masterfrom
10-update-driver-catalog-host-api-docs
Apr 16, 2026
Merged

frahlg merged 1 commit into
masterfrom
10-update-driver-catalog-host-api-docs

Conversation

@frahlg

@frahlg frahlg commented Apr 16, 2026

Copy link
Copy Markdown
Member

Summary

  • driver-catalog.md: Updated driver count from 17 to 18 and read-only count from 11 to 12. Added the missing solaredge_pv.lua (PV-only SolarEdge variant) row to the table with correct metadata from the driver's DRIVER block.
  • host-api.md: Updated the header and intro paragraph — the old text said "Legacy WASM ABI reference" but the document covers both Lua and WASM functions. Now accurately describes coverage of both runtimes and cross-references the authoritative Lua source (go/internal/drivers/lua.go).

Test plan

  • cd go && go test ./... — all tests pass (docs-only changes)
  • Verify driver count matches ls drivers/*.lua | wc -l = 18

🤖 Generated with Claude Code

driver-catalog.md claimed 17 drivers but there are 18 .lua files —
the missing solaredge_pv.lua (PV-only SolarEdge variant) is now listed
and the count/read-only tally is corrected.

host-api.md header said "Legacy WASM ABI reference" but the document
covers both Lua and WASM functions. Updated header and intro to reflect
both runtimes and cross-reference the authoritative Lua source.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@frahlg
frahlg merged commit af37f6f into master Apr 16, 2026

@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: a7a2f19142

ℹ️ 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 docs/host-api.md
Comment on lines +3 to +4
> Complete reference for the `host` capability interface exposed to both
> **Lua** and **WASM** driver runtimes. For a tutorial-style introduction

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 Limit this reference to Lua or document WASM differences

This header now states the page is a complete reference for both Lua and WASM runtimes, but the body documents Lua-only helpers (for example host.decode_u32_le/host.json_decode) that are not WASM host imports; the WASM import surface in go/internal/drivers/abi.go is a different, lower-level ABI (host.emit_telemetry, host.mqtt_poll_messages, etc.). As written, WASM driver authors can follow this page and implement calls that do not exist in the WASM namespace, causing driver integration failures and avoidable debugging churn.

Useful? React with 👍 / 👎.

@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 10-update-driver-catalog-host-api-docs branch August 7, 2026 08:14
frahlg added a commit that referenced this pull request Sep 27, 2026
…overs (#1456)

* refactor(state,mpc,api): remove dead storage, planner and backup leftovers

- #49 Keep on a driver draft now takes the driver update lock and removes
  the record before the saved original, so an expiry already in flight
  finishes first and Keep answers 409 instead of "kept" for a reverted draft.
- #20 History maintenance runs only the plain SQLite stages. Remove the
  Parquet archive pipeline (rolloff, aggregate/sample archive, legacy
  compaction, cold/diagnostic Parquet pruning, Store.Prune) and the unused
  retentionDays closure of rolloffLoop; keep the Parquet readers.
- #40 Drop the hot-history alias (s.hot, hotPath, hotWriteMu), dead
  hot-only branches and readers, forceRotate, heldBytes, RotateHistory and
  the test-only historyWriter.maintainHistory.
- #41 Remove the always-empty ImportedHistoryFiles filter, the unused
  coldDir parameter of legacyHistoryIdle and the test-only backup.Restore;
  round-trip tests now use RestoreContents.
- #29 Remove the recourse/multistage challenger, unix and auto transports,
  transport Health and the stateful shadow evaluator. The worker request
  keeps the same solver settings as constants; the Energyplan process
  transport and Core DP shadow are unchanged.
- #47 Remove the always-zero PV nameplate and load caps (Service fields,
  Plan.pv_nameplate_w/load_max_w, forecast ACLimitW/ClampForecasts and
  their web chart caps), the load rain-check and test-only wrappers. A
  single sanitiser still maps NaN or negative load to 0 W.
- #48 Handshake errors now say the bundled Energyplan worker does not match
  Core and to run `ftw update` or reinstall. Drop PYTHONPATH and fix stale
  Update Center, CVXPY, Python shadow and scenario comments.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MuerPFZFG88kgu8sWVHeq7

* test(mpc): the native contract test no longer expects a scenario model

The shared PV scenarios in buildRequest were reachable only by calling
ExternalOptimizer directly with a risk margin; production runs through
EnergyplanOptimizer, which applies the margin to the slots and zeroes it
before the request. Removing that dead block left the native contract
test asking for three scenarios. It now checks that a margin never
builds a scenario model.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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