Begin development of full DS Lite build

Author: jwbonner

CONTRIBUTING.md

@@ -62,6 +62,12 @@ export ASCOPE_DISTRIBUTION=WPILIB
 export ASCOPE_DISTRIBUTION=LITE
 ```
 
+- **Lite (Driver Station) Distribution:**
+
+```bash
+export ASCOPE_DISTRIBUTION=LITEDS
+```
+
 ## Available NPM Tasks
 
 The following tasks are defined in `package.json` to assist with development:

docs/docusaurus-embed.config.ts

@@ -7,7 +7,7 @@
 
 import config from "./docusaurus.config";
 
-const isLite = process.env.ASCOPE_DISTRIBUTION === "LITE";
+const isLite = process.env.ASCOPE_DISTRIBUTION === "LITE" || process.env.ASCOPE_DISTRIBUTION === "LITEDS";
 const configEmbed = Object.assign(config, {
   future: {
     experimental_router: "hash"

rollup.config.mjs

@@ -18,6 +18,7 @@ import replaceRegEx from "rollup-plugin-re";
 
 const isWpilib = process.env.ASCOPE_DISTRIBUTION === "WPILIB";
 const isLite = process.env.ASCOPE_DISTRIBUTION === "LITE";
+const isLiteDS = process.env.ASCOPE_DISTRIBUTION === "LITEDS";
 const licenseHeader =
   "// Copyright (c) 2021-2026 Littleton Robotics\n// http://github.com/Mechanical-Advantage\n//\n// Use of this source code is governed by a BSD\n// license that can be found in the LICENSE file\n// at the resources directory of this application.\n";
 
@@ -30,7 +31,7 @@ function bundle(input, output, isMain, isXRClient, external = []) {
   return {
     input: "src/" + input,
     output: {
-      file: (isLite ? "lite/static/" : "") + "bundles/" + output,
+      file: (isLite || isLiteDS ? "lite/static/" : "") + "bundles/" + output,
       format: isMain ? "cjs" : "es",
       banner: licenseHeader
     },
@@ -51,7 +52,7 @@ function bundle(input, output, isMain, isXRClient, external = []) {
             }),
             terser()
           ]
-        : isLite
+        : isLite || isLiteDS
         ? [
             getBabelOutputPlugin({
               presets: [["@babel/preset-env", { modules: false }]],
@@ -65,7 +66,7 @@ function bundle(input, output, isMain, isXRClient, external = []) {
       replace({
         preventAssignment: true,
         values: {
-          __distribution__: isWpilib ? "WPILib" : isLite ? "Lite" : "FRC6328",
+          __distribution__: isWpilib ? "WPILib" : isLite ? "Lite" : isLiteDS ? "LiteDS" : "FRC6328",
           __version__: packageJson.version,
           __build_date__: new Date().toLocaleString("en-US", {
             timeZone: "UTC",
@@ -108,56 +109,59 @@ function bundle(input, output, isMain, isXRClient, external = []) {
   };
 }
 
-const mainBundles = isLite
-  ? [bundle("main/lite/main.ts", "main.js", false, false)]
-  : [
-      bundle("main/electron/main.ts", "main.js", true, false, [
-        "electron",
-        "electron-fetch",
-        "fs",
-        "jsonfile",
-        "net",
-        "os",
-        "ws",
-        "http",
-        "path",
-        "basic-ftp",
-        "download",
-        "youtube-dl-exec",
-        "tesseract.js",
-        "lzma-native",
-        "@rev-robotics/revlog-converter"
-      ]),
-      bundle("preload.ts", "preload.js", true, false, ["electron"])
-    ];
+const mainBundles =
+  isLite || isLiteDS
+    ? [bundle("main/lite/main.ts", "main.js", false, false)]
+    : [
+        bundle("main/electron/main.ts", "main.js", true, false, [
+          "electron",
+          "electron-fetch",
+          "fs",
+          "jsonfile",
+          "net",
+          "os",
+          "ws",
+          "http",
+          "path",
+          "basic-ftp",
+          "download",
+          "youtube-dl-exec",
+          "tesseract.js",
+          "lzma-native",
+          "@rev-robotics/revlog-converter"
+        ]),
+        bundle("preload.ts", "preload.js", true, false, ["electron"])
+      ];
 const largeRendererBundles = [
   bundle("hub/hub.ts", "hub.js", false, false),
-  ...(isLite ? [] : [bundle("satellite.ts", "satellite.js", false, false)])
+  ...(isLite || isLiteDS ? [] : [bundle("satellite.ts", "satellite.js", false, false)])
 ];
 const smallRendererBundles = [
   bundle("editRange.ts", "editRange.js", false, false),
   bundle("unitConversion.ts", "unitConversion.js", false, false),
   bundle("renameTab.ts", "renameTab.js", false, false),
-  bundle("editFov.ts", "editFov.js", false, false),
+  ...(isLiteDS ? [] : [bundle("editFov.ts", "editFov.js", false, false)]),
   bundle("sourceListHelp.ts", "sourceListHelp.js", false, false),
   bundle("betaWelcome.ts", "betaWelcome.js", false, false),
-  bundle("preferences.ts", "preferences.js", false, false),
+  ...(isLiteDS ? [] : [bundle("preferences.ts", "preferences.js", false, false)]),
   bundle("licenses.ts", "licenses.js", false, false),
   bundle("download.ts", "download.js", false, false),
-  ...(isLite
+  ...(isLite || isLiteDS
     ? [bundle("uploadAsset.ts", "uploadAsset.js", false, false)]
     : [bundle("export.ts", "export.js", false, false)])
 ];
-const workerBundles = [
-  bundle("hub/dataSources/csv/csvWorker.ts", "hub$csvWorker.js", false, false),
-  bundle("hub/dataSources/rlog/rlogWorker.ts", "hub$rlogWorker.js", false, false),
-  bundle("hub/dataSources/roadrunnerlog/roadRunnerWorker.ts", "hub$roadRunnerWorker.js", false, false),
-  bundle("hub/dataSources/wpilog/wpilogWorker.ts", "hub$wpilogWorker.js", false, false),
-  bundle("hub/dataSources/dslog/dsLogWorker.ts", "hub$dsLogWorker.js", false, false),
-  ...(isLite ? [] : [bundle("hub/exportWorker.ts", "hub$exportWorker.js", false, false)]),
-  bundle("shared/renderers/field3d/workers/loadField.ts", "shared$loadField.js", false, false),
-  bundle("shared/renderers/field3d/workers/loadRobot.ts", "shared$loadRobot.js", false, false)
-];
+const workerBundles = isLiteDS
+  ? [bundle("hub/dataSources/wpilog/wpilogWorker.ts", "hub$wpilogWorker.js", false, false)]
+  : [
+      bundle("hub/dataSources/csv/csvWorker.ts", "hub$csvWorker.js", false, false),
+      bundle("hub/dataSources/rlog/rlogWorker.ts", "hub$rlogWorker.js", false, false),
+      bundle("hub/dataSources/roadrunnerlog/roadRunnerWorker.ts", "hub$roadRunnerWorker.js", false, false),
+      bundle("hub/dataSources/wpilog/wpilogWorker.ts", "hub$wpilogWorker.js", false, false),
+      bundle("hub/dataSources/dslog/dsLogWorker.ts", "hub$dsLogWorker.js", false, false),
+      ...(isLite ? [] : [bundle("hub/exportWorker.ts", "hub$exportWorker.js", false, false)]),
+      bundle("shared/renderers/field3d/workers/loadField.ts", "shared$loadField.js", false, false),
+      bundle("shared/renderers/field3d/workers/loadRobot.ts", "shared$loadRobot.js", false, false)
+    ];
 const xrBundles = [
   bundle("xrClient/xrClient.ts", "xrClient.js", false, true),
   bundle("xrControls.ts", "xrControls.js", false, false)
@@ -187,12 +191,12 @@ export default (cliArgs) => {
   if (cliArgs.configSmallRenderers === true) return smallRendererBundles;
   if (cliArgs.configWorkers === true) return workerBundles;
   if (cliArgs.configXR === true) {
-    if (isLite) process.exit();
+    if (isLite || isLiteDS) process.exit();
     return xrBundles;
   }
   if (cliArgs.configRunOwletDownload === true) return runOwletDownload;
 
-  return isLite
+  return isLite || isLiteDS
     ? [...mainBundles, ...largeRendererBundles, ...smallRendererBundles, ...workerBundles]
     : [...mainBundles, ...largeRendererBundles, ...smallRendererBundles, ...workerBundles, ...xrBundles];
 };

src/betaWelcome.ts

@@ -5,7 +5,7 @@
 // license that can be found in the LICENSE file
 // at the root directory of this project.
 
-import { Distribution, DISTRIBUTION } from "./shared/buildConstants";
+import { IS_LITE } from "./shared/buildConstants";
 
 const CHECKBOXES = Array.from(document.getElementsByTagName("input")) as HTMLInputElement[];
 const CONTINUE_BUTTON = document.getElementsByTagName("button")[0] as HTMLButtonElement;
@@ -43,9 +43,9 @@ window.addEventListener("message", (event) => {
 
 window.addEventListener("load", () => {
   Array.from(document.getElementsByClassName("desktop-only")).forEach((element) => {
-    (element as HTMLElement).hidden = DISTRIBUTION === Distribution.Lite;
+    (element as HTMLElement).hidden = IS_LITE;
   });
   Array.from(document.getElementsByClassName("lite-only")).forEach((element) => {
-    (element as HTMLElement).hidden = DISTRIBUTION !== Distribution.Lite;
+    (element as HTMLElement).hidden = !IS_LITE;
   });
 });

src/download.ts

@@ -5,7 +5,7 @@
 // license that can be found in the LICENSE file
 // at the root directory of this project.
 
-import { DISTRIBUTION, Distribution } from "./shared/buildConstants";
+import { IS_LITE } from "./shared/buildConstants";
 import { USB_ADDRESS } from "./shared/IPAddresses";
 import NamedMessage from "./shared/NamedMessage";
 import Preferences from "./shared/Preferences";
@@ -27,7 +27,7 @@ let messagePort: MessagePort | null = null;
 let platform: string = "";
 let preferences: Preferences | null = null;
 
-let address: string = DISTRIBUTION === Distribution.Lite ? window.location.hostname : "";
+let address: string = IS_LITE ? window.location.hostname : "";
 let loading = true;
 let startTime: number | null = null;
 let alertIsError = false;
@@ -63,7 +63,7 @@ function handleMainMessage(message: NamedMessage) {
       preferences = message.data;
       let path = "";
       if (preferences) {
-        if (DISTRIBUTION !== Distribution.Lite) {
+        if (!IS_LITE) {
           address = preferences.usb ? USB_ADDRESS : preferences.robotAddress;
           // https://github.com/Mechanical-Advantage/AdvantageScope/issues/167
           address = address
@@ -334,11 +334,7 @@ DOWNLOAD_BUTTON.addEventListener("click", save);
 window.addEventListener("keydown", (event) => {
   if (event.code === "Enter") {
     save();
-  } else if (
-    DISTRIBUTION !== Distribution.Lite &&
-    event.key === "a" &&
-    (platform === "darwin" ? event.metaKey : event.ctrlKey)
-  ) {
+  } else if (!IS_LITE && event.key === "a" && (platform === "darwin" ? event.metaKey : event.ctrlKey)) {
     if (filenames.length === selectedFiles.length) {
       // Deselect all
       selectedFiles = [];
@@ -357,6 +353,6 @@ window.addEventListener("keydown", (event) => {
   }
 });
 window.addEventListener("load", () => {
-  (DOWNLOAD_BUTTON.children[0] as HTMLElement).hidden = DISTRIBUTION === Distribution.Lite;
-  (DOWNLOAD_BUTTON.children[1] as HTMLElement).hidden = DISTRIBUTION !== Distribution.Lite;
+  (DOWNLOAD_BUTTON.children[0] as HTMLElement).hidden = IS_LITE;
+  (DOWNLOAD_BUTTON.children[1] as HTMLElement).hidden = !IS_LITE;
 });

src/hub/Sidebar.ts

@@ -5,7 +5,7 @@
 // license that can be found in the LICENSE file
 // at the root directory of this project.
 
-import { Distribution, DISTRIBUTION } from "../shared/buildConstants";
+import { Distribution, DISTRIBUTION, IS_LITE } from "../shared/buildConstants";
 import { SidebarState } from "../shared/HubState";
 import LogFieldTree from "../shared/log/LogFieldTree";
 import LoggableType from "../shared/log/LoggableType";
@@ -136,7 +136,7 @@ export default class Sidebar {
     Array.from(menuBar.getElementsByTagName("button")).forEach((button, index) => {
       let active = false;
       button.addEventListener("click", () => {
-        if (active && DISTRIBUTION !== Distribution.Lite) {
+        if (active && !IS_LITE) {
           active = false;
           window.sendMainMessage("close-app-menu", {
             index: index
@@ -432,11 +432,18 @@ export default class Sidebar {
 
       // Add new list
       let tree = window.log.getFieldTree();
-      let rootKeys = Object.keys(tree);
+      let rootKeys = Object.keys(tree).filter((x) => !x.startsWith("."));
       if (rootKeys.length === 1 && tree[rootKeys[0]].fullKey === null) {
         // If only one table, use it as the root
         tree = tree[rootKeys[0]].children;
       }
+      if (DISTRIBUTION === Distribution.LiteDS) {
+        // Repeat for DS to use "NT:/Dscomm/" as the root
+        let rootKeys = Object.keys(tree).filter((x) => !x.startsWith("."));
+        if (rootKeys.length === 1 && tree[rootKeys[0]].fullKey === null) {
+          tree = tree[rootKeys[0]].children;
+        }
+      }
       Object.keys(tree)
         .filter((key) => !this.HIDDEN_KEYS.includes(key))
         .sort((a, b) => this.sortKeys(a, b, true))

src/hub/Tabs.ts

@@ -8,6 +8,7 @@
 import { TabsState } from "../shared/HubState";
 import LineGraphFilter from "../shared/LineGraphFilter";
 import TabType, { getDefaultTabTitle, getTabIcon } from "../shared/TabType";
+import { Distribution, DISTRIBUTION } from "../shared/buildConstants";
 import { getAutonomousKey, getEnabledKey } from "../shared/log/LogUtil";
 import ConsoleRenderer from "../shared/renderers/ConsoleRenderer";
 import DocumentationRenderer from "../shared/renderers/DocumentationRenderer";
@@ -290,11 +291,19 @@ export default class Tabs {
     });
 
     // Add default tabs
-    this.addTab(TabType.Documentation);
-    this.addTab(TabType.LineGraph);
-    this.addTab(TabType.Field2d);
-    this.addTab(TabType.Field3d);
-    this.setSelected(1);
+    if (DISTRIBUTION === Distribution.LiteDS) {
+      this.addTab(TabType.Documentation);
+      this.addTab(TabType.LineGraph);
+      this.addTab(TabType.Console);
+      this.addTab(TabType.Joysticks);
+      this.setSelected(1);
+    } else {
+      this.addTab(TabType.Documentation);
+      this.addTab(TabType.LineGraph);
+      this.addTab(TabType.Field2d);
+      this.addTab(TabType.Field3d);
+      this.setSelected(1);
+    }
 
     // Scroll management
     this.tabsScrollSensor = new ScrollSensor(

src/hub/controllers/Field3dController.ts

@@ -7,7 +7,7 @@
 
 import { BuiltIn3dFields } from "../../shared/AdvantageScopeAssets";
 import { SourceListItemState, SourceListOptionValueConfig, SourceListState } from "../../shared/SourceListConfig";
-import { DISTRIBUTION, Distribution } from "../../shared/buildConstants";
+import { IS_LITE } from "../../shared/buildConstants";
 import {
   APRIL_TAG_16H5_COUNT,
   APRIL_TAG_36H11_COUNT,
@@ -55,7 +55,7 @@ export default class Field3dController implements TabController {
     this.FIELD_SELECT = settings.getElementsByClassName("field-select")[0] as HTMLSelectElement;
 
     // Set up XR button
-    if (DISTRIBUTION === Distribution.Lite) {
+    if (IS_LITE) {
       Array.from(settings.getElementsByClassName("xr-control")).forEach((element) => {
         let htmlElement = element as HTMLElement;
         htmlElement.parentElement?.removeChild(htmlElement);

src/hub/dataSources/nt4/NT4.ts

@@ -8,6 +8,7 @@
 import { Decoder, Encoder } from "@msgpack/msgpack";
 
 export const NT4_PORTS_DEFAULT = [5810];
+export const NT4_PORTS_DS = [6767];
 
 const typestrIdxLookup: { [id: string]: number } = {
   boolean: 0,

src/hub/dataSources/nt4/NT4Source.ts

@@ -5,15 +5,15 @@
 // license that can be found in the LICENSE file
 // at the root directory of this project.
 
-import { Distribution, DISTRIBUTION } from "../../../shared/buildConstants";
+import { Distribution, DISTRIBUTION, IS_LITE } from "../../../shared/buildConstants";
 import Log from "../../../shared/log/Log";
 import { getEnabledKey, getURCLKeys, PHOTON_PREFIX, PROTO_PREFIX, STRUCT_PREFIX } from "../../../shared/log/LogUtil";
 import LoggableType from "../../../shared/log/LoggableType";
 import ProtoDecoder from "../../../shared/log/ProtoDecoder";
 import { checkArrayType } from "../../../shared/util";
 import { LiveDataSource, LiveDataSourceStatus } from "../LiveDataSource";
 import CustomSchemas from "../schema/CustomSchemas";
-import { NT4_Client, NT4_PORTS_DEFAULT, NT4_Topic } from "./NT4";
+import { NT4_Client, NT4_PORTS_DEFAULT, NT4_PORTS_DS, NT4_Topic } from "./NT4";
 import NT4Tuner from "./NT4Tuner";
 
 export const WPILOG_PREFIX = "NT:";
@@ -197,8 +197,8 @@ export default class NT4Source extends LiveDataSource {
       this.log = new Log();
       this.client = new NT4_Client(
         address,
-        NT4_PORTS_DEFAULT,
-        DISTRIBUTION === Distribution.Lite ? "AdvantageScopeLite" : "AdvantageScope",
+        DISTRIBUTION === Distribution.LiteDS ? NT4_PORTS_DS : NT4_PORTS_DEFAULT,
+        IS_LITE ? "AdvantageScopeLite" : "AdvantageScope",
         (topic: NT4_Topic) => {
           // Announce
           if (!this.log) return;