Merge pull request #1016 from jake-b/configurable_columns

Configurable table columns and chart series for the Environment Metrics Log

Author: garthvh

Localizable.xcstrings

@@ -4517,6 +4517,9 @@
           }
         }
       }
+    },
+    "Chart" : {
+
     },
     "CHG" : {
       "localizations" : {
@@ -4869,6 +4872,9 @@
           }
         }
       }
+    },
+    "Config" : {
+
     },
     "config.module.paxcounter.enabled.description" : {
       "localizations" : {
@@ -9245,6 +9251,9 @@
           }
         }
       }
+    },
+    "Done" : {
+
     },
     "Double Tap as Button" : {
       "localizations" : {
@@ -19348,6 +19357,9 @@
           }
         }
       }
+    },
+    "Metric" : {
+
     },
     "Minimum Distance" : {
       "localizations" : {
@@ -26503,6 +26515,9 @@
           }
         }
       }
+    },
+    "Series" : {
+
     },
     "Server" : {
       "localizations" : {
@@ -27718,6 +27733,9 @@
           }
         }
       }
+    },
+    "Table" : {
+
     },
     "tapback" : {
       "localizations" : {

Meshtastic.xcodeproj/project.pbxproj

@@ -7,6 +7,13 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		231B3F212D087A4C0069A07D /* MetricTableColumn.swift in Sources */ = {isa = PBXBuildFile; fileRef = 231B3F202D087A4C0069A07D /* MetricTableColumn.swift */; };
+		231B3F222D087A4C0069A07D /* MetricsColumnList.swift in Sources */ = {isa = PBXBuildFile; fileRef = 231B3F1F2D087A4C0069A07D /* MetricsColumnList.swift */; };
+		231B3F252D087C3C0069A07D /* EnvironmentDefaultColumns.swift in Sources */ = {isa = PBXBuildFile; fileRef = 231B3F242D087C3C0069A07D /* EnvironmentDefaultColumns.swift */; };
+		231B3F272D0885240069A07D /* MetricsColumnDetail.swift in Sources */ = {isa = PBXBuildFile; fileRef = 231B3F262D0885240069A07D /* MetricsColumnDetail.swift */; };
+		2373AE132D0A216C0086C749 /* MetricsChartSeries.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2373AE122D0A216C0086C749 /* MetricsChartSeries.swift */; };
+		2373AE152D0A24930086C749 /* MetricsSeriesList.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2373AE142D0A24930086C749 /* MetricsSeriesList.swift */; };
+		2373AE172D0A26620086C749 /* EnviornmentDefaultSeries.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2373AE162D0A26620086C749 /* EnviornmentDefaultSeries.swift */; };
 		251926852C3BA97800249DF5 /* FavoriteNodeButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 251926842C3BA97800249DF5 /* FavoriteNodeButton.swift */; };
 		251926872C3BAE2200249DF5 /* NodeAlertsButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 251926862C3BAE2200249DF5 /* NodeAlertsButton.swift */; };
 		2519268A2C3BB1B200249DF5 /* ExchangePositionsButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 251926892C3BB1B200249DF5 /* ExchangePositionsButton.swift */; };
@@ -259,6 +266,13 @@
 /* End PBXCopyFilesBuildPhase section */
 
 /* Begin PBXFileReference section */
+		231B3F1F2D087A4C0069A07D /* MetricsColumnList.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MetricsColumnList.swift; sourceTree = "<group>"; };
+		231B3F202D087A4C0069A07D /* MetricTableColumn.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MetricTableColumn.swift; sourceTree = "<group>"; };
+		231B3F242D087C3C0069A07D /* EnvironmentDefaultColumns.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EnvironmentDefaultColumns.swift; sourceTree = "<group>"; };
+		231B3F262D0885240069A07D /* MetricsColumnDetail.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MetricsColumnDetail.swift; sourceTree = "<group>"; };
+		2373AE122D0A216C0086C749 /* MetricsChartSeries.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MetricsChartSeries.swift; sourceTree = "<group>"; };
+		2373AE142D0A24930086C749 /* MetricsSeriesList.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MetricsSeriesList.swift; sourceTree = "<group>"; };
+		2373AE162D0A26620086C749 /* EnviornmentDefaultSeries.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EnviornmentDefaultSeries.swift; sourceTree = "<group>"; };
 		251926842C3BA97800249DF5 /* FavoriteNodeButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FavoriteNodeButton.swift; sourceTree = "<group>"; };
 		251926862C3BAE2200249DF5 /* NodeAlertsButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NodeAlertsButton.swift; sourceTree = "<group>"; };
 		251926892C3BB1B200249DF5 /* ExchangePositionsButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ExchangePositionsButton.swift; sourceTree = "<group>"; };
@@ -555,6 +569,27 @@
 /* End PBXFrameworksBuildPhase section */
 
 /* Begin PBXGroup section */
+		231B3F1E2D0879BC0069A07D /* Metrics Visualization */ = {
+			isa = PBXGroup;
+			children = (
+				2373AE122D0A216C0086C749 /* MetricsChartSeries.swift */,
+				231B3F202D087A4C0069A07D /* MetricTableColumn.swift */,
+				231B3F1F2D087A4C0069A07D /* MetricsColumnList.swift */,
+				2373AE142D0A24930086C749 /* MetricsSeriesList.swift */,
+			);
+			path = "Metrics Visualization";
+			sourceTree = "<group>";
+		};
+		231B3F232D087C020069A07D /* Metrics Columns */ = {
+			isa = PBXGroup;
+			children = (
+				231B3F242D087C3C0069A07D /* EnvironmentDefaultColumns.swift */,
+				2373AE162D0A26620086C749 /* EnviornmentDefaultSeries.swift */,
+				231B3F262D0885240069A07D /* MetricsColumnDetail.swift */,
+			);
+			path = "Metrics Columns";
+			sourceTree = "<group>";
+		};
 		251926882C3BAF2E00249DF5 /* Actions */ = {
 			isa = PBXGroup;
 			children = (
@@ -935,6 +970,7 @@
 		DDC2E18826CE24EE0042C5E4 /* Model */ = {
 			isa = PBXGroup;
 			children = (
+				231B3F1E2D0879BC0069A07D /* Metrics Visualization */,
 				DD23A50E26FD1B4400D9B90C /* PeripheralModel.swift */,
 			);
 			path = Model;
@@ -1036,6 +1072,7 @@
 		DDDB26402AABEF7B003AFCB7 /* Helpers */ = {
 			isa = PBXGroup;
 			children = (
+				231B3F232D087C020069A07D /* Metrics Columns */,
 				DDAD49EB2AFAE82500B4425D /* Map */,
 				DDDB26432AAC0206003AFCB7 /* NodeDetail.swift */,
 				DDDB26452AACC0B7003AFCB7 /* NodeInfoItem.swift */,
@@ -1311,6 +1348,7 @@
 				DD5D0A9C2931B9F200F7EA61 /* EthernetModes.swift in Sources */,
 				6DEDA55A2A957B8E00321D2E /* DetectionSensorLog.swift in Sources */,
 				DD798B072915928D005217CD /* ChannelMessageList.swift in Sources */,
+				231B3F272D0885240069A07D /* MetricsColumnDetail.swift in Sources */,
 				DDC2E1A726CEB3400042C5E4 /* LocationHelper.swift in Sources */,
 				DD77093D2AA1AFA3007A8BF0 /* ChannelTips.swift in Sources */,
 				6D825E622C34786C008DBEE4 /* CommonRegex.swift in Sources */,
@@ -1327,11 +1365,13 @@
 				DDB6ABD628AE742000384BA1 /* BluetoothConfig.swift in Sources */,
 				251926902C3CB44900249DF5 /* ClientHistoryButton.swift in Sources */,
 				DDD5BB102C285FB3007E03CA /* AppLogFilter.swift in Sources */,
+				2373AE172D0A26620086C749 /* EnviornmentDefaultSeries.swift in Sources */,
 				DD4640202AFF10F4002A5ECB /* WaypointForm.swift in Sources */,
 				DD769E0328D18BF1001A3F05 /* DeviceMetricsLog.swift in Sources */,
 				DDAF8C5326EB1DF10058C060 /* BLEManager.swift in Sources */,
 				DD15E4F32B8BA56E00654F61 /* PaxCounterConfig.swift in Sources */,
 				DDDB445229F8ACF900EE2349 /* Date.swift in Sources */,
+				2373AE132D0A216C0086C749 /* MetricsChartSeries.swift in Sources */,
 				DDC4D568275499A500A4208E /* Persistence.swift in Sources */,
 				DDD6EEAF29BC024700383354 /* Firmware.swift in Sources */,
 				DD77093B2AA1ABB8007A8BF0 /* BluetoothTips.swift in Sources */,
@@ -1341,7 +1381,9 @@
 				DD964FBD296E6B01007C176F /* EmojiOnlyTextField.swift in Sources */,
 				DD8169FF272476C700F4AB02 /* LogDocument.swift in Sources */,
 				DDC94FC129CE063B0082EA6E /* BatteryLevel.swift in Sources */,
+				231B3F252D087C3C0069A07D /* EnvironmentDefaultColumns.swift in Sources */,
 				25F5D5BE2C3F6D87008036E3 /* NavigationState.swift in Sources */,
+				2373AE152D0A24930086C749 /* MetricsSeriesList.swift in Sources */,
 				DD354FD92BD96A0B0061A25F /* IAQScale.swift in Sources */,
 				DDDB445429F8AD1600EE2349 /* Data.swift in Sources */,
 				DDDB26462AACC0B7003AFCB7 /* NodeInfoItem.swift in Sources */,
@@ -1425,6 +1467,8 @@
 				DD3CC24C2C498D6C001BD3A2 /* BatteryCompact.swift in Sources */,
 				BCB613812C67290800485544 /* SendWaypointIntent.swift in Sources */,
 				DD1B8F402B35E2F10022AABC /* GPSStatus.swift in Sources */,
+				231B3F212D087A4C0069A07D /* MetricTableColumn.swift in Sources */,
+				231B3F222D087A4C0069A07D /* MetricsColumnList.swift in Sources */,
 				DD8ED9C52898D51F00B3B0AB /* NetworkConfig.swift in Sources */,
 				DDC3B274283F411B00AC321C /* LastHeardText.swift in Sources */,
 				DDDE5A1029AFE69700490C6C /* MeshActivityAttributes.swift in Sources */,

Meshtastic/Model/Metrics Visualization/MetricTableColumn.swift

@@ -0,0 +1,84 @@
+//
+//  SeriesConfigurationEntry.swift
+//  Meshtastic
+//
+//  Created by Jake Bordens on 12/7/24.
+//
+
+import Charts
+import OSLog
+import SwiftUI
+
+// MetricsTableColumn stores metadata about an attribute in TelemetryEntity.
+// Given a keypath, this class holds information about how to render the attrbute in
+// the table.  MetricsTableColumn objects are collected in a MetricsColumnList
+class MetricsTableColumn: ObservableObject {
+	// CoreData Attribute Name on TelemetryEntity
+	let attribute: String
+
+	// Heading for wider tables
+	let name: String
+
+	// Heading for space-constrained tables
+	let abbreviatedName: String
+
+	// Minimum/maximum grid width for this column
+	let minWidth: CGFloat?
+	let maxWidth: CGFloat?
+
+	// Recommended spacing, may be overridden
+	let spacing: CGFloat
+	// Should this column appear in the table
+
+	var visible: Bool
+
+	// Closure to render the table cell
+	let tableBodyClosure: (MetricsTableColumn, TelemetryEntity) -> AnyView?
+
+	// Main initializer
+	init<Value, TableContent: View>(
+		keyPath: KeyPath<TelemetryEntity, Value>,
+		name: String,
+		abbreviatedName: String,
+		minWidth: CGFloat? = nil,
+		maxWidth: CGFloat? = nil,
+		spacing: CGFloat = 0.1,
+		visible: Bool = true,
+		@ViewBuilder tableBody: @escaping (MetricsTableColumn, Value) -> TableContent?
+	) {
+		// This works because TelemetryEntity is an NSManagedObject and derrived from NSObject
+		self.attribute = NSExpression(forKeyPath: keyPath).keyPath
+		self.name = name
+		self.abbreviatedName = abbreviatedName
+		self.minWidth = minWidth
+		self.maxWidth = maxWidth
+		self.spacing = spacing
+		self.visible = visible
+		self.tableBodyClosure = { config, entity in
+			AnyView(tableBody(config, entity[keyPath: keyPath]))
+		}
+	}
+
+	var gridItemSize: GridItem.Size {
+		if let minWidth, let maxWidth {
+			return .flexible(minimum: minWidth, maximum: maxWidth)
+		}
+		return .flexible()
+	}
+
+	func body(_ te: TelemetryEntity) -> AnyView? {
+		return tableBodyClosure(self, te)
+	}
+}
+
+extension MetricsTableColumn: Identifiable, Hashable {
+	var id: String { self.attribute }
+
+	static func == (lhs: MetricsTableColumn, rhs: MetricsTableColumn) -> Bool {
+		lhs.attribute == rhs.attribute
+	}
+
+	func hash(into hasher: inout Hasher) {
+		hasher.combine(attribute)
+	}
+}

Meshtastic/Model/Metrics Visualization/MetricsChartSeries.swift

@@ -0,0 +1,113 @@
+//
+//  MetricsChartSeries.swift
+//  Meshtastic
+//
+//  Created by Jake Bordens on 12/11/24.
+//
+
+import Charts
+import Foundation
+import SwiftUI
+
+// MetricsChartSeries stores metadata about an attribute in TelemetryEntity.
+// Given a keypath, this class holds information about how to render the attrbute in a
+// the chart.  MetricsChartSeries objects are collected in a MetricsSeriesList
+class MetricsChartSeries: ObservableObject {
+
+	// CoreData Attribute Name on TelemetryEntity
+	let attribute: String
+
+	// Heading for areas that have the room
+	let name: String
+
+	// Heading for space-constrained areas
+	let abbreviatedName: String
+
+	// Should this column appear in the chart
+	var visible: Bool
+
+	// A closure that will provide the foreground style given the data set and overall chart range
+	let foregroundStyle: (ClosedRange<Float>?) -> AnyShapeStyle?
+
+	// A closure that will provide the Chart Content for this series
+	let chartBodyClosure:
+		(MetricsChartSeries, ClosedRange<Float>?, TelemetryEntity) -> AnyChartContent?  // Closure to render the chart
+
+	// A closure that will privide the value of a TelemetryEntity for this series
+	// Possibly converted to the proper units
+	let valueClosure: (TelemetryEntity) -> Float?
+
+	// Main initializer
+	init<Value, ChartBody: ChartContent, ForegroundStyle: ShapeStyle>(
+		keyPath: KeyPath<TelemetryEntity, Value>,
+		name: String,
+		abbreviatedName: String,
+		conversion: ((Value) -> Value)? = nil,
+		visible: Bool = true,
+		foregroundStyle: @escaping ((ClosedRange<Float>?) -> ForegroundStyle?) = { _ in nil },
+		@ChartContentBuilder chartBody: @escaping (MetricsChartSeries, ClosedRange<Float>?, Date, Value) -> ChartBody?
+	) where Value: Plottable & Comparable {
+
+		// This works because TelemetryEntity is an NSManagedObject and derrived from NSObject
+		self.attribute = NSExpression(forKeyPath: keyPath).keyPath
+		self.name = name
+		self.abbreviatedName = abbreviatedName
+		self.visible = visible
+
+		// By saving these closures, MetricsChartSeries can be type agnostic
+		// This is a less elegant form of type erasure, but doesn't require a new Any-type
+		self.foregroundStyle = { range in foregroundStyle(range).map({ AnyShapeStyle($0) }) }
+		self.chartBodyClosure = { series, range, entity in
+			AnyChartContent(
+				chartBody(series, range, entity.time!, entity[keyPath: keyPath]))
+		}
+		self.valueClosure = { te in
+			if let conversion {
+				return conversion(te[keyPath: keyPath]).floatValue
+			}
+			return te[keyPath: keyPath].floatValue
+		}
+	}
+
+	// Return the value for this series attribute given a full row of telemetry data
+	func valueFor(_ te: TelemetryEntity) -> Float? {
+		return self.valueClosure(te)?.floatValue
+	}
+
+	// Return the chart content for this series given a full row of telemetry data
+	func body<T>(_ te: TelemetryEntity, inChartRange chartRange: ClosedRange<T>? = nil) -> AnyChartContent? where T: BinaryFloatingPoint {
+		let range = chartRange.map { Float($0.lowerBound)...Float($0.upperBound) }
+		return chartBodyClosure(self, range, te)
+	}
+}
+
+extension MetricsChartSeries: Identifiable, Hashable {
+	var id: String { self.attribute }
+
+	static func == (lhs: MetricsChartSeries, rhs: MetricsChartSeries) -> Bool {
+		lhs.attribute == rhs.attribute
+	}
+
+	func hash(into hasher: inout Hasher) {
+		hasher.combine(attribute)
+	}
+}
+
+extension Plottable {
+	var floatValue: Float? {
+		if let integerValue = self.primitivePlottable as? any BinaryInteger {
+			return Float(integerValue)
+		} else if let floatingPointValue = self.primitivePlottable as? any BinaryFloatingPoint {
+			return Float(floatingPointValue)
+		}
+		return nil
+	}
+	var doubleValue: Double? {
+		if let integerValue = self.primitivePlottable as? any BinaryInteger {
+			return Double(integerValue)
+		} else if let floatingPointValue = self.primitivePlottable as? any BinaryFloatingPoint {
+			return Double(floatingPointValue)
+		}
+		return nil
+	}
+}