software: add a Hardware Layout field reference - #559
Draft
MUSTARDTIGERFPV wants to merge 1 commit into
Draft
Conversation
The Web UI page warns that Hardware Layout is for advanced users but never says what any of the fields do. The only coverage on the site is two sentences and a warning, and there is no mention anywhere of hardware.json or of the schema behind it. This adds a reference for all 130 fields across the 17 sections of hardware-schema.js, giving the key as it appears in hardware.json, the label shown in the Web UI, the type, and the description. The tables are generated from the schema rather than written by hand, so the wording matches the tool exactly and the page can be regenerated when the schema changes. Platform restrictions are taken from the FEATURE markers in the schema and are stated on the section, or on the individual field where it differs from its section. Also documents what the types mean and that an empty or negative pin value means the pin is not fitted, which is how the firmware reads it. The warnings cover the two things that actually hurt: a wrong value can stop the device booting or damage it, and raising a power limit only changes what the device reports, not what the amplifier can deliver. The word list gains the technical terms the schema uses, such as the radio bus pins, the power detection fields and the voltage sensor names.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Web UI page warns that Hardware Layout is for advanced users, but never says what any field does. Total coverage on the site today is two sentences plus a warning, and
hardware.jsonis not mentioned anywhere.This adds
software/hardware-layout.md, covering all 130 fields across the 17 sections ofhardware-schema.js, with the key as it appears inhardware.json, the Web UI label, the type, and the description.Generated, not hand written
The tables are generated from
src/html/src/utils/hardware-schema.jsby walking the file and readingtitle,id,label,type,descandoptions. That means:Two
selectfields,power_maxandscreen_type, carry nodescbecause theiroptionsare self describing, so their option labels are listed instead.power_pdetdoes have a description; it just uses double quotes because it contains an apostrophe, which an early pass of the extraction missed.Platform restrictions come from the
/* FEATURE: ... */markers in the schema and are mapped to plain wording:IS_TXNOT IS_TXNOT IS_8285HAS_SX127XNOT HAS_SX127XNOT HAS_SX128XHAS_LR1121The restriction is stated on the section, or on the individual field where it differs from its section.
Other content
The page explains what each type means, and that an empty or negative pin value means the pin is not fitted. That is how the firmware reads it, for example in
getVoltageSourcesFromHardware, which treatsnull,''and any negative number as absent.Two warnings: a wrong value can stop the device booting or damage the hardware, and raising a power limit only changes what the device reports, not what the amplifier can deliver. The second is the existing warning from the Web UI page, kept because it is a real and common misunderstanding.
This also gives the fields the audit called out individually,
screen_mirror,pwm_out_only,ant_group,vbatandvsrc1tovsrc3, a documented home.Notes for review
webui.md, to avoid conflicting with the Voltage Calibration hunk in the Web UI tabs PR. Worth adding once both land.Schmittis added identically to the PWM receivers PR so the two merge cleanly.