webui: document Voltage Calibration, WiFi State and the password reveal - #554
Draft
MUSTARDTIGERFPV wants to merge 1 commit into
Draft
webui: document Voltage Calibration, WiFi State and the password reveal#554MUSTARDTIGERFPV wants to merge 1 commit into
MUSTARDTIGERFPV wants to merge 1 commit into
Conversation
Three parts of the 4.1 Web UI are not covered by this page. Voltage Calibration is a whole tab that is not mentioned at all. It is added between Hardware Layout and Continuous Wave to match the order of the navigation menu. The tab only appears on receivers, and only when the Hardware Layout defines at least one voltage source, so the section says so. The four wizard steps match the panel: High Voltage, Low Voltage, No Voltage, Review. Values are entered in millivolts. The Information Tab section did not describe the WiFi State row. It reports Client with the network name, or AP mode, and adds the signal strength in dBm where the device can measure it. The note records that the number means different things in the two modes, since in Access Point mode it is the RSSI of the single connected client and is absent on ESP8285. A weak signal is a common cause of a failed firmware upload, so that is called out. The WiFi Tab section did not mention the control that reveals the stored password, or the obvious consequence of using it.
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
1 participant
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.
Three parts of the 4.1 Web UI are missing from this page.
Voltage Calibration
A whole tab that is not mentioned anywhere on the site. Added between Hardware Layout and Continuous Wave to match the navigation menu order in
app.js.Scope and gating come from
app.js: the menu entry sits inside<!-- FEATURE:NOT IS_TX -->and is only emitted whenelrsState.settings?.voltage_source_count > 0, so it is receivers only and only when the Hardware Layout defines a voltage source.The four steps match
voltage-calibration-panel.jsexactly:'1. High Voltage', "Set a known voltage near ... and capture it", input labelledKnown voltage (mV)'2. Low Voltage', same input'3. No Voltage', "Disconnect the source and capture the idle reading, or skip if it is always present", with Capture and Skip'4. Review', shows offset, scale, no-reading and the low/high fit error, then "Reconnect or adjust the PSU and confirm the live reading before saving"Saving writes
<source>_offset,<source>_scale,<source>_attenand<source>_noreadingintohardware.jsonwithcustomised: trueviasaveJSONWithReboot, which is why the section says the receiver reboots and why the calibration travels with the Hardware Layout on export.The attenuation sweep is ESP32 only.
CALIBRATION_ATTENUATIONSis[4,5,6,7]on ESP32 and[-1]underFEATURE:IS_8285, so the text limits that claim to ESP32.The warning about input voltage is included because the wizard has no way to protect the hardware; the limit is set by the divider on the board.
Information Tab
The
WiFi Staterow was not described. It isformatWifiRssi()fromstate.js, rendered byinfo-panel.js. Note this is on the Information tab, not the WiFi tab.It shows
Client [ssid]orAP mode, plus the strength in dBm whenwifi_dbmis non-zero. The note records that the value means different things per mode, becausewifi_GetClientRssi()returnsWiFi.RSSI()in STA mode but the RSSI of the single connected client in AP mode, and returns nothing on ESP8285. A weak signal causing a failed firmware upload is a common support question, so that is called out.I deliberately did not reproduce the quality strings verbatim. They include a joke tier and an easter egg at exactly -69dBm, so the page describes them generically rather than treating them as a stable interface.
WiFi Tab
The control that reveals the stored password was not documented.
wifi-panel.jstoggles the field betweenpasswordandtextwith an eye button. The text notes the obvious consequence before sharing a screenshot.