Public Access
Every screen's keys are constant tables in lib/core/src/app_keys.h (52 of them, each under an `// id: Title` comment). An App's help() picks the table of the state it is in. site/tools/gen_dev_docs.py reads the same file and writes site/data/keys.toml; the `keys` shortcode shows a screen's tables on its guide page, and /guide/keys/ shows all of them. The Site job fails when the data file is out of date or a page asks for a table that doesn't exist, and now also runs when app_keys.h changes. A key added to an App shows up on the website without anyone editing a page. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EhqxQ49eCju4CzKYNjZzwT
50 lines
3.2 KiB
Markdown
50 lines
3.2 KiB
Markdown
+++
|
|
title = "Settings"
|
|
description = "The device's names, region, screen, sound, GNSS and Wi-Fi, and where firmware updates are found."
|
|
weight = 10
|
|
[extra]
|
|
tag = "Settings"
|
|
+++
|
|
|
|
Move with the arrows. On a toggle, a choice or a slider, left and right change the value; <kbd>Enter</kbd> opens a text field or a list of choices, or a page marked `>`. Back leaves.
|
|
|
|
| Setting | What it is |
|
|
|---|---|
|
|
| **Long name**, **Short name** | The names you gave in the first-start Setup (up to 39 bytes, and up to 4 characters) |
|
|
| **Region** | The regulatory region; EU868 |
|
|
| **Timezone** | For the clock and the dates in file names |
|
|
| **Brightness** | A slider |
|
|
| **Dim after**, **Screen off after** | Screen timeouts. Dimming must come before the screen turns off |
|
|
| **Sound & LED** | The beep and the flash on a [Toast](/guide/basics/) |
|
|
| **GNSS** | Switches the receiver on and off (see [GNSS](/guide/gnss/)) |
|
|
| **Pause GNSS for LoRa** | Puts the receiver on standby while the radio listens (see [LoRa Scanner](/guide/lora-scanner/)) |
|
|
| **Coordinates** | Decimal degrees, or degrees, minutes and seconds |
|
|
| **Wi-Fi** | The page below |
|
|
| **Check for updates** | Once a day, see [Updates](/guide/updates/) |
|
|
| **Firmware** | The page described in [Updates](/guide/updates/) |
|
|
| **Debug Console** | Off unless you switch it on. It lets a PC on the same network read the device's console and drive it, with a token shown on this page: see [the developer docs](/dev/debug/switch-it-on/). Leave it off if that means nothing to you |
|
|
| **About** | The firmware version, the node number, battery, memory, uptime, clock and licence |
|
|
|
|
## Wi-Fi
|
|
|
|
**Wi-Fi** on its own page switches the radio on and off. The page also has:
|
|
|
|
- **Status:** whether it is searching, joining, or connected, and to what.
|
|
- **Add a network:** scans, lets you pick one, and asks for the password (leave it empty for an open network). **Add a hidden network** asks for the name first.
|
|
- **DNS and NTP:** see below.
|
|
- **Your saved networks.** The device joins one on its own whenever it is in range, the strongest first. <kbd>Enter</kbd> on a network opens its page.
|
|
|
|
### An address by hand
|
|
|
|
A network normally gives the device its address by itself (DHCP, **Automatic**). On a network without DHCP, open its page and set **IP address** to **Fixed**: then it takes an **address**, a **prefix** (24 is 255.255.255.0) and an optional **gateway**. Switching to Fixed starts from what the network is giving the device at that moment, and the setting is checked and applied when you leave the page. IPv4 only. **Forget this network** is on the same page.
|
|
|
|
### DNS and NTP
|
|
|
|
Two DNS servers (9.9.9.9 and 1.1.1.1 by default), used on Fixed networks, or on every network if **Always use my DNS** is on; and two NTP servers (pool.ntp.org and time.cloudflare.com), used after any that the network's DHCP offers. <kbd>Enter</kbd> on **Status** shows what is in use and where each value came from.
|
|
|
|
## The keys, as the device lists them
|
|
|
|
What <kbd>Fn</kbd> + <kbd>h</kbd> shows on these screens. These tables are generated from the firmware's own lists, so they are always the current ones.
|
|
|
|
{{ keys(scopes=["settings", "settings-choice", "wifi", "wifi-servers", "wifi-network", "wifi-status", "wifi-scan", "wifi-name", "debug-console"]) }}
|