Skip to content

Add support for smol receiver and tracker in serial console #1868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ImSapphire wants to merge 4 commits into
base: main
Choose a base branch
from
+248 −136
Open

Add support for smol receiver and tracker in serial console #1868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
19b373e
Add support for smol receiver and tracker in serial console
ImSapphire May 30, 2026
37ab072
Don't include SlimeNRF devices in serial auto selection by default
ImSapphire Jun 1, 2026
cb39705
Hide SlimeNRF devices from DIY firmware tool serial device list
ImSapphire Jun 1, 2026
20e9c04
Refresh serial console devices list every 3 seconds
ImSapphire Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions gui/public/i18n/en/translation.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,6 +790,12 @@ settings-serial-factory_reset-warning-cancel = Cancel
settings-serial-serial_select = Select a serial port
settings-serial-auto_dropdown_item = Auto
settings-serial-get_wifi_scan = Get WiFi Scan
settings-serial-enter_pairing = Enter Pairing
settings-serial-exit_pairing = Exit Pairing
settings-serial-calibrate = Calibrate
settings-serial-six_side_calibrate = 6-Side Calibrate
settings-serial-dfu = Enter DFU
settings-serial-meow = Meow!
settings-serial-file_type = Plain text
settings-serial-save_logs = Save To File
settings-serial-send_command = Send
Expand Down
15 changes: 10 additions & 5 deletions gui/src/components/firmware-tool/steps/FlashingMethodStep.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import {
NewSerialDeviceResponseT,
RpcMessage,
SerialDeviceT,
SerialDeviceType,
SerialDevicesRequestT,
SerialDevicesResponseT,
TrackerStatus,
Expand Down Expand Up @@ -78,10 +79,14 @@ function SerialDevicesList({
(res: SerialDevicesResponseT) => {
setDevices(
res.devices.reduce(
(curr, device) => ({
...curr,
[device?.port?.toString() ?? 'unknown']: device,
}),
(curr, device) => {
if (device?.type != SerialDeviceType.ESP_TRACKER) return curr;

return {
...curr,
[device?.port?.toString() ?? 'unknown']: device,
};
},
{}
)
);
Expand All @@ -92,7 +97,7 @@ function SerialDevicesList({
useRPCPacket(
RpcMessage.NewSerialDeviceResponse,
({ device }: NewSerialDeviceResponseT) => {
if (device?.port)
if (device?.port && device?.type === SerialDeviceType.ESP_TRACKER)
setDevices((old) => ({
...old,
[device?.port?.toString() ?? 'unknown']: device,
Expand Down
244 changes: 170 additions & 74 deletions gui/src/components/settings/pages/Serial.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
SerialUpdateResponseT,
SerialTrackerGetWifiScanRequestT,
SerialTrackerCustomCommandRequestT,
SerialDeviceType,
} from 'solarxr-protocol';
import { useWebsocketAPI } from '@/hooks/websocket-api';
import { Button } from '@/components/commons/Button';
Expand Down Expand Up @@ -41,7 +42,10 @@ export function Serial() {
const consoleRef = useRef<HTMLDivElement>(null);
const [consoleContent, setConsole] = useState('');

const [isSerialOpen, setSerialOpen] = useState(false);
const [openedSerialDevice, setOpenedSerialDevice] = useState<Omit<
SerialDeviceT,
'pack'
> | null>(null);
const [serialDevices, setSerialDevices] = useState<
Omit<SerialDeviceT, 'pack'>[]
>([]);
Expand Down Expand Up @@ -87,11 +91,16 @@ export function Serial() {
};

useEffect(() => {
sendRPCPacket(RpcMessage.SerialDevicesRequest, new SerialDevicesRequestT());
const typedState: { serialPort: string } = state as any;
if (typedState?.serialPort) {
reset({ port: typedState.serialPort });
}

sendRPCPacket(RpcMessage.SerialDevicesRequest, new SerialDevicesRequestT());
const interval = setInterval(() => {
sendRPCPacket(RpcMessage.SerialDevicesRequest, new SerialDevicesRequestT());
}, 3000);
return () => clearInterval(interval);
}, []);

useEffect(() => {
Expand All @@ -103,11 +112,8 @@ export function Serial() {
useRPCPacket(
RpcMessage.SerialUpdateResponse,
(data: SerialUpdateResponseT) => {
if (data.closed) {
setSerialOpen(false);
} else {
setSerialOpen(true);
}
if (data.device) setOpenedSerialDevice(data.device);
else if (data.closed) setOpenedSerialDevice(null);

if (data.log) {
setConsole((console) => console + data.log);
Expand All @@ -122,6 +128,7 @@ export function Serial() {
{
name: l10n.getString('settings-serial-auto_dropdown_item'),
port: 'Auto',
type: SerialDeviceType.ESP_TRACKER,
},
...(res.devices || []),
]);
Expand Down Expand Up @@ -161,7 +168,7 @@ export function Serial() {

useEffect(() => {
const id = setInterval(() => {
if (!isSerialOpen) {
if (openedSerialDevice === null) {
openSerial(port ?? defaultValues.port);
} else {
clearInterval(id);
Expand All @@ -171,14 +178,16 @@ export function Serial() {
return () => {
clearInterval(id);
};
}, [isSerialOpen]);
}, [openedSerialDevice]);

const reboot = () => {
sendRPCPacket(
RpcMessage.SerialTrackerRebootRequest,
new SerialTrackerRebootRequestT()
);
};

// ESP
const factoryReset = () => {
sendRPCPacket(
RpcMessage.SerialTrackerFactoryResetRequest,
Expand Down Expand Up @@ -209,6 +218,48 @@ export function Serial() {
setValue('customCommand', '');
};

// HID
const enterPairing = () => {
sendRPCPacket(
RpcMessage.SerialTrackerCustomCommandRequest,
new SerialTrackerCustomCommandRequestT('pair')
);
};
const dfu = () => {
sendRPCPacket(
RpcMessage.SerialTrackerCustomCommandRequest,
new SerialTrackerCustomCommandRequestT('dfu')
);
};
const meow = () => {
sendRPCPacket(
RpcMessage.SerialTrackerCustomCommandRequest,
new SerialTrackerCustomCommandRequestT('meow')
);
};

// HID receiver
const exitPairing = () => {
sendRPCPacket(
RpcMessage.SerialTrackerCustomCommandRequest,
new SerialTrackerCustomCommandRequestT('exit')
);
};

// HID tracker
const calibrate = () => {
sendRPCPacket(
RpcMessage.SerialTrackerCustomCommandRequest,
new SerialTrackerCustomCommandRequestT('calibrate')
);
};
const sixSideCalibrate = () => {
sendRPCPacket(
RpcMessage.SerialTrackerCustomCommandRequest,
new SerialTrackerCustomCommandRequestT('6-side')
);
};

const consoleContentRef = useRef(consoleContent);
useLayoutEffect(() => {
consoleContentRef.current = consoleContent;
Expand Down Expand Up @@ -318,78 +369,123 @@ export function Serial() {
>
<div className="flex select-text">
<pre>
{isSerialOpen
{openedSerialDevice !== null
? consoleContent
: l10n.getString('settings-serial-connection_lost')}
</pre>
</div>
</div>
<div className="border-t-2 pt-2 border-background-60 border-solid gap-2 flex flex-row">
<div className="xs:flex flex-grow xs:flex-wrap gap-2 grid grid-cols-2">
<Button variant="quaternary" onClick={reboot}>
{l10n.getString('settings-serial-reboot')}
</Button>
<Button
variant="quaternary"
onClick={() => setTryFactoryReset(true)}
>
{l10n.getString('settings-serial-factory_reset')}
</Button>
<Button variant="quaternary" onClick={getWifiScan}>
{l10n.getString('settings-serial-get_wifi_scan')}
</Button>
<Button
variant="quaternary"
onClick={saveLogToFile}
disabled={!isSerialOpen || !consoleContent.trim()}
>
{l10n.getString('settings-serial-save_logs')}
</Button>
<div className="ml-auto">
<Button
variant="quaternary"
onClick={pauseScroll}
icon={
isPaused ? (
<PlayIcon width={16} />
) : (
<PauseIcon width={16} />
)
}
/>
</div>
<form
className="w-full flex flex-row gap-2 mobile:col-span-2"
onSubmit={(e) => {
if (!isSerialOpen) {
return;
}
e.preventDefault();
if (!acceptedCustomCommandWarning) {
setTrySendCustomCommand(true);
} else {
sendCustomSerialCommand();
}
}}
>
<div className="flex-grow">
<Input
control={control}
name="customCommand"
className="flex-grow"
placeholder={l10n.getString(
'settings-serial-send_command-placeholder'
)}
/>
</div>
<Button
variant="quaternary"
disabled={!isSerialOpen}
type="submit"
>
{l10n.getString('settings-serial-send_command')}
</Button>
</form>
{openedSerialDevice !== null && (
<>
<Button variant="quaternary" onClick={reboot}>
{l10n.getString('settings-serial-reboot')}
</Button>
{openedSerialDevice?.type ===
SerialDeviceType.ESP_TRACKER && (
<>
<Button
variant="quaternary"
onClick={() => setTryFactoryReset(true)}
>
{l10n.getString('settings-serial-factory_reset')}
</Button>
<Button variant="quaternary" onClick={getWifiScan}>
{l10n.getString('settings-serial-get_wifi_scan')}
</Button>
</>
)}
{openedSerialDevice?.type !==
SerialDeviceType.ESP_TRACKER && (
<Button variant="quaternary" onClick={enterPairing}>
{l10n.getString('settings-serial-enter_pairing')}
</Button>
)}
{openedSerialDevice?.type ===
SerialDeviceType.HID_RECEIVER && (
<Button variant="quaternary" onClick={exitPairing}>
{l10n.getString('settings-serial-exit_pairing')}
</Button>
)}
{openedSerialDevice?.type ===
SerialDeviceType.HID_TRACKER && (
<>
<Button variant="quaternary" onClick={calibrate}>
{l10n.getString('settings-serial-calibrate')}
</Button>
<Button variant="quaternary" onClick={sixSideCalibrate}>
{l10n.getString('settings-serial-six_side_calibrate')}
</Button>
</>
)}
{openedSerialDevice?.type !==
SerialDeviceType.ESP_TRACKER && (
<>
<Button variant="quaternary" onClick={dfu}>
{l10n.getString('settings-serial-dfu')}
</Button>
<Button variant="quaternary" onClick={meow}>
{l10n.getString('settings-serial-meow')}
</Button>
</>
)}
<Button
variant="quaternary"
onClick={saveLogToFile}
disabled={
openedSerialDevice === null || !consoleContent.trim()
}
>
{l10n.getString('settings-serial-save_logs')}
</Button>
<div className="ml-auto">
<Button
variant="quaternary"
onClick={pauseScroll}
icon={
isPaused ? (
<PlayIcon width={16} />
) : (
<PauseIcon width={16} />
)
}
/>
</div>
<form
className="w-full flex flex-row gap-2 mobile:col-span-2"
onSubmit={(e) => {
if (openedSerialDevice === null) {
return;
}
e.preventDefault();
if (!acceptedCustomCommandWarning) {
setTrySendCustomCommand(true);
} else {
sendCustomSerialCommand();
}
}}
>
<div className="flex-grow">
<Input
control={control}
name="customCommand"
className="flex-grow"
placeholder={l10n.getString(
'settings-serial-send_command-placeholder'
)}
/>
</div>
<Button
variant="quaternary"
disabled={openedSerialDevice === null}
type="submit"
>
{l10n.getString('settings-serial-send_command')}
</Button>
</form>
</>
)}

<div className="w-full mobile:col-span-2">
<Dropdown
Expand Down
Loading
Loading