<< All versions

Skill v1.0.2

Automated scan100/100
meshtastic/meshtastic-android/project-overview

~3 modified

──Details
PublishedAugust 17, 2026 at 10:08 AM
Content Hashsha256:34f4ea824f008c44...
Git SHA07b5a8d1c1cf
Bump Typepatch
Compare with v1.0.1
──Files
Files (1 file, 6.0 KB)
SKILL.md6.0 KBactive
SKILL.md · 82 lines · 6.0 KB

version: "1.0.2"

Skill: Project Overview & Codebase Map

Description

Module directory, namespacing conventions, environment setup, and troubleshooting for Meshtastic-Android.

  • Build System: Gradle (Kotlin DSL). JDK 25 REQUIRED. Target SDK: API 36. Min SDK: API 26.
  • Flavors: fdroid (OSS only) · google (Maps + DataDog analytics)
  • Android-only Modules: core:barcode (CameraX), feature:widget (Glance home-screen widget), feature:car (Android Auto via the Car App Library, google flavor only), and baselineprofile (Macrobenchmark). Shared contracts are abstracted into core:ui/commonMain.

Codebase Map

DirectoryDescription
androidApp/Main application module. Contains MainActivity, Koin DI modules, and app-level logic. Uses package org.meshtastic.app.
build-logic/Convention plugins for shared build configuration (e.g., meshtastic.kmp.feature, meshtastic.kmp.library, meshtastic.kmp.jvm.android, meshtastic.koin).
config/Detekt static analysis rules (config/detekt/detekt.yml) and Spotless formatting config (config/spotless/.editorconfig).
docs/Architecture docs and agent playbooks. See docs/kmp-status.md and docs/roadmap.md for current status.
core/modelDomain models and common data structures.
core:commonLow-level utilities, I/O abstractions (Okio), and common types.
core:databaseRoom KMP database implementation.
core:datastoreMultiplatform DataStore for preferences.
core:repositoryHigh-level domain interfaces (e.g., NodeRepository, LocationRepository).
core:domainPure KMP business logic and UseCases.
core:dataCore manager implementations and data orchestration.
core:networkKMP networking layer using Ktor, MQTT abstractions, and shared transport (StreamFrameCodec, TcpTransport, SerialTransport, BleRadioInterface).
core:diCommon DI qualifiers and dispatchers.
core:navigationShared navigation keys/routes for Navigation 3 using @Serializable sealed interface hierarchies. DeepLinkRouter for typed backstack synthesis, and MeshtasticNavSavedStateConfig with subclassesOfSealed() for automatic polymorphic backstack persistence.
core:uiShared Compose UI components (MeshtasticAppShell, MeshtasticNavDisplay, MeshtasticNavigationSuite, AlertHost, SharedDialogs, PlaceholderScreen, MainAppBar, dialogs, preferences) and platform abstractions.
core:serviceKMP service layer; Android bindings stay in androidMain.
core:takserverMeshtastic ↔ TAK (ATAK/iTAK) bridge — local CoT server and CoT ⇄ mesh conversion.
core:prefsKMP preferences layer built on DataStore abstractions.
core:barcodeBarcode scanning (Android-only).
core:nfcNFC abstractions (KMP). Android NFC hardware implementation in androidMain.
core/ble/Bluetooth Low Energy stack using Kable.
core/resources/Centralized string and image resources (Compose Multiplatform).
core/testing/Shared test doubles, fakes, and utilities for commonTest across all KMP modules.
feature/Feature modules (e.g., settings, map, messaging, node, intro, connections, firmware, wifi-provision, discovery, docs, widget, car). Most are KMP and use the meshtastic.kmp.feature convention plugin; widget (Glance) and car (Android Auto, google flavor only) are Android-only.
baselineprofile/Macrobenchmark Baseline Profile generation for :androidApp (AOT-compiled cold-start journey). Android-only.
feature/wifi-provisionKMP WiFi provisioning via BLE (Nymea protocol). Uses core:ble Kable abstractions.
feature/firmwareFully KMP firmware update system: Unified OTA (BLE + WiFi), native Nordic Secure DFU protocol (pure KMP), USB/UF2 updates, and FirmwareRetriever with manifest-based resolution. Desktop is a first-class target.
desktopApp/Compose Desktop application. Thin host shell relying on feature modules for shared UI. Full Koin DI graph, TCP, Serial/USB, and BLE transports. Versioning via config.properties + GitVersionValueSource.

Namespacing

  • Standard: Use the org.meshtastic.* namespace for all code.
  • Legacy: Maintain the com.geeksville.mesh Application ID.

Environment Setup

  1. JDK 25 MUST be used to prevent Gradle sync/build failures.
  2. Secrets: Copy secrets.defaults.properties to local.properties:

``properties MAPS_API_KEY=dummy_key datadogApplicationId=dummy_id datadogClientToken=dummy_token ``

Workspace Bootstrap (MUST run before any build)

Agents MUST perform these steps automatically at the start of every session before running any Gradle task. Do not wait for the user to tell you.

  1. Android SDK: ANDROID_HOME may not be set in agent workspaces. Detect and export it:

``bash # Check common macOS/Linux locations in order of preference if [ -z "$ANDROID_HOME" ]; then for dir in "$HOME/Library/Android/sdk" "$HOME/Android/Sdk" "/opt/android-sdk"; do if [ -d "$dir" ]; then export ANDROID_HOME="$dir"; break; fi done fi ` All ./gradlew invocations must include ANDROID_HOME` in the environment. If the SDK cannot be found, ask the user for the path.

  1. Init secrets: If local.properties does not exist, copy secrets.defaults.properties to local.properties. Without this the google flavor build fails:

``bash [ -f local.properties ] || cp secrets.defaults.properties local.properties ``

Troubleshooting

  • Build Failures: Check gradle/libs.versions.toml for dependency conflicts.
  • Configuration Cache: Add -Dorg.gradle.isolated-projects=false --no-configuration-cache if cache-related issues persist. Both flags are required: Isolated Projects (on by default here) implies the configuration cache, and Gradle 9.7+ fails the build if you disable the cache without also disabling Isolated Projects.
  • Koin Injection Failures: Verify the component is included in AppKoinModule.
← v1.0.1All versionsv1.0.3 →