mirror/Meshtastic-Android
1
0 Fork 0
mirror of https://github.com/meshtastic/Meshtastic-Android.git synced 2026-09-24 04:35:10 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
a2ccedf2e32b2b2bff62ff6f186830751e16970d
Meshtastic-Android/main/en/developer/architecture.html
T

18 lines
41 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/Meshtastic-Android/main/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/Meshtastic-Android/main/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav > ul.nav-list:first-child > li > a, .site-nav > ul.nav-list:first-child > li > ul > li:not(:nth-child(1)) > a, .site-nav > ul.nav-list:first-child > li > ul > li > ul > li a { background-image: none; } .site-nav > ul.nav-list:not(:first-child) a, .site-nav li.external a { background-image: none; } .site-nav > ul.nav-list:first-child > li:nth-child(4) > ul > li:nth-child(1) > a { font-weight: 600; text-decoration: none; }.site-nav > ul.nav-list:first-child > li:nth-child(4) > button svg, .site-nav > ul.nav-list:first-child > li:nth-child(4) > ul > li:nth-child(1) > button svg { transform: rotate(-90deg); }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(4) > ul.nav-list, .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(4) > ul.nav-list > li.nav-list-item:nth-child(1) > ul.nav-list { display: block; } </style> <script src="/Meshtastic-Android/main/assets/js/vendor/lunr.min.js"></script> <script src="/Meshtastic-Android/main/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.9.0 --> <title>Architecture | Meshtastic Android</title> <meta name="generator" content="Jekyll v4.4.1" /> <meta property="og:title" content="Architecture" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="How the Android and Desktop apps split into androidApp/desktopApp, feature modules, and core modules, and how radio control and navigation are layered across them." /> <meta name="twitter:description" property="og:description" content="How the Android and Desktop apps split into androidApp/desktopApp, feature modules, and core modules, and how radio control and navigation are layered across them." /> <link rel="canonical" href="/Meshtastic-Android/main/en/developer/architecture.html" /> <meta property="og:url" content="/Meshtastic-Android/main/en/developer/architecture.html" /> <meta property="og:site_name" content="Meshtastic Android" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary" /> <meta name="twitter:title" content="Architecture" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"How the Android and Desktop apps split into androidApp/desktopApp, feature modules, and core modules, and how radio control and navigation are layered across them.","headline":"Architecture","url":"/Meshtastic-Android/main/en/developer/architecture.html"}</script> <!-- End Jekyll SEO tag --> <!-- Inter font from Google Fonts --> <link rel="preconnect" href="https://fonts.googleapis.com"> <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet"> <style> /* M3-inspired typography */ :root { --font-sans: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', system-ui, sans-serif; --font-mono: 'JetBrains Mono', 'Fira Code', 'Cascadia Code', ui-monospace, monospace; } body, .site-title, .search-input { font-family: var(--font-sans) !important; } code, pre, .highlight { font-family: var(--font-mono) !important; font-size: 0.875em; } /* M3 surface elevation & rounding */ .main-content table { border-radius: 12px; overflow: hidden; } .main-content blockquote { border-radius: 12px; padding: 1rem 1.25rem; border-left-width: 4px; } .main-content pre { border-radius: 12px; } .main-content code { border-radius: 6px; padding: 0.15em 0.4em; } /* Smooth transitions for theme switching */ body, .side-bar, .main, .main-content, .site-header, .search-input, .search-results, a { transition: background-color 0.2s ease, color 0.2s ease, border-color 0.2s ease; } /* Theme toggle button styling */ .theme-toggle { background: none; border: 1px solid var(--border-color, #D5D6E0); border-radius: 20px; padding: 6px 12px; cursor: pointer; font-family: var(--font-sans); font-size: 0.75rem; font-weight: 500; display: inline-flex; align-items: center; gap: 6px; color: inherit; margin: 0 auto; transition: background-color 0.2s ease, border-color 0.2s ease; } .theme-toggle:hover { background-color: rgba(128, 128, 128, 0.1); } .theme-toggle-wrap { text-align: center; padding: 12px 0 4px; } /* Heading weight refinement */ h1, h2, h3, h4, h5, h6 { font-weight: 600; letter-spacing: -0.01em; } h1 { font-weight: 700; letter-spacing: -0.02em; } /* Smooth anchor scroll */ html { scroll-behavior: smooth; } /* Language switcher */ .language-switcher { display: inline-block; position: relative; margin-left: 8px; } .language-switcher-btn { cursor: pointer; font-size: 0.8rem; font-weight: 500; font-family: var(--font-sans); list-style: none; padding: 4px 10px; border: 1px solid var(--border-color, #D5D6E0); border-radius: 16px; display: inline-flex; align-items: center; gap: 4px; transition: background-color 0.2s ease; } .language-switcher-btn:hover { background-color: rgba(128, 128, 128, 0.1); } .language-switcher[open] .language-switcher-list { display: block; } .language-switcher-list { position: absolute; top: 100%; right: 0; left: auto; z-index: 100; list-style: none; padding: 8px 0; margin: 4px 0 0; min-width: 140px; background: var(--body-background-color, #fff); border: 1px solid var(--border-color, #D5D6E0); border-radius: 12px; box-shadow: 0 4px 12px rgba(0,0,0,0.1); } .language-switcher-list li { padding: 0; } .language-switcher-list a { display: block; padding: 6px 16px; text-decoration: none; font-size: 0.85rem; color: inherit; } .language-switcher-list a:hover { background-color: rgba(103, 234, 148, 0.15); } /* Version switcher (shares the language-switcher dropdown styling) */ .version-switcher { margin-left: 8px; } .version-switcher[hidden] { display: none; } /* Link out to the upstream meshtastic.org docs */ .upstream-docs-link { display: inline-flex; align-items: center; margin-left: 8px; padding: 4px 10px; border: 1px solid var(--border-color, #D5D6E0); border-radius: 16px; font-size: 0.8rem; font-weight: 500; font-family: var(--font-sans); text-decoration: none; color: inherit; transition: background-color 0.2s ease; } .upstream-docs-link:hover { background-color: rgba(128, 128, 128, 0.1); } </style> <script> // Respect OS preference on first visit, then remember user choice (function() { var stored = localStorage.getItem('jtd-theme'); if (stored) return; // will be applied by jtd.setTheme below if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) { localStorage.setItem('jtd-theme', 'meshtastic-dark'); } })(); </script> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md --> <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <header class="side-bar"> <div class="site-header"> <a href="/Meshtastic-Android/main/" class="site-title lh-tight"> Meshtastic Android </a> <button id="menu-button" class="site-button btn-reset" aria-label="Menu" aria-expanded="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/" class="nav-list-link">Home</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/" class="nav-list-link">Home</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="User Guide submenu" aria-expanded="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/Meshtastic-Android/main/en/user.html" class="nav-list-link">User Guide</a><ul class="nav-list"><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/onboarding.html" class="nav-list-link">Getting Started</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/onboarding.html" class="nav-list-link">Getting Started</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/connections.html" class="nav-list-link">Connections</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/connections.html" class="nav-list-link">Connexions</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/messages-and-channels.html" class="nav-list-link">Messages & Channels</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/messages-and-channels.html" class="nav-list-link">Messages & Channels</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/nodes.html" class="nav-list-link">Nodes</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/nodes.html" class="nav-list-link">Nœuds</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/node-metrics.html" class="nav-list-link">Node Metrics</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/node-metrics.html" class="nav-list-link">Node Metrics</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/map-and-waypoints.html" class="nav-list-link">Map & Waypoints</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/map-and-waypoints.html" class="nav-list-link">Map & Waypoints</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/settings-radio-user.html" class="nav-list-link">Settings — Radio & User</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/settings-radio-user.html" class="nav-list-link">Settings — Radio & User</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/settings-module-admin.html" class="nav-list-link">Settings — Modules & Admin</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/settings-module-admin.html" class="nav-list-link">Settings — Modules & Admin</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/telemetry-and-sensors.html" class="nav-list-link">Telemetry & Sensors</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/telemetry-and-sensors.html" class="nav-list-link">Telemetry & Sensors</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/tak.html" class="nav-list-link">TAK Integration</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/tak.html" class="nav-list-link">TAK Integration</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/mqtt.html" class="nav-list-link">MQTT</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/mqtt.html" class="nav-list-link">MQTT</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/discovery.html" class="nav-list-link">Local Mesh Discovery</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/discovery.html" class="nav-list-link">Découverte de maille locale</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/firmware.html" class="nav-list-link">Firmware Updates</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/firmware.html" class="nav-list-link">Firmware Updates</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/desktop.html" class="nav-list-link">Desktop App</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/desktop.html" class="nav-list-link">Desktop App</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/signal-meter.html" class="nav-list-link">How the Meshtastic Signal Meter Works</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/signal-meter.html" class="nav-list-link">How the Meshtastic Signal Meter Works</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/units-and-locale.html" class="nav-list-link">Units, Measurement & Locale</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/units-and-locale.html" class="nav-list-link">Units, Measurement & Locale</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/translate.html" class="nav-list-link">Translate the App</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/fr-rCA/user/translate.html" class="nav-list-link">Translate the App</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/app-functions.html" class="nav-list-link">App Functions</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/widget.html" class="nav-list-link">Home Screen Widget</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/help-and-docs.html" class="nav-list-link">Help & In-App Docs</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/user/debug-logs.html" class="nav-list-link">Debug Logs</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Developer Guide submenu" aria-expanded="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/Meshtastic-Android/main/en/developer.html" class="nav-list-link">Developer Guide</a><ul class="nav-list"><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/developer/architecture.html" class="nav-list-link">Architecture</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/developer/codebase.html" class="nav-list-link">Codebase</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/developer/adding-a-feature-module.html" class="nav-list-link">Adding a Feature Module</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/developer/navigation-and-deep-links.html" class="nav-list-link">Navigation & Deep Links</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/developer/transport.html" class="nav-list-link">Transport</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/developer/persistence.html" class="nav-list-link">Persistence</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/developer/testing.html" class="nav-list-link">Testing</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/developer/contributing.html" class="nav-list-link">Contributing</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/developer/measurement.html" class="nav-list-link">Measurement & Formatting</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/developer/test-builds.html" class="nav-list-link">Test Builds & Obtainium</a></li><li class="nav-list-item"><a href="/Meshtastic-Android/main/en/developer/documentation-style.html" class="nav-list-link">Documentation Style</a></li></ul></li></ul> </nav> <div class="d-md-block d-sm-none"> <div class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </div> </div> </header> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search Meshtastic Android" autocomplete="off"> <label for="search-input" class="search-label"> <span class="sr-only">Search Meshtastic Android</span> <svg viewBox="0 0 24 24" class="search-icon" aria-hidden="true"><use xlink:href="#svg-search"></use></svg> </label> </div> <div id="search-results" class="search-results"></div> </div> <div class="theme-toggle-wrap"> <button class="theme-toggle" id="theme-toggle" aria-label="Toggle dark mode" title="Toggle light/dark theme" onclick="toggleMeshtasticTheme()"> <span id="theme-icon">🌙</span> <span id="theme-label">Dark</span> </button> <details class="language-switcher version-switcher" id="version-switcher" aria-label="Documentation version" hidden> <summary class="language-switcher-btn" title="Switch documentation version"> 🏷️ <span id="version-current"></span> </summary> <ul class="language-switcher-list" id="version-switcher-list"></ul> </details> <script> (function() { var baseurl = '/Meshtastic-Android/main'; var root = baseurl; var channel = 'latest'; // /main/, /vX.Y.Z/ or a prerelease snapshot like /v2.8.0-open.1/. var match = baseurl.match(/^(.*)\/(main|v\d+\.\d+\.\d+(?:-(?:open|closed)\.\d+)?)$/); if (match) { root = match[1]; channel = match[2]; } fetch(root + '/versions.json') .then(function(res) { return res.ok ? res.json() : Promise.reject(); }) .then(function(data) { var switcher = document.getElementById('version-switcher'); var list = document.getElementById('version-switcher-list'); var current = document.getElementById('version-current'); if (!switcher || !list || !current) return; // Keep the reader on the same page when switching channels; a page // that doesn't exist in the target version lands on the 404 page. var relativePath = location.pathname.slice(baseurl.length) + location.hash; var entries = []; if (data.latest) { entries.push({ id: 'latest', label: 'latest (v' + data.latest + ')', base: root }); } // Prereleases are documented ahead of general availability, so the track // is always spelled out — a reader must not mistake a closed-testing // snapshot for a shipped release. (data.prereleases || []).forEach(function(p) { entries.push({ id: p.dir, label: p.dir.replace(/^v/, 'v') + ' — ' + p.track + ' testing', base: root + '/' + p.dir }); }); if (data.hasMain) { entries.push({ id: 'main', label: 'main (unreleased snapshot)', base: root + '/main' }); } (data.versions || []).forEach(function(v) { entries.push({ id: 'v' + v, label: 'v' + v, base: root + '/v' + v }); }); var currentEntry = entries.filter(function(e) { return e.id === channel; })[0]; current.textContent = currentEntry ? currentEntry.label : channel; var others = entries.filter(function(e) { return e.id !== channel; }); if (others.length === 0) return; others.forEach(function(e) { var li = document.createElement('li'); var a = document.createElement('a'); a.href = e.base + relativePath; a.textContent = e.label; li.appendChild(a); list.appendChild(li); }); switcher.hidden = false; }) .catch(function() { /* no manifest (local build) — leave switcher hidden */ }); })(); </script> <a class="upstream-docs-link" href="https://meshtastic.org/docs/" title="Official Meshtastic documentation (meshtastic.org)">Meshtastic Docs ↗</a> </div> <script> function toggleMeshtasticTheme() { var current = localStorage.getItem('jtd-theme') || 'meshtastic'; var next = (current === 'meshtastic-dark') ? 'meshtastic' : 'meshtastic-dark'; if (typeof jtd !== 'undefined' && typeof jtd.setTheme === 'function') { jtd.setTheme(next); } localStorage.setItem('jtd-theme', next); var icon = document.getElementById('theme-icon'); var label = document.getElementById('theme-label'); if (icon && label) { icon.textContent = (next === 'meshtastic-dark') ? '☀️' : '🌙'; label.textContent = (next === 'meshtastic-dark') ? 'Light' : 'Dark'; } } // Apply stored/OS theme on page load (function() { var theme = localStorage.getItem('jtd-theme') || 'meshtastic'; // Sync toggle label immediately var icon = document.getElementById('theme-icon'); var label = document.getElementById('theme-label'); if (icon && label) { icon.textContent = (theme === 'meshtastic-dark') ? '☀️' : '🌙'; label.textContent = (theme === 'meshtastic-dark') ? 'Light' : 'Dark'; } // Apply theme once jtd is ready function tryApply() { if (typeof jtd !== 'undefined' && typeof jtd.setTheme === 'function') { jtd.setTheme(theme); } else { setTimeout(tryApply, 50); } } tryApply(); })(); </script> </div> <div class="main-content-wrap"> <nav aria-label="Breadcrumb" class="breadcrumb-nav"> <ol class="breadcrumb-nav-list"> <li class="breadcrumb-nav-list-item"><a href="/Meshtastic-Android/main/en/developer.html">Developer Guide</a></li> <li class="breadcrumb-nav-list-item"><span>Architecture</span></li> </ol> </nav> <div id="main-content" class="main-content"> <main> <h1 id="architecture"> <a href="#architecture" class="anchor-heading" aria-labelledby="architecture"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Architecture </h1> <p>The Meshtastic Android and Desktop apps follow a modular Kotlin Multiplatform (KMP) architecture with clear layer boundaries. iOS is a compile-only validation target; no iOS app ships.</p> <h2 id="layer-overview"> <a href="#layer-overview" class="anchor-heading" aria-labelledby="layer-overview"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Layer Overview </h2> <div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>┌─────────────────────────────────────────────┐
│ androidApp / desktopApp │ Platform entry points
├─────────────────────────────────────────────┤
│ feature/* modules │ UI + Business Logic
├─────────────────────────────────────────────┤
│ core/* modules │ Shared infrastructure
├─────────────────────────────────────────────┤
│ Platform (Android/JVM/iOS) │ OS-specific bindings
└─────────────────────────────────────────────┘
</code></pre></div></div> <h2 id="module-categories"> <a href="#module-categories" class="anchor-heading" aria-labelledby="module-categories"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Module Categories </h2> <h3 id="androidapp--android-application"> <a href="#androidapp--android-application" class="anchor-heading" aria-labelledby="androidapp--android-application"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <code class="language-plaintext highlighter-rouge">androidApp/</code> — Android Application </h3> <p>The Android application entry point:</p> <ul> <li>Activity, Application, and Manifest definitions</li> <li>Koin DI module composition (<code class="language-plaintext highlighter-rouge">AppKoinModule</code>)</li> <li>Flavor-specific bindings (<code class="language-plaintext highlighter-rouge">google/</code>, <code class="language-plaintext highlighter-rouge">fdroid/</code>)</li> <li>Android-only integrations (widgets, services)</li> </ul> <h3 id="desktopapp--desktop-jvm-application"> <a href="#desktopapp--desktop-jvm-application" class="anchor-heading" aria-labelledby="desktopapp--desktop-jvm-application"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <code class="language-plaintext highlighter-rouge">desktopApp/</code> — Desktop JVM Application </h3> <p>The Desktop (Linux/macOS/Windows) entry point:</p> <ul> <li>Compose Desktop window management</li> <li>Desktop-specific DI (<code class="language-plaintext highlighter-rouge">DesktopKoinModule</code>)</li> <li>Platform stubs for Android-only capabilities</li> <li><code class="language-plaintext highlighter-rouge">DesktopRadioTransportFactory</code> and a jSerialComm-based serial transport; the BLE and TCP transport implementations it wires up are shared code — they live in <code class="language-plaintext highlighter-rouge">core:network</code>, built on <code class="language-plaintext highlighter-rouge">core:ble</code>’s BLE primitives — not desktopApp-owned</li> </ul> <h3 id="feature--feature-modules"> <a href="#feature--feature-modules" class="anchor-heading" aria-labelledby="feature--feature-modules"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <code class="language-plaintext highlighter-rouge">feature/*</code> — Feature Modules </h3> <p>Each <code class="language-plaintext highlighter-rouge">feature/</code> module owns a vertical slice of functionality:</p> <div class="table-wrapper"><table> <thead> <tr> <th>Module</th> <th>Responsibility</th> </tr> </thead> <tbody> <tr> <td><code class="language-plaintext highlighter-rouge">feature:intro</code></td> <td>Onboarding/welcome flow</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">feature:messaging</code></td> <td>Messages, channels, contacts, quick chat</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">feature:connections</code></td> <td>Bluetooth/USB/TCP connection management</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">feature:map</code></td> <td>Map display, waypoints — shared state, policy and the waypoint editor</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">feature:map-maplibre</code></td> <td>MapLibre map surfaces — used by the <code class="language-plaintext highlighter-rouge">fdroid</code> flavor and Desktop; the <code class="language-plaintext highlighter-rouge">google</code> flavor uses Google Maps instead. Tile-source definitions and the custom-source editor are in <code class="language-plaintext highlighter-rouge">feature:map</code>, so both renderers share them</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">feature:node</code></td> <td>Node list, node detail, metrics</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">feature:settings</code></td> <td>All configuration screens</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">feature:firmware</code></td> <td>Firmware update flow</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">feature:docs</code></td> <td>In-app documentation browser</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">feature:wifi-provision</code></td> <td>Wi-Fi provisioning</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">feature:widget</code></td> <td>Android home screen widgets</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">feature:discovery</code></td> <td>Mesh network discovery</td> </tr> </tbody> </table></div> <p>Feature modules:</p> <ul> <li>Use the <code class="language-plaintext highlighter-rouge">meshtastic.kmp.feature</code> convention plugin</li> <li>Depend on <code class="language-plaintext highlighter-rouge">core</code> modules, never on other <code class="language-plaintext highlighter-rouge">feature</code> modules</li> <li>Own their navigation entries and DI registrations</li> <li>Contain platform-specific implementations in <code class="language-plaintext highlighter-rouge">androidMain</code>/<code class="language-plaintext highlighter-rouge">jvmMain</code>/<code class="language-plaintext highlighter-rouge">iosMain</code></li> </ul> <h3 id="core--core-modules"> <a href="#core--core-modules" class="anchor-heading" aria-labelledby="core--core-modules"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <code class="language-plaintext highlighter-rouge">core/*</code> — Core Modules </h3> <p>Shared infrastructure used by all features:</p> <div class="table-wrapper"><table> <thead> <tr> <th>Module</th> <th>Responsibility</th> </tr> </thead> <tbody> <tr> <td><code class="language-plaintext highlighter-rouge">core:common</code></td> <td>Utilities, extensions, build config</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:navigation</code></td> <td>Routes, deep links, Navigation 3</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:ui</code></td> <td>Shared Compose components, icons, theme</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:resources</code></td> <td>Shared string resources</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:model</code></td> <td>Domain models</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:data</code></td> <td>Data layer abstractions</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:domain</code></td> <td>Use cases / business logic</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:database</code></td> <td>Room KMP database</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:datastore</code></td> <td>DataStore preferences</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:prefs</code></td> <td>App preferences</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:repository</code></td> <td>Repository interfaces</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:service</code></td> <td>Mesh service layer</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:di</code></td> <td>DI utilities</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:network</code></td> <td>HTTP/serial/transport</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:ble</code></td> <td>Bluetooth LE abstractions</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:barcode</code></td> <td>QR / barcode scanning (channel-share QR codes)</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:nfc</code></td> <td>NFC read/write support</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:takserver</code></td> <td>Embedded TAK server integration</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:testing</code></td> <td>Test utilities</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">core:konsist</code></td> <td>Konsist architecture/convention tests</td> </tr> </tbody> </table></div> <p>Protobuf models come from the external <code class="language-plaintext highlighter-rouge">org.meshtastic:protobufs</code> Maven artifact (pinned in <code class="language-plaintext highlighter-rouge">gradle/libs.versions.toml</code>).</p> <h2 id="kmp-source-sets"> <a href="#kmp-source-sets" class="anchor-heading" aria-labelledby="kmp-source-sets"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> KMP Source Sets </h2> <p>Each module uses the standard KMP source set hierarchy:</p> <div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>src/
├── commonMain/ ← Shared code (all platforms)
├── commonTest/ ← Shared tests
├── androidMain/ ← Android-specific
├── jvmMain/ ← Desktop JVM-specific
├── iosMain/ ← iOS-specific
└── jvmTest/ ← Desktop test host
</code></pre></div></div> <p><strong>Golden Rules:</strong></p> <ul> <li>No <code class="language-plaintext highlighter-rouge">android.*</code> imports in <code class="language-plaintext highlighter-rouge">commonMain</code></li> <li>Platform-specific code goes in appropriate source set</li> <li>Prefer interfaces + DI over <code class="language-plaintext highlighter-rouge">expect</code>/<code class="language-plaintext highlighter-rouge">actual</code> for complex behaviors</li> <li>Use <code class="language-plaintext highlighter-rouge">expect</code>/<code class="language-plaintext highlighter-rouge">actual</code> only for simple declarations</li> </ul> <h2 id="dependency-injection"> <a href="#dependency-injection" class="anchor-heading" aria-labelledby="dependency-injection"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Dependency Injection </h2> <p>The project uses <strong>Koin</strong> with annotation processing:</p> <ul> <li><code class="language-plaintext highlighter-rouge">@Module</code>, <code class="language-plaintext highlighter-rouge">@Single</code>, <code class="language-plaintext highlighter-rouge">@Factory</code> annotations</li> <li><code class="language-plaintext highlighter-rouge">@ComponentScan</code> for automatic registration</li> <li>Feature modules export their own <code class="language-plaintext highlighter-rouge">Feature*Module</code> class</li> <li>App/Desktop compose all modules in their root DI configuration</li> </ul> <h2 id="radio-control"> <a href="#radio-control" class="anchor-heading" aria-labelledby="radio-control"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Radio Control </h2> <p>Features issue radio commands through <code class="language-plaintext highlighter-rouge">RadioController</code> (<code class="language-plaintext highlighter-rouge">core:repository</code>), a composite of four focused sub-interfaces so callers can depend on just the slice they need:</p> <div class="table-wrapper"><table> <thead> <tr> <th>Sub-interface</th> <th>Responsibility</th> </tr> </thead> <tbody> <tr> <td><code class="language-plaintext highlighter-rouge">AdminController</code></td> <td>Config, channels, owner, device lifecycle, <code class="language-plaintext highlighter-rouge">editSettings { }</code> transactions</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">MessagingController</code></td> <td>Send packets, reactions, shared contacts</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">NodeController</code></td> <td>Favorite, ignore, mute, remove nodes</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">QueryController</code></td> <td>Telemetry, traceroute, position/user-info queries</td> </tr> </tbody> </table></div> <p><code class="language-plaintext highlighter-rouge">RadioControllerImpl</code> (<code class="language-plaintext highlighter-rouge">core:service</code>) is the in-process composition root for all targets (Desktop, iOS, single-process Android). It assembles the four sub-controllers via Kotlin interface delegation and adds the cross-cutting concerns (connection state, packet-id, location, device-address switching). Commands are direct suspend calls; admin writes are fire-and-forget because the device is the source of truth (local persistence is an optimistic cache). The layered shape mirrors the <a href="https://github.com/meshtastic/meshtastic-sdk">meshtastic-sdk</a> <code class="language-plaintext highlighter-rouge">AdminApi</code>/<code class="language-plaintext highlighter-rouge">TelemetryApi</code> design to ease a future SDK migration.</p> <h2 id="service-repository"> <a href="#service-repository" class="anchor-heading" aria-labelledby="service-repository"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Service Repository </h2> <p><code class="language-plaintext highlighter-rouge">ServiceRepository</code> is the reactive bridge between the mesh service and all feature/UI layers. It is decomposed into focused provider interfaces following the Interface Segregation Principle:</p> <div class="table-wrapper"><table> <thead> <tr> <th>Interface</th> <th>Responsibility</th> </tr> </thead> <tbody> <tr> <td><code class="language-plaintext highlighter-rouge">ConnectionStateProvider</code></td> <td>Read-only <code class="language-plaintext highlighter-rouge">connectionState: StateFlow&lt;ConnectionState&gt;</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">TracerouteResponseProvider</code></td> <td>Traceroute response state + clear</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">NeighborInfoResponseProvider</code></td> <td>Neighbor info response state + clear</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">ServiceStateWriter</code></td> <td>Write-side for handlers (set<em>, emit</em>, clear*)</td> </tr> </tbody> </table></div> <p><code class="language-plaintext highlighter-rouge">ServiceRepository</code> extends all four interfaces — consumers inject the narrowest interface they actually need. For example, <code class="language-plaintext highlighter-rouge">ContactsViewModel</code> injects only <code class="language-plaintext highlighter-rouge">ConnectionStateProvider</code> rather than the entire <code class="language-plaintext highlighter-rouge">ServiceRepository</code>, preventing accidental access to write operations from UI code. <code class="language-plaintext highlighter-rouge">RadioController</code> also extends <code class="language-plaintext highlighter-rouge">ConnectionStateProvider</code> so VMs that already inject a controller sub-interface can read connection state without a separate dependency.</p> <h2 id="navigation"> <a href="#navigation" class="anchor-heading" aria-labelledby="navigation"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Navigation </h2> <p>Navigation uses <strong>Navigation 3</strong> with typed routes:</p> <ul> <li>All routes defined in <code class="language-plaintext highlighter-rouge">core/navigation/Routes.kt</code></li> <li>Routes are <code class="language-plaintext highlighter-rouge">@Serializable</code> data classes/objects</li> <li>Deep links resolved through <code class="language-plaintext highlighter-rouge">DeepLinkRouter</code></li> <li>Each feature registers its own navigation entries</li> </ul> <p>See <a href="navigation-and-deep-links">Navigation &amp; Deep Links</a> for details.</p> </main> <hr> <footer> <footer class="site-footer"> Copyright &copy; 2026 Meshtastic LLC. Distributed under the <a href="https://www.gnu.org/licenses/gpl-3.0.html">GPL v3 License.</a> </footer> <div class="d-sm-block d-md-none"> <div class="mt-4 fs-2"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </div> </div> </footer> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
Reference in new issue View Git Blame Copy Permalink