Adds initial support for the x3 device

src/app/page.tsx

@@ -10,7 +10,10 @@
   Alert,
   Stack,
   Flex,
+  HStack,
+  Text,
 } from '@chakra-ui/react';
+import type { DeviceModel } from '@/esp/useEspOperations';
 import FileUpload, { FileUploadHandle } from '@/components/FileUpload';
 import Steps from '@/components/Steps';
 import { useEspOperations } from '@/esp/useEspOperations';
@@ -20,7 +23,8 @@
 } from '@/remote/firmwareFetcher';
 
 export default function Home() {
-  const { actions, stepData, isRunning } = useEspOperations();
+  const { actions, stepData, isRunning, deviceModel, setDeviceModel } =
+    useEspOperations();
   const [officialFirmwareVersions, setOfficialFirmwareVersions] = useState<{
     en: string;
     ch: string;
@@ -32,15 +36,42 @@
   const appPartitionFileInput = useRef<FileUploadHandle>(null);
 
   useEffect(() => {
-    getOfficialFirmwareVersions().then((versions) =>
-      setOfficialFirmwareVersions(versions),
-    );
+    let cancelled = false;
+    setOfficialFirmwareVersions(null);
+    getOfficialFirmwareVersions(deviceModel).then((versions) => {
+      if (!cancelled) {
+        setOfficialFirmwareVersions(versions);
+      }
+    });
 
+    return () => {
+      cancelled = true;
+    };
+  }, [deviceModel]);
+
+  useEffect(() => {
     getCommunityFirmwareRemoteData().then(setCommunityFirmwareVersions);
   }, []);
 
   return (
     <Flex direction="column" gap="20px">
+      <Stack gap={3} as="section">
+        <Heading size="xl">Device model</Heading>
+        <HStack gap={3}>
+          {(['x4', 'x3'] as const).map((model) => (
+            <Button
+              key={model}
+              variant={deviceModel === model ? 'solid' : 'outline'}
+              aria-pressed={deviceModel === model}
+              onClick={() => setDeviceModel(model)}
+              disabled={isRunning}
+            >
+              Xteink {model.toUpperCase()}
+            </Button>
+          ))}
+        </HStack>
+      </Stack>
+      <Separator />
       <Alert.Root status="warning">
         <Alert.Indicator />
         <Alert.Content>
@@ -208,8 +239,8 @@
           <Alert.Title>Change device language</Alert.Title>
           <Alert.Description>
             Before starting the process, it is recommended to change the device
-            language to English. To do this, select “Settings” icon, then click
-            “OK / Confirm” button and “OK / Confirm” again until English is
+            language to English. To do this, select &ldquo;Settings&rdquo; icon, then click
+            &ldquo;OK / Confirm&rdquo; button and &ldquo;OK / Confirm&rdquo; again until English is
             shown. Otherwise, the language will still be Chinese after flashing
             and you may not notice changes.
           </Alert.Description>
@@ -220,13 +251,23 @@
         <Alert.Content>
           <Alert.Title>Device restart instructions</Alert.Title>
           <Alert.Description>
-            Once you complete a write operation, you will need to restart your
-            device by pressing and releasing the small “Reset” button near the
-            bottom right, followed quickly by pressing and holding of the main
-            power button for about 3 seconds.
+            <Stack>
+              <p>
+                Once you complete a write operation, you will need to restart
+                your device by pressing and releasing the small &ldquo;Reset&rdquo; button
+                near the bottom right, followed quickly by pressing and holding
+                of the main power button for about 3 seconds.
+              </p>
+              {deviceModel === 'x3' && (
+                <p>
+                  For CrossPoint firmware, disconnect the USB cable and connect
+                  it again instead.
+                </p>
+              )}
+            </Stack>
           </Alert.Description>
         </Alert.Content>
       </Alert.Root>
     </Flex>
   );
-}
+}

src/esp/EspController.ts

@@ -41,6 +41,24 @@
   },
 };
 
+export interface PartitionLayout {
+  app0Offset: number;
+  app1Offset: number;
+  appSize: number;
+}
+
+export const X4_PARTITION_LAYOUT: PartitionLayout = {
+  app0Offset: 0x10000,
+  app1Offset: 0x650000,
+  appSize: 0x640000,
+};
+
+export const X3_PARTITION_LAYOUT: PartitionLayout = {
+  app0Offset: 0x10000,
+  app1Offset: 0x780000,
+  appSize: 0x770000,
+};
+
 export default class EspController {
   static async requestDevice() {
     if (!('serial' in navigator && navigator.serial)) {
@@ -54,15 +72,19 @@
     });
   }
 
-  static async fromRequestedDevice() {
+  static async fromRequestedDevice(
+    partitionLayout: PartitionLayout = X4_PARTITION_LAYOUT,
+  ) {
     const device = await this.requestDevice();
-    return new EspController(device);
+    return new EspController(device, partitionLayout);
   }
 
   private espLoader;
+  private layout: PartitionLayout;
 
-  constructor(device: SerialPort) {
+  constructor(device: SerialPort, partitionLayout: PartitionLayout = X4_PARTITION_LAYOUT) {
     const transport = new Transport(device, false);
+    this.layout = partitionLayout;
     this.espLoader = new ESPLoader({
       transport,
       baudrate: 115200,
@@ -71,12 +93,16 @@
     });
   }
 
+  setPartitionLayout(layout: PartitionLayout) {
+    this.layout = layout;
+  }
+
   async connect() {
     await this.espLoader.main();
   }
 
   async disconnect({ skipReset = false }: { skipReset?: boolean } = {}) {
-    await this.espLoader.after(skipReset ? 'no_reset' : 'hard_reset');
+    await this.espLoader.after(skipReset ? 'no_reset_stub' : 'hard_reset');
     await this.espLoader.transport.disconnect();
   }
 
@@ -180,8 +206,11 @@
       totalSize: number,
     ) => void,
   ) {
-    const offset = partitionLabel === 'app0' ? 0x10000 : 0x650000;
-    return this.espLoader.readFlash(offset, 0x640000, onPacketReceived);
+    const offset =
+      partitionLabel === 'app0'
+        ? this.layout.app0Offset
+        : this.layout.app1Offset;
+    return this.espLoader.readFlash(offset, this.layout.appSize, onPacketReceived);
   }
 
   async readAppPartitionForIdentification(
@@ -206,7 +235,10 @@
     // In testing, most firmwares are identified within the first 25KB read, so reading the entire
     // partition is unnecessary in the majority of cases.
 
-    const baseOffset = partitionLabel === 'app0' ? 0x10000 : 0x650000;
+    const baseOffset =
+      partitionLabel === 'app0'
+        ? this.layout.app0Offset
+        : this.layout.app1Offset;
 
     return this.espLoader.readFlash(
       baseOffset + offset,
@@ -224,16 +256,21 @@
       total: number,
     ) => void,
   ) {
-    if (data.length > 0x640000) {
-      throw new Error(`Data cannot be larger than 0x640000`);
+    if (data.length > this.layout.appSize) {
+      throw new Error(
+        `Data cannot be larger than 0x${this.layout.appSize.toString(16)}`,
+      );
     }
     if (data.length < 0xf0000) {
       throw new Error(
         `Data seems too small, are you sure this is the right file?`,
       );
     }
 
-    const offset = partitionLabel === 'app0' ? 0x10000 : 0x650000;
+    const offset =
+      partitionLabel === 'app0'
+        ? this.layout.app0Offset
+        : this.layout.app1Offset;
 
     await this.writeData(data, offset, reportProgress);
   }