mirror of https://github.com/meshtastic/Meshtastic-Android.git synced 2026-04-20 22:23:37 +00:00

History

GitHub Copilot CLI c1c01d7765 chore(r8): remove redundant keep rules covered by consumer rules Removes explicit -keep/-dontwarn wildcards whose behavior is already provided by the library's own bundled consumer-rules.pro, by Room's generated static references, or by narrower annotation-targeted keeps. The merged R8 configuration shrinks by 34 lines (1981→1947 googleRelease, 1653→1619 fdroidRelease), giving R8 more tree-shaking freedom. Removed (covered by library-bundled consumer rules): - kotlin.Metadata, kotlin.reflect., kotlin.coroutines.Continuation, kotlinx.coroutines. (kotlin-stdlib + kotlinx-coroutines-core) - androidx.datastore., androidx.paging., androidx.lifecycle., androidx.navigation3., androidx.sqlite. - coil3., okio., co.touchlab.kermit., com.mikepenz.aboutlibraries., com.mikepenz.markdown., com.juul.kable., io.ktor., io.ktor.client.engine.java. (HttpClientEngineFactory ServiceLoader keep retained) Room (room3) narrowed: - Dropped org.meshtastic.core.database.{dao,entity,Converters}. and _Impl wildcards. RoomDatabaseConstructor + MeshtasticDatabaseConstructor/MeshtasticDatabase keeps retained. Room 3.0 KMP generates static references rather than reflective lookups, so reachable DAO/entity/_Impl code survives tree-shaking. Wire protobuf narrowed: - Dropped com.squareup.wire., org.meshtastic.proto., meshtastic. wildcards and deleted core/proto/consumer-rules.pro (20 per-class keeps). - Replaced with targeted -keepclassmembers for ADAPTER fields on Message subclasses and ProtoAdapter member preservation. Verified no Class.forName lookups into org.meshtastic.proto namespace. Meshtastic model + DI: - Dropped org.meshtastic.core.model. wildcard and deleted core/model/consumer-rules.pro (DataPacket is @CommonParcelize'd; no reflective access to core.model). - Replaced org.meshtastic..di. wildcard with a narrow @KoinViewModel class annotation keep (the @Module, @ComponentScan, @Single, @Factory keeps above already cover the rest of Koin). Compose resources refinement: - Narrowed org.meshtastic.core.resources. to Res + Res$* members only (sufficient for the fdroid startup-crash workaround in #5146). Intentionally retained (documented workarounds / policy): - -dontoptimize, -dontobfuscate, -printconfiguration - All Koin annotation keeps + org.koin. - kotlinx-serialization @Serializable keeps - Room RoomDatabaseConstructor + MeshtasticDatabase(-Constructor) - Ktor HttpClientEngineFactory ServiceLoader keep - Desktop MainKt + org.meshtastic.desktop. entry points - All -dontwarn rules for JVM/Android platform gaps - app/proguard-rules.pro Compose runtime/ui/animation/foundation/ material3 keeps (defence-in-depth with -dontoptimize; may interact with the parallel CMP freeze RCA investigation). Verified: - ./gradlew :app:assembleFdroidRelease — SUCCESS (after each batch) - ./gradlew :app:assembleGoogleRelease — SUCCESS - ./gradlew spotlessApply detekt — SUCCESS - :desktop:createReleaseDistributable — pre-existing failure on origin/main (Vico/Skia warnings), unrelated to these changes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>		2026-04-17 11:59:39 -05:00
..
src	fix: redact MeshLog proto secrets and centralize Compose keep-rules (#5166 )	2026-04-17 16:20:50 +00:00
build.gradle.kts	chore: review-cleanup fleet (audit + fix + hardening) (#5158 )	2026-04-17 00:02:59 +00:00
detekt-baseline.xml	refactor: migrate core modules to Kotlin Multiplatform and consolidat… (#4735 )	2026-03-06 22:06:50 +00:00
README.md	refactor: BLE transport and UI for Kotlin Multiplatform unification (#4911 )	2026-03-25 02:15:51 +00:00

README.md

`:core:model` (Meshtastic Domain Models)

Overview

The :core:model module is a Kotlin Multiplatform (KMP) library containing the domain models and data classes used throughout the application and its API. These models are platform-agnostic and designed to be shared across Android, JVM, and future supported platforms.

Multiplatform Support

Models in this module use the CommonParcelable and CommonParcelize abstractions from :core:common. This allows them to maintain Android Parcelable compatibility (via @Parcelize) while residing in commonMain and remaining accessible to non-Android targets.

Key Models

DataPacket: Represents a mesh packet (text, telemetry, etc.).
NodeInfo: Contains detailed information about a node (position, SNR, battery, etc.).
DeviceHardware: Represents supported Meshtastic hardware devices and their capabilities.
Channel: Represents a mesh channel configuration.

Usage

This module is a core dependency of core:api and most feature modules.

// In commonMain
implementation(projects.core.model)

Structure

commonMain: Contains the majority of domain models and logic.
androidMain: Contains Android-specific utilities and implementations for expect declarations.
androidUnitTest: Contains unit tests that require Android-specific features (like Parcel testing via Robolectric).

Module dependency graph

graph TB
  :core:model[model]:::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;