feat(wifi): introduce BLE-based WiFi provisioning for nymea-compatible devices (#4968)
Some checks are pending
Dependency Submission / dependency-submission (push) Waiting to run
Main CI (Verify & Build) / validate-and-build (push) Waiting to run
Main Push Changelog / Generate main push changelog (push) Waiting to run

This commit is contained in:
James Rich 2026-04-02 12:31:17 -05:00 committed by GitHub
parent 1fee6c4431
commit 7e041c00e1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
38 changed files with 3326 additions and 50 deletions

View file

@ -0,0 +1,96 @@
/*
* Copyright (c) 2026 Meshtastic LLC
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package org.meshtastic.core.common.util
import kotlin.test.Test
import kotlin.test.assertEquals
class FormatStringTest {
@Test
fun positionalStringSubstitution() {
assertEquals("Hello World", formatString("%1\$s %2\$s", "Hello", "World"))
}
@Test
fun positionalIntSubstitution() {
assertEquals("Count: 42", formatString("Count: %1\$d", 42))
}
@Test
fun positionalFloatSubstitution() {
assertEquals("Value: 3.1", formatString("Value: %1\$.1f", 3.14159))
}
@Test
fun positionalFloatTwoDecimals() {
assertEquals("12.35%", formatString("%1\$.2f%%", 12.345))
}
@Test
fun literalPercentEscape() {
assertEquals("100%", formatString("100%%"))
}
@Test
fun mixedPositionalArgs() {
assertEquals("Battery: 85, Voltage: 3.7 V", formatString("Battery: %1\$d, Voltage: %2\$.1f V", 85, 3.7))
}
@Test
fun deviceMetricsPercentTemplate() {
assertEquals("ChUtil: 18.5%", formatString("%1\$s: %2\$.1f%%", "ChUtil", 18.456))
}
@Test
fun deviceMetricsVoltageTemplate() {
assertEquals("Voltage: 3.7 V", formatString("%1\$s: %2\$.1f V", "Voltage", 3.725))
}
@Test
fun deviceMetricsNumericTemplate() {
assertEquals("42.3", formatString("%1\$.1f", 42.345))
}
@Test
fun localStatsUtilizationTemplate() {
assertEquals(
"ChUtil: 12.35% | AirTX: 5.68%",
formatString("ChUtil: %1\$.2f%% | AirTX: %2\$.2f%%", 12.345, 5.678),
)
}
@Test
fun noArgsPlainString() {
assertEquals("Hello", formatString("Hello"))
}
@Test
fun sequentialStringSubstitution() {
assertEquals("a b", formatString("%s %s", "a", "b"))
}
@Test
fun sequentialIntSubstitution() {
assertEquals("1 2", formatString("%d %d", 1, 2))
}
@Test
fun sequentialFloatSubstitution() {
assertEquals("1.2 3.5", formatString("%.1f %.1f", 1.23, 3.45))
}
}

View file

@ -16,7 +16,85 @@
*/
package org.meshtastic.core.common.util
/** Apple (iOS) implementation of string formatting. Stub implementation for compile-only validation. */
actual fun formatString(pattern: String, vararg args: Any?): String = throw UnsupportedOperationException(
"formatString is not supported on iOS at runtime; this target is intended for compile-only validation.",
)
/**
* Apple (iOS) implementation of string formatting.
*
* Implements a subset of Java's `String.format()` patterns used in this codebase:
* - `%s`, `%d` positional or sequential string/integer
* - `%N$s`, `%N$d` explicit positional string/integer
* - `%N$.Nf`, `%.Nf` float with decimal precision
* - `%%` literal percent
*
* This avoids a dependency on `NSString.stringWithFormat` (which uses Obj-C `%@` conventions).
*/
actual fun formatString(pattern: String, vararg args: Any?): String = buildString {
var i = 0
var autoIndex = 0
while (i < pattern.length) {
if (pattern[i] != '%') {
append(pattern[i])
i++
continue
}
i++ // skip '%'
if (i >= pattern.length) break
// Literal %%
if (pattern[i] == '%') {
append('%')
i++
continue
}
// Parse optional positional index (N$)
var explicitIndex: Int? = null
val startPos = i
while (i < pattern.length && pattern[i].isDigit()) i++
if (i < pattern.length && pattern[i] == '$' && i > startPos) {
explicitIndex = pattern.substring(startPos, i).toInt() - 1 // 1-indexed → 0-indexed
i++ // skip '$'
} else {
i = startPos // rewind — digits are part of width/precision, not positional index
}
// Parse optional flags/width (skip for now — not used in this codebase)
// Parse optional precision (.N)
var precision: Int? = null
if (i < pattern.length && pattern[i] == '.') {
i++ // skip '.'
val precStart = i
while (i < pattern.length && pattern[i].isDigit()) i++
if (i > precStart) {
precision = pattern.substring(precStart, i).toInt()
}
}
// Parse conversion character
if (i >= pattern.length) break
val conversion = pattern[i]
i++
val argIndex = explicitIndex ?: autoIndex++
val arg = args.getOrNull(argIndex)
when (conversion) {
's' -> append(arg?.toString() ?: "null")
'd' -> append((arg as? Number)?.toLong()?.toString() ?: arg?.toString() ?: "0")
'f' -> {
val value = (arg as? Number)?.toDouble() ?: 0.0
val places = precision ?: DEFAULT_FLOAT_PRECISION
append(NumberFormatter.format(value, places))
}
else -> {
// Unknown conversion — reproduce original token
append('%')
if (explicitIndex != null) append("${explicitIndex + 1}$")
if (precision != null) append(".$precision")
append(conversion)
}
}
}
}
private const val DEFAULT_FLOAT_PRECISION = 6

View file

@ -35,7 +35,8 @@ import org.meshtastic.core.common.util.CommonUri
* - `/messages/{contactKey}` -> Specific conversation
* - `/settings` -> Settings root
* - `/settings/{destNum}/{page}` -> Specific settings page for a node
* - `/share?message={text}` -> Share message screen
* - `/wifi-provision` -> WiFi provisioning screen
* - `/wifi-provision?address={mac}` -> WiFi provisioning targeting a specific device MAC address
*/
object DeepLinkRouter {
/**
@ -64,6 +65,7 @@ object DeepLinkRouter {
"settings" -> routeSettings(pathSegments)
"channels" -> listOf(ChannelsRoutes.ChannelsGraph)
"firmware" -> routeFirmware(pathSegments)
"wifi-provision" -> routeWifiProvision(uri)
else -> {
Logger.w { "Unrecognized deep link segment: $firstSegment" }
null
@ -151,6 +153,11 @@ object DeepLinkRouter {
}
}
private fun routeWifiProvision(uri: CommonUri): List<NavKey> {
val address = uri.getQueryParameter("address")
return listOf(WifiProvisionRoutes.WifiProvision(address))
}
private fun routeFirmware(segments: List<String>): List<NavKey> {
val update = if (segments.size > 1) segments[1].lowercase() == "update" else false
return if (update) {

View file

@ -176,3 +176,9 @@ object FirmwareRoutes {
@Serializable data object FirmwareUpdate : Route
}
object WifiProvisionRoutes {
@Serializable data object WifiProvisionGraph : Graph
@Serializable data class WifiProvision(val address: String? = null) : Route
}

View file

@ -29,7 +29,7 @@
<string name="default_mqtt_address" translatable="false">mqtt.meshtastic.org</string>
<string name="fallback_node_name">Meshtastic</string>
<string name="fallback_node_name">Meshtastic %1$s</string>
<string name="node_filter_placeholder">Filter</string>
<string name="desc_node_filter_clear">clear node filter</string>
<string name="node_filter_title">Filter by</string>
@ -186,7 +186,6 @@
<string name="debug">Debug</string>
<string name="elevation_suffix" translatable="false">MSL</string>
<string name="channel_air_util" translatable="false">ChUtil %.1f%% AirUtilTX %.1f%%</string>
<string name="channel">Ch</string>
<string name="channel_name">Channel Name</string>
@ -405,8 +404,8 @@
<string name="currently">Currently:</string>
<string name="mute_status_always">Always muted</string>
<string name="mute_status_unmuted">Not muted</string>
<string name="mute_status_muted_for_days">Muted for %1$d days, %2$.1f hours</string>
<string name="mute_status_muted_for_hours">Muted for %1$.1f hours</string>
<string name="mute_status_muted_for_days">Muted for %1$d days, %2$s hours</string>
<string name="mute_status_muted_for_hours">Muted for %1$s hours</string>
<string name="mute_status_label">Mute status</string>
<string name="mute_add">Mute notifications for '%1$s'?</string>
<string name="mute_remove">Unmute notifications for '%1$s'?</string>
@ -504,7 +503,7 @@
<string name="are_you_sure">Are you sure?</string>
<string name="router_role_confirmation_text"><![CDATA[I have read the <a href="https://meshtastic.org/docs/configuration/radio/device/#roles">Device Role Documentation</a> and the blog post about <a href="http://meshtastic.org/blog/choosing-the-right-device-role">Choosing The Right Device Role</a>.]]></string>
<string name="i_know_what_i_m_doing">I know what I'm doing.</string>
<string name="low_battery_message">Node %1$s has a low battery (%2$d%%)</string>
<string name="low_battery_message">Node %1$s has a low battery (%2$d%)</string>
<string name="meshtastic_low_battery_notifications">Low battery notifications</string>
<string name="low_battery_title">Low battery: %1$s</string>
<string name="meshtastic_low_battery_temporary_remote_notifications">Low battery notifications (favorite nodes)</string>
@ -1081,7 +1080,7 @@
<string name="firmware_update_stable">Stable</string>
<string name="firmware_update_alpha">Alpha</string>
<string name="firmware_update_disconnect_warning">Note: This will temporarily disconnect your device during the update.</string>
<string name="firmware_update_downloading_percent">Downloading firmware... %1$d%%</string>
<string name="firmware_update_downloading_percent">Downloading firmware... %1$d%</string>
<string name="firmware_update_error">Error: %1$s</string>
<string name="firmware_update_retry">Retry</string>
<string name="firmware_update_success">Update Successful!</string>
@ -1132,7 +1131,7 @@
<string name="firmware_update_dfu_error">DFU Error: %1$s</string>
<string name="firmware_update_dfu_aborted">DFU Aborted</string>
<string name="firmware_update_node_info_missing">Node user information is missing.</string>
<string name="firmware_update_battery_low">Battery too low (%1$d%%). Please charge your device before updating.</string>
<string name="firmware_update_battery_low">Battery too low (%1$d%). Please charge your device before updating.</string>
<string name="firmware_update_retrieval_failed">Could not retrieve firmware file.</string>
<string name="firmware_update_nordic_failed">Nordic DFU Update failed</string>
<string name="firmware_update_usb_failed">USB Update failed</string>
@ -1144,7 +1143,7 @@
<string name="firmware_update_checking_version">Checking device version...</string>
<string name="firmware_update_starting_ota">Starting OTA update...</string>
<string name="firmware_update_uploading">Uploading firmware...</string>
<string name="firmware_update_uploading_progress">Uploading firmware... %1$d%% (%2$s)</string>
<string name="firmware_update_uploading_progress">Uploading firmware... %1$d% (%2$s)</string>
<string name="firmware_update_rebooting_device">Rebooting device...</string>
<string name="firmware_update_channel_name">Firmware Update</string>
<string name="firmware_update_channel_description">Firmware update status</string>
@ -1230,10 +1229,10 @@
<string name="map_style_selection">Map style selection</string>
<string name="local_stats_battery">Battery: %1$d%%</string>
<string name="local_stats_battery">Battery: %1$d%</string>
<string name="local_stats_nodes">Nodes: %1$d online / %2$d total</string>
<string name="local_stats_uptime">Uptime: %1$s</string>
<string name="local_stats_utilization">ChUtil: %1$.2f%% | AirTX: %2$.2f%%</string>
<string name="local_stats_utilization">ChUtil: %1$s% | AirTX: %2$s%</string>
<string name="local_stats_traffic">Traffic: TX %1$d / RX %2$d (D: %3$d)</string>
<string name="local_stats_relays">Relays: %1$d (Canceled: %2$d)</string>
<string name="local_stats_diagnostics_prefix">Diagnostics: %1$s</string>
@ -1325,4 +1324,28 @@
<string name="files_available">Files available (%1$d):</string>
<string name="file_entry">- %1$s (%2$d bytes)</string>
<string name="no_files_manifested">No files manifested.</string>
<string name="connect">Connect</string>
<string name="done">Done</string>
<string name="wifi_provisioning">WiFi Provisioning</string>
<string name="wifi_provision_description">Provision WiFi credentials to your Meshtastic device via Bluetooth.</string>
<string name="wifi_provision_scanning_ble">Searching for device…</string>
<string name="wifi_provision_device_found">Device found</string>
<string name="wifi_provision_device_found_detail">Ready to scan for WiFi networks.</string>
<string name="wifi_provision_scan_networks">Scan for Networks</string>
<string name="wifi_provision_scanning_wifi">Scanning…</string>
<string name="wifi_provision_sending_credentials">Applying WiFi configuration…</string>
<string name="wifi_provision_success">WiFi configured successfully!</string>
<string name="wifi_provision_success_detail">WiFi credentials applied. The device will connect to the network shortly.</string>
<string name="wifi_provision_no_networks">No networks found</string>
<string name="wifi_provision_no_networks_detail">Make sure the device is powered on and within range.</string>
<string name="wifi_provision_connect_failed">Could not connect: %1$s</string>
<string name="wifi_provision_scan_failed">Failed to scan for WiFi networks: %1$s</string>
<string name="wifi_provision_refresh">Refresh</string>
<string name="wifi_provision_signal_strength">%1$d%</string>
<string name="wifi_provision_available_networks">Available Networks</string>
<string name="wifi_provision_ssid_label">Network Name (SSID)</string>
<string name="wifi_provision_ssid_placeholder">Enter or select a network</string>
<string name="wifi_provision_status_applied">WiFi configured successfully!</string>
<string name="wifi_provision_status_failed">Failed to apply WiFi configuration</string>
</resources>

View file

@ -40,6 +40,7 @@ import kotlinx.coroutines.flow.first
import kotlinx.coroutines.runBlocking
import org.jetbrains.compose.resources.StringResource
import org.koin.core.annotation.Single
import org.meshtastic.core.common.util.NumberFormatter
import org.meshtastic.core.common.util.nowMillis
import org.meshtastic.core.model.DataPacket
import org.meshtastic.core.model.Message
@ -667,7 +668,7 @@ class MeshServiceNotificationsImpl(
}
private fun createNewNodeSeenNotification(name: String, message: String, nodeNum: Int): Notification {
val title = getString(Res.string.new_node_seen).format(name)
val title = getString(Res.string.new_node_seen, name)
val builder =
commonBuilder(NotificationType.NewNode, createOpenNodeDetailIntent(nodeNum))
.setCategory(Notification.CATEGORY_STATUS)
@ -683,9 +684,9 @@ class MeshServiceNotificationsImpl(
private fun createLowBatteryNotification(node: Node, isRemote: Boolean): Notification {
val type = if (isRemote) NotificationType.LowBatteryRemote else NotificationType.LowBatteryLocal
val title = getString(Res.string.low_battery_title).format(node.user.short_name)
val title = getString(Res.string.low_battery_title, node.user.short_name)
val batteryLevel = node.deviceMetrics.battery_level ?: 0
val message = getString(Res.string.low_battery_message).format(node.user.long_name, batteryLevel)
val message = getString(Res.string.low_battery_message, node.user.long_name, batteryLevel)
return commonBuilder(type, createOpenNodeDetailIntent(node.num))
.setCategory(Notification.CATEGORY_STATUS)
@ -876,44 +877,48 @@ class MeshServiceNotificationsImpl(
if (it > MAX_BATTERY_LEVEL) {
parts.add(BULLET + getString(Res.string.powered))
} else {
parts.add(BULLET + getString(Res.string.local_stats_battery).format(it))
parts.add(BULLET + getString(Res.string.local_stats_battery, it))
}
}
parts.add(BULLET + getString(Res.string.local_stats_nodes).format(num_online_nodes, num_total_nodes))
parts.add(BULLET + getString(Res.string.local_stats_uptime).format(formatUptime(uptime_seconds)))
parts.add(BULLET + getString(Res.string.local_stats_utilization).format(channel_utilization, air_util_tx))
parts.add(BULLET + getString(Res.string.local_stats_nodes, num_online_nodes, num_total_nodes))
parts.add(BULLET + getString(Res.string.local_stats_uptime, formatUptime(uptime_seconds)))
parts.add(
BULLET +
getString(
Res.string.local_stats_utilization,
NumberFormatter.format(channel_utilization.toDouble(), 2),
NumberFormatter.format(air_util_tx.toDouble(), 2),
),
)
if (heap_free_bytes > 0 || heap_total_bytes > 0) {
parts.add(
BULLET +
getString(Res.string.local_stats_heap) +
": " +
getString(Res.string.local_stats_heap_value).format(heap_free_bytes, heap_total_bytes),
getString(Res.string.local_stats_heap_value, heap_free_bytes, heap_total_bytes),
)
}
// Traffic Stats
if (num_packets_tx > 0 || num_packets_rx > 0) {
parts.add(
BULLET + getString(Res.string.local_stats_traffic).format(num_packets_tx, num_packets_rx, num_rx_dupe),
)
parts.add(BULLET + getString(Res.string.local_stats_traffic, num_packets_tx, num_packets_rx, num_rx_dupe))
}
if (num_tx_relay > 0) {
parts.add(BULLET + getString(Res.string.local_stats_relays).format(num_tx_relay, num_tx_relay_canceled))
parts.add(BULLET + getString(Res.string.local_stats_relays, num_tx_relay, num_tx_relay_canceled))
}
// Diagnostic Fields
val diagnosticParts = mutableListOf<String>()
if (noise_floor != 0) diagnosticParts.add(getString(Res.string.local_stats_noise).format(noise_floor))
if (noise_floor != 0) diagnosticParts.add(getString(Res.string.local_stats_noise, noise_floor))
if (num_packets_rx_bad > 0) {
diagnosticParts.add(getString(Res.string.local_stats_bad).format(num_packets_rx_bad))
diagnosticParts.add(getString(Res.string.local_stats_bad, num_packets_rx_bad))
}
if (num_tx_dropped > 0) diagnosticParts.add(getString(Res.string.local_stats_dropped).format(num_tx_dropped))
if (num_tx_dropped > 0) diagnosticParts.add(getString(Res.string.local_stats_dropped, num_tx_dropped))
if (diagnosticParts.isNotEmpty()) {
parts.add(
BULLET +
getString(Res.string.local_stats_diagnostics_prefix).format(diagnosticParts.joinToString(" | ")),
BULLET + getString(Res.string.local_stats_diagnostics_prefix, diagnosticParts.joinToString(" | ")),
)
}
@ -922,12 +927,16 @@ class MeshServiceNotificationsImpl(
private fun DeviceMetrics.formatToString(): String {
val parts = mutableListOf<String>()
battery_level?.let { parts.add(BULLET + getString(Res.string.local_stats_battery).format(it)) }
uptime_seconds?.let { parts.add(BULLET + getString(Res.string.local_stats_uptime).format(formatUptime(it))) }
battery_level?.let { parts.add(BULLET + getString(Res.string.local_stats_battery, it)) }
uptime_seconds?.let { parts.add(BULLET + getString(Res.string.local_stats_uptime, formatUptime(it))) }
if (channel_utilization != null || air_util_tx != null) {
parts.add(
BULLET +
getString(Res.string.local_stats_utilization).format(channel_utilization ?: 0f, air_util_tx ?: 0f),
getString(
Res.string.local_stats_utilization,
NumberFormatter.format((channel_utilization ?: 0f).toDouble(), 2),
NumberFormatter.format((air_util_tx ?: 0f).toDouble(), 2),
),
)
}
return parts.joinToString("\n")