Merge pull request #13 from pioneers/device-info

Communicate with Runtime and display peripheral info

.eslintrc.js

@@ -12,8 +12,14 @@ module.exports = {
     'no-shadow': 'off',
     '@typescript-eslint/no-shadow': 'error',
     'no-unused-vars': 'off',
-    '@typescript-eslint/no-unused-vars': 'error',
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        argsIgnorePattern: '^_',
+      },
+    ],
     'no-redeclare': 'off', // False positives on typescript's function overloads
+    'no-undef': 'off', // False positives and typescript won't build if actually undefined vars
   },
   parserOptions: {
     ecmaVersion: 2022,

src/common/DeviceInfoState.ts

@@ -0,0 +1,28 @@
+/**
+ * Maps device types to user-friendly names.
+ */
+export const DeviceTypes: { [type: number]: string } = {
+  0: 'Dummy device',
+  1: 'Limit switch',
+  2: 'Line follower',
+  3: 'Battery buzzer',
+  4: 'Servo controller',
+  5: 'Polar bear motor controller',
+  6: 'KoalaBear motor controller',
+  7: 'Power distribution board',
+  8: 'Distance sensor',
+};
+
+/**
+ * Represents one lowcar device and its reported data.
+ */
+export default interface DeviceInfoState {
+  /**
+   * The device id: the device type and uid separated by an underscore.
+   */
+  id: string;
+  /**
+   * Human-presentable data reported by the device, by the keys used by Robot.get_value.
+   */
+  [key: string]: string;
+}

src/common/IpcEventTypes.ts

@@ -1,18 +1,25 @@
 import type AppConsoleMessage from './AppConsoleMessage';
+import type DeviceInfoState from './DeviceInfoState';
+import { Mode as RobotRunMode } from '../../protos-main/protos';
 
 /**
  * IPC event channels used for communication from the main process to the renderer.
  */
 export type RendererChannels =
   | 'renderer-init'
-  | 'renderer-robot-update'
+  | 'renderer-battery-update'
+  | 'renderer-latency-update'
+  | 'renderer-devices-update'
   | 'renderer-post-console'
   | 'renderer-file-control'
   | 'renderer-quit-request';
 /**
  * IPC event channels used for communication from the renderer to the main process.
  */
-export type MainChannels = 'main-file-control' | 'main-quit';
+export type MainChannels =
+  | 'main-file-control'
+  | 'main-quit'
+  | 'main-update-robot-mode';
 
 /**
  * Data for the renderer-init event, sent when the renderer process has finished initializing and is
@@ -174,27 +181,20 @@ export type RendererFileControlData =
  */
 export type RendererPostConsoleData = AppConsoleMessage;
 /**
- * Data for the renderer-robot-update event when some info related to the robot or its connection
- * changes.
+ * Data for the renderer-battery-update event sent by the main process to update the robot's battery
+ * voltage.
  */
-export interface RendererRobotUpdateData {
-  /**
-   * User-presentable runtime version string. May be omitted if the value has not changed since the
-   * last update.
-   */
-  runtimeVersion?: string;
-  /**
-   * Robot battery voltage in volts. May be omitted if the value has not changed since the last
-   * update.
-   */
-  robotBatteryVoltage?: number;
-  /**
-   * Robot connection latency in milliseconds. May be omitted if the value has not changed since the
-   * last update.
-   */
-  robotLatencyMs?: number;
-}
-
+export type RendererBatteryUpdateData = number;
+/**
+ * Data for the renderer-latency-update event sent by the main process to update the displayed robot
+ * connection latency.
+ */
+export type RendererLatencyUpdateData = number;
+/**
+ * Data for the renderer-devices-update event sent by the main process to update the state of
+ * connected lowcar devices.
+ */
+export type RendererDevicesUpdateData = DeviceInfoState[];
 /**
  * Data for a specialization of the main-file-control event, sent by the renderer to
  * initiate/respond to a request to save the code.
@@ -300,3 +300,8 @@ export interface MainQuitData {
    */
   showDirtyUploadWarning: boolean;
 }
+/**
+ * Data for the main-update-robot-mode event sent by the renderer to stop the robot or start it with
+ * a specified opmode.
+ */
+export type MainUpdateRobotModeData = RobotRunMode;