- Could not find the Web Serial API (navigator.serial) provided by the browser. Natively supported browsers include Chromium-based desktop browsers (e.t.c.
- Chrome, Edge, Brave) and Opera. Firefox is supported but you have to install the{' '}
+ Could not find the Web Serial API (navigator.serial) provided by the browser. Natively supported browsers include Chromium-based desktop browsers (e.t.c. Chrome, Edge,
+ Brave) and Opera. Firefox is supported but you have to install the{' '}
WebSerial for Firefox extension
{' '}
@@ -404,9 +404,9 @@ export class App {
this.closedPromise = this.readUntilClosed();
});
- const lastUsedSerialPort = this.profileManager.currentAppConfig.lastUsedSerialPort;
+ const lastUsedSerialPort = this.profileManager.appData.currentAppConfig.lastUsedSerialPort;
lastUsedSerialPort.portState = PortState.OPENED;
- this.profileManager.saveAppConfig();
+ this.profileManager.saveAppData();
// Create custom GA4 event to see how many ports have
// been opened in NinjaTerm :-)
@@ -461,7 +461,17 @@ export class App {
'warning'
);
} else if (error.name === 'BreakError') {
- this.snackbar.sendToSnackbar('Encountered break signal.\n' + 'Returned error from reader.read():\n' + `${error}`, 'warning');
+ // The user has the ability to disable these warnings as break signals
+ // might be expected in certain use cases (e.g. framing of raw data)
+ if (this.settings.rxSettings.showWarningOnRxBreakSignal) {
+ this.snackbar.sendToSnackbar(
+ 'Received break signal.\n' +
+ 'You can disable this warning in the RX Settings view if break signals are expected.\n' +
+ 'Returned error from reader.read():\n' +
+ `${error}`,
+ 'warning'
+ );
+ }
} else if (error.name === 'FramingError') {
this.snackbar.sendToSnackbar('Encountered framing error.\n' + 'Returned error from reader.read():\n' + `${error}`, 'warning');
} else if (error.name === 'ParityError') {
@@ -553,9 +563,9 @@ export class App {
}
this.reader = null;
this.closedPromise = null;
- const lastUsedSerialPort = this.profileManager.currentAppConfig.lastUsedSerialPort;
+ const lastUsedSerialPort = this.profileManager.appData.currentAppConfig.lastUsedSerialPort;
lastUsedSerialPort.portState = PortState.CLOSED;
- this.profileManager.saveAppConfig();
+ this.profileManager.saveAppData();
} else if (this.lastSelectedPortType === PortType.FAKE) {
this.fakePortController.closePort();
} else {
@@ -575,7 +585,7 @@ export class App {
* - Pressing "f" while on the Port Configuration settings.
*/
async handleKeyDown(event: React.KeyboardEvent) {
- console.log('handleKeyDown() called. event.key=', event.key);
+ // console.log('handleKeyDown() called. event.key=', event.key);
// SPECIAL TESTING "FAKE PORTS"
if (this.shownMainPane === MainPanes.SETTINGS && this.settings.activeSettingsCategory === SettingsCategories.PORT_CONFIGURATION && event.key === 'f') {
this.fakePortController.setIsDialogOpen(true);
@@ -801,6 +811,8 @@ export class App {
} else if (this.settings.txSettings.enterKeyPressBehavior === EnterKeyPressBehavior.SEND_CRLF) {
bytesToWrite.push(0x0d);
bytesToWrite.push(0x0a);
+ } else if (this.settings.txSettings.enterKeyPressBehavior === EnterKeyPressBehavior.SEND_BREAK) {
+ await this.sendBreakSignal();
} else {
throw Error('Unsupported enter key press behavior!');
}
diff --git a/src/model/FakePorts/FakePortsController.tsx b/src/model/FakePorts/FakePortsController.tsx
index 1a8806d5..c4dfda1f 100644
--- a/src/model/FakePorts/FakePortsController.tsx
+++ b/src/model/FakePorts/FakePortsController.tsx
@@ -8,15 +8,15 @@ import { generateRandomString } from 'src/model/Util/Util';
class FakePort {
name: string;
description: string;
- intervalId: NodeJS.Timer | null;
- connectFunction: () => NodeJS.Timer | null;
- disconnectFunction: (intervalId: NodeJS.Timer | null) => void;
+ intervalId: NodeJS.Timeout | null;
+ connectFunction: () => NodeJS.Timeout | null;
+ disconnectFunction: (intervalId: NodeJS.Timeout | null) => void;
constructor(
name: string,
description: string,
- connectFunction: () => NodeJS.Timer | null,
- disconnectFunction: (intervalId: NodeJS.Timer | null) => void
+ connectFunction: () => NodeJS.Timeout | null,
+ disconnectFunction: (intervalId: NodeJS.Timeout | null) => void
) {
this.name = name;
this.description = description;
@@ -66,7 +66,7 @@ export default class FakePortsController {
}, 10000);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -92,7 +92,7 @@ export default class FakePortsController {
}, 1000);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -118,7 +118,7 @@ export default class FakePortsController {
}, 200);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -144,7 +144,7 @@ export default class FakePortsController {
}, 100);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -181,7 +181,7 @@ export default class FakePortsController {
}, 5000);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -285,7 +285,7 @@ export default class FakePortsController {
}, 200);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -311,7 +311,7 @@ export default class FakePortsController {
}, 100);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -342,7 +342,7 @@ export default class FakePortsController {
}, 200);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -378,7 +378,7 @@ export default class FakePortsController {
}, 200);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -414,7 +414,7 @@ export default class FakePortsController {
// No timer needed
return null;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -442,7 +442,7 @@ export default class FakePortsController {
}, 2000);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -454,7 +454,7 @@ export default class FakePortsController {
// mcu modules
//=================================================================================
// This intervalId is a hacky way of allowing for variable intervals
- let intervalId: NodeJS.Timer | null = null;
+ let intervalId: NodeJS.Timeout | null = null;
this.fakePorts.push(
new FakePort(
'mcu modules',
@@ -500,7 +500,7 @@ export default class FakePortsController {
intervalId = setInterval(onTimeoutFn, 1000);
return null;
},
- (_: NodeJS.Timer | null) => {
+ (_: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -530,7 +530,7 @@ export default class FakePortsController {
}, 200);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -560,7 +560,7 @@ export default class FakePortsController {
}, 200);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -590,7 +590,7 @@ export default class FakePortsController {
}, 200);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -628,7 +628,7 @@ export default class FakePortsController {
}, 1000);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -667,7 +667,7 @@ export default class FakePortsController {
}, 1000);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
@@ -703,7 +703,7 @@ export default class FakePortsController {
}, 1000);
return intervalId;
},
- (intervalId: NodeJS.Timer | null) => {
+ (intervalId: NodeJS.Timeout | null) => {
// Stop the interval
if (intervalId !== null) {
clearInterval(intervalId);
diff --git a/src/model/Logging/Logging.ts b/src/model/Logging/Logging.ts
index 478a35bd..3581cbd6 100644
--- a/src/model/Logging/Logging.ts
+++ b/src/model/Logging/Logging.ts
@@ -30,7 +30,7 @@ export default class Logging {
isLogging = false;
- intervalId: NodeJS.Timer | null = null;
+ intervalId: NodeJS.Timeout | null = null;
/**
* Stored data to be written to the file, until the next file write
diff --git a/src/model/ProfileManager/ProfileManager.spec.ts b/src/model/ProfileManager/ProfileManager.spec.ts
index abc5931a..6ad59523 100644
--- a/src/model/ProfileManager/ProfileManager.spec.ts
+++ b/src/model/ProfileManager/ProfileManager.spec.ts
@@ -13,15 +13,15 @@ describe("profile manager tests", () => {
test("default profile should be created", () => {
const app = new App();
const profileManager = new ProfileManager(app);
- expect(profileManager.profiles.length).toEqual(1);
- expect(profileManager.profiles[0].name).toEqual("Default profile");
+ expect(profileManager.appData.profiles.length).toEqual(1);
+ expect(profileManager.appData.profiles[0].name).toEqual("Default profile");
});
test("new profile can be created", () => {
const app = new App();
const profileManager = new ProfileManager(app);
profileManager.newProfile();
- expect(profileManager.profiles.length).toEqual(2);
- expect(profileManager.profiles[1].name).toEqual("New profile 1");
+ expect(profileManager.appData.profiles.length).toEqual(2);
+ expect(profileManager.appData.profiles[1].name).toEqual("New profile 1");
});
});
diff --git a/src/model/ProfileManager/ProfileManager.ts b/src/model/ProfileManager/ProfileManager.ts
index bf49526e..d6832054 100644
--- a/src/model/ProfileManager/ProfileManager.ts
+++ b/src/model/ProfileManager/ProfileManager.ts
@@ -1,13 +1,14 @@
-import { makeAutoObservable } from "mobx";
-
-import { DisplaySettingsConfig } from "../Settings/DisplaySettings/DisplaySettings";
-import { GeneralSettingsConfig } from "../Settings/GeneralSettings/GeneralSettings";
-import { PortConfigurationConfig, PortState } from "../Settings/PortConfigurationSettings/PortConfigurationSettings";
-import { RxSettingsConfig } from "../Settings/RxSettings/RxSettings";
-import { TxSettingsConfig } from "../Settings/TxSettings/TxSettings";
-import { MacroControllerConfig } from "../Terminals/RightDrawer/Macros/MacroController";
-import { App } from "../App";
-import { VariantType } from "notistack";
+import { makeAutoObservable } from 'mobx';
+
+import { DisplaySettingsConfig } from '../Settings/DisplaySettings/DisplaySettings';
+import { GeneralSettingsConfig } from '../Settings/GeneralSettings/GeneralSettings';
+import { PortConfigurationConfig, PortState } from '../Settings/PortConfigurationSettings/PortConfigurationSettings';
+import { RxSettingsConfig } from '../Settings/RxSettings/RxSettings';
+import { TxSettingsConfig } from '../Settings/TxSettings/TxSettings';
+import { MacroControllerConfig } from '../Terminals/RightDrawer/Macros/MacroController';
+import { App } from '../App';
+import { VariantType } from 'notistack';
+import { RightDrawerConfig } from '../Terminals/RightDrawer/RightDrawer';
export class LastUsedSerialPort {
serialPortInfo: Partial = {};
@@ -18,10 +19,11 @@ export class LastUsedSerialPort {
* Everything in this class must be POD (plain old data) and serializable to JSON.
*/
export class RootConfig {
- version = 1;
+ version = 2;
terminal = {
macroController: new MacroControllerConfig(),
+ rightDrawer: new RightDrawerConfig(),
};
lastUsedSerialPort: LastUsedSerialPort = new LastUsedSerialPort();
@@ -36,12 +38,12 @@ export class RootConfig {
}
/**
- * This class represents a serial port profile. It is used to store use-specific
+ * This class represents all the data stored in a user profile. It is used to store use-specific
* settings for the application (e.g. all the settings to talk to a particular
* embedded device). The class is serializable to JSON.
*/
export class Profile {
- name: string = "";
+ name: string = '';
rootConfig: RootConfig = new RootConfig();
constructor(name: string) {
@@ -50,10 +52,13 @@ export class Profile {
}
}
-const PROFILES_STORAGE_KEY = "profiles";
+/**
+ * This class represents all the data that the app needs to store/load from
+ * local storage (i.e. the root object). It must be serializable to JSON.
+ */
+export class AppData {
-export class ProfileManager {
- app: App;
+ version = 1;
profiles: Profile[] = [];
@@ -63,90 +68,107 @@ export class ProfileManager {
*/
currentAppConfig: RootConfig = new RootConfig();
+ constructor() {
+ makeAutoObservable(this);
+ }
+}
+
+const APP_DATA_STORAGE_KEY = 'appData';
+
+export class ProfileManager {
+ app: App;
+
+ appData: AppData = new AppData();
+
_profileChangeCallbacks: (() => void)[] = [];
/**
* Represents the name of the last profile that was applied to the app. Used for displaying
* in various places such as the toolbar.
*/
- lastAppliedProfileName: string = "No profile";
+ lastAppliedProfileName: string = 'No profile';
constructor(app: App) {
this.app = app;
- addEventListener("storage", (event) => {
- console.log("Caught storage event. event.key: ", event.key, " event.newValue: ", event.newValue);
-
- if (event.key === PROFILES_STORAGE_KEY) {
- console.log("Profiles changed. Reloading...");
- this._loadProfilesFromStorage();
- }
- });
-
- // Read in profiles
- this._loadProfilesFromStorage();
+ addEventListener('storage', this.onStorageEvent);
- // Load current app config
- const currentAppConfigJson = window.localStorage.getItem("currentAppConfig");
- let currentAppConfig: RootConfig;
- if (currentAppConfigJson === null) {
- // No config key found in users store, create one!
- currentAppConfig = new RootConfig();
- // Save just-created config back to store.
- window.localStorage.setItem("currentAppConfig", JSON.stringify(this.currentAppConfig));
- } else {
- currentAppConfig = JSON.parse(currentAppConfigJson);
- console.log("Loading current app config from local storage. currentAppConfig: ", currentAppConfig);
- }
- this.currentAppConfig = currentAppConfig;
+ // Load app data from storage
+ this._loadAppDataFromStorage();
makeAutoObservable(this);
}
- setActiveProfile = (profile: Profile) => {
- // this.activeProfile = profile;
- // Need to tell the rest of the app to update
- this._profileChangeCallbacks.forEach((callback) => {
- callback();
- });
- };
+ /**
+ * Function should be registered as a listener for the 'storage' event. It will check
+ * to see if the profile data in storage has changed and if so, reload the profiles.
+ * @param event The storage event.
+ * @returns
+ */
+ onStorageEvent = (event: StorageEvent) => {
+ console.log('Caught storage event. event.key: ', event.key, ' event.newValue: ', event.newValue);
+
+ if (event.key === APP_DATA_STORAGE_KEY) {
+ console.log('App data changed from another process. Checking if profiles changed...');
+ // Check if the profiles changed
+ const appDataAsJson = window.localStorage.getItem(APP_DATA_STORAGE_KEY);
+ if (appDataAsJson === null) {
+ console.error('App data not found in local storage.');
+ return;
+ }
+ const appDataInStorage = JSON.parse(appDataAsJson);
+ // Compare the JSON strings of the profiles to work out if they are different
+ if (JSON.stringify(appDataInStorage.profiles) !== JSON.stringify(this.appData.profiles)) {
+ console.log('Profiles changed. Reloading profiles...');
+ // Reload just the profiles, we don't want to overwrite the current app config
+ this.appData.profiles = appDataInStorage.profiles;
+ }
+ }
+ }
registerOnProfileLoad = (callback: () => void) => {
this._profileChangeCallbacks.push(callback);
};
- _loadProfilesFromStorage = () => {
- const profilesJson = window.localStorage.getItem(PROFILES_STORAGE_KEY);
+ _loadAppDataFromStorage = () => {
+ const appDataAsJson = window.localStorage.getItem(APP_DATA_STORAGE_KEY);
// let profileManagerData: ProfileManagerData;
- let profiles: Profile[];
- if (profilesJson === null) {
+ let appData: AppData;
+ if (appDataAsJson === null) {
// No config key found in users store, create one!
- profiles = [];
- profiles.push(new Profile("Default profile"));
- console.log("No profiles found in local storage. Creating default profile.");
+ console.log('App data not found in local storage. Creating default app data.');
+ appData = new AppData();
+ appData.profiles = [];
+ appData.profiles.push(new Profile('Default profile'));
// Save just-created config back to store.
- window.localStorage.setItem(PROFILES_STORAGE_KEY, JSON.stringify(profiles));
+ window.localStorage.setItem(APP_DATA_STORAGE_KEY, JSON.stringify(appData));
} else {
- profiles = JSON.parse(profilesJson);
+ // A version of app data was found in local storage. Load it.
+ let appDataUnknownVersion = JSON.parse(appDataAsJson);
+ if (appDataUnknownVersion.version == 1) {
+ // Latest version, don't need to convert anything
+ // or save it back
+ appData = appDataUnknownVersion;
+ } else {
+ console.error('Unknown app data version found: ', appDataUnknownVersion.version);
+ appData = new AppData();
+ appData.profiles = [];
+ appData.profiles.push(new Profile('Default profile'));
+ // Save just-created config back to store.
+ window.localStorage.setItem(APP_DATA_STORAGE_KEY, JSON.stringify(appData));
+ }
}
- // Only support the 1 active config for now
- // this.activeProfile = this.profiles[0];
// Load data into class
- this.profiles = profiles;
- };
-
- saveProfiles = () => {
- console.log("Saving profiles...");
- window.localStorage.setItem(PROFILES_STORAGE_KEY, JSON.stringify(this.profiles));
+ this.appData = appData;
};
/**
- * Save all profiles to local storage.
+ * Save the current app configuration to local storage.
*/
- saveAppConfig = () => {
- console.log("Saving app config...");
- window.localStorage.setItem("currentAppConfig", JSON.stringify(this.currentAppConfig));
+ saveAppData = () => {
+ console.log('Saving app data. appData: ', this.appData);
+ window.localStorage.setItem(APP_DATA_STORAGE_KEY, JSON.stringify(this.appData));
};
/**
@@ -155,20 +177,20 @@ export class ProfileManager {
newProfile = () => {
// Calculate name for new profile, in the form "New profile X" where X is the next number
let nextProfileNum = 1;
- const newProfileName = "New profile";
- let newProfileNameToCheck = newProfileName + " " + nextProfileNum;
- while (this.profiles.find((profile) => profile.name === newProfileNameToCheck) !== undefined) {
+ const newProfileName = 'New profile';
+ let newProfileNameToCheck = newProfileName + ' ' + nextProfileNum;
+ while (this.appData.profiles.find((profile) => profile.name === newProfileNameToCheck) !== undefined) {
nextProfileNum++;
- newProfileNameToCheck = newProfileName + " " + nextProfileNum;
+ newProfileNameToCheck = newProfileName + ' ' + nextProfileNum;
}
// At this point newProfileNameToCheck is the name we want
const newProfile = new Profile(newProfileNameToCheck);
- this.profiles.push(newProfile);
- this.saveProfiles();
+ this.appData.profiles.push(newProfile);
+ this.saveAppData();
// Automatically save the current app state to the newly created profile
// and silence the snackbar message
- this.saveCurrentAppConfigToProfile(this.profiles.length - 1, true);
+ this.saveCurrentAppConfigToProfile(this.appData.profiles.length - 1, true);
};
/**
@@ -176,35 +198,42 @@ export class ProfileManager {
* @param profileIdx The index of the profile to delete.
*/
deleteProfile = (profileIdx: number) => {
- this.profiles.splice(profileIdx, 1);
- this.saveProfiles();
+ this.appData.profiles.splice(profileIdx, 1);
+ this.saveAppData();
};
/**
* Apply the profile at the provided index to the current app config (i.e. update the app
* to reflect the profile).
+ *
+ * Will attempt to connect to the serial port specified in the profile if it is available.
+ *
* @param profileIdx The index of the profile to apply to the app.
*/
applyProfileToApp = async (profileIdx: number) => {
- const profile = this.profiles[profileIdx];
+ const profile = this.appData.profiles[profileIdx];
// Check the last connected serial port of the profile and compare with
// currently connected one
const profileSerialPortInfoJson = JSON.stringify(profile.rootConfig.lastUsedSerialPort.serialPortInfo);
- const currentSerialPortInfoJson = JSON.stringify(this.currentAppConfig.lastUsedSerialPort.serialPortInfo);
+ const currentSerialPortInfoJson = JSON.stringify(this.appData.currentAppConfig.lastUsedSerialPort.serialPortInfo);
let weNeedToConnect = false;
let matchedAvailablePorts: SerialPort[] = [];
let snackbarMessage = `Profile "${profile.name}" loaded.`;
let snackbarVariant: VariantType = 'success';
- if (profileSerialPortInfoJson == "{}") {
+ if (profileSerialPortInfoJson == '{}') {
weNeedToConnect = false;
} else if (profileSerialPortInfoJson === currentSerialPortInfoJson) {
// Same serial port, no need to disconnect and connect
+ // Note there is a chance we are not connected to the right one due to
+ // ambiguity...but if already connected it is a better user experience to
+ // not disconnect on the high chance it is the correct port
weNeedToConnect = false;
+ snackbarMessage += '\nAlready connected port matches one specified in profile. Leaving port connected.';
} else {
// They are both different and the profile one is non-empty. Check to see if the profile ports is available
- console.log("Port infos are both different and non-empty. Checking if ports are available...");
+ console.log('Port infos are both different and non-empty. Checking if ports are available...');
const availablePorts = await navigator.serial.getPorts();
matchedAvailablePorts = availablePorts.filter((port) => JSON.stringify(port.getInfo()) === profileSerialPortInfoJson);
@@ -217,10 +246,10 @@ export class ProfileManager {
// The profile port is available
weNeedToConnect = true;
} else {
- // There are multiple ports that match the profile port, to ambiguous, do
+ // There are multiple ports that match the profile port, too ambiguous, do
// not connect to any
weNeedToConnect = false;
- snackbarMessage += '\nMultiple available ports info match the profile port info. Not connecting to any.';
+ snackbarMessage += '\nMultiple available ports info match the profile port info (ambiguous). Not connecting to any.';
snackbarVariant = 'warning';
}
}
@@ -228,17 +257,15 @@ export class ProfileManager {
// Only disconnect if we have found a valid port to connect to
if (weNeedToConnect) {
if (this.app.portState === PortState.OPENED) {
- console.log('Closing port...');
- await this.app.closePort({silenceSnackbar: true});
+ await this.app.closePort({ silenceSnackbar: true });
} else if (this.app.portState === PortState.CLOSED_BUT_WILL_REOPEN) {
this.app.stopWaitingToReopenPort();
}
}
- console.log('Port closed.');
// Update the current app config from the provided profile,
// and then save this new app config
- this.currentAppConfig = JSON.parse(JSON.stringify(profile.rootConfig));
- this.saveAppConfig();
+ this.appData.currentAppConfig = JSON.parse(JSON.stringify(profile.rootConfig));
+ this.saveAppData();
// Need to tell the rest of the app to update
this._profileChangeCallbacks.forEach((callback) => {
@@ -249,10 +276,8 @@ export class ProfileManager {
// Now connect to the port if we need to
if (weNeedToConnect) {
- console.log('Setting selected port...', matchedAvailablePorts[0]);
this.app.setSelectedPort(matchedAvailablePorts[0]);
- console.log('Opening port...');
- await this.app.openPort({silenceSnackbar: true});
+ await this.app.openPort({ silenceSnackbar: true });
snackbarMessage += '\nConnected to port with info: "' + profileSerialPortInfoJson + '".';
}
@@ -264,15 +289,19 @@ export class ProfileManager {
* Save the current app config to the provided profile and the save the profiles to local storage.
* @param profileIdx The index of the profile to save the current app config to.
*/
- saveCurrentAppConfigToProfile = (profileIdx: number, noSnackbar=false) => {
- console.log("Saving current app config to profile...");
- const profile = this.profiles[profileIdx];
- profile.rootConfig = JSON.parse(JSON.stringify(this.currentAppConfig));
- this.saveProfiles();
+ saveCurrentAppConfigToProfile = (profileIdx: number, noSnackbar = false) => {
+ console.log('Saving current app config to profile...');
+ const profile = this.appData.profiles[profileIdx];
+ profile.rootConfig = JSON.parse(JSON.stringify(this.appData.currentAppConfig));
+ this.saveAppData();
+
+ // Although we are not loading a profile, saving the app state to a profile
+ // is essentially the same thing, so update the name (this is used in the app title)
+ this.lastAppliedProfileName = profile.name;
// Post message to snackbar
if (!noSnackbar) {
- this.app.snackbar.sendToSnackbar('Profile "' + profile.name + '" saved.', "success");
+ this.app.snackbar.sendToSnackbar('Profile "' + profile.name + '" saved.', 'success');
}
};
}
diff --git a/src/model/Settings/DisplaySettings/DisplaySettings.ts b/src/model/Settings/DisplaySettings/DisplaySettings.ts
index e9ff9606..888664cb 100644
--- a/src/model/Settings/DisplaySettings/DisplaySettings.ts
+++ b/src/model/Settings/DisplaySettings/DisplaySettings.ts
@@ -74,7 +74,7 @@ export default class DisplaySettings {
};
_saveConfig = () => {
- let config = this.profileManager.currentAppConfig.settings.displaySettings;
+ let config = this.profileManager.appData.currentAppConfig.settings.displaySettings;
config.charSizePx = this.charSizePx.appliedValue;
config.verticalRowPaddingPx = this.verticalRowPaddingPx.appliedValue;
@@ -82,11 +82,11 @@ export default class DisplaySettings {
config.scrollbackBufferSizeRows = this.scrollbackBufferSizeRows.appliedValue;
config.dataViewConfiguration = this.dataViewConfiguration;
- this.profileManager.saveAppConfig();
+ this.profileManager.saveAppData();
};
_loadConfig = () => {
- let configToLoad = this.profileManager.currentAppConfig.settings.displaySettings;
+ let configToLoad = this.profileManager.appData.currentAppConfig.settings.displaySettings;
//===============================================
// UPGRADE PATH
//===============================================
@@ -95,7 +95,7 @@ export default class DisplaySettings {
} else {
console.log(`Out-of-date config version ${configToLoad.version} found.` + ` Updating to version ${latestVersion}.`);
this._saveConfig();
- configToLoad = this.profileManager.currentAppConfig.settings.displaySettings;
+ configToLoad = this.profileManager.appData.currentAppConfig.settings.displaySettings;
}
this.charSizePx.setDispValue(configToLoad.charSizePx.toString());
diff --git a/src/model/Settings/GeneralSettings/GeneralSettings.ts b/src/model/Settings/GeneralSettings/GeneralSettings.ts
index 87149099..b0e54347 100644
--- a/src/model/Settings/GeneralSettings/GeneralSettings.ts
+++ b/src/model/Settings/GeneralSettings/GeneralSettings.ts
@@ -39,16 +39,16 @@ export default class RxSettings {
};
_saveConfig = () => {
- let config = this.profileManager.currentAppConfig.settings.generalSettings;
+ let config = this.profileManager.appData.currentAppConfig.settings.generalSettings;
config.whenPastingOnWindowsReplaceCRLFWithLF = this.whenPastingOnWindowsReplaceCRLFWithLF;
config.whenCopyingToClipboardDoNotAddLFIfRowWasCreatedDueToWrapping = this.whenCopyingToClipboardDoNotAddLFIfRowWasCreatedDueToWrapping;
- this.profileManager.saveAppConfig();
+ this.profileManager.saveAppData();
};
_loadConfig = () => {
- let configToLoad = this.profileManager.currentAppConfig.settings.generalSettings;
+ let configToLoad = this.profileManager.appData.currentAppConfig.settings.generalSettings;
//===============================================
// UPGRADE PATH
//===============================================
@@ -58,7 +58,7 @@ export default class RxSettings {
} else {
console.log(`Out-of-date config version ${configToLoad.version} found.` + ` Updating to version ${latestVersion}.`);
this._saveConfig();
- configToLoad = this.profileManager.currentAppConfig.settings.generalSettings;
+ configToLoad = this.profileManager.appData.currentAppConfig.settings.generalSettings;
}
this.whenPastingOnWindowsReplaceCRLFWithLF = configToLoad.whenPastingOnWindowsReplaceCRLFWithLF;
diff --git a/src/model/Settings/PortConfigurationSettings/PortConfigurationSettings.ts b/src/model/Settings/PortConfigurationSettings/PortConfigurationSettings.ts
index 861c88a4..4d8b7dd7 100644
--- a/src/model/Settings/PortConfigurationSettings/PortConfigurationSettings.ts
+++ b/src/model/Settings/PortConfigurationSettings/PortConfigurationSettings.ts
@@ -159,7 +159,7 @@ export default class PortConfiguration {
}
_loadConfig = () => {
- let configToLoad = this.profileManager.currentAppConfig.settings.portSettings
+ let configToLoad = this.profileManager.appData.currentAppConfig.settings.portSettings
//===============================================
// UPGRADE PATH
//===============================================
@@ -170,7 +170,7 @@ export default class PortConfiguration {
console.log(`Out-of-date config version ${configToLoad.version} found.` +
` Updating to version ${latestVersion}.`);
this._saveConfig();
- configToLoad = this.profileManager.currentAppConfig.settings.portSettings
+ configToLoad = this.profileManager.appData.currentAppConfig.settings.portSettings
}
// At this point we are confident that the deserialized config matches what
@@ -188,7 +188,7 @@ export default class PortConfiguration {
};
_saveConfig = () => {
- let config = this.profileManager.currentAppConfig.settings.portSettings;
+ let config = this.profileManager.appData.currentAppConfig.settings.portSettings;
config.baudRate = this.baudRate;
config.numDataBits = this.numDataBits;
@@ -199,7 +199,7 @@ export default class PortConfiguration {
config.resumeConnectionToLastSerialPortOnStartup = this.resumeConnectionToLastSerialPortOnStartup;
config.reopenSerialPortIfUnexpectedlyClosed = this.reopenSerialPortIfUnexpectedlyClosed;
- this.profileManager.saveAppConfig();
+ this.profileManager.saveAppData();
};
/**
diff --git a/src/model/Settings/ProfileSettings/ProfileSettings.ts b/src/model/Settings/ProfileSettings/ProfileSettings.ts
index 308a7c3a..52afccca 100644
--- a/src/model/Settings/ProfileSettings/ProfileSettings.ts
+++ b/src/model/Settings/ProfileSettings/ProfileSettings.ts
@@ -43,7 +43,7 @@ export default class ProfilesSettings {
// Nothing to do if no profile is selected
return;
}
- const selectedProfile = this.profileManager.profiles[this.selectedProfiles[0] as number];
+ const selectedProfile = this.profileManager.appData.profiles[this.selectedProfiles[0] as number];
if (selectedProfile.name === this.profileNameText) {
// The profile name hasn't changed so nothing to do
return;
@@ -51,7 +51,7 @@ export default class ProfilesSettings {
// If we get here profile name has changed
selectedProfile.name = this.profileNameText;
// Profile name has changed so save the profiles
- this.profileManager.saveProfiles();
+ this.profileManager.saveAppData();
}
setSelectedProfiles(selectedProfiles: GridRowSelectionModel) {
@@ -65,7 +65,7 @@ export default class ProfilesSettings {
// Whenever the selected profile changes, update the profile name field to match the selected profile
let name;
if (this.selectedProfiles.length === 1) {
- name = this.profileManager.profiles[this.selectedProfiles[0] as number].name;
+ name = this.profileManager.appData.profiles[this.selectedProfiles[0] as number].name;
} else {
name = '';
}
diff --git a/src/model/Settings/RxSettings/RxSettings.ts b/src/model/Settings/RxSettings/RxSettings.ts
index dc1f72eb..d5edfde6 100644
--- a/src/model/Settings/RxSettings/RxSettings.ts
+++ b/src/model/Settings/RxSettings/RxSettings.ts
@@ -126,6 +126,9 @@ export class RxSettingsConfig {
floatStringConversionMethod = FloatStringConversionMethod.TO_STRING;
floatNumOfDecimalPlaces = 5;
+ // OTHER SETTINGS
+ showWarningOnRxBreakSignal = true;
+
constructor() {
makeAutoObservable(this); // Make sure this is at the end of the constructor
}
@@ -183,6 +186,9 @@ export default class RxSettings {
floatStringConversionMethod = FloatStringConversionMethod.TO_STRING;
floatNumOfDecimalPlaces = new ApplyableNumberField("5", z.coerce.number().min(0).max(100).int());
+ // OTHER SETTINGS
+ showWarningOnRxBreakSignal = true;
+
constructor(profileManager: ProfileManager) {
this.profileManager = profileManager;
@@ -209,7 +215,7 @@ export default class RxSettings {
}
_loadConfig = () => {
- let configToLoad = this.profileManager.currentAppConfig.settings.rxSettings
+ let configToLoad = this.profileManager.appData.currentAppConfig.settings.rxSettings
//===============================================
// UPGRADE PATH
//===============================================
@@ -220,7 +226,7 @@ export default class RxSettings {
console.log(`Out-of-date config version ${configToLoad.version} found.` +
` Updating to version ${latestVersion}.`);
this._saveConfig();
- configToLoad = this.profileManager.currentAppConfig.settings.rxSettings
+ configToLoad = this.profileManager.appData.currentAppConfig.settings.rxSettings
}
/**
@@ -269,10 +275,13 @@ export default class RxSettings {
this.floatStringConversionMethod = configToLoad.floatStringConversionMethod;
this.floatNumOfDecimalPlaces.setDispValue(configToLoad.floatNumOfDecimalPlaces.toString());
this.floatNumOfDecimalPlaces.apply();
+
+ // OTHER SETTINGS
+ this.showWarningOnRxBreakSignal = configToLoad.showWarningOnRxBreakSignal;
};
_saveConfig = () => {
- let config = this.profileManager.currentAppConfig.settings.rxSettings;
+ let config = this.profileManager.appData.currentAppConfig.settings.rxSettings;
config.dataType = this.dataType;
// ASCII-SPECIFIC SETTINGS
@@ -306,7 +315,10 @@ export default class RxSettings {
config.floatStringConversionMethod = this.floatStringConversionMethod;
config.floatNumOfDecimalPlaces = this.floatNumOfDecimalPlaces.appliedValue;
- this.profileManager.saveAppConfig();
+ // OTHER SETTINGS
+ config.showWarningOnRxBreakSignal = this.showWarningOnRxBreakSignal;
+
+ this.profileManager.saveAppData();
};
setDataType = (value: DataType) => {
@@ -419,6 +431,11 @@ export default class RxSettings {
// OTHER
//=================================================================
+ setShowWarningOnRxBreakSignal = (value: boolean) => {
+ this.showWarningOnRxBreakSignal = value;
+ this._saveConfig();
+ };
+
/**
* Provides a descriptive name for the currently selected data type for the app
* to display in the toolbar.
diff --git a/src/model/Settings/TxSettings/TxSettings.ts b/src/model/Settings/TxSettings/TxSettings.ts
index 6ba7eb9d..d46cadc4 100644
--- a/src/model/Settings/TxSettings/TxSettings.ts
+++ b/src/model/Settings/TxSettings/TxSettings.ts
@@ -2,9 +2,10 @@ import { makeAutoObservable } from 'mobx';
import { ProfileManager } from 'src/model/ProfileManager/ProfileManager';
export enum EnterKeyPressBehavior {
- SEND_LF,
- SEND_CR,
- SEND_CRLF,
+ SEND_LF = 'Send LF',
+ SEND_CR = 'Send CR',
+ SEND_CRLF = 'Send CRLF',
+ SEND_BREAK = 'Send break', // Send the break signal (not a character)
}
export enum BackspaceKeyPressBehavior {
@@ -93,7 +94,7 @@ export default class DataProcessingSettings {
}
_loadConfig = () => {
- let configToLoad = this.profileManager.currentAppConfig.settings.txSettings;
+ let configToLoad = this.profileManager.appData.currentAppConfig.settings.txSettings;
//===============================================
// UPGRADE PATH
//===============================================
@@ -104,7 +105,7 @@ export default class DataProcessingSettings {
console.log(`Out-of-date config version ${configToLoad.version} found.` +
` Updating to version ${latestVersion}.`);
this._saveConfig();
- configToLoad = this.profileManager.currentAppConfig.settings.txSettings
+ configToLoad = this.profileManager.appData.currentAppConfig.settings.txSettings
}
this.enterKeyPressBehavior = configToLoad.enterKeyPressBehavior;
@@ -115,7 +116,7 @@ export default class DataProcessingSettings {
};
_saveConfig = () => {
- let config = this.profileManager.currentAppConfig.settings.txSettings;
+ let config = this.profileManager.appData.currentAppConfig.settings.txSettings;
config.enterKeyPressBehavior = this.enterKeyPressBehavior;
config.backspaceKeyPressBehavior = this.backspaceKeyPressBehavior;
@@ -123,7 +124,7 @@ export default class DataProcessingSettings {
config.send0x01Thru0x1AWhenCtrlAThruZPressed = this.send0x01Thru0x1AWhenCtrlAThruZPressed;
config.sendEscCharWhenAltKeyPressed = this.sendEscCharWhenAltKeyPressed;
- this.profileManager.saveAppConfig();
+ this.profileManager.saveAppData();
};
setEnterKeyPressBehavior = (value: EnterKeyPressBehavior) => {
diff --git a/src/model/Terminals/RightDrawer/Macros/Macro.spec.ts b/src/model/Terminals/RightDrawer/Macros/Macro.spec.ts
index dbb65a64..96a6ea38 100644
--- a/src/model/Terminals/RightDrawer/Macros/Macro.spec.ts
+++ b/src/model/Terminals/RightDrawer/Macros/Macro.spec.ts
@@ -1,82 +1,168 @@
import { expect, test, describe } from 'vitest';
-import { Macro, MacroDataType } from './Macro';
+import { Macro, MacroDataType, TxStepBreak, TxStepData } from './Macro';
describe('macro tests', () => {
test('basic ascii to bytes', () => {
let macro = new Macro('M1', () => '\n');
macro.setData('a');
- const bytes = macro.dataToBytes();
- expect(bytes).toStrictEqual(Uint8Array.from([97]));
+ macro.setSendOnEnterValueForEveryNewLineInTextBox(true);
+
+ const txSequence = macro.dataToTxSequence();
+ expect(txSequence.steps.length).toBe(1);
+ let step = txSequence.steps[0] as TxStepData;
+ expect(step).toBeInstanceOf(TxStepData);
+ expect(step.data).toStrictEqual(Uint8Array.from([97, 10]));
});
test('new line converted to \n', () => {
let macro = new Macro('M1', () => '\n');
macro.setData('a\nb');
- const bytes = macro.dataToBytes();
- expect(bytes).toStrictEqual(Uint8Array.from([97, 10, 98]));
+ macro.setSendOnEnterValueForEveryNewLineInTextBox(true);
+
+ const txSequence = macro.dataToTxSequence();
+ expect(txSequence.steps.length).toBe(1);
+ let step = txSequence.steps[0] as TxStepData;
+ expect(step).toBeInstanceOf(TxStepData);
+ expect(step.data).toStrictEqual(Uint8Array.from([97, 10, 98, 10]));
});
test('new line converted to \r\n', () => {
let macro = new Macro('M1', () => '\r\n');
macro.setData('a\nb');
- const bytes = macro.dataToBytes();
- expect(bytes).toStrictEqual(Uint8Array.from([97, 13, 10, 98]));
+ macro.setSendOnEnterValueForEveryNewLineInTextBox(true);
+
+ const txSequence = macro.dataToTxSequence();
+ expect(txSequence.steps.length).toBe(1);
+ let step = txSequence.steps[0] as TxStepData;
+ expect(step).toBeInstanceOf(TxStepData);
+ expect(step.data).toStrictEqual(Uint8Array.from([97, 13, 10, 98, 13, 10]));
});
test('new line converted to \r', () => {
let macro = new Macro('M1', () => '\r');
macro.setData('a\nb');
- const bytes = macro.dataToBytes();
- expect(bytes).toStrictEqual(Uint8Array.from([97, 13, 98]));
+ macro.setSendOnEnterValueForEveryNewLineInTextBox(true);
+
+ const txSequence = macro.dataToTxSequence();
+ expect(txSequence.steps.length).toBe(1);
+ let step = txSequence.steps[0] as TxStepData;
+ expect(step).toBeInstanceOf(TxStepData);
+ expect(step.data).toStrictEqual(Uint8Array.from([97, 13, 98, 13]));
});
test('basic hex', () => {
let macro = new Macro('M1', () => '\n');
macro.setDataType(MacroDataType.HEX);
macro.setData('00');
- const bytes = macro.dataToBytes();
- expect(bytes).toStrictEqual(Uint8Array.from([0]));
+
+ const txSequence = macro.dataToTxSequence();
+ expect(txSequence.steps.length).toBe(1);
+ let step = txSequence.steps[0] as TxStepData;
+ expect(step).toBeInstanceOf(TxStepData);
+ expect(step.data).toStrictEqual(Uint8Array.from([0]));
});
test('two bytes of hex', () => {
let macro = new Macro('M1', () => '\n');
macro.setDataType(MacroDataType.HEX);
macro.setData('0001');
- const bytes = macro.dataToBytes();
- expect(bytes).toStrictEqual(Uint8Array.from([0, 1]));
+
+ const txSequence = macro.dataToTxSequence();
+ expect(txSequence.steps.length).toBe(1);
+ let step = txSequence.steps[0] as TxStepData;
+ expect(step).toBeInstanceOf(TxStepData);
+ expect(step.data).toStrictEqual(Uint8Array.from([0, 1]));
});
test('two bytes of hex with space', () => {
let macro = new Macro('M1', () => '\n');
macro.setDataType(MacroDataType.HEX);
macro.setData('00 01');
- const bytes = macro.dataToBytes();
- expect(bytes).toStrictEqual(Uint8Array.from([0, 1]));
+
+ const txSequence = macro.dataToTxSequence();
+ expect(txSequence.steps.length).toBe(1);
+ let step = txSequence.steps[0] as TxStepData;
+ expect(step).toBeInstanceOf(TxStepData);
+ expect(step.data).toStrictEqual(Uint8Array.from([0, 1]));
});
test('two bytes of hex with new lines', () => {
let macro = new Macro('M1', () => '\n');
macro.setDataType(MacroDataType.HEX);
macro.setData('00\n01');
- const bytes = macro.dataToBytes();
- expect(bytes).toStrictEqual(Uint8Array.from([0, 1]));
+
+ const txSequence = macro.dataToTxSequence();
+ expect(txSequence.steps.length).toBe(1);
+ let step = txSequence.steps[0] as TxStepData;
+ expect(step).toBeInstanceOf(TxStepData);
+ expect(step.data).toStrictEqual(Uint8Array.from([0, 1]));
});
test('make sure odd number of hex chars throws error', () => {
let macro = new Macro('M1', () => '\n');
macro.setDataType(MacroDataType.HEX);
macro.setData('abc');
- expect(() => macro.dataToBytes()).toThrowError();
+
+ expect(() => macro.dataToTxSequence()).toThrowError();
});
test('complicated hex works', () => {
let macro = new Macro('M1', () => '\n');
macro.setDataType(MacroDataType.HEX);
macro.setData('00 ff AB 32\n 689\n1');
- const bytes = macro.dataToBytes();
- expect(bytes).toStrictEqual(Uint8Array.from([0x00, 0xFF, 0xAB, 0x32, 0x68, 0x91]));
+
+ const txSequence = macro.dataToTxSequence();
+ expect(txSequence.steps.length).toBe(1);
+ let step = txSequence.steps[0] as TxStepData;
+ expect(step).toBeInstanceOf(TxStepData);
+ expect(step.data).toStrictEqual(Uint8Array.from([0x00, 0xFF, 0xAB, 0x32, 0x68, 0x91]));
+ });
+
+ test('send break for hex works with 2 lines', () => {
+ let macro = new Macro('M1', () => '\n');
+ macro.setDataType(MacroDataType.HEX);
+ macro.setData('00\n01');
+ macro.setSendBreakAtEndOfEveryLineOfHex(true);
+
+ const txSequence = macro.dataToTxSequence();
+ expect(txSequence.steps.length).toBe(4);
+
+ // Step 1
+ {
+ let step = txSequence.steps[0] as TxStepData;
+ expect(step).toBeInstanceOf(TxStepData);
+ expect(step.data).toStrictEqual(Uint8Array.from([0x00]));
+ }
+
+ // Step 2
+ {
+ let step = txSequence.steps[1] as TxStepBreak;
+ expect(step).toBeInstanceOf(TxStepBreak);
+ }
+
+ // Step 3
+ {
+ let step = txSequence.steps[2] as TxStepData;
+ expect(step).toBeInstanceOf(TxStepData);
+ expect(step.data).toStrictEqual(Uint8Array.from([0x01]));
+ }
+
+ // Step 4
+ {
+ let step = txSequence.steps[3] as TxStepBreak;
+ expect(step).toBeInstanceOf(TxStepBreak);
+ }
+ });
+
+ test('send break and hex throws error if any line is not valid hex', () => {
+ let macro = new Macro('M1', () => '\n');
+ macro.setDataType(MacroDataType.HEX);
+ macro.setData('00\n0\n02'); // Forget the 1 in the 2nd line
+ macro.setSendBreakAtEndOfEveryLineOfHex(true);
+
+ expect(() => macro.dataToTxSequence()).toThrowError();
});
test('toConfig() and fromConfig() work', () => {
diff --git a/src/model/Terminals/RightDrawer/Macros/Macro.ts b/src/model/Terminals/RightDrawer/Macros/Macro.ts
index 71361c89..1726619a 100644
--- a/src/model/Terminals/RightDrawer/Macros/Macro.ts
+++ b/src/model/Terminals/RightDrawer/Macros/Macro.ts
@@ -12,7 +12,24 @@ export class MacroConfig {
dataType = MacroDataType.ASCII;
data = '';
processEscapeChars = true;
- sendOnEnterValueForEveryNewLineInTextBox = true;
+ sendOnEnterValueForEveryNewLineInTextBox = false;
+ sendBreakAtEndOfEveryLineOfHex = false;
+}
+
+export class TxStepData {
+ data: Uint8Array;
+
+ constructor(data: Uint8Array) {
+ this.data = data;
+ }
+}
+
+export class TxStepBreak {
+
+}
+
+export class TxSequence {
+ steps: (TxStepData | TxStepBreak)[] = [];
}
export class Macro {
@@ -24,10 +41,15 @@ export class Macro {
processEscapeChars: boolean = true;
- sendOnEnterValueForEveryNewLineInTextBox: boolean = true;
+ sendOnEnterValueForEveryNewLineInTextBox: boolean = false;
+
+ sendBreakAtEndOfEveryLineOfHex: boolean = false;
errorMsg: string = '';
+ /**
+ * Callback function which is passed to the constructor.
+ */
getNewLineReplacementStr: () => string;
onChange: (() => void) | null;
@@ -62,7 +84,7 @@ export class Macro {
try {
// TODO: Fix hardcoded \n
- this.dataToBytes();
+ this.dataToTxSequence();
this.errorMsg = '';
} catch (e) {
if (e instanceof Error) {
@@ -89,8 +111,8 @@ export class Macro {
* @param newLineReplacementChar Ignored if the data type is HEX. If the data type is ASCII, this string will replace all instances of LF in the data.
* @returns The Uint8Array representation of the data.
*/
- dataToBytes = (): Uint8Array => {
- let bytes;
+ dataToTxSequence = (): TxSequence => {
+ let txSequence = new TxSequence();
if (this.dataType === MacroDataType.ASCII) {
// Replace all instances of LF with the newLinesChar
// NOTE: This has to be done before JSON.parse() is called below, otherwise the LF that
@@ -103,11 +125,7 @@ export class Macro {
// Loop through each line
let processedStr = '';
for (let i = 0; i < lines.length; i++) {
- // If we are sending the "on enter" sequence for every new line in the text box, then we need to replace
- // all new lines with the newLineReplacementChar
- if (i !== 0 && this.sendOnEnterValueForEveryNewLineInTextBox) {
- processedStr += this.getNewLineReplacementStr();
- }
+
// Add the line, parsing as JSON if asked for
// This will convert all literal "\r" and "\n" to actual CR and LF characters
// (among others like \t).
@@ -121,35 +139,65 @@ export class Macro {
} else {
processedStr += lines[i];
}
+
+ // Check if we are sending the "on enter" sequence at the end of every line in the text
+ // and add it if needed
+ if (this.sendOnEnterValueForEveryNewLineInTextBox) {
+ processedStr += this.getNewLineReplacementStr();
+ }
}
// Convert to Uint8Array
- bytes = stringToUint8Array(processedStr);
+ let txStepData = new TxStepData(stringToUint8Array(processedStr));
+ txSequence.steps.push(txStepData);
} else if (this.dataType === MacroDataType.HEX) {
- // Remove all spaces and new lines
- let str = this.data;
- str = str.replace(/ /g, '');
- str = str.replace(/\n/g, '');
-
- if (str.length === 0) {
- throw new Error("Hex string is empty.");
+ // If "sendEnterValueForEveryNewLineInTextBox" is true, then we need to parse the hex
+ // per line
+ let linesOfHex;
+ if (this.sendBreakAtEndOfEveryLineOfHex) {
+ // Split the string into lines, since we need to send break signals
+ // between each line
+ linesOfHex = this.data.split('\n');
+ } else {
+ // Treat the entire string as one hex string since no
+ // break signals are needed
+ linesOfHex = [this.data];
}
- if (str.length % 2 !== 0) {
- throw new Error("Hex string must have an even number of characters.");
- }
+ for (let i = 0; i < linesOfHex.length; i++) {
+ // Remove all spaces and new lines. If break signals at the end of every line
+ // is disabled, there might be new lines here, and we just ignore them along
+ // with all spaces.
+ let str = linesOfHex[i];
+ str = str.replace(/ /g, '');
+ str = str.replace(/\n/g, '');
- if (/[^a-fA-F0-9]/u.test(str)) {
- throw new Error("Hex string must only contain: the numbers 0-9 and A-F (or a-f).");
- }
+ if (str.length === 0) {
+ throw new Error("Hex string is empty.");
+ }
+
+ if (str.length % 2 !== 0) {
+ throw new Error("Hex string must have an even number of characters.");
+ }
+
+ if (/[^a-fA-F0-9]/u.test(str)) {
+ throw new Error("Hex string must only contain: the numbers 0-9 and A-F (or a-f).");
+ }
- // Convert hex string to Uint8Array
- bytes = this._hexStringToUint8Array(str);
+ // Convert hex string to Uint8Array
+ let txStepData = new TxStepData(this._hexStringToUint8Array(str));
+ txSequence.steps.push(txStepData);
+
+ if (this.sendBreakAtEndOfEveryLineOfHex) {
+ // Add a break signal
+ txSequence.steps.push(new TxStepBreak());
+ }
+ }
} else {
throw new Error("Invalid data type");
}
- return bytes;
+ return txSequence;
}
/**
@@ -182,6 +230,7 @@ export class Macro {
this.dataType = config.dataType;
this.processEscapeChars = config.processEscapeChars;
this.sendOnEnterValueForEveryNewLineInTextBox = config.sendOnEnterValueForEveryNewLineInTextBox;
+ this.sendBreakAtEndOfEveryLineOfHex = config.sendBreakAtEndOfEveryLineOfHex
}
toConfig = (): MacroConfig => {
@@ -192,6 +241,7 @@ export class Macro {
dataType: this.dataType,
processEscapeChars: this.processEscapeChars,
sendOnEnterValueForEveryNewLineInTextBox: this.sendOnEnterValueForEveryNewLineInTextBox,
+ sendBreakAtEndOfEveryLineOfHex: this.sendBreakAtEndOfEveryLineOfHex,
};
}
@@ -215,4 +265,14 @@ export class Macro {
this.onChange();
}
}
+
+ setSendBreakAtEndOfEveryLineOfHex(allow: boolean) {
+ this.sendBreakAtEndOfEveryLineOfHex = allow;
+ // This could change the validation status, need to
+ // re-validate
+ this.validateData();
+ if (this.onChange) {
+ this.onChange();
+ }
+ }
}
diff --git a/src/model/Terminals/RightDrawer/Macros/MacroController.ts b/src/model/Terminals/RightDrawer/Macros/MacroController.ts
index d8ba0c4d..8552f042 100644
--- a/src/model/Terminals/RightDrawer/Macros/MacroController.ts
+++ b/src/model/Terminals/RightDrawer/Macros/MacroController.ts
@@ -1,7 +1,7 @@
import { makeAutoObservable } from "mobx";
import { App } from "src/model/App";
-import { Macro, MacroConfig, MacroDataType } from "./Macro";
+import { Macro, MacroConfig, MacroDataType, TxStepBreak, TxStepData } from "./Macro";
import { EnterKeyPressBehavior } from "src/model/Settings/TxSettings/TxSettings";
const NUM_MACROS = 8;
@@ -96,28 +96,35 @@ export class MacroController {
* Send the provided macro data to the serial port.
* @param macro The macro to send.
*/
- send(macro: Macro) {
+ send = async (macro: Macro) => {
// Send the data to the serial port
// If the user presses enter in the multiline text field, it will add a newline character
// (0x0A or 10) to the string.
- let outputData;
- outputData = macro.dataToBytes();
- this.app.writeBytesToSerialPort(outputData);
+ const outputData = macro.dataToTxSequence();
+ for (let i = 0; i < outputData.steps.length; i++) {
+ // Determine type of item in array. If data, write to port. If break, send a break.
+ const currStep = outputData.steps[i];
+ if (currStep instanceof TxStepData) {
+ this.app.writeBytesToSerialPort(currStep.data);
+ } else if (currStep instanceof TxStepBreak) {
+ await this.app.sendBreakSignal();
+ }
+ }
}
_saveConfig = () => {
- let config = this.app.profileManager.currentAppConfig.terminal.macroController;
+ let config = this.app.profileManager.appData.currentAppConfig.terminal.macroController;
config.macroConfigs = this.macrosArray.map((macro) => {
return macro.toConfig();
});
- this.app.profileManager.saveAppConfig();
+ this.app.profileManager.saveAppData();
};
_loadConfig() {
- let configToLoad = this.app.profileManager.currentAppConfig.terminal.macroController;
+ let configToLoad = this.app.profileManager.appData.currentAppConfig.terminal.macroController;
//===============================================
// UPGRADE PATH
@@ -129,7 +136,7 @@ export class MacroController {
console.log(`Out-of-date config version ${configToLoad.version} found.` +
` Updating to version ${latestVersion}.`);
this._saveConfig();
- configToLoad = this.app.profileManager.currentAppConfig.terminal.macroController;
+ configToLoad = this.app.profileManager.appData.currentAppConfig.terminal.macroController;
}
// If we get here we loaded a valid config. Apply config.
diff --git a/src/model/Terminals/RightDrawer/RightDrawer.ts b/src/model/Terminals/RightDrawer/RightDrawer.ts
index 9ca70c70..a358a4ea 100644
--- a/src/model/Terminals/RightDrawer/RightDrawer.ts
+++ b/src/model/Terminals/RightDrawer/RightDrawer.ts
@@ -1,15 +1,100 @@
import { makeAutoObservable } from 'mobx';
import { MacroController } from './Macros/MacroController';
import { App } from 'src/model/App';
+import { ProfileManager } from 'src/model/ProfileManager/ProfileManager';
+
+export class RightDrawerConfig {
+ /**
+ * Increment this version number if you need to update this data in this class.
+ * This will cause the app to ignore whatever is in local storage and use the defaults,
+ * updating to this new version.
+ */
+ version = 1;
+
+ showRightDrawer = true;
+
+ rightDrawerWidth_px = 400;
+
+ /**
+ * Expand the quick port settings and macro accordions by default.
+ */
+ quickPortSettingsIsExpanded = true;
+ otherQuickSettingsIsExpanded = false;
+ macrosIsExpanded = true;
+}
export default class RightDrawer {
+ profileManager: ProfileManager;
macroController: MacroController;
+ drawerWidth_px = 400;
+
+ quickPortSettingsIsExpanded = false;
+ otherQuickSettingsIsExpanded = false;
+ macrosIsExpanded = false;
+
constructor(app: App) {
+ this.profileManager = app.profileManager;
this.macroController = new MacroController(app);
+ this._loadConfig();
+ this.profileManager.registerOnProfileLoad(() => {
+ this._loadConfig();
+ });
makeAutoObservable(this); // Make sure this near the end
}
+
+ handleQuickPortSettingsAccordionChange = (event: React.SyntheticEvent, isExpanded: boolean) => {
+ this.quickPortSettingsIsExpanded = isExpanded;
+ this._saveConfig();
+ };
+
+ handleOtherQuickSettingsAccordionChange = (event: React.SyntheticEvent, isExpanded: boolean) => {
+ this.otherQuickSettingsIsExpanded = isExpanded;
+ this._saveConfig();
+ };
+
+ handleMacrosAccordionChange = (event: React.SyntheticEvent, isExpanded: boolean) => {
+ this.macrosIsExpanded = isExpanded;
+ this._saveConfig();
+ };
+
+ _saveConfig = () => {
+ let config = this.profileManager.appData.currentAppConfig.terminal.rightDrawer;
+
+ config.rightDrawerWidth_px = this.drawerWidth_px;
+
+ config.quickPortSettingsIsExpanded = this.quickPortSettingsIsExpanded;
+ config.otherQuickSettingsIsExpanded = this.otherQuickSettingsIsExpanded;
+ config.macrosIsExpanded = this.macrosIsExpanded;
+
+ this.profileManager.saveAppData();
+ };
+
+ _loadConfig = () => {
+ let configToLoad = this.profileManager.appData.currentAppConfig.terminal.rightDrawer;
+ //===============================================
+ // UPGRADE PATH
+ //===============================================
+ const latestVersion = new RightDrawerConfig().version;
+ if (configToLoad.version === latestVersion) {
+ // Do nothing
+ } else {
+ console.log(`Out-of-date config version ${configToLoad.version} found.` + ` Updating to version ${latestVersion}.`);
+ this._saveConfig();
+ configToLoad = this.profileManager.appData.currentAppConfig.terminal.rightDrawer;
+ }
+
+ this.drawerWidth_px = configToLoad.rightDrawerWidth_px;
+ this.quickPortSettingsIsExpanded = configToLoad.quickPortSettingsIsExpanded;
+ this.otherQuickSettingsIsExpanded = configToLoad.otherQuickSettingsIsExpanded;
+ this.macrosIsExpanded = configToLoad.macrosIsExpanded
+ };
+
+ setDrawerWidth(width: number) {
+ this.drawerWidth_px = width;
+ this._saveConfig();
+ }
}
diff --git a/src/model/Terminals/Terminals.ts b/src/model/Terminals/Terminals.ts
index efed3529..e0746025 100644
--- a/src/model/Terminals/Terminals.ts
+++ b/src/model/Terminals/Terminals.ts
@@ -8,6 +8,8 @@ import RightDrawer from './RightDrawer/RightDrawer';
export default class Terminals {
+ app: App;
+
txRxTerminal: SingleTerminal;
rxTerminal: SingleTerminal;
@@ -21,6 +23,8 @@ export default class Terminals {
showRightDrawer = true;
constructor(app: App) {
+ this.app = app;
+
this.txRxTerminal = new SingleTerminal('tx-rx-terminal', true, app.settings.rxSettings, app.settings.displaySettings, app.handleTerminalKeyDown);
this.rxTerminal = new SingleTerminal('rx-terminal', false, app.settings.rxSettings, app.settings.displaySettings, app.handleTerminalKeyDown); // Not focusable
this.txTerminal = new SingleTerminal('tx-terminal', true, app.settings.rxSettings, app.settings.displaySettings, app.handleTerminalKeyDown);
@@ -29,6 +33,11 @@ export default class Terminals {
this.filterText = new ApplyableTextField('', z.string());
this.filterText.setOnApplyChanged(this.onFilterTextApply);
+ this._loadConfig();
+ this.app.profileManager.registerOnProfileLoad(() => {
+ this._loadConfig();
+ });
+
makeAutoObservable(this); // Make sure this near the end
}
@@ -43,5 +52,17 @@ export default class Terminals {
setShowRightDrawer(show: boolean) {
this.showRightDrawer = show;
+ this._saveConfig();
}
+
+ _saveConfig = () => {
+ let config = this.app.profileManager.appData.currentAppConfig.terminal.rightDrawer;
+ config.showRightDrawer = this.showRightDrawer;
+ this.app.profileManager.saveAppData();
+ };
+
+ _loadConfig = () => {
+ let configToLoad = this.app.profileManager.appData.currentAppConfig.terminal.rightDrawer;
+ this.showRightDrawer = configToLoad.showRightDrawer;
+ };
}
diff --git a/src/view/AppView.module.css b/src/view/AppView.module.css
index 9dfb69c2..144425fc 100644
--- a/src/view/AppView.module.css
+++ b/src/view/AppView.module.css
@@ -44,3 +44,8 @@
10% { background-color: var(--blue-bright-color); box-shadow: rgba(0, 0, 0, 0.2) 0 -1px 7px 1px, inset var(--blue-idle-color) 0 -1px 9px, var(--blue-idle-color) 0 2px 0; }
to { background-color: var(--blue-idle-color); }
}
+
+.onHover:hover {
+ cursor: pointer;
+ background-color: #404040;
+}
diff --git a/src/view/AppView.tsx b/src/view/AppView.tsx
index ec702d56..e189677a 100644
--- a/src/view/AppView.tsx
+++ b/src/view/AppView.tsx
@@ -30,6 +30,7 @@ import LoggingView from './Logging/LoggingView';
import { SelectionController, SelectionInfo } from '../model/SelectionController/SelectionController';
import 'src/model/WindowTypes';
import { DataType } from 'src/model/Settings/RxSettings/RxSettings';
+import { SettingsCategories } from 'src/model/Settings/Settings';
// Create dark theme for MUI
const darkTheme = createTheme({
@@ -284,13 +285,39 @@ const AppView = observer((props: Props) => {
}}
>
{/* DATA TYPE */}
- {app.settings.rxSettings.getDataTypeNameForToolbarDisplay()}
+ {
+ // Go to Settings -> RX Settings where the user can change the data type
+ app.setShownMainPane(MainPanes.SETTINGS);
+ app.settings.setActiveSettingsCategory(SettingsCategories.RX_SETTINGS);
+ }}
+ style={{ padding: '0 10px' }}
+ >
+ {app.settings.rxSettings.getDataTypeNameForToolbarDisplay()}
+
{/* LOGGING ON/OFF */}
- {app.logging.isLogging ? 'Logging ON' : 'Logging OFF'}
+ {
+ app.setShownMainPane(MainPanes.LOGGING);
+ }}
+ style={{ backgroundColor: app.logging.isLogging ? '#388e3c' : '', padding: '0 10px' }}
+ >
+ {app.logging.isLogging ? 'Logging ON' : 'Logging OFF'}
+
{/* GRAPHING ON/OFF */}
- {app.graphing.graphingEnabled ? 'Graphing ON' : 'Graphing OFF'}
+ {
+ app.setShownMainPane(MainPanes.GRAPHING);
+ }}
+ style={{ backgroundColor: app.graphing.graphingEnabled ? '#388e3c' : '', padding: '0 10px' }}
+ >
+ {app.graphing.graphingEnabled ? 'Graphing ON' : 'Graphing OFF'}
+
{/* TX/RX ACTIVITY INDICATORS */}
{/* Use the key prop here to make React consider this a new element everytime the number of bytes changes. This will re-trigger the flashing animation as desired. Wrap each indicator in another box, so that the keys don't collide (because they might be the same). */}
@@ -304,11 +331,26 @@ const AppView = observer((props: Props) => {
RX
+
{/* PORT CONFIG */}
{/* Show port configuration in short hand, e.g. "115200 8n1" */}
- {app.settings.portConfiguration.shortSerialConfigName}
+ {
+ app.setShownMainPane(MainPanes.SETTINGS);
+ app.settings.setActiveSettingsCategory(SettingsCategories.PORT_CONFIGURATION);
+ }}
+ style={{ width: '100px', padding: '0 10px' }}
+ >
+ {app.settings.portConfiguration.shortSerialConfigName}
+
+
{/* PORT STATE */}
- {portStateToToolbarStatusProperties[app.portState].text}
+
+ {portStateToToolbarStatusProperties[app.portState].text}
+
diff --git a/src/view/Settings/ProfileSettings/ProfileSettingsView.tsx b/src/view/Settings/ProfileSettings/ProfileSettingsView.tsx
index 750982e6..28bc21fd 100644
--- a/src/view/Settings/ProfileSettings/ProfileSettingsView.tsx
+++ b/src/view/Settings/ProfileSettings/ProfileSettingsView.tsx
@@ -19,7 +19,7 @@ interface Props {
function ProfileSettingsView(props: Props) {
const { profileManager, profilesSettings } = props;
- const profiles = profileManager.profiles;
+ const profiles = profileManager.appData.profiles;
// Define the columns of the profiles table
const columns: GridColDef[] = [
@@ -94,49 +94,55 @@ function ProfileSettingsView(props: Props) {
enterDelay={500}
arrow
>
-