config-editor-base 2.9.4 → 2.9.6

package/README.md

@@ -145,7 +145,86 @@ The config editor also supports various S3 calls, e.g. for loading Rule Schema a
 
 The config editor relies on styling from the parent application. For examples of styling, see the CANedge configuration editor.
 
---- 
+---
+
+## Editor Base Tools
+
+The module includes built-in tools for OBD configuration and filter building. These are exported as `OBDTool` and `FilterBuilderTool`.
+
+### OBD Tool
+
+Generates OBD-II transmit lists for CANedge devices. Key features:
+- **PID Selection**: Select standard OBD-II PIDs from a built-in database
+- **Supported PIDs Parser**: Parse response data to identify vehicle-supported PIDs
+- **Control Signal**: Optional GPS-based speed control signal to prevent battery drain when vehicle is off
+- **Transmit List Generation**: Outputs partial JSON for merging with device configuration
+
+```jsx
+import { OBDTool } from "config-editor-base";
+
+// In editorTools array:
+{
+  name: "obd-modal",
+  comment: "OBD tool",
+  class: "fa fa-car",
+  modal: <OBDTool showAlert={this.props.showAlert} />
+}
+```
+
+### Filter Builder Tool
+
+Analyzes CSV log files to help users create optimized CAN filters. Key features:
+- **CSV Analysis**: Load mdf2csv output to see CAN ID distribution by size contribution
+- **DBC Matching**: Match CAN IDs to DBC message names and signals
+- **J1939 PGN Grouping**: Group 29-bit IDs by PGN for J1939/ISOBUS protocols
+- **Filter Generation**: Generate acceptance filters with optional prescalers
+- **Reset Filters**: Reset CAN channel filters to defaults (record everything)
+
+```jsx
+import { FilterBuilderTool } from "config-editor-base";
+
+// In editorTools array:
+{
+  name: "filter-builder-modal",
+  comment: "Filter builder",
+  class: "fa fa-sliders",
+  modal: <FilterBuilderTool showAlert={this.props.showAlert} deviceType="CANedge" />
+}
+```
+
+The `deviceType` prop controls device-specific behavior:
+- `"CANedge"` or `"CANedge2 GNSS"`: Standard CANedge filter structure
+- `"CANmod"`: CANmod.router filter structure (requires `frame_format` field)
+
+### Updating for New Firmware Revisions
+
+When a new firmware revision is released (e.g., CANedge 01.10.XX), update these files:
+
+#### 1. Supported Firmware Versions (`FilterBuilderTool.js`)
+```javascript
+// Add new version to the supported arrays at top of file:
+const SUPPORTED_FIRMWARE_CANEDGE = ["01.08", "01.09", "01.10"];  // Add here
+const SUPPORTED_FIRMWARE_CANMOD_ROUTER = ["01.02"];
+```
+
+#### 2. Default Filter Configs (`src/editorBaseTools/filterBuilder/`)
+If the filter schema changes, create new default filter JSON files:
+- `canedge-default-filters-XX.YY.json`
+- `canedge-default-filters-gps-XX.YY.json`
+- `canmod-router-default-filters-XX.YY.json`
+
+Then update imports in `FilterBuilderTool.js` if structure changes.
+
+#### 3. Control Signal Config (`src/editorBaseTools/obd/`)
+If the control signal schema changes:
+- Create `control-signal-internal-gps-XX.YY.json`
+- Update import in `OBDTool.js`
+
+#### 4. Schema Files (`dist/schema/`)
+Add new schema and uischema files to the appropriate folders and update `schemaAry`/`uiSchemaAry` in `Editor.js`.
+
+---
+
 ## Regarding JSON Schema files 
 
 The module expects to find JSON Schema files in the structure below to facilitate auto-loading of these:

package/dist/index.js

@@ -22309,7 +22309,8 @@ var OBDTool = /*#__PURE__*/function (_React$Component) {
   _proto.onMerge = function onMerge() {
     var _this$state5 = this.state,
       combinedConfig = _this$state5.combinedConfig,
-      mergedConfigValid = _this$state5.mergedConfigValid;
+      mergedConfigValid = _this$state5.mergedConfigValid,
+      enableControlSignal = _this$state5.enableControlSignal;
     var formData = this.props.formData;
     if (mergedConfigValid !== true) {
       this.props.showAlert("warning", "Cannot merge - the combined configuration is invalid. Check console for details.");
@@ -22327,10 +22328,19 @@ var OBDTool = /*#__PURE__*/function (_React$Component) {
     });
     this.props.setConfigContent(freshMergedConfig);
     this.props.setUpdatedFormData(freshMergedConfig);
-    this.props.showAlert("success", "Merged OBD transmit list with Configuration File");
+    if (!enableControlSignal) {
+      this.props.showAlert("warning", "Merged OBD transmit list with Configuration File. Important: If your CANedge transmits data while the vehicle ignition is off it can drain the vehicle battery. Use a control signal to start/stop transmission or ensure the device powers off with the ignition (e.g. by changing the installation setup or manually disconnecting the device).");
+    } else {
+      this.props.showAlert("success", "Merged OBD transmit list with Configuration File");
+    }
   };
   _proto.onDownload = function onDownload() {
-    var generatedConfig = this.state.generatedConfig;
+    var _this$state6 = this.state,
+      generatedConfig = _this$state6.generatedConfig,
+      enableControlSignal = _this$state6.enableControlSignal;
+    if (!enableControlSignal) {
+      this.props.showAlert("warning", "Important: If your CANedge transmits data while the vehicle ignition is off it can drain the vehicle battery. Use a control signal to start/stop transmission or ensure the device powers off with the ignition (e.g. by changing the installation setup or manually disconnecting the device).");
+    }
     var dataStr = JSON.stringify(generatedConfig, null, 2);
     var dataUri = 'data:application/json;charset=utf-8,' + encodeURIComponent(dataStr);
     var exportFileDefaultName = 'obd-transmit-list.json';
@@ -22341,23 +22351,23 @@ var OBDTool = /*#__PURE__*/function (_React$Component) {
   };
   _proto.render = function render() {
     var _this9 = this;
-    var _this$state6 = this.state,
-      toolMode = _this$state6.toolMode,
-      channel = _this$state6.channel,
-      bitRate = _this$state6.bitRate,
-      canId = _this$state6.canId,
-      obdMode = _this$state6.obdMode,
-      spacing = _this$state6.spacing,
-      searchQuery = _this$state6.searchQuery,
-      supportedPids = _this$state6.supportedPids,
-      generatedConfig = _this$state6.generatedConfig,
-      mergedConfigValid = _this$state6.mergedConfigValid,
-      csvFileName = _this$state6.csvFileName,
-      mixedWarning = _this$state6.mixedWarning,
-      showPreview = _this$state6.showPreview,
-      enableControlSignal = _this$state6.enableControlSignal,
-      enableOBDFilter = _this$state6.enableOBDFilter,
-      combinedConfig = _this$state6.combinedConfig;
+    var _this$state7 = this.state,
+      toolMode = _this$state7.toolMode,
+      channel = _this$state7.channel,
+      bitRate = _this$state7.bitRate,
+      canId = _this$state7.canId,
+      obdMode = _this$state7.obdMode,
+      spacing = _this$state7.spacing,
+      searchQuery = _this$state7.searchQuery,
+      supportedPids = _this$state7.supportedPids,
+      generatedConfig = _this$state7.generatedConfig,
+      mergedConfigValid = _this$state7.mergedConfigValid,
+      csvFileName = _this$state7.csvFileName,
+      mixedWarning = _this$state7.mixedWarning,
+      showPreview = _this$state7.showPreview,
+      enableControlSignal = _this$state7.enableControlSignal,
+      enableOBDFilter = _this$state7.enableOBDFilter,
+      combinedConfig = _this$state7.combinedConfig;
     var _this$props = this.props,
       formData = _this$props.formData,
       editorConfigFiles = _this$props.editorConfigFiles;
@@ -23120,6 +23130,392 @@ function evaluateFilters(frames, configData, detectedDeviceType) {
   };
 }
 
+var can_internal$1 = {
+	filter: {
+		id: [
+			{
+				name: "Heartbeat",
+				state: 0,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "2",
+				f2: "2",
+				prescaler_type: 0
+			},
+			{
+				name: "TimeCalendar",
+				state: 0,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "3",
+				f2: "3",
+				prescaler_type: 0
+			},
+			{
+				name: "TimeExternal",
+				state: 0,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "5",
+				f2: "5",
+				prescaler_type: 0
+			}
+		]
+	}
+};
+var can_1$2 = {
+	filter: {
+		remote_frames: 0,
+		id: [
+			{
+				name: "AllStandardID",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "0",
+				f2: "7FF",
+				prescaler_type: 0
+			},
+			{
+				name: "AllExtendedID",
+				state: 1,
+				type: 0,
+				id_format: 1,
+				method: 0,
+				f1: "0",
+				f2: "1FFFFFFF",
+				prescaler_type: 0
+			}
+		]
+	}
+};
+var can_2$1 = {
+	filter: {
+		remote_frames: 0,
+		id: [
+			{
+				name: "AllStandardID",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "0",
+				f2: "7FF",
+				prescaler_type: 0
+			},
+			{
+				name: "AllExtendedID",
+				state: 1,
+				type: 0,
+				id_format: 1,
+				method: 0,
+				f1: "0",
+				f2: "1FFFFFFF",
+				prescaler_type: 0
+			}
+		]
+	}
+};
+var canedgeDefaultFilters = {
+	can_internal: can_internal$1,
+	can_1: can_1$2,
+	can_2: can_2$1
+};
+
+var can_internal$2 = {
+	filter: {
+		id: [
+			{
+				name: "Heartbeat",
+				state: 0,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "2",
+				f2: "2",
+				prescaler_type: 0
+			},
+			{
+				name: "TimeCalendar",
+				state: 0,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "3",
+				f2: "3",
+				prescaler_type: 0
+			},
+			{
+				name: "TimeExternal",
+				state: 0,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "5",
+				f2: "5",
+				prescaler_type: 0
+			},
+			{
+				name: "GnssStatus",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "65",
+				f2: "65",
+				prescaler_type: 0
+			},
+			{
+				name: "GnssTime",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "66",
+				f2: "66",
+				prescaler_type: 0
+			},
+			{
+				name: "GnsssPosition",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "67",
+				f2: "67",
+				prescaler_type: 0
+			},
+			{
+				name: "GnssAltitude",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "68",
+				f2: "68",
+				prescaler_type: 0
+			},
+			{
+				name: "GnssAttitude",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "69",
+				f2: "69",
+				prescaler_type: 0
+			},
+			{
+				name: "GnssDistance",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "6A",
+				f2: "6A",
+				prescaler_type: 0
+			},
+			{
+				name: "GnssSpeed",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "6B",
+				f2: "6B",
+				prescaler_type: 0
+			},
+			{
+				name: "GnssGeofence",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "6C",
+				f2: "6C",
+				prescaler_type: 0
+			},
+			{
+				name: "ImuAlign",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "6E",
+				f2: "6E",
+				prescaler_type: 0
+			},
+			{
+				name: "ImuAcc",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "6F",
+				f2: "6F",
+				prescaler_type: 0
+			}
+		]
+	}
+};
+var can_1$3 = {
+	filter: {
+		remote_frames: 0,
+		id: [
+			{
+				name: "AllStandardID",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "0",
+				f2: "7FF",
+				prescaler_type: 0
+			},
+			{
+				name: "AllExtendedID",
+				state: 1,
+				type: 0,
+				id_format: 1,
+				method: 0,
+				f1: "0",
+				f2: "1FFFFFFF",
+				prescaler_type: 0
+			}
+		]
+	}
+};
+var can_2$2 = {
+	filter: {
+		remote_frames: 0,
+		id: [
+			{
+				name: "AllStandardID",
+				state: 1,
+				type: 0,
+				id_format: 0,
+				method: 0,
+				f1: "0",
+				f2: "7FF",
+				prescaler_type: 0
+			},
+			{
+				name: "AllExtendedID",
+				state: 1,
+				type: 0,
+				id_format: 1,
+				method: 0,
+				f1: "0",
+				f2: "1FFFFFFF",
+				prescaler_type: 0
+			}
+		]
+	}
+};
+var canedgeDefaultFiltersGps = {
+	can_internal: can_internal$2,
+	can_1: can_1$3,
+	can_2: can_2$2
+};
+
+var phy = {
+	can_s1: {
+		filter: [
+			{
+				name: "AllStandardID",
+				state: 1,
+				id_format: 0,
+				frame_format: 2,
+				f1: "7FF",
+				f2: "0",
+				prescaler_type: 0
+			},
+			{
+				name: "AllExtendedID",
+				state: 1,
+				id_format: 1,
+				frame_format: 2,
+				f1: "1FFFFFFF",
+				f2: "0",
+				prescaler_type: 0
+			}
+		]
+	},
+	can_s2: {
+		filter: [
+			{
+				name: "AllStandardID",
+				state: 1,
+				id_format: 0,
+				frame_format: 2,
+				f1: "7FF",
+				f2: "0",
+				prescaler_type: 0
+			},
+			{
+				name: "AllExtendedID",
+				state: 1,
+				id_format: 1,
+				frame_format: 2,
+				f1: "1FFFFFFF",
+				f2: "0",
+				prescaler_type: 0
+			}
+		]
+	},
+	can_s3: {
+		filter: [
+			{
+				name: "AllStandardID",
+				state: 1,
+				id_format: 0,
+				frame_format: 2,
+				f1: "7FF",
+				f2: "0",
+				prescaler_type: 0
+			},
+			{
+				name: "AllExtendedID",
+				state: 1,
+				id_format: 1,
+				frame_format: 2,
+				f1: "1FFFFFFF",
+				f2: "0",
+				prescaler_type: 0
+			}
+		]
+	},
+	can_s4: {
+		filter: [
+			{
+				name: "AllStandardID",
+				state: 1,
+				id_format: 0,
+				frame_format: 2,
+				f1: "7FF",
+				f2: "0",
+				prescaler_type: 0
+			},
+			{
+				name: "AllExtendedID",
+				state: 1,
+				id_format: 1,
+				frame_format: 2,
+				f1: "1FFFFFFF",
+				f2: "0",
+				prescaler_type: 0
+			}
+		]
+	}
+};
+var canmodRouterDefaultFilters = {
+	phy: phy
+};
+
 var _excluded = ["name"],
   _excluded2 = ["name"];
 var merge$2 = require("deepmerge");
@@ -23140,8 +23536,10 @@ var MAX_11BIT_FILTERS_CANEDGE = 128;
 var MAX_29BIT_FILTERS_CANEDGE = 64;
 var MAX_FILTERS_CANMOD_ROUTER = 32;
 var CANEDGE_CHANNELS = ["CAN1", "CAN2", "CAN9"];
-var MIN_FIRMWARE_CANEDGE = "01.09";
-var MIN_FIRMWARE_CANMOD_ROUTER = "01.02";
+var SUPPORTED_FIRMWARE_CANEDGE = ["01.08", "01.09"];
+var SUPPORTED_FIRMWARE_CANMOD_ROUTER = ["01.02"];
+var MIN_FIRMWARE_CANEDGE = SUPPORTED_FIRMWARE_CANEDGE[0];
+var MIN_FIRMWARE_CANMOD_ROUTER = SUPPORTED_FIRMWARE_CANMOD_ROUTER[0];
 var FilterBuilderTool = /*#__PURE__*/function (_React$Component) {
   function FilterBuilderTool(props) {
     var _this;
@@ -23159,6 +23557,7 @@ var FilterBuilderTool = /*#__PURE__*/function (_React$Component) {
     _this.testMergedFile = _this.testMergedFile.bind(_this);
     _this.onMerge = _this.onMerge.bind(_this);
     _this.onDownload = _this.onDownload.bind(_this);
+    _this.onReset = _this.onReset.bind(_this);
     _this.onSubmit = _this.onSubmit.bind(_this);
     _this.onValidationError = _this.onValidationError.bind(_this);
     _this.state = {
@@ -23248,9 +23647,9 @@ var FilterBuilderTool = /*#__PURE__*/function (_React$Component) {
     var version = this.getConfigVersion();
     if (!version) return false;
     if (this.props.deviceType === "CANmod") {
-      return version >= MIN_FIRMWARE_CANMOD_ROUTER;
+      return SUPPORTED_FIRMWARE_CANMOD_ROUTER.includes(version);
     }
-    return version >= MIN_FIRMWARE_CANEDGE;
+    return SUPPORTED_FIRMWARE_CANEDGE.includes(version);
   };
   _proto.calculateFrameWeight = function calculateFrameWeight(dataLength) {
     var baseWeight = 4;
@@ -24312,6 +24711,33 @@ var FilterBuilderTool = /*#__PURE__*/function (_React$Component) {
     linkElement.setAttribute('download', exportFileDefaultName);
     linkElement.click();
   };
+  _proto.onReset = function onReset() {
+    var _this$props = this.props,
+      formData = _this$props.formData,
+      deviceType = _this$props.deviceType;
+    if (!formData || Object.keys(formData).length === 0) {
+      this.props.showAlert("warning", "No configuration file loaded");
+      return;
+    }
+    var defaultFilters;
+    var isCanmodRouter = this.isCanmodRouter();
+    if (deviceType === "CANmod" && isCanmodRouter) {
+      defaultFilters = canmodRouterDefaultFilters;
+    } else if (deviceType && deviceType.includes("GNSS")) {
+      defaultFilters = canedgeDefaultFiltersGps;
+    } else {
+      defaultFilters = canedgeDefaultFilters;
+    }
+    var overwriteMerge = function overwriteMerge(destinationArray, sourceArray, options) {
+      return sourceArray;
+    };
+    var resetConfig = merge$2(formData, defaultFilters, {
+      arrayMerge: overwriteMerge
+    });
+    this.props.setConfigContent(resetConfig);
+    this.props.setUpdatedFormData(resetConfig);
+    this.props.showAlert("success", "CAN channel filters reset to defaults (record everything)");
+  };
   _proto.renderBarChart = function renderBarChart(percentage, maxPercentage) {
     var maxWidth = 25;
     var barWidth = Math.max(1, percentage / maxPercentage * maxWidth);
@@ -24357,7 +24783,7 @@ var FilterBuilderTool = /*#__PURE__*/function (_React$Component) {
       style: {
         display: "flex",
         gap: "10px",
-        alignItems: "flex-start",
+        alignItems: "center",
         flexWrap: "wrap"
       }
     }, /*#__PURE__*/React.createElement("div", {
@@ -24388,9 +24814,25 @@ var FilterBuilderTool = /*#__PURE__*/function (_React$Component) {
       clickable: true
     }, /*#__PURE__*/React.createElement("button", {
       className: "btn btn-primary"
-    }, "Load DBC(s)")))), /*#__PURE__*/React.createElement("p", {
+    }, "Load DBC(s)"))), function () {
+      var isFirmwareSupported = _this12.isFirmwareVersionSupported();
+      var isCanmod = _this12.props.deviceType === "CANmod";
+      var isCanmodRouter = isCanmod && _this12.isCanmodRouter();
+      var isDeviceSupported = !isCanmod || isCanmodRouter;
+      var hasConfig = _this12.props.formData && Object.keys(_this12.props.formData).length > 0;
+      return /*#__PURE__*/React.createElement("button", {
+        className: "btn",
+        onClick: _this12.onReset,
+        disabled: !hasConfig || !isFirmwareSupported || !isDeviceSupported,
+        style: {
+          backgroundColor: "#fff",
+          border: "1px solid #ccc",
+          color: "#333"
+        }
+      }, "Reset filters");
+    }()), /*#__PURE__*/React.createElement("span", {
       className: "field-description field-description-shift"
-    }, this.props.deviceType === "CANmod" ? "Load a CSV log file output from the MF4 converter 'mdf2csv' which reflects a realistic log session with the default filters applied. The MF4 should be recorded with a CANedge with one or two CANmod.router(s) on CAN2. The CSV should be created by first demuxing the MF4 via the 'mdf2mdf' converter using the argument '--muxtp-can2=010#11:12:13:14'. If you are analyzing a second router, use --muxtp-can2=012#15:16:17:18. Recommended CSV file size is 1-10 MB. Optionally load DBC file(s) to add further details or enable filter selection based on DBC messages. DBC files must have a CAN channel prefix (e.g. can11-abc.dbc)." : "Load a CSV log file output from the MF4 converter 'mdf2csv' which reflects a realistic log session with the default filters applied. Recommended CSV file size is 1-10 MB. Optionally load DBC file(s) to add further details or enable filter selection based on DBC messages. DBC files must have a CAN channel prefix (e.g. can1-abc.dbc)."), (csvFileName || dbcFileNames.length > 0) && /*#__PURE__*/React.createElement("div", {
+    }, this.props.deviceType === "CANmod" ? "Load CSV: Load a log file recorded with CANedge + CANmod.router(s), demuxed via 'mdf2mdf' and converted to CSV via 'mdf2csv'. Load DBC(s): Add DBC files with channel prefix (e.g. can11-abc.dbc). Reset filters: Reset all CAN channel filters to defaults (record everything)." : "Load CSV: Load a CSV from 'mdf2csv' reflecting a realistic log session. Load DBC(s): Add DBC files with channel prefix (e.g. can1-abc.dbc). Reset filters: Reset all CAN channel filters to defaults (record everything)."), (csvFileName || dbcFileNames.length > 0) && /*#__PURE__*/React.createElement("div", {
       style: {
         fontSize: "11px",
         color: "#666",
@@ -24943,13 +25385,16 @@ var FilterBuilderTool = /*#__PURE__*/function (_React$Component) {
       }), /*#__PURE__*/React.createElement("span", {
         className: "field-description field-description-shift"
       }, _this12.state.prescalerType === "count" && "Accept every Nth message (1-256)", _this12.state.prescalerType === "time" && "Minimum time between messages (1-4194304 ms)", _this12.state.prescalerType === "data" && "Hex mask for data change detection")), /*#__PURE__*/React.createElement("div", {
+        className: "form-group pl0 field-string",
+        style: {
+          marginBottom: "10px"
+        }
+      }, /*#__PURE__*/React.createElement("div", {
         style: {
           display: "flex",
           alignItems: "center",
-          marginBottom: "15px",
           gap: "10px"
-        },
-        title: "The new filters can either replace existing filters on the affected channel(s) or be appended at the top/bottom of the existing filters."
+        }
       }, /*#__PURE__*/React.createElement("label", {
         style: {
           display: "flex",
@@ -25034,7 +25479,9 @@ var FilterBuilderTool = /*#__PURE__*/function (_React$Component) {
           position: "relative",
           top: "1px"
         }
-      }, "Append (bottom)"))), /*#__PURE__*/React.createElement("div", {
+      }, "Append (bottom)"))), /*#__PURE__*/React.createElement("span", {
+        className: "field-description field-description-shift"
+      }, "The new filters can either replace existing filters on the affected channel(s) or be appended at the top/bottom of the existing filters. If you e.g. wish to prescale 5 specific IDs and then log everything else as-is, you can append the 5 ID filters at the top of the default filters.")), /*#__PURE__*/React.createElement("div", {
         style: {
           fontSize: "12px",
           color: "#666",