2 |
3 | # QUICKSILVER Configurator
4 |
5 | Configurator for the [QUICKSILVER Flight Controller Firmware](https://github.com/BossHobby/QUICKSILVER).
6 | A web version is available at [config.bosshobby.com](https://config.bosshobby.com).
7 | Standalone versions can be found in the [github releases](https://github.com/BossHobby/Configurator/releases).
8 | The Web version might or might not work with an Android device and an OTG cable.
9 |
10 | ## Building
11 |
12 | ```
13 | npm install
14 | npm run serve # run in a local browser
15 | npm run start # run in nwjs
16 | ```
17 |
18 | ## Contributing
19 |
20 | Contributions are welcome and encouraged.
21 |
--------------------------------------------------------------------------------
/electron-builder.yml:
--------------------------------------------------------------------------------
1 | appId: com.bosshobby.config
2 | productName: quic-config
3 | directories:
4 | output: build
5 | buildResources: public
6 | files:
7 | - "out/**/*"
8 | - package-lock.json
9 | - package.json
10 | - README.md
11 | win:
12 | target: portable
13 | artifactName: ${name}-${version}.${ext}
14 | dmg:
15 | artifactName: ${name}-${version}.${ext}
16 | linux:
17 | target:
18 | - AppImage
19 | artifactName: ${name}-${version}.${ext}
20 |
--------------------------------------------------------------------------------
/electron.vite.config.ts:
--------------------------------------------------------------------------------
1 | import { resolve } from "path";
2 | import { defineConfig } from "electron-vite";
3 | import VueConfig from "./vite.config";
4 |
5 | export default defineConfig({
6 | main: {
7 | build: {
8 | rollupOptions: {
9 | input: {
10 | index: resolve(__dirname, "electron/main/index.ts"),
11 | },
12 | },
13 | },
14 | },
15 | preload: {
16 | build: {
17 | rollupOptions: {
18 | input: {
19 | index: resolve(__dirname, "electron/preload/index.ts"),
20 | },
21 | },
22 | },
23 | },
24 | renderer: {
25 | root: ".",
26 | build: {
27 | rollupOptions: {
28 | input: {
29 | index: resolve(__dirname, "index.html"),
30 | },
31 | },
32 | },
33 | envPrefix: "VITE_",
34 | ...VueConfig,
35 | },
36 | });
37 |
--------------------------------------------------------------------------------
/electron/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/BossHobby/Configurator/912a3b92b528014d5bf068395880faf918c1b77d/electron/icon.png
--------------------------------------------------------------------------------
/electron/icon.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
--------------------------------------------------------------------------------
/electron/main/index.ts:
--------------------------------------------------------------------------------
1 | import { app, shell, BrowserWindow, ipcMain } from "electron";
2 | import { join } from "path";
3 | import { electronApp, optimizer, is } from "@electron-toolkit/utils";
4 |
5 | import icon from "../icon.png?asset";
6 |
7 | const USB_DEVICE_FILTER = [
8 | { vendorId: 0x0483, productId: 0xdf11 },
9 | { vendorId: 0x2e3c, productId: 0xdf11 },
10 | ];
11 |
12 | function createWindow(): void {
13 | // Create the browser window.
14 | const mainWindow = new BrowserWindow({
15 | width: 1280,
16 | height: 720,
17 | show: false,
18 | autoHideMenuBar: true,
19 | ...(process.platform === "linux" ? { icon } : {}),
20 | webPreferences: {
21 | preload: join(__dirname, "../preload/index.mjs"),
22 | sandbox: false,
23 | },
24 | });
25 |
26 | mainWindow.on("ready-to-show", () => {
27 | mainWindow.show();
28 | });
29 |
30 | mainWindow.webContents.setWindowOpenHandler((details) => {
31 | shell.openExternal(details.url);
32 | return { action: "deny" };
33 | });
34 |
35 | mainWindow.webContents.session.on(
36 | "select-serial-port",
37 | (event, portList, webContents, callback) => {
38 | event.preventDefault();
39 | mainWindow.webContents.send("select-serial", portList);
40 | ipcMain.once("serial", (_event, port) => {
41 | callback(port ? port : "");
42 | });
43 | },
44 | );
45 |
46 | mainWindow.webContents.session.on(
47 | "select-usb-device",
48 | (event, details, callback) => {
49 | event.preventDefault();
50 |
51 | const devices = details.deviceList.filter((d) => {
52 | return USB_DEVICE_FILTER.some(
53 | (f) => f.vendorId == d.vendorId && f.productId == d.productId,
54 | );
55 | });
56 |
57 | mainWindow.webContents.send("select-usb-device", devices);
58 | ipcMain.once("usb-device", (_event, dev) => {
59 | if (dev) {
60 | callback(dev);
61 | } else {
62 | callback();
63 | }
64 | });
65 | },
66 | );
67 |
68 | mainWindow.webContents.session.setPermissionCheckHandler(
69 | (webContents, permission, requestingOrigin, details) => {
70 | if (permission === "serial" || permission === "usb") {
71 | return true;
72 | }
73 |
74 | return false;
75 | },
76 | );
77 |
78 | mainWindow.webContents.session.setDevicePermissionHandler((details) => {
79 | if (details.deviceType === "serial" || details.deviceType === "usb") {
80 | return true;
81 | }
82 |
83 | return false;
84 | });
85 |
86 | // HMR for renderer base on electron-vite cli.
87 | // Load the remote URL for development or the local html file for production.
88 | if (is.dev && process.env["ELECTRON_RENDERER_URL"]) {
89 | mainWindow.loadURL(process.env["ELECTRON_RENDERER_URL"]);
90 | } else {
91 | mainWindow.loadFile(join(__dirname, "../renderer/index.html"));
92 | }
93 | }
94 |
95 | // This method will be called when Electron has finished
96 | // initialization and is ready to create browser windows.
97 | // Some APIs can only be used after this event occurs.
98 | app.whenReady().then(() => {
99 | // Set app user model id for windows
100 | electronApp.setAppUserModelId("com.electron");
101 |
102 | // Default open or close DevTools by F12 in development
103 | // and ignore CommandOrControl + R in production.
104 | // see https://github.com/alex8088/electron-toolkit/tree/master/packages/utils
105 | app.on("browser-window-created", (_, window) => {
106 | optimizer.watchWindowShortcuts(window);
107 | });
108 |
109 | createWindow();
110 |
111 | app.on("activate", function () {
112 | // On macOS it's common to re-create a window in the app when the
113 | // dock icon is clicked and there are no other windows open.
114 | if (BrowserWindow.getAllWindows().length === 0) createWindow();
115 | });
116 | });
117 |
118 | // Quit when all windows are closed, except on macOS. There, it's common
119 | // for applications and their menu bar to stay active until the user quits
120 | // explicitly with Cmd + Q.
121 | app.on("window-all-closed", () => {
122 | if (process.platform !== "darwin") {
123 | app.quit();
124 | }
125 | });
126 |
127 | // In this file you can include the rest of your app"s specific main process
128 | // code. You can also put them in separate files and require them here.
129 |
--------------------------------------------------------------------------------
/electron/preload/index.d.ts:
--------------------------------------------------------------------------------
1 | import { ElectronAPI } from "@electron-toolkit/preload";
2 |
3 | declare global {
4 | interface Window {
5 | electron: ElectronAPI;
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/electron/preload/index.ts:
--------------------------------------------------------------------------------
1 | import { contextBridge } from "electron";
2 | import { electronAPI } from "@electron-toolkit/preload";
3 |
4 | // Use `contextBridge` APIs to expose Electron APIs to
5 | // renderer only if context isolation is enabled, otherwise
6 | // just add to the DOM global.
7 | if (process.contextIsolated) {
8 | try {
9 | contextBridge.exposeInMainWorld("electron", electronAPI);
10 | } catch (error) {
11 | console.error(error);
12 | }
13 | } else {
14 | // @ts-ignore (define in dts)
15 | window.electron = electronAPI;
16 | }
17 |
--------------------------------------------------------------------------------
/env.d.ts:
--------------------------------------------------------------------------------
1 | import { ElectronAPI } from "@electron-toolkit/preload";
2 |
3 | ///
20 |
21 |
24 |
26 | 27 |
58 | {{ tmpl.desc }}
25 |26 | 27 |
28 |
57 |
29 |
33 |
34 |
35 |
56 |
36 |
55 |
37 |
45 |
38 |
43 |
44 | 46 | Please select an option! 47 |
48 |52 | {{ selectedValues[o.name]?.desc }} 53 |
54 |