Skip to content

Fix firmware sample and document core generation - #137

Merged
glopesdev merged 1 commit into
harp-tech:mainfrom
glopesdev:core-interface-docs
Sep 5, 2026
Merged

Fix firmware sample and document core generation#137
glopesdev merged 1 commit into
harp-tech:mainfrom
glopesdev:core-interface-docs

Conversation

@glopesdev

@glopesdev glopesdev commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

The firmware usage sample in the package readme deserializes into a PortPinMetadata type that does not exist, so it would not compile. That name is a T4 template parameter, declared in AppRegs.tt as Dictionary<string, PortPinInfo>, and the sample has carried it since v0.5.0. It now names the type FirmwareGenerator actually takes.

Generating from metadata that declares no device name gains remarks on DeviceMetadata.IsApplicationDevice for the register classes and the address map, and on InterfaceGenerator for the absent asynchronous interface.

Documentation only, so no generated output changes and no reference outputs move.

The firmware usage sample deserialized into a PortPinMetadata type that
does not exist, and now uses the Dictionary<string, PortPinInfo> the
generator takes. Generating from metadata that declares no device name
is documented on IsApplicationDevice and InterfaceGenerator.
@glopesdev glopesdev added the documentation Improvements or additions to documentation label Sep 5, 2026
@glopesdev
glopesdev merged commit 01c2baa into harp-tech:main Sep 5, 2026
9 checks passed
@glopesdev
glopesdev deleted the core-interface-docs branch September 5, 2026 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant