Add optional chip-family filter to firmware picker

This commit is contained in:
mikecarper committed 2026-09-06 11:38:13 -07:00
1 parent b781b3df89
commit 840458c0e6
4 files changed
+114 -4

No files matched your search

+63 -3
View File
@@ -11,6 +11,7 @@
]);
const FILTER_FIELDS = Object.freeze([
"chipFamily",
"hardwareFamily",
"hardware",
"role",
@@ -23,6 +24,14 @@
const FACET_FIELDS = Object.freeze(FILTER_FIELDS.concat(["install"]));
const CHIP_FAMILY_LABELS = Object.freeze({
esp32: "ESP32",
nrf52: "nRF52",
rp2040: "RP2040",
stm32: "STM32",
unknown: "Other / unspecified",
});
const ROLE_LABELS = Object.freeze({
companion: "Companion",
repeater: "Repeater",
@@ -701,6 +710,27 @@
);
});
// Use release-bound platform metadata, never a filename extension (UF2
// is used by both nRF52 and RP2040). Legacy images may inherit the chip
// family, but no runtime capabilities, from the same exact hardware.
profiles.forEach(function (profile) {
const platform = profile.controls && profile.controls.platform;
profile.chipFamily = platform
? platform.replace(/_PLATFORM$/, "").toLowerCase() : "";
});
const knownChips = new Map();
profiles.forEach(function (profile) {
if (!profile.chipFamily) return;
if (!knownChips.has(profile.hardware)) knownChips.set(profile.hardware, new Set());
knownChips.get(profile.hardware).add(profile.chipFamily);
});
profiles.forEach(function (profile) {
const chips = knownChips.get(profile.hardware);
if (!profile.chipFamily) {
profile.chipFamily = chips && chips.size === 1 ? Array.from(chips)[0] : "unknown";
}
});
return {
releaseSet: releaseSet,
rows: firmwareRows,
@@ -807,6 +837,7 @@
}
function labelFor(field, value) {
if (field === "chipFamily") return CHIP_FAMILY_LABELS[value] || value;
if (field === "hardwareFamily") return humanizeHardware(value);
if (field === "hardware") return humanizeHardware(value);
if (field === "role") return ROLE_LABELS[value] || value;
@@ -1209,6 +1240,7 @@
});
let catalog = { releaseSet: null, rows: [], profiles: [] };
const filters = {};
let automaticChipFamily = false;
const groupPrefix = "firmware-picker-" + (++pickerInstanceCount);
function matchingProfiles(ignoredField) {
@@ -1220,6 +1252,7 @@
function setSelectOptions(select, field, values, selected) {
select.replaceChildren();
const placeholders = {
chipFamily: "Any chip family — skip this filter",
hardwareFamily: "Any hardware",
hardware: "Choose a hardware variant",
mode: "Any connection / mode",
@@ -1279,11 +1312,16 @@
}
function valuesForField(field) {
const ignored = field === "chipFamily" ? ["hardwareFamily", "hardware"]
: field === "hardwareFamily" ? ["hardware"] : [];
if (automaticChipFamily && (field === "hardwareFamily" || field === "hardware")) {
ignored.push("chipFamily");
}
return facetValues(
catalog.profiles,
filters,
field,
field === "hardwareFamily" ? ["hardware"] : []
ignored
);
}
@@ -1315,7 +1353,12 @@
}
function refreshFacets() {
if (automaticChipFamily) filters.chipFamily = "";
stabilizeFilters();
if (automaticChipFamily && filters.hardwareFamily) {
const chips = uniqueValues(matchingProfiles("chipFamily"), "chipFamily");
filters.chipFamily = chips.length === 1 ? chips[0] : "";
}
FACET_FIELDS.forEach(function (field) {
setControlOptions(field, valuesForField(field));
});
@@ -1325,6 +1368,9 @@
);
hardwareVariantControl.hidden = !filters.hardwareFamily ||
hardwareVariants.length <= 1;
const chipSummary = root.querySelector('[data-role="chip-family-summary"]');
if (chipSummary) chipSummary.textContent = "Optional: chip family" +
(filters.chipFamily ? " — " + labelFor("chipFamily", filters.chipFamily) : "");
render();
}
@@ -1333,12 +1379,12 @@
missing.hidden = true;
resultList.replaceChildren();
const missingFields = FACET_FIELDS.filter(function (field) {
return !filters[field];
return field !== "chipFamily" && !filters[field];
});
const matches = matchingProfiles();
if (missingFields.length) {
if (missingFields.length === FACET_FIELDS.length) {
if (missingFields.length === FACET_FIELDS.length - 1 && !filters.chipFamily) {
status.textContent = "Pick options in any order. " +
matches.length + " compatible configurations are available.";
} else {
@@ -1437,6 +1483,19 @@
const target = event.target;
const field = target.dataset.choiceField || target.dataset.field;
if (!FACET_FIELDS.includes(field)) return;
if (field === "chipFamily") {
automaticChipFamily = false;
// A deliberate family switch takes precedence over an old board.
if (target.value && !matchingProfiles("chipFamily").some(function (profile) {
return profile.chipFamily === target.value;
})) {
filters.hardwareFamily = "";
filters.hardware = "";
}
}
if (field === "hardwareFamily" || field === "hardware") {
automaticChipFamily = true;
}
if (field === "hardwareFamily") filters.hardware = "";
filters[field] = target.value;
refreshFacets();
@@ -1444,6 +1503,7 @@
form.addEventListener("reset", function (event) {
event.preventDefault();
if (!catalog.profiles.length) return;
automaticChipFamily = false;
FACET_FIELDS.forEach(function (field) {
filters[field] = "";
});
+14
View File
@@ -43,6 +43,20 @@
color: var(--md-default-fg-color--light);
}
.firmware-picker-chip-family {
border-bottom: 1px solid var(--picker-border);
padding-bottom: 0.75rem;
}
.firmware-picker-chip-family summary {
cursor: pointer;
font-weight: 600;
}
.firmware-picker-chip-family p {
color: var(--md-default-fg-color--light);
}
.firmware-picker-control {
min-width: 0;
margin: 0;
+14 -1
View File
@@ -10,6 +10,8 @@ default ASCII terminal on Full Companion and infrastructure roles.
Pick the choices in any order. Every selection narrows all the other controls
to firmware combinations that were actually built in the current release set.
The optional chip-family filter (ESP32, nRF52, RP2040, or STM32) can narrow the
hardware list first. You can skip it: picking hardware fills it in automatically.
The picker reads public release metadata from GitHub. It does not upload device
information. Hardware names, target names, and download links come directly
@@ -22,7 +24,7 @@ from the published firmware assets.
<p>
For a new installation, choose the exact board and role, prefer a
<strong>FULL / complete profile</strong> when it is available, and select
<strong>Erase &amp; fresh install (merged .bin)</strong>. Narrower profiles
<strong>Full install / layout migration (merged .bin)</strong>. Narrower profiles
remain available when their reduced transport or feature set is intentional.
</p>
</div>
@@ -33,6 +35,17 @@ from the published firmware assets.
</p>
<form class="firmware-picker-form" data-role="form">
<details class="firmware-picker-chip-family firmware-picker-wide">
<summary data-role="chip-family-summary">Optional: chip family</summary>
<p id="firmware-picker-chip-help">Skip this if you know your board. Picking hardware selects its chip family automatically. Choose Any to clear this filter.</p>
<div class="firmware-picker-control firmware-picker-select-control">
<label for="firmware-picker-chip-family">Chip family</label>
<select id="firmware-picker-chip-family" data-field="chipFamily" aria-describedby="firmware-picker-chip-help" disabled>
<option value="">Any chip family — skip this filter</option>
</select>
</div>
</details>
<div class="firmware-picker-control firmware-picker-select-control">
<label for="firmware-picker-hardware-family">Hardware</label>
<select id="firmware-picker-hardware-family" data-field="hardwareFamily" disabled>
+23
View File
@@ -726,6 +726,7 @@ assert.deepStrictEqual(
assert.deepStrictEqual(
picker.FACET_FIELDS,
[
"chipFamily",
"hardwareFamily",
"hardware",
"role",
@@ -913,3 +914,25 @@ const stale = picker.buildCatalog(controlledReleases, {...controls, familyTag: '
assert(stale.profiles.every(p => !p.controls));
assert(!picker.runtimeDirections({...mqttCompanion, controls: undefined}, {}).some(s => s.title === 'GPS'));
console.log('role-specific runtime directions tests passed');
assert.strictEqual(nrf.chipFamily, 'nrf52');
assert.strictEqual(mqttCompanion.chipFamily, 'esp32');
assert.deepStrictEqual(picker.facetValues(controlled.profiles, {chipFamily: 'nrf52'}, 'hardwareFamily'), ['RAK_4631']);
assert(stale.profiles.every(p => p.chipFamily === 'unknown'));
const chipReleases = [release(family, '2026-09-01T00:00:00Z', [
asset('pico_repeater-' + family + '.uf2'),
asset('pico_room_server-' + family + '.uf2'),
asset('wio-e5-repeater-' + family + '.hex'),
asset('unlisted_repeater-' + family + '.uf2'),
])];
const chipCatalog = picker.buildCatalog(chipReleases, {familyTag: family, profiles: {
pico_repeater: {platform: 'RP2040_PLATFORM'},
'wio-e5-repeater': {platform: 'STM32_PLATFORM'},
}});
assert.deepStrictEqual(picker.uniqueValues(chipCatalog.profiles, 'chipFamily').sort(), ['rp2040', 'stm32', 'unknown']);
const sibling = chipCatalog.profiles.find(p => p.target === 'pico_room_server');
assert.strictEqual(sibling.chipFamily, 'rp2040');
assert.strictEqual(sibling.controls, undefined, 'Chip inheritance must not invent runtime controls');
assert.strictEqual(chipCatalog.profiles.find(p => p.target === 'unlisted_repeater').chipFamily, 'unknown', 'UF2 does not identify a chip family');
console.log('chip-family filtering tests passed');