mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-04-20 22:23:37 +00:00
5aabf58576
Replace 11 inline formatString("%.Nf ...") metric display calls with
MetricFormatter helpers in core/common. Adds two new helpers (windSpeed,
rainfall) for m/s and mm readings.
Migrated (11 sites):
- feature/node EnvironmentMetrics.kt: humidity, pressure, voltage,
current, wind_speed, wind_gust, wind_lull, rainfall_1h, rainfall_24h
- feature/settings LoadingOverlay.kt, PacketResponseStateDialog.kt:
progress percent indicators
New helpers in MetricFormatter:
- windSpeed(metersPerSecond, decimalPlaces = 1) -> "X.X m/s"
- rainfall(millimeters, decimalPlaces = 1) -> "X.X mm"
Intentionally left alone:
- core/model DistanceExtensions.kt: specialized unit-conversion helpers,
which are themselves the canonical distance/speed formatters
- feature/node PositionLogComponents.kt, MetricsViewModel.kt: GPS
coordinates and heading-angle formatters (not metric display strings)
- feature/node TracerouteChart, HostMetricsChart, EnvironmentCharts,
PaxMetrics valueFormatter lambdas: chart-library axis callbacks with
format strings scoped to the chart lib contract
- feature/node TracerouteLog.kt, HostMetricsLog.kt: generic
"label: value" log rows, not metric displays
- feature/node CompassBottomSheet.kt: one-off %.0f° angle
- EnvironmentMetrics.kt lux, UV-lux, gas resistance, radiation, and
wind-with-direction formats: one-off specialized units not worth a
dedicated helper
Also adds detekt @Suppress("TooManyFunctions") on MetricFormatter
(11 helpers now exceeds the default threshold) and unit tests for the
new windSpeed/rainfall helpers.
Validation: ./gradlew spotlessApply, :core:common:jvmTest,
:core:common:detekt, spotlessCheck, and kmpSmokeCompile all pass.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
||
|---|---|---|
| .. | ||
| src | ||
| build.gradle.kts | ||
| README.md | ||
:core:common
Overview
The :core:common module contains low-level utility functions, extensions, and common data structures that do not depend on any other Meshtastic-specific modules. It is designed to be highly reusable across the project.
Key Components
1. util package
Contains general-purpose extensions and helpers:
- Coroutines: Helpers for structured concurrency and Flow transformations.
- Time: Utilities for handling timestamps and durations.
- Exceptions: Standardized exception types for common error scenarios.
2. MetricFormatter.kt
Centralized utility for display strings — temperature, voltage, current, percent, humidity, pressure, SNR, RSSI. Ensures consistent unit spacing and formatting across all UI surfaces.
3. BuildConfigProvider.kt
An interface for accessing build-time configuration in a multiplatform-friendly way.
Module dependency graph
graph TB
:core:common[common]:::kmp-library
classDef android-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;
classDef android-application-compose fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;
classDef compose-desktop-application fill:#CAFFBF,stroke:#000,stroke-width:2px,color:#000;
classDef android-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000;
classDef android-library fill:#9BF6FF,stroke:#000,stroke-width:2px,color:#000;
classDef android-library-compose fill:#9BF6FF,stroke:#000,stroke-width:2px,color:#000;
classDef android-test fill:#A0C4FF,stroke:#000,stroke-width:2px,color:#000;
classDef jvm-library fill:#BDB2FF,stroke:#000,stroke-width:2px,color:#000;
classDef kmp-feature fill:#FFD6A5,stroke:#000,stroke-width:2px,color:#000;
classDef kmp-library-compose fill:#FFC1CC,stroke:#000,stroke-width:2px,color:#000;
classDef kmp-library fill:#FFC1CC,stroke:#000,stroke-width:2px,color:#000;
classDef unknown fill:#FFADAD,stroke:#000,stroke-width:2px,color:#000;