Rename ser2net to serial

rjwats · mjkl-gh · Jan 2, 2021 · Jan 2, 2021 · Dec 25, 2021 · Dec 25, 2021
commit 39a8d2d07a158bcecd8321963cab9327bba41d2d
diff --git a/README.md b/README.md
@@ -173,7 +173,7 @@ Customize the settings as you see fit. A value of 0 will disable the specified f
     -D FT_SECURITY=1
     -D FT_MQTT=1
     -D FT_NTP=1
-    -D FT_SER2NET=1
+    -D FT_SERIAL=1
     -D FT_OTA=1
     -D FT_UPLOAD_FIRMWARE=1
 ```

diff --git a/interface/src/AppRouting.tsx b/interface/src/AppRouting.tsx
@@ -13,7 +13,7 @@ import AccessPoint from './ap/AccessPoint';
 import NetworkTime from './ntp/NetworkTime';
 import Security from './security/Security';
 import System from './system/System';
-import Ser2net from './ser2net/Ser2net';
+import Serial from './serial/Serial';
 
 import { PROJECT_PATH } from './api';
 import Mqtt from './mqtt/Mqtt';
@@ -47,8 +47,8 @@ class AppRouting extends Component<WithFeaturesProps> {
           {features.mqtt && (
             <AuthenticatedRoute exact path="/mqtt/*" component={Mqtt} />
           )}
-          {features.ser2net && (
-            <AuthenticatedRoute exact path="/ser2net/*" component={Ser2net} />
+          {features.serial && (<
8000
/span>
+            <AuthenticatedRoute exact path="/serial/*" component={Serial} />
           )}
           {features.security && (
             <AuthenticatedRoute exact path="/security/*" component={Security} />

diff --git a/interface/src/api/Endpoints.ts b/interface/src/api/Endpoints.ts
@@ -14,8 +14,8 @@ export const OTA_SETTINGS_ENDPOINT = ENDPOINT_ROOT + "otaSettings";
 export const UPLOAD_FIRMWARE_ENDPOINT = ENDPOINT_ROOT + "uploadFirmware";
 export const MQTT_SETTINGS_ENDPOINT = ENDPOINT_ROOT + "mqttSettings";
 export const MQTT_STATUS_ENDPOINT = ENDPOINT_ROOT + "mqttStatus";
-export const SER2NET_SETTINGS_ENDPOINT = ENDPOINT_ROOT + "ser2netSettings";
-export const SER2NET_STATUS_ENDPOINT = ENDPOINT_ROOT + "ser2netStatus";
+export const SERIAL_SETTINGS_ENDPOINT = ENDPOINT_ROOT + "serialSettings";
+export const SERIAL_STATUS_ENDPOINT = ENDPOINT_ROOT + "serialStatus";
 export const SYSTEM_STATUS_ENDPOINT = ENDPOINT_ROOT + "systemStatus";
 export const SIGN_IN_ENDPOINT = ENDPOINT_ROOT + "signIn";
 export const VERIFY_AUTHORIZATION_ENDPOINT = ENDPOINT_ROOT + "verifyAuthorization";

diff --git a/interface/src/components/MenuAppBar.tsx b/interface/src/components/MenuAppBar.tsx
@@ -166,12 +166,12 @@ class MenuAppBar extends React.Component<MenuAppBarProps, MenuAppBarState> {
               <ListItemText primary="MQTT" />
             </ListItem>
           )}
-          {features.ser2net && (
-            <ListItem to='/ser2net/' selected={path.startsWith('/ser2net/')} button component={Link}>
+          {features.serial && (
+            <ListItem to='/serial/' selected={path.startsWith('/serial/')} button component={Link}>
               <ListItemIcon>
                 <Icon icon={serialPort} width="24" height="24" />
               </ListItemIcon>
-              <ListItemText primary="Ser2net" />
+              <ListItemText primary="Serial" />
             </ListItem>
           )}
           {features.security && (

diff --git a/interface/src/features/types.ts b/interface/src/features/types.ts
@@ -2,7 +2,7 @@ export interface Features {
   project: boolean;
   security: boolean;
   mqtt: boolean;
-  ser2net: boolean;
+  serial: boolean;
   ntp: boolean;
   ota: boolean;
   upload_firmware: boolean;

diff --git a/interface/src/ser2net/Ser2net.tsx b/interface/src/ser2net/Ser2net.tsx
diff --git a/interface/src/ser2net/Ser2netSettingsController.tsx b/interface/src/ser2net/Ser2netSettingsController.tsx
diff --git a/interface/src/ser2net/Ser2netStatus.ts b/interface/src/ser2net/Ser2netStatus.ts
diff --git a/interface/src/ser2net/Ser2netStatusController.tsx b/interface/src/ser2net/Ser2netStatusController.tsx
diff --git a/interface/src/ser2net/types.ts b/interface/src/ser2net/types.ts
diff --git a/interface/src/system/LogEventConsole.tsx → interface/src/serial/LogEventConsole.tsx b/interface/src/system/LogEventConsole.tsx → interface/src/serial/LogEventConsole.tsx
diff --git a/interface/src/system/LogEventController.tsx → interface/src/serial/LogEventController.tsx b/interface/src/system/LogEventController.tsx → interface/src/serial/LogEventController.tsx
diff --git a/interface/src/serial/Serial.tsx b/interface/src/serial/Serial.tsx
@@ -0,0 +1,40 @@
+import React, { Component } from 'react';
+import { Redirect, Switch, RouteComponentProps } from 'react-router-dom'
+
+import { Tabs, Tab } from '@material-ui/core';
+
+import { AuthenticatedContextProps, withAuthenticatedContext, AuthenticatedRoute } from '../authentication';
+import { MenuAppBar } from '../components';
+import SerialStatusController from './SerialStatusController';
+import SerialSettingsController from './SerialSettingsController';
+import LogEventController from './LogEventController';
+
+type SerialProps = AuthenticatedContextProps & RouteComponentProps;
+
+class Serial extends Component<SerialProps> {
+
+  handleTabChange = (event: React.ChangeEvent<{}>, path: string) => {
+    this.props.history.push(path);
+  };
+
+  render() {
+    const { authenticatedContext } = this.props;
+    return (
+      <MenuAppBar sectionTitle="Serial">
+        <Tabs value={this.props.match.url} onChange={this.handleTabChange} variant="fullWidth">
+          <Tab value="/serial/status" label="Serial Status" />
+          <Tab value="/serial/log" label="Remote Log" />
+          <Tab value="/serial/settings" label="Serial Settings" disabled={!authenticatedContext.me.admin} />
+        </Tabs>
+        <Switch>
+          <AuthenticatedRoute exact path="/serial/status" component={SerialStatusController} />
+          <AuthenticatedRoute exact path="/serial/log" component={LogEventController} />
+          <AuthenticatedRoute exact path="/serial/settings" component={SerialSettingsController} />
+          <Redirect to="/serial/status" />
+        </Switch>
+      </MenuAppBar>
+    )
+  }
+}
+
+export default withAuthenticatedContext(Serial);
diff --git a/interface/src/serial/SerialSettingsController.tsx b/interface/src/serial/SerialSettingsController.tsx
@@ -0,0 +1,30 @@
+import React, { Component } from 'react';
+
+import {restController, RestControllerProps, RestFormLoader, SectionContent } from '../components';
+import { SERIAL_SETTINGS_ENDPOINT } from '../api';
+
+import SerialSettingsForm from './SerialSettingsForm';
+import { SerialSettings } from './types';
+
+type SerialSettingsControllerProps = RestControllerProps<SerialSettings>;
+
+class SerialSettingsController extends Component<SerialSettingsControllerProps> {
+
+  componentDidMount() {
+    this.props.loadData();
+  }
+
+  render() {
+    return (
+      <SectionContent title="Serial Settings" titleGutter>
+        <RestFormLoader
+          {...this.props}
+          render={formProps => <SerialSettingsForm {...formProps} />}
+        />
+      </SectionContent>
+    )
+  }
+
+}
+
+export default restController(SERIAL_SETTINGS_ENDPOINT, SerialSettingsController);
diff --git a/...rface/src/ser2net/Ser2netSettingsForm.tsx → interface/src/serial/SerialSettingsForm.tsx b/...rface/src/ser2net/Ser2netSettingsForm.tsx → interface/src/serial/SerialSettingsForm.tsx
@@ -6,11 +6,11 @@ import SaveIcon from '@material-ui/icons/Save';
 
 import { RestFormProps, FormActions, FormButton, BlockFormControlLabel } from '../components';
 
-import { Ser2netSettings } from './types';
+import { SerialSettings } from './types';
 
-type Ser2netSettingsFormProps = RestFormProps<Ser2netSettings>;
+type SerialSettingsFormProps = RestFormProps<SerialSettings>;
 
-class Ser2netSettingsForm extends React.Component<Ser2netSettingsFormProps> {
+class SerialSettingsForm extends React.Component<SerialSettingsFormProps> {
 
   componentDidMount() {
   }
@@ -30,7 +30,7 @@ class Ser2netSettingsForm extends React.Component<Ser2netSettingsFormProps> {
                 color="primary"
               />
             }
-          label="Enable Ser2net"
+          label="Enable Serial"
         />
         <FormActions>
           <FormButton startIcon={<SaveIcon />} variant="contained" color="primary" type="submit">
@@ -42,4 +42,4 @@ class Ser2netSettingsForm extends React.Component<Ser2netSettingsFormProps> {
   }
 }
 
-export default Ser2netSettingsForm;
+export default SerialSettingsForm;
diff --git a/interface/src/serial/SerialStatus.ts b/interface/src/serial/SerialStatus.ts
@@ -0,0 +1,39 @@
+import { Theme } from "@material-ui/core";
+import { SerialStatus  } from "./types";
+
+export const serialStatusHighlight = ({ enabled }: SerialStatus, theme: Theme) => {
+  if (!enabled) {
+    return theme.palette.info.main;
+  }
+  return theme.palette.success.main;
+}
+
+export const serialStatus = ({ enabled  }: SerialStatus) => {
+  if (!enabled) {
+    return "Not enabled";
+  }
+  return "Enabled";
+}
+
+// export const disconnectReason = ({ disconnect_reason }: SerialStatus) => {
+//   switch (disconnect_reason) {
+//     case SerialDisconnectReason.TCP_DISCONNECTED:
+//       return "TCP disconnected";
+//     case SerialDisconnectReason.SERIAL_UNACCEPTABLE_PROTOCOL_VERSION:
+//       return "Unacceptable protocol version";
+//     case SerialDisconnectReason.SERIAL_IDENTIFIER_REJECTED:
+//       return "Client ID rejected";
+//     case SerialDisconnectReason.SERIAL_SERVER_UNAVAILABLE:
+//       return "Server unavailable";
+//     case SerialDisconnectReason.SERIAL_MALFORMED_CREDENTIALS:
+//       return "Malformed credentials";
+//     case SerialDisconnectReason.SERIAL_NOT_AUTHORIZED:
+//       return "Not authorized";
+//     case SerialDisconnectReason.ESP8266_NOT_ENOUGH_SPACE:
+//       return "Device out of memory";
+//     case SerialDisconnectReason.TLS_BAD_FINGERPRINT:
+//       return "Server fingerprint invalid";
+//     default:
+//       return "Unknown"
+//   }
+// }