download stack binaries on demand

Author: AlCalzone

.github/workflows/run-zwave-wsl.yml

@@ -15,12 +15,6 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v4
 
-    - name: Extract CTT setup files
-      shell: powershell
-      run: |
-        Write-Host "Extracting CTT setup archive..."
-        .\setup\extract-setup-archive.ps1
-
     - name: Setup Node.js
       uses: actions/setup-node@v4
       with:
@@ -41,10 +35,21 @@ jobs:
         sudo apt-get update
         sudo apt-get install -y libc6:i386 libstdc++6:i386
 
+    - name: Download Z-Wave stack binaries
+      env:
+        GH_TOKEN: ${{ secrets.ZW_STACK_TOKEN }}
+      run: npm run setup
+
     - name: Make Z-Wave binaries executable
       shell: wsl-bash {0}
       run: chmod +x zwave_stack/bin/*.elf
 
+    - name: Extract CTT setup files
+      shell: powershell
+      run: |
+        Write-Host "Extracting CTT setup archive..."
+        .\setup\extract-setup-archive.ps1
+
     - name: Copy Z-Wave storage to WSL native filesystem
       shell: wsl-bash {0}
       run: |

.gitignore

@@ -7,4 +7,7 @@ ctt/project/Log
 # Directories extracted from setup.zip on CI
 zwave_stack/storage/
 zwave-js/storage/
-zwave-js/log/
+zwave-js/log/
+
+# Z-Wave stack binaries (downloaded via setup script)
+zwave_stack/bin/*.elf

package.json

@@ -9,7 +9,8 @@
     "start": "node --experimental-transform-types src/start.ts",
     "devices": "node --experimental-transform-types src/start.ts --devices-only",
     "ctt": "ctt/bin/CTT-Remote.exe ctt/project/zwave-js.cttsln",
-    "create-setup-archive": "powershell -ExecutionPolicy Bypass -File setup/create-setup-archive.ps1"
+    "create-setup-archive": "powershell -ExecutionPolicy Bypass -File setup/create-setup-archive.ps1",
+    "setup": "node --experimental-transform-types setup/download-zwave-stack.ts"
   },
   "keywords": [],
   "author": "",

setup/download-zwave-stack.ts

@@ -0,0 +1,57 @@
+import { execSync } from "node:child_process";
+import { copyFileSync, mkdtempSync, readdirSync, rmSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+
+const REPO = "Z-Wave-Alliance/z-wave-stack-binaries";
+const OUTPUT_DIR = "zwave_stack/bin";
+
+const BINARIES = [
+	{
+		pattern: /^ZW_zwave_ncp_serial_api_controller_.*_REALTIME_DEBUG\.elf$/,
+		output: "ZW_zwave_ncp_serial_api_controller.elf",
+	},
+	{
+		pattern: /^ZW_zwave_ncp_serial_api_end_device_.*_REALTIME_DEBUG\.elf$/,
+		output: "ZW_zwave_ncp_serial_api_end_device.elf",
+	},
+];
+
+const tempDir = mkdtempSync(join(tmpdir(), "zwave-stack-"));
+
+try {
+	console.log("Downloading latest Z-Wave stack binaries...");
+	execSync(
+		`gh release download --repo ${REPO} --pattern "*Linux.tar.gz" -D "${tempDir}"`,
+		{ stdio: "inherit" },
+	);
+
+	const tarball = readdirSync(tempDir).find((f) => f.endsWith(".tar.gz"));
+	if (!tarball) {
+		throw new Error("No tarball found in downloaded files");
+	}
+
+	console.log(`Extracting ${tarball}...`);
+	execSync(`tar -xzf "${join(tempDir, tarball)}" -C "${tempDir}"`, {
+		stdio: "inherit",
+	});
+
+	const binDir = join(tempDir, "bin");
+	const files = readdirSync(binDir);
+
+	for (const { pattern, output } of BINARIES) {
+		const match = files.find((f) => pattern.test(f));
+		if (!match) {
+			throw new Error(`No file matching ${pattern} found`);
+		}
+
+		const src = join(binDir, match);
+		const dest = join(OUTPUT_DIR, output);
+		console.log(`Copying ${match} -> ${output}`);
+		copyFileSync(src, dest);
+	}
+
+	console.log("Done!");
+} finally {
+	rmSync(tempDir, { recursive: true, force: true });
+}

zwave_stack/bin/ZW_zwave_ncp_serial_api_controller_25_9_0_x86_REALTIME_DEBUG.elf

@@ -6,20 +6,20 @@ echo "Starting Z-Wave Stack..."
 
 # Start 3 controllers
 echo "Starting Controller 1 (Z-Wave JS) on port 5000..."
-./zwave_stack/bin/ZW_zwave_ncp_serial_api_controller_25_9_0_x86_REALTIME_DEBUG.elf --port 5000 --storage ./zwave_stack/storage/controller1 &
+./zwave_stack/bin/ZW_zwave_ncp_serial_api_controller.elf --port 5000 --storage ./zwave_stack/storage/controller1 &
 
 echo "Starting Controller 2 (CTT) on port 5001..."
-./zwave_stack/bin/ZW_zwave_ncp_serial_api_controller_25_9_0_x86_REALTIME_DEBUG.elf --port 5001 --storage ./zwave_stack/storage/controller2 &
+./zwave_stack/bin/ZW_zwave_ncp_serial_api_controller.elf --port 5001 --storage ./zwave_stack/storage/controller2 &
 
 echo "Starting Controller 3 (CTT) on port 5002..."
-./zwave_stack/bin/ZW_zwave_ncp_serial_api_controller_25_9_0_x86_REALTIME_DEBUG.elf --port 5002 --storage ./zwave_stack/storage/controller3 &
+./zwave_stack/bin/ZW_zwave_ncp_serial_api_controller.elf --port 5002 --storage ./zwave_stack/storage/controller3 &
 
 # Start 2 end devices
 echo "Starting End Device 1 on port 5003..."
-./zwave_stack/bin/ZW_zwave_ncp_serial_api_end_device_25_9_0_x86_REALTIME_DEBUG.elf --port 5003 --storage ./zwave_stack/storage/enddevice1 &
+./zwave_stack/bin/ZW_zwave_ncp_serial_api_end_device.elf --port 5003 --storage ./zwave_stack/storage/enddevice1 &
 
 echo "Starting End Device 2 on port 5004..."
-./zwave_stack/bin/ZW_zwave_ncp_serial_api_end_device_25_9_0_x86_REALTIME_DEBUG.elf --port 5004 --storage ./zwave_stack/storage/enddevice2 &
+./zwave_stack/bin/ZW_zwave_ncp_serial_api_end_device.elf --port 5004 --storage ./zwave_stack/storage/enddevice2 &
 
 # Start the Zniffer simulator
 echo "Starting Zniffer on port 4905..."