Skip to content

README.md

Latest commit

 

History

History
47 lines (35 loc) · 2.19 KB

README.md

File metadata and controls

47 lines (35 loc) · 2.19 KB
Raw

:core:common

Overview

Targets: Android · JVM (Desktop) · iOS

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, plus DateFormatter for display dates.
  • Exceptions: Standardized exception types for common error scenarios.
  • NumberFormatter: Locale-aware number formatting (pre-format floats before Compose display).
  • UrlUtils / CommonUri: URL helpers and a multiplatform URI abstraction.

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.

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;
Loading