webui: add a device hostname and access point table - #553
Draft
MUSTARDTIGERFPV wants to merge 1 commit into
Draft
Conversation
Closes ExpressLRS#528. The site documents elrs_tx.local and elrs_rx.local well, and mentions elrs_txbp.local and elrs_vrx.local on the Backpack pages, but elrs_aat.local and elrs_timer.local do not appear anywhere. There is also no single place that lists them, so a user with a Backpack has to guess or search. All values are taken from source: - elrs_tx and elrs_rx, with the ExpressLRS TX and ExpressLRS RX access points, are in options.cpp in the main firmware. - elrs_aat, elrs_vrx, elrs_txbp and elrs_timer, with their access point names, are in lib/WIFI/devWIFI.cpp in the Backpack repository. The TX Backpack access point name is built at runtime from the selected service, so the table says so rather than naming one. - The access point password is expresslrs and the address is 10.0.0.1 on both the main firmware and the Backpack. Add DHCP, MDNS, VRx, hostname and hostnames to the word list. These terms are already used on the site, but only inside admonition bodies, which the spellcheck treats as code blocks because its markdown filter loads only markdown.extensions.extra.
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.
Closes #528.
elrs_tx.localandelrs_rx.localare documented well.elrs_txbp.localandelrs_vrx.localappear on the Backpack pages.elrs_aat.localandelrs_timer.localdo not appear anywhere on the site. There is also no single place that lists them, so a user setting up a Backpack has to guess or go searching.This adds one table at the end of "How to get to the Web UI".
elrs_tx.localExpressLRS TXelrs_rx.localExpressLRS RXelrs_txbp.localelrs_vrx.localExpressLRS VRx Backpackelrs_aat.localExpressLRS AAT Backpackelrs_timer.localExpressLRS Timer BackpackSources
Everything is taken from source rather than from existing docs.
elrs_tx/elrs_rxand theExpressLRS TX/ExpressLRS RXaccess point names are insrc/lib/OPTIONS/options.cppin this firmware repo, along withwifi_ap_password = "expresslrs"andwifi_ap_address = "10.0.0.1".elrs_aat,elrs_vrx,elrs_txbpandelrs_timerand their access point names are inlib/WIFI/devWIFI.cppin the Backpack repository, selected byAAT_BACKPACK,TARGET_VRX_BACKPACK,TARGET_TX_BACKPACKandTARGET_TIMER_BACKPACK.static char wifi_ap_ssid[33]and is filled in at runtime from the selectedwifiService, so the table says it changes rather than naming a fixed string.expresslrspassword and the same10.0.0.1address (static IPAddress apIP(10, 0, 0, 1)).Word list
Adds
DHCP,MDNS,VRx,hostnameandhostnames.These terms are already used across the site, but every existing occurrence sits inside an admonition body. The spellcheck's markdown filter loads only
markdown.extensions.extra, so those indented blocks are parsed as code blocks and skipped. The new table is top level prose, so the words are checked for the first time.VRxis kept in that exact mixed case because it is the literal SSID string the user sees when picking a network.