Files
MeshCore/docs/firmware_picker.md
T

6.6 KiB

Firmware picker

Choose the exact hardware first. The remaining menus then show only firmware roles and features that were actually built for that hardware in the current release set.

The picker reads public release metadata from GitHub. It does not upload device information. Hardware names, target names, and download links come directly from the published firmware assets.

Current release set

Loading release information...

For a new installation, choose the exact board and role, prefer a FULL / complete profile when it is available, and select USB first install / recovery. Narrower profiles remain available when their reduced transport or feature set is intentional.

1. Hardware Loading hardware...
<label>
  2. Firmware role
  <select data-field="role" disabled>
    <option value="">Choose hardware first</option>
  </select>
</label>

<label>
  3. Logging / MQTT
  <select data-field="logging" disabled>
    <option value="">Choose role first</option>
  </select>
</label>

<label>
  4. OTA capability
  <select data-field="ota" disabled>
    <option value="">Choose earlier options first</option>
  </select>
</label>

<label>
  5. Connection / bridge mode
  <select data-field="mode" disabled>
    <option value="">Choose earlier options first</option>
  </select>
</label>

<label>
  6. Feature profile
  <select data-field="feature" disabled>
    <option value="">Choose earlier options first</option>
  </select>
</label>

<label>
  7. Hardware/profile variant
  <select data-field="variant" disabled>
    <option value="">Choose earlier options first</option>
  </select>
</label>

<label>
  8. Installation method
  <select data-field="install" disabled>
    <option value="">Choose firmware options first</option>
  </select>
</label>
Loading the current firmware catalog...

Exact firmware match

No exact firmware matched

Browse all firmware releases
Advanced: search current release filenames

Use this for uncommon board suffixes or expert recovery. A filename match is not a board-identity check.

Filename contains

What the choices mean

Choice Use
Companion A phone, computer, or host application controls the radio
Repeater Standalone mesh relay
Room Server Hosts room conversations and history
Sensor / telemetry Publishes supported sensor data
Terminal Chat Standalone serial-terminal interface
USB logging / USB-connected MQTT Node remains attached to a computer over a data-capable USB cable
Wi-Fi MQTT observer Firmware connects directly to MQTT over Wi-Fi; this is not USB logging
No logging Normal standalone operation without the dedicated logging/MQTT profile
LoRa OTA receiver Repeater profile that can stage an exact matching update received over LoRa
LoRa OTA source Full Companion serving a host-supplied update to another node
OTA-enabled profile Build uses an OTA-capable application/partition profile, but is not necessarily an explicit LoRa receiver

Connection and bridge choices depend on the selected role. Companion firmware may offer Full, Bluetooth, USB, Wi-Fi, serial, or Ethernet transports. Repeaters may offer standard, ESP-NOW bridge, RS-232 bridge, Ethernet, or MQTT observer modes.

FULL versus standard

For a new installation, use the FULL / complete profile when it exists and the board has enough flash. FULL profiles keep the complete supported feature set and CLI. Standard profiles remain useful for boards without a FULL build, for an intentionally narrower transport, or when retaining an existing compatible partition layout.

Changing between standard and FULL ESP32 layouts requires the exact-board merged image over USB. A running application cannot safely move its own active and inactive partitions.

Installation methods

File Use
-merged.bin ESP32 first install, recovery, role migration, or partition-profile change over USB
Non-merged .bin Same-board, same-role, same-partition application update
.zip Native nRF52 Serial DFU package; it is not an extra archive
.uf2 UF2 bootloader drag-and-drop installation
.hex Full wired programmer or recovery flash

Never send a merged ESP32 image through browser OTA or LoRa OTA. Back up the node configuration and verify every filename suffix before flashing.

LoRa OTA and OTAFIX

An OTA receiver build installs the receiving/staging firmware. A later LoRa update still needs an exact target identity, compatible partition signature, matching radio settings, and the correct update package.

nRF52 LoRa OTA requires an OTAFIX bootloader built for the exact board. There is no universal bootloader file. Use the latest stable OTAFIX release and select the hardware-matched HEX, Serial DFU ZIP, or bootloader-update UF2.

Hardware and variant names

The hardware menu preserves meaningful board suffixes such as display type, radio chip, PA/FEM layout, pin map, and external-flash variant. Later menus expose build variants such as FEM on/off, power saving, serial port, or no-external-sensors when those choices exist. Do not substitute a similarly named target.