visualizer-components 0.1.0

package/dist/types/telemetryInterfaces.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @file telemetryInterfaces.ts
+ * @description This module defines the TypeScript interfaces and types used in the telemetry slice of the Redux store for the ASV dashboard.
+ * @author Carson Fujita
+ * @license MIT
+
+ */
+import type { Status } from "./statusTypes";
+/**
+ * Action type for fetching telemetry data
+ *
+ * @remarks
+ * - These constants represent the action types for fetching telemetry data from the basestation.
+ * - They are used in the Redux actions and reducers to handle the state changes related to telemetry data fetching.
+ * - The FETCH_TELEMETRY_SUCCESS action is dispatched when telemetry data is successfully received,
+ *  while the FETCH_TELEMETRY_FAILURE action is dispatched when there is an error in fetching telemetry data.
+ *
+ * @value FETCH_TELEMETRY_SUCCESS - Action type for successful telemetry data fetch
+ * @value FETCH_TELEMETRY_FAILURE - Action type for failed telemetry data fetch
+ *
+ * @author Carson Fujita
+ */
+declare const FETCH_TELEMETRY_SUCCESS = "FETCH_TELEMETRY_SUCCESS";
+/**
+ * Action type for handling errors when fetching telemetry data
+ *
+ * @author Carson Fujita
+ */
+declare const FETCH_TELEMETRY_FAILURE = "FETCH_TELEMETRY_FAILURE";
+/**
+ * Action interfaces for fetching telemetry data
+ *
+ * @author Carson Fujita
+ *
+ * @value extraProps - Allows for any additional properties that may be included in the action,
+ *  providing flexibility for future extensions of the action payload.
+ * @value type - The type of the action, which can be either FETCH_TELEMETRY_SUCCESS or FETCH_TELEMETRY_FAILURE.
+ * @value payload - The payload of the action, which contains the telemetry data for
+ *  success actions or an error message for failure actions.
+ *
+ * @remarks
+ * - Redux action
+ */
+interface FetchTelemetrySuccessAction {
+    [extraProps: string]: unknown;
+    type: typeof FETCH_TELEMETRY_SUCCESS;
+    payload: Status;
+}
+/**
+ * Action interface for handling errors when fetching telemetry data
+ *
+ * @author Carson Fujita
+ *
+ * @value extraProps - Allows for any additional properties that may be included in the action,
+ *  providing flexibility for future extensions of the action payload.
+ * @value type - The type of the action, which is FETCH_TELEMETRY_FAILURE.
+ * @value payload - The payload of the action, which contains an error message describing the failure.
+ *
+ * @remarks
+ * - Redux action
+ */
+interface FetchTelemetryFailureAction {
+    [extraProps: string]: unknown;
+    type: typeof FETCH_TELEMETRY_FAILURE;
+    payload: string;
+}
+/**
+ * Union type for telemetry action types
+ *
+ * @author Carson Fujita
+ * @remarks
+ * - This type represents the union of all possible action types related to fetching telemetry data,
+ *  including both success and failure actions.
+ * - It is used in the Redux reducer to handle state changes based on the type of action dispatched.
+ * - By defining this union type, we can ensure type safety and proper handling of telemetry-related actions in the Redux store.
+ * @see {@link TelemetryActionTypes}
+ */
+type TelemetryActionTypes = FetchTelemetrySuccessAction | FetchTelemetryFailureAction;
+export type { TelemetryActionTypes };
+export { FETCH_TELEMETRY_SUCCESS, FETCH_TELEMETRY_FAILURE };
+//# sourceMappingURL=telemetryInterfaces.d.ts.map

package/dist/types/telemetryInterfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetryInterfaces.d.ts","sourceRoot":"","sources":["../../src/types/telemetryInterfaces.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AA0BH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;;GAaG;AACH,QAAA,MAAM,uBAAuB,4BAA4B,CAAC;AAE1D;;;;GAIG;AACH,QAAA,MAAM,uBAAuB,4BAA4B,CAAC;AAE1D;;;;;;;;;;;;;GAaG;AACH,UAAU,2BAA2B;IACjC,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,IAAI,EAAE,OAAO,uBAAuB,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;;GAYG;AACH,UAAU,2BAA2B;IACjC,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,IAAI,EAAE,OAAO,uBAAuB,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;GAUG;AACH,KAAK,oBAAoB,GAAG,2BAA2B,GAAG,2BAA2B,CAAC;AAEtF,YAAY,EAAE,oBAAoB,EAAE,CAAC;AACrC,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,CAAC"}

package/dist/types/telemetryInterfaces.js

@@ -0,0 +1,30 @@
+/**
+ * @file telemetryInterfaces.ts
+ * @description This module defines the TypeScript interfaces and types used in the telemetry slice of the Redux store for the ASV dashboard.
+ * @author Carson Fujita
+ * @license MIT
+
+ */
+/**
+ * Action type for fetching telemetry data
+ *
+ * @remarks
+ * - These constants represent the action types for fetching telemetry data from the basestation.
+ * - They are used in the Redux actions and reducers to handle the state changes related to telemetry data fetching.
+ * - The FETCH_TELEMETRY_SUCCESS action is dispatched when telemetry data is successfully received,
+ *  while the FETCH_TELEMETRY_FAILURE action is dispatched when there is an error in fetching telemetry data.
+ *
+ * @value FETCH_TELEMETRY_SUCCESS - Action type for successful telemetry data fetch
+ * @value FETCH_TELEMETRY_FAILURE - Action type for failed telemetry data fetch
+ *
+ * @author Carson Fujita
+ */
+const FETCH_TELEMETRY_SUCCESS = 'FETCH_TELEMETRY_SUCCESS';
+/**
+ * Action type for handling errors when fetching telemetry data
+ *
+ * @author Carson Fujita
+ */
+const FETCH_TELEMETRY_FAILURE = 'FETCH_TELEMETRY_FAILURE';
+export { FETCH_TELEMETRY_SUCCESS, FETCH_TELEMETRY_FAILURE };
+//# sourceMappingURL=telemetryInterfaces.js.map

package/dist/types/telemetryInterfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetryInterfaces.js","sourceRoot":"","sources":["../../src/types/telemetryInterfaces.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AA4BH;;;;;;;;;;;;;GAaG;AACH,MAAM,uBAAuB,GAAG,yBAAyB,CAAC;AAE1D;;;;GAIG;AACH,MAAM,uBAAuB,GAAG,yBAAyB,CAAC;AAuD1D,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,CAAC"}

package/dist/utils/basestation.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks whether the ASV basestation HTTP server is reachable.
+ * Hits the /health endpoint (CORS-enabled) with a 2-second timeout.
+ * Returns false on any error — network failure, CORS, timeout, or non-2xx.
+ */
+export declare function isBasestationOnline(): Promise<boolean>;
+//# sourceMappingURL=basestation.d.ts.map

package/dist/utils/basestation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"basestation.d.ts","sourceRoot":"","sources":["../../src/utils/basestation.ts"],"names":[],"mappings":"AA2BA;;;;GAIG;AACH,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,OAAO,CAAC,CAe5D"}

package/dist/utils/basestation.js

@@ -0,0 +1,49 @@
+/*
+MIT License
+
+Copyright (c) 2026 HumberASV
+Copyright (c) 2026 Carson Fujita
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+import { getTelemetryConnectionConfig } from '../connection/config';
+/**
+ * Checks whether the ASV basestation HTTP server is reachable.
+ * Hits the /health endpoint (CORS-enabled) with a 2-second timeout.
+ * Returns false on any error — network failure, CORS, timeout, or non-2xx.
+ */
+export async function isBasestationOnline() {
+    const { httpBase } = getTelemetryConnectionConfig();
+    const controller = new AbortController();
+    const timer = setTimeout(() => controller.abort(), 2000);
+    try {
+        const res = await fetch(`${httpBase}/health`, {
+            signal: controller.signal,
+            mode: 'cors',
+        });
+        return res.ok;
+    }
+    catch {
+        return false;
+    }
+    finally {
+        clearTimeout(timer);
+    }
+}
+//# sourceMappingURL=basestation.js.map

package/dist/utils/basestation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basestation.js","sourceRoot":"","sources":["../../src/utils/basestation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;EAuBE;AAEF,OAAO,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAC;AAEpE;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB;IACrC,MAAM,EAAE,QAAQ,EAAE,GAAG,4BAA4B,EAAE,CAAC;IACpD,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,CAAC;IACzD,IAAI,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,QAAQ,SAAS,EAAE;YAC1C,MAAM,EAAE,UAAU,CAAC,MAAM;YACzB,IAAI,EAAE,MAAM;SACf,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,EAAE,CAAC;IAClB,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;YAAS,CAAC;QACP,YAAY,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;AACL,CAAC"}

package/dist/utils/batteryUtil.d.ts

@@ -0,0 +1,8 @@
+/**
+ *
+ */
+declare const batteryIconFor: (level: number) => import("@mui/material/OverridableComponent").OverridableComponent<import("@mui/material").SvgIconTypeMap<{}, "svg">> & {
+    muiName: string;
+};
+export { batteryIconFor };
+//# sourceMappingURL=batteryUtil.d.ts.map

package/dist/utils/batteryUtil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batteryUtil.d.ts","sourceRoot":"","sources":["../../src/utils/batteryUtil.ts"],"names":[],"mappings":"AAAA;;GAEG;AAaH,QAAA,MAAM,cAAc,GAAI,OAAO,MAAM;;CASpC,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,CAAA"}

package/dist/utils/batteryUtil.js

@@ -0,0 +1,32 @@
+/**
+ *
+ */
+// Battery icons from MUI
+import Battery0BarIcon from "@mui/icons-material/Battery0Bar";
+import Battery1BarIcon from "@mui/icons-material/Battery1Bar";
+import Battery2BarIcon from "@mui/icons-material/Battery2Bar";
+import Battery3BarIcon from "@mui/icons-material/Battery3Bar";
+import Battery4BarIcon from "@mui/icons-material/Battery4Bar";
+import Battery5BarIcon from "@mui/icons-material/Battery5Bar";
+import Battery6BarIcon from "@mui/icons-material/Battery6Bar";
+import BatteryFullIcon from "@mui/icons-material/BatteryFull";
+//Not a switch statement for brevity.
+const batteryIconFor = (level) => {
+    if (level >= 95)
+        return BatteryFullIcon;
+    if (level >= 85)
+        return Battery6BarIcon;
+    if (level >= 75)
+        return Battery5BarIcon;
+    if (level >= 60)
+        return Battery4BarIcon;
+    if (level >= 45)
+        return Battery3BarIcon;
+    if (level >= 30)
+        return Battery2BarIcon;
+    if (level >= 15)
+        return Battery1BarIcon;
+    return Battery0BarIcon;
+};
+export { batteryIconFor };
+//# sourceMappingURL=batteryUtil.js.map

package/dist/utils/batteryUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batteryUtil.js","sourceRoot":"","sources":["../../src/utils/batteryUtil.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,yBAAyB;AACzB,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAC9D,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAE9D,qCAAqC;AACrC,MAAM,cAAc,GAAG,CAAC,KAAa,EAAE,EAAE;IACrC,IAAI,KAAK,IAAI,EAAE;QAAE,OAAO,eAAe,CAAC;IACxC,IAAI,KAAK,IAAI,EAAE;QAAE,OAAO,eAAe,CAAC;IACxC,IAAI,KAAK,IAAI,EAAE;QAAE,OAAO,eAAe,CAAC;IACxC,IAAI,KAAK,IAAI,EAAE;QAAE,OAAO,eAAe,CAAC;IACxC,IAAI,KAAK,IAAI,EAAE;QAAE,OAAO,eAAe,CAAC;IACxC,IAAI,KAAK,IAAI,EAAE;QAAE,OAAO,eAAe,CAAC;IACxC,IAAI,KAAK,IAAI,EAAE;QAAE,OAAO,eAAe,CAAC;IACxC,OAAO,eAAe,CAAC;AAC3B,CAAC,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,CAAA"}

package/dist/utils/telemetry/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @file src/utils/telemetry/index.ts
+ * @description
+ * This file serves as the main entry point for the telemetry utilities in the ASV telemetry application.
+ *
+ *
+ * @author Carson Fujita
+ * @license MIT
+ *
+ */
+import * as telemetryFactory from './telemetryFactory';
+export { telemetryFactory, };
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/telemetry/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/telemetry/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,KAAK,gBAAgB,MAAM,oBAAoB,CAAC;AAEvD,OAAO,EACH,gBAAgB,GACnB,CAAC"}

package/dist/utils/telemetry/index.js

@@ -0,0 +1,13 @@
+/**
+ * @file src/utils/telemetry/index.ts
+ * @description
+ * This file serves as the main entry point for the telemetry utilities in the ASV telemetry application.
+ *
+ *
+ * @author Carson Fujita
+ * @license MIT
+ *
+ */
+import * as telemetryFactory from './telemetryFactory';
+export { telemetryFactory, };
+//# sourceMappingURL=index.js.map

package/dist/utils/telemetry/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/telemetry/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,KAAK,gBAAgB,MAAM,oBAAoB,CAAC;AAEvD,OAAO,EACH,gBAAgB,GACnB,CAAC"}

package/dist/utils/telemetry/telemetryFactory.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @file telemetryFactory.ts
+ *
+ * @description
+ * Factory functions for generating random telemetry data for testing and development purposes.
+ * This includes functions to create random telemetry states, as well as utilities for generating random values within specified ranges.
+ * @author Carson Fujita
+ * @license MIT
+ * @remarks
+ * - The `generateRandomTelemetry` function creates a complete telemetry state with random values for all parameters, including speed, heading, battery levels, task data, and more.
+ * - The `generateMockTelemetryUpdate` function takes a previous telemetry state and generates a new state with small random variations to simulate real-time updates.
+ * - These factory functions are useful for testing the application's UI and functionality without needing a live connection to the basestation or actual telemetry data.
+ *
+ * @example
+ * ```typescript
+ * import { generateRandomTelemetry } from './telemetryFactory';
+ *
+ * const randomTelemetry = generateRandomTelemetry();
+ * console.log(randomTelemetry);
+ * ```
+ *
+ * @example
+ * ```typescript
+ * import { generateMockTelemetryUpdate } from './telemetryFactory';
+ *
+ * let currentTelemetry = generateRandomTelemetry();
+ * setInterval(() => {
+ *     currentTelemetry = generateMockTelemetryUpdate(currentTelemetry);
+ *     console.log(currentTelemetry);
+ * }, 1000);
+ * ```
+ *
+ */
+import type { Status, Grid } from "../../types";
+export declare function generateRandomState(): {
+    status: Status;
+    fineGrid: Grid;
+};
+export declare function generateMockVideoUrl(): string;
+/**
+ * Generates a new state by applying small random variations to the previous state, simulating real-time updates.
+ * @param previous the previous State to base the new state on.
+ * @returns a new State object with updated values based on the previous state,
+ *  with random variations applied to simulate changes over time.
+ */
+export declare function generateMockStateUpdate(previous: Status): Status;
+export default generateRandomState;
+//# sourceMappingURL=telemetryFactory.d.ts.map

package/dist/utils/telemetry/telemetryFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetryFactory.d.ts","sourceRoot":"","sources":["../../../src/utils/telemetry/telemetryFactory.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AA2BH,OAAO,KAAK,EAAE,MAAM,EAAE,IAAI,EAAgC,MAAM,aAAa,CAAC;AAuT9E,wBAAgB,mBAAmB,IAAI;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,CA2DxE;AAED,wBAAgB,oBAAoB,IAAI,MAAM,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAwBhE;AAED,eAAe,mBAAmB,CAAC"}